SpringBoot与日志

落日映苍穹つ 2023-05-29 05:12 203阅读 0赞

文章目录

  • 一、日志框架
  • 二、SLF4J 的使用
    • 2.1 使用 log4J
    • 2.2 slf4j 与实现框架图总览
    • 2.3 统一日志记录
  • 三、SpringBoot 日志关系
  • 四、SpringBoot 中日志的使用
    • 4.1 默认配置
    • 4.2 指定配置
  • 五、切换日志框架

一、日志框架

​ 1、市面上的日志框架:JULJCL(Apache 基金会的)、Jboss-logginglogbacklog4jlog4j2slf4j


















日志门面(日志抽象层) 日志实现
JCLJakarta Commons Logging-属于Apache基金会) jboss-logging JULjava.util.logging-Java JDK自带的)
SLF4jSimple Logging Facade for Java Log4jLog4j2Logback

​ 2、其中 SLF4jLog4jLogback 出自同一人之手,LogbackLog4j 的升级版;而 Log4j2 只是借用了Log4j 的名号而已

​ 3、SpringBoot 底层是 Spring 框架,而 Spring 框架默认是用 JCL,但是 SpringBoot选用的是 SLF4jlogback,所以SpringBoot 的日志框架重点是学习使用 SLF4jlogback

​ 4、所以为了开发日志系统扩展性更好的应用,就得从上表中左右两边各选择一个进行日志接口和实现进行开发,而且编码的时候应该调用左边的接口,而不是右边的实现,这样利于将来扩展。

二、SLF4J 的使用

2.1 使用 log4J

  1. <!--日志-->
  2. <dependency>
  3. <groupId>org.slf4j</groupId>
  4. <artifactId>slf4j-api</artifactId>
  5. <version>1.7.25</version>
  6. </dependency>
  7. <!--log4j需要slf4j-log4j12进行适配,slf4j-log4j12同时依赖了log4j,导入slf4j-log4j12即可-->
  8. <dependency>
  9. <groupId>org.slf4j</groupId>
  10. <artifactId>slf4j-log4j12</artifactId>
  11. <version>1.7.25</version>
  12. </dependency>

log4j.properties

  1. #指定输出信息的级别--以及输出的位置
  2. log4j.rootLogger=DEBUG,console,logFile
  3. #表示Logger不会在父Logger的appender里输出,默认为true
  4. log4j.additivity.org.apache=true
  5. #控制台
  6. log4j.appender.console=org.apache.log4j.ConsoleAppender
  7. log4j.appender.console.layout=org.apache.log4j.PatternLayout
  8. log4j.appender.console.ImmediateFlush=true
  9. log4j.appender.console.Target=System.err
  10. log4j.appender.console.layout.ConversionPattern=%5p [%t] (%c:%L) %d{yyyy-MM-dd HH:mm:ss,SSS} ---- %m%n
  11. #日志文件
  12. log4j.appender.logFile=org.apache.log4j.FileAppender
  13. log4j.appender.logFile.Threshold=DEBUG
  14. log4j.appender.logFile.ImmediateFlush=true
  15. log4j.appender.logFile.Append=true
  16. log4j.appender.logFile.File=D:/logs/log.txt
  17. log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
  18. log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
  19. package com.hucheng.log.log4j;
  20. import org.slf4j.Logger;
  21. import org.slf4j.LoggerFactory;
  22. /** * @author HuCheng */
  23. public class Test {
  24. public static void main(String[] args) {
  25. Logger logger = LoggerFactory.getLogger(Test.class);
  26. logger.info("Hello Slf4j/Log4j");
  27. logger.error("error print");
  28. }
  29. }

开发时,日志记录方法的调用,不应该直接调用日志的实现类,而是调用日志抽象层的方法。每一个日志的实现框架都有自己的配置文件,使用slf4j时,需要使用日志实现框架的配置文件。

2.2 slf4j 与实现框架图总览

slf4j的使用
图中,可以看出:

  • 如果只导入了slf4j-api.jar日志门面,则调用日志记录的方法无效
  • 如果导入slf4j-api.jar和日志实现logback-classic.jar,则调用slf4j之后底层会以logback进行记录
  • 如果导入slf4j-api.jar和日志实现log4j.jar,中间还需要导入一个适配包slf4j-log412.jar,所以当应用中调用SLF4J记录日志的时候,会先经过适配包,最后调用实现包
  • 第4个是jullog4j相似,同样需要适配包…

2.3 统一日志记录

统一日志记录
如何将系统中的所有日志都统一到slf4j?

  1. 将系统中其他日志框架先排除出去
  2. 用中间包来替换原有的日志框架
  3. 我们导入slf4j其他的实现

三、SpringBoot 日志关系

通过分析spring-boot-starter的底层依赖关系,可以看出springboot通过依赖spring-boot-starter-logging来做日志。SpringBoot底层是通过slf4j+logback的方式进行日志记录,同时将其他的日志都替换成了slf4j

springboot日志分析图
如何替换呢?
jcl替换包
创建的LogFactory实际上是用SLF4JLogFactory的实例

  1. @SuppressWarnings("rawtypes")
  2. public abstract class LogFactory {
  3. static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
  4. static LogFactory logFactory = new SLF4JLogFactory();

SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可。

比如Spring框架使用的是commons-loggingspringboot底层使用spring框架需要排除掉commons-logging

  1. <dependency>
  2. <groupId>org.springframework</groupId>
  3. <artifactId>spring-core</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <groupId>commons-logging</groupId>
  7. <artifactId>commons-logging</artifactId>
  8. </exclusion>
  9. </exclusions>
  10. </dependency>

四、SpringBoot 中日志的使用

4.1 默认配置

SpringBoot默认集成了日志服务:

  1. //日志记录器
  2. Logger logger = LoggerFactory.getLogger(getClass());
  3. @Test
  4. public void contextLoads() {
  5. //日志的级别;
  6. //由低到高 trace<debug<info<warn<error
  7. //可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效
  8. logger.trace("这是trace日志...");
  9. logger.debug("这是debug日志...");
  10. //SpringBoot默认给我们使用的是info级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别
  11. logger.info("这是info日志...");
  12. logger.warn("这是warn日志...");
  13. logger.error("这是error日志...");
  14. }

输出:

  1. 2019-11-04 16:35:43.636 INFO 12604 --- [ main] c.h.log.SpringbootLogApplicationTests : 这是info日志...
  2. 2019-11-04 16:35:43.636 WARN 12604 --- [ main] c.h.log.SpringbootLogApplicationTests : 这是warn日志...
  3. 2019-11-04 16:35:43.637 ERROR 12604 --- [ main] c.h.log.SpringbootLogApplicationTests : 这是error日志...

日志输出格式:

  1. %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
  2. 注:
  3. %d表示日期时间,
  4. %thread表示线程名,
  5. %-5level:级别从左显示5个字符宽度
  6. %logger{50} 表示logger名字最长50个字符,否则按照句点分割。
  7. %msg:日志消息,
  8. %n是换行符

springboot修改日志的默认配置

  1. # 修改日志的级别,默认级别为info
  2. logging.level.com.atguigu=trace
  3. # 指定完整的路径
  4. #logging.file=G:/springboot.log
  5. # 仅指定路径,使用 spring.log 作为默认文件
  6. logging.path=/spring/log
  7. # 在控制台输出的日志的格式
  8. logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
  9. # 指定文件中日志输出的格式
  10. logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

当配置文件中logging.filelogging.path存在或不存在时(推荐仅使用logging.path):































logging.file logging.path Description
只在控制台输出
输出日志到指定文件中
输出到指定目录的 spring.log 文件中
相当于logging.file仅存的情况

4.2 指定配置

给类路径下放上每个日志框架自己的配置文件即可,就会替代SpringBoot的默认配置,以下是各日志实现的配置文件默认文件名:






















日志实现 文件名
Logback logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2 log4j2-spring.xml or log4j2.xml
JUL logging.properties

​ SpringBoot官方建议使用logback-spring.xml,具体的配置参考logback-spring.xml文件。

当使用logback.xml,应用启动时会被日志框架logback识别而使用,不经过SpringBoot,如果需要使用SpringBootProfile高级功能即文档块功能则就需要使用logback-spring.xml

profile需新增配置:

  1. <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
  2. <layout class="ch.qos.logback.classic.PatternLayout">
  3. <springProfile name="dev">
  4. <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
  5. </springProfile>
  6. <springProfile name="!dev">
  7. <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
  8. </springProfile>
  9. </layout>
  10. </appender>

五、切换日志框架

使用slf4j+log4j的方式

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <artifactId>logback-classic</artifactId>
  7. <groupId>ch.qos.logback</groupId>
  8. </exclusion>
  9. <exclusion>
  10. <artifactId>log4j-over-slf4j</artifactId>
  11. <groupId>org.slf4j</groupId>
  12. </exclusion>
  13. </exclusions>
  14. </dependency>
  15. <dependency>
  16. <groupId>org.slf4j</groupId>
  17. <artifactId>slf4j-log4j12</artifactId>
  18. </dependency>

使用slf4j+log4j2的方式

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. <exclusions>
  5. <exclusion>
  6. <artifactId>spring-boot-starter-logging</artifactId>
  7. <groupId>org.springframework.boot</groupId>
  8. </exclusion>
  9. </exclusions>
  10. </dependency>
  11. <dependency>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-log4j2</artifactId>
  14. </dependency>

发表评论

表情:
评论列表 (有 0 条评论,203人围观)

还没有评论,来说两句吧...

相关阅读

    相关 SpringBoot

    日志级别是开发人员设置的,用来给开发人员看的,开发人员根据自己的理解来判断该信息的重要程度,若将ERROR级别的日志设置成INFO,很有可能会影响开发人员对项目运行情况的...

    相关 SpringBoot

            在代码有问题的时候,很多人应该都是通过 debug 的方式去排查,往往忽略了日志的重要性。好的日志管理可以快速定位问题出现的位置,也可以提高代码的阅读性。

    相关 springboot

    springboot自动配置原理 配置文件到底能写什么呢?很多----参照官方文档的最后一个模块,但是还是很多,看懂原理就很简单了 首先springBoot加载主配置类@