网站建设运营方案,扬中最近最新事件,东莞网站建设最牛,工业设计就业前景关于 Logback
日志系统是一个线上项目必备的素质之一#xff0c;代表性的日志框架 Log4j、SLF4J、Logback 这哥仨竟然是亲兄弟#xff0c;他们有一个亲爹#xff0c;那就是巨佬 Ceki Gulcu。
由于 Spring Boot 的默认日志框架选用的 Logback#xff0c;再加上 Log4j2 之前…关于 Logback
日志系统是一个线上项目必备的素质之一代表性的日志框架 Log4j、SLF4J、Logback 这哥仨竟然是亲兄弟他们有一个亲爹那就是巨佬 Ceki Gulcu。
由于 Spring Boot 的默认日志框架选用的 Logback再加上 Log4j2 之前爆过严重的漏洞所以我们这次就只关注 Logback。 1Logback 非常自然地实现了 SLF4J不需要像 Log4j 和 JUL 那样加一个适配层。 2Spring Boot 的默认日志框架使用的是 Logback启动编程喵项目的时候就可以看到 Logback 记录的日志了 怎么看出来是 logback 呢 说实话看不出来哈哈哈不过可以从 Spring Boot 官网找到证据。 源码中也偶有 3logback 分为三个模块 logback-core核心模块提供了关键的通用机制logback-classic可以看作是 log4j 的改进版实现了简单的日志门面 SLF4Jlogback-access主要用来和 Servlet 容器交互比如说 Tomcat提供了一些 HTTP 访问的功能。 如果想研究 logback 源码的话可以按照这三个模块去研究 直接上手 不废话直接新建一个空的 Spring Boot 项目在测试类中加上两行代码。 SpringBootTest
class CodingmoreLogbackApplicationTests {static Logger logger LoggerFactory.getLogger(CodingmoreLogbackApplicationTests.class);Testvoid contextLoads() {logger.info(logback testing);}
}
Logger 和 LoggerFactory 都来自 SLF4J所以如果项目是从 Log4j SLF4J 切换到 Logback 的话此时的代码是零改动的。 其他什么也不用做运行后就可以看到 logback 已经正常工作了。 在没有配置文件的情况下一切都是默认的Logback 的日志信息会输出到控制台。可以通过 StatusPrinter 来打印 Logback 的内部信息
LoggerContext lc (LoggerContext)LoggerFactory.getILoggerFactory();
StatusPrinter.print(lc);再次运行测试类可以在控制台看到以下信息 也就是说Logback 会在 classpath 路径下先寻找 logback-test.xml 文件没有找到的话寻找 logback.xml 文件都找不到的话就输出到控制台。 并且Logger 的默认日志级别是 INFO 级别的这就意味着如果尝试下面的代码
logger.debug(哈哈哈哈); 控制台是看不到这行日志输出的。Logback 的日志级别是这样的 TRACE DEBUG INFO WARN ERROR 也就是说小于 INFO 级别的日志都不会记录只有大于等于 INFO 级别的日志才会被记录 编程喵实战项目的日志案例分析 尽管默认配置很有用但它很可能不能满足我们的实际开发需求于是我们需要找到一种更优雅的解决方案。
当 src/main/resources 目录下有以下名称之一的配置文件时Spring Boot 将自动加载它来作为 Logback 的配置项 logback-spring.xmllogback.xmllogback-spring.groovylogback.groovy Spring Boot 建议我们使用 -spring 结尾的配置文件这样可以使用 Spring Boot 的 Profile 功能针对不同的环境开发环境、测试环境、正式环境提供不同的配置项。 编程喵用的是 logback-spring.xml在 codingmore-admin 项目下可以找得到 ?xml version1.0 encodingUTF-8?
!--
scan当此属性设置为true时配置文件如果发生改变将会被重新加载默认值为true。
scanPeriod设置监测配置文件是否有修改的时间间隔如果没有给出时间单位默认单位是毫秒当scan为true时此属性生效。默认的时间间隔为1分钟。
debug当此属性设置为true时将打印出logback内部日志信息实时查看logback运行状态。默认值为false。
--
configuration!-- https://github.com/spring-projects/spring-boot/blob/v1.4.2.RELEASE/spring-boot/src/main/resources/org/springframework/boot/logging/logback/defaults.xml --include resourceorg/springframework/boot/logging/logback/defaults.xml /!-- 定义日志文件名称 --property nameAPP_NAME valuecodingmore-admin /!-- 定义日志文件的路径 --property nameLOG_PATH value${user.home}/${APP_NAME}/logs /!-- 定义日志的文件名 --property nameLOG_FILE value${LOG_PATH}/${APP_NAME}.log /!-- 滚动记录日志先将日志记录到指定文件当符合某个条件时将日志记录到其他文件 --appender nameAPPLICATIONclassch.qos.logback.core.rolling.RollingFileAppender!-- 指定日志文件的名称 --file${LOG_FILE}/file!--当发生滚动时决定 RollingFileAppender 的行为涉及文件移动和重命名TimeBasedRollingPolicy 最常用的滚动策略它根据时间来制定滚动策略既负责滚动也负责触发滚动。--rollingPolicy classch.qos.logback.core.rolling.TimeBasedRollingPolicy!--滚动时产生的文件的存放位置及文件名称%d{yyyy-MM-dd}按天进行日志滚动%i当文件大小超过maxFileSize时按照i进行文件滚动--fileNamePattern${LOG_FILE}.%d{yyyy-MM-dd}.%i.log/fileNamePattern!--可选节点控制保留的归档文件的最大数量超出数量就删除旧文件。假设设置每天滚动且maxHistory是7则只保存最近7天的文件删除之前的旧文件。注意删除旧文件时那些为了归档而创建的目录也会被删除。--maxHistory7/maxHistory!--当日志文件超过maxFileSize指定的大小时根据上面提到的%i进行日志文件滚动注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的必须配置timeBasedFileNamingAndTriggeringPolicy--timeBasedFileNamingAndTriggeringPolicy classch.qos.logback.core.rolling.SizeAndTimeBasedFNATPmaxFileSize50MB/maxFileSize/timeBasedFileNamingAndTriggeringPolicy/rollingPolicy!-- 日志输出格式 --layout classch.qos.logback.classic.PatternLayoutpattern%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n/pattern/layout/appender!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --appender nameCONSOLE classch.qos.logback.core.ConsoleAppender!--日志输出格式%d表示日期时间%green 绿色%thread表示线程名%magenta 洋红色%-5level级别从左显示5个字符宽度 %highlight 高亮色%logger{36} 表示logger名字最长36个字符否则按照句点分割 %yellow 黄色%msg日志消息%n是换行符--layout classch.qos.logback.classic.PatternLayoutpattern%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%magenta(%thread)] %highlight(%-5level) %yellow(%logger{36}): %msg%n/pattern/layout/appender!--root与logger是父子关系没有特别定义则默认为root任何一个类只会和一个logger对应要么是定义的logger要么是root判断的关键在于找到这个logger然后判断这个logger的appender和level。--root levelinfoappender-ref refCONSOLE /appender-ref refAPPLICATION //root
/configuration 具体含义都写在了注释里大家可以细致看一下了解即可。基本上生产环境下的 Logback 配置就是这样的可微调。
也可以使用下面这份 logback-spring.xml。 ?xml version1.0 encodingUTF-8?
configuration include resourceorg/springframework/boot/logging/logback/defaults.xml /property nameAPP_NAME valuecodingmore-admin /property nameLOG_PATH value${user.home}/${APP_NAME}/logs /property nameLOG_FILE value${LOG_PATH}/codingmore-admin.log /appender nameAPPLICATIONclassch.qos.logback.core.rolling.RollingFileAppenderfile${LOG_FILE}/fileencoderpattern${FILE_LOG_PATTERN}/pattern/encoderrollingPolicy classch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicyfileNamePattern${LOG_FILE}.%d{yyyy-MM-dd}.%i.log/fileNamePatternmaxHistory7/maxHistorymaxFileSize50MB/maxFileSizetotalSizeCap2GB/totalSizeCap/rollingPolicy/appenderappender nameCONSOLE classch.qos.logback.core.ConsoleAppenderencoderpattern${CONSOLE_LOG_PATTERN}/patterncharsetutf8/charset/encoder/appenderroot levelinfoappender-ref refCONSOLE /appender-ref refAPPLICATION //root
/configuration
只说几个不同的点。 FILE_LOG_PATTERN 和 CONSOLE_LOG_PATTERN 是在 Spring Boot 中默认定义的。 使用 lombok 进行日志记录 在上面的例子中我们必须在类中声明一个静态的 Logger 对象才能在需要记录日志的地方使用它。 static Logger logger LoggerFactory.getLogger(CodingmoreLogbackApplicationTests.class); 这样的样板代码令人生厌 我们可以通过 lombok 的方式来解决这个问题在 pom.xml 文件中加入依赖。 dependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactId
/dependency 然后在类上加上 Slf4j 注解之后就可以直接使用 log添加Slf4j 注解后会自动添加一个 log 字段来记录日志了。 SpringBootTest
Slf4j
class CodingmoreLogbackApplicationTests {Testvoid testSlf4j() {log.info(哈哈啊哈哈);}
} 运行该测试方法可以在控制台看到日志 日志文件也有 查看字节码反编译后的文件就明白了。lombok 在编译的时候会自动添加一行代码 private static final Logger log LoggerFactory.getLogger(CodingmoreLogbackApplicationTests.class); logback 中文手册 GitHub 上有一份 Logback 的中文手册总共有 150 多页主要包含以下基本的和高级的特性 logback 的整体架构讨论 logback 最好的实践以及反模式logback 的 xml 配置方式appenderencoderlayoutfilter上下文诊断Joran - logback 的配置系统 GitHub - YLongo/logback-chinese-manual: logback 中文手册/文档。
