springboot日志依赖 springboot日志yml配置

转载

技术领航者之声 2024-03-16 09:22:03

文章标签 springboot日志依赖 log4j spring boot java spring 文章分类 架构后端开发

1.引入相关的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>


<!-- 包含 mvc,aop 等jar资源 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!-- 切换log4j2日志读取 -->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>


<!-- 配置 log4j2 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
<!-- 加上这个才能辨认到log4j2.yml文件 -->
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-yaml</artifactId>
</dependency>

注意
一定要注意项目中原本的依赖，可能会有冲突，因为使用log4j2依赖一定要排除原本项目中的log4j、logback相关依赖。
我就在此处一直报错，但是最后也不知道哪里错了。。

如果一直报错，如下代码所示。就在右侧maven框中，将项目clean再install一下。

2.配置相应的log4j2.yml及application.yml文件

log4j2.yml

# 共有8个级别，按照从低到高为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF。
# intLevel值依次为0,100,200,300,400,500,600,700
# intLevel 值越小，级别越高
Configuration:
  #日志框架本身的输出日志级别
  status: WARN
  #自动加载配置文件的间隔时间，不低于5秒
  monitorInterval: 5

  Properties: # 定义全局变量
    Property: # 缺省配置（用于开发环境）。其他环境需要在VM参数中指定，如下：
      #测试：-Dlog.level.console=warn -Dlog.level.xjj=trace
      #生产：-Dlog.level.console=warn -Dlog.level.xjj=info
      - name: log.level.console
        value: info
      - name: log.path
        value: ./${project.name}_log
      - name: project.name
        value: daily
      - name: log.pattern
        value: "%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-30.30C{1.} : %m%n"

  Appenders:
    Console:  #输出到控制台
      name: CONSOLE
      target: SYSTEM_OUT
      PatternLayout:   #日志消息格式
        pattern: ${log.pattern}
    #   启动日志
    RollingFile:
      - name: ROLLING_FILE
        fileName: ${log.path}/daily/${project.name}.log        #输出文件的地址
        filePattern: "${log.path}/daily/$${date:yyyy-MM-dd}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"   #文件生成规则
        PatternLayout:
          pattern: ${log.pattern}
        Filters:
          #  一定要先去除不接受的日志级别，然后获取需要接受的日志级别
          ThresholdFilter:   # 日志级别过滤器
            - level: error   # 日志级别
              onMatch: DENY  # 高于的拒绝
              onMismatch: NEUTRAL  # 低于的
            - level: info
              onMatch: ACCEPT
              onMismatch: DENY
        Policies:
          SizeBasedTriggeringPolicy: # 日志拆分规则
            size: "10MB"
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 单目录下，文件最多20个，超过会删除最早之前的
          max: 20
      #   错误日志
      - name: EXCEPTION_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/exception/${project.name}_exception.log
        filePattern: "${log.path}/exception/$${date:yyyy-MM-dd}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        ThresholdFilter:
          level: error
          #onMatch="ACCEPT" 匹配该级别及以上
          #onMatch="DENY"  不匹配该级别及以上
          #onMismatch="ACCEPT"  表示匹配该级别以下的级别
          #onMismatch="DENY"  不表示匹配该级别以下的级别
          onMatch: ACCEPT
          onMismatch: DENY
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          SizeBasedTriggeringPolicy: # 日志拆分规则
            size: "10MB"
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 100
      # 警告日志
      - name: WARN_ROLLING_FILE
        ignoreExceptions: false
        fileName: ${log.path}/warn/${project.name}_warn.log
        filePattern: "${log.path}/warn/$${date:yyyy-MM-dd-dd}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        ThresholdFilter:
          level: warn
          #onMatch="ACCEPT" 匹配该级别及以上
          #onMatch="DENY"  不匹配该级别及以上
          #onMismatch="ACCEPT"  表示匹配该级别以下的级别
          #onMismatch="DENY"  不表示匹配该级别以下的级别
          onMatch: ACCEPT
          onMismatch: DENY
        PatternLayout:
          pattern: ${log.pattern}
        Policies:
          SizeBasedTriggeringPolicy: # 日志拆分规则
            size: "10MB"
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 20
     # 用户行为日志
      - name: ROLLING_FILE_USER
        fileName: ${log.path}/user/user-${project.name}.log
        filePattern: "${log.path}/user/$${date:yyyy-MM-dd}/user-${project.name}-%d{yyyy-MM-dd}-%i.log.gz"
        PatternLayout:
          pattern: ${log.pattern}
        Filters:
          #        一定要先去除不接受的日志级别，然后获取需要接受的日志级别
          ThresholdFilter:
            - level: error
              onMatch: DENY
              onMismatch: NEUTRAL
              #onMismatch:NEUTRAL 交给下一个filter处理
            - level: info
              onMatch: ACCEPT
              onMismatch: DENY
        Policies:
          SizeBasedTriggeringPolicy: # 日志拆分规则
            size: "10MB"
          TimeBasedTriggeringPolicy:  # 按天分类
            modulate: true
            interval: 1
        DefaultRolloverStrategy:     # 文件最多100个
          max: 100

  Loggers:
    Root:
      # 共有8个级别，按照从低到高为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF  选择all则输出全部的日志
      level: info
      AppenderRef:
        - ref: CONSOLE
        - ref: ROLLING_FILE
        - ref: EXCEPTION_ROLLING_FILE
        - ref: WARN_ROLLING_FILE
    Logger:
      - name: exception
        level: debug
        additivity: true  #追加
        AppenderRef:
          - ref: EXCEPTION_ROLLING_FILE

    #监听具体包下面的日志
#    Logger: # 为com.xjj包配置特殊的Log级别，方便调试
      - name: com.example.aspect
        additivity: false
        level: info
        AppenderRef:
          - ref: CONSOLE
          - ref: ROLLING_FILE_USER

我把目前所知道的配置的信息都放上去了。

application.yml

指明log4j2.yml的位置(注意将原本springboot文件中内置日志的相关配置清除）

logging:
  config: classpath:log4j2.yml

3.编写相应的测试接口

import com.example.domain.User;
import com.example.mapper.UserMapper;
import com.example.utils.result.R;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@Slf4j
@RestController
@RequestMapping("/user")
@RequiredArgsConstructor(onConstructor_ = @Autowired)
public class UserController {
    private final UserMapper userMapper;

    @GetMapping("/hello")
    public R getInfo(){
        log.debug("debug ****************************");
        log.info("info ****************************");
        log.warn("warn ****************************");
        log.error("error ****************************");
        List<Map<String, Object>> maps = this.userMapper.selectMaps(null);
        return R.ok(maps);
    }

    @GetMapping("/hello2")
    public R getInfo2(){
        log.debug("debug ****************************");
        log.info("info ****************************");
        log.warn("warn ****************************");
        log.error("error ****************************");
            User user = User.builder()
                    .userName("111")
                    .userPwd("222")
                    .createTime(new Date()).build();
            Map<Object, Object> map = new HashMap<>();
            return R.ok(user);
    }

}