Java项目引入日志生成器及其日志分级

• 项目情况
• • 依赖引入
  • bootstrap.yml文件添加内容
  • 添加日志生成器配置文件
  • 使用

项目情况

maven管理依赖的spring（spring-cloud-alibaba）项目，使用idea编译，jdk版本1.8。

为项目引入日志生成器，为方便依赖管理，决定采用Lombok自带的Slf4j，加上logstash-logback-encoder，实现日志分级输出到文件和控制台。

依赖引入

项目pom文件里添加以下依赖，然后重新加载依赖。

        org.projectlomboklombok1.18.24providednet.logstash.logbacklogstash-logback-encoder4.11

bootstrap.yml文件添加内容

bootstrap.yml是spring cloud的配置文件，可以存在多个，在指定的bootstrap.yml文件里，添加日志相关配置。

logging:file:path: logs #content root目录下的logs文件夹存放日志，不存在则创建level: #设置指定包下的日志级别com:alibaba:nacos:client:config:impl: warnexample: debugorg:apache:ibatis:logging:jdbc: debugpattern: # 日志输出格式console:%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n

添加日志生成器配置文件

在resources文件夹下新增两个文件logback-json.xml、logback-spring.xml。

logback-json.xml

${JSON_LOG_FILE}${LOG_FILE_CLEAN_HISTORY_ON_START:-false}${JSON_ROLLING_FILE_NAME_PATTERN:-${JSON_LOG_FILE}.%d{yyyy-MM-dd}.%i.gz}${LOG_FILE_MAX_SIZE:-512MB}${LOG_FILE_MAX_HISTORY:-30}${LOG_FILE_TOTAL_SIZE_CAP:-0}UTC{"serviceName": "${LOG_NAME}","level": "%level","trace": "%X{X-B3-TraceId:-}","span": "%X{X-B3-SpanId:-}","parent": "%X{X-B3-ParentSpanId:-}","thread": "%thread","class": "%logger{40}","message": "%message","exception": "%exception{10}"}

logback-spring.xml

${LOG_NAME}%boldMagenta(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %cyan(%logger{50}) - %msg %ndebug%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%nUTF-8${LOG_PATH}/${LOG_NAME}-debug.%d{yyyy-MM-dd}.log${LOG_FILE_MAX_HISTORY}${LOG_FILE_MAX_SIZE}INFO%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%nUTF-8${LOG_PATH}/${LOG_NAME}-info.%d{yyyy-MM-dd}.log${LOG_FILE_MAX_HISTORY}${LOG_FILE_MAX_SIZE}ERROR%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%nUTF-8${LOG_PATH}/${LOG_NAME}-error.%d{yyyy-MM-dd}.log${LOG_FILE_MAX_HISTORY}${LOG_FILE_MAX_SIZE}

使用

if (log.isDebugEnabled()) {log.info("测试日志");
}

2022-12-20 16:28:54 [http-nio-8088-exec-1] INFO  com.example.interfaces.UserController - 测试日志