Springboot+logback

超、凢脫俗 2022-06-05 12:36 190阅读 0赞

*  如何引入日志？
 *  日志输出格式以及输出方式如何配置？
 *  代码中如何使用？
    
    # 正文 #
    
    Spring Boot在所有内部日志中使用Commons Logging，但是默认配置也提供了对常用日志的支持，如：[Java ][Java]Util Logging，Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。
    
    # 默认日志Logback #
    
    SLF4J——Simple Logging Facade For [Java][]，它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口，而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。
    
    Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。
    
    默认情况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。在运行应用程序和其他例子时，你应该已经看到很多INFO级别的日志了。
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot]
    
    从上图可以看到，日志输出内容元素具体如下：
    
     *  在运行命令后加入--debug标志，如：$ java -jar springTest.jar --debug
     *  在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含[嵌入式][Link 1]容器、[hibernate][]、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。
    
    文件输出
    
    默认情况下，Spring Boot将日志输出到控制台，不会写到日志文件。如果要编写除控制台输出之外的日志文件，则需在application.properties中设置logging.file或logging.path属性。
    
     *  logging.level：日志级别控制前缀，\*为包名或Logger名
     *  LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
    
    举例：
    
     *  Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
     *  Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
     *  Log4j2：log4j2-spring.xml, log4j2.xml
     *  JDK ([java ][Java]Util Logging)：logging.properties
    
    Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。
    
    上面是默认的命名规则，并且放在src/main/resources下面即可。
    
    如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以通过logging.config属性指定自定义的名字：
    
        logging.config=classpath:logging-config.xml
    
    虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时Profile使用不同的日
    
    志配置，这个功能会很有用。
    
    下面我们来看看一个普通的logback-spring.xml例子
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 1]
    
    # 根节点<configuration>包含的属性 #
    
     *  %d\{HH: mm:ss.SSS\}——日志输出时间
     *  %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
     *  %-5level——日志级别，并且使用5个字符靠左对齐
     *  %logger\{36\}——日志输出者的名字
     *  %msg——日志消息
     *  %n——平台的换行符
    
    ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志~
    
    # 输出到文件RollingFileAppender #
    
    另一种常见的日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志：
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 2]
    
    其中重要的是rollingPolicy的定义，上例中<fileNamePattern>logback.%d\{yyyy-MM-dd\}.log</fileNamePattern>定义了日志的切分方式——把每一天的日志归档到一个文件中，<maxHistory>30</maxHistory>表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d\{yyyy-MM-dd\_HH-mm\}来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。
    
    # 子节点二<root> #
    
    root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。
    
     *  name:用来指定受此loger约束的某一个包或者具体的某一个类。
     *  level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
     *  addtivity:是否向上级loger传递打印信息。默认是true。
    
    loger在实际使用的时候有两种情况，先来看一看代码中如何使用：
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 3]
    
    这是一个登录的判断的方法，我们引入日志，并且打印不同级别的日志，然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。
    
    # 第一种：带有loger的配置，不指定级别，不指定appender #
    
        <logger name="com.dudu.controller"/>
    
    <logger name="com.dudu.controller" />将控制controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级<root>的日志级别“info”；
    
    没有设置addtivity，默认为true，将此loger的打印信息向上级传递；
    
    没有设置appender，此loger本身不打印任何信息。
    
    <root level="info">将root的打印级别设置为“info”，指定了名字为“console”的appender。
    
    当执行com.dudu.controller.LearnController类的login方法时，LearnController 在包com.dudu.controller中，所以首先执行<logger name="com.dudu.controller"/>，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印；
    
    root接到下级传递的信息，交给已经配置好的名为“console”的appender处理，“console”appender将信息打印到控制台；
    
    打印结果如下：
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 4]
    
    # 第二种：带有多个loger的配置，指定级别，指定appender #
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 5]
    
    控制com.dudu.controller.LearnController类的日志打印，打印级别为“WARN”
    
    additivity属性为false，表示此loger的打印信息不再向上级传递
    
    指定了名字为“console”的appender
    
    这时候执行com.dudu.controller.LearnController类的login方法时，先执行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">,
    
    将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理，在控制台中打出日志，不再向上级root传递打印信息。
    
    打印结果如下：
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 6]
    
    当然如果你把additivity="false"改成additivity="true"的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。
    
    # 多环境日志输出 #
    
    据不同环境（prod:生产环境，test:[测试][Link 2]环境，dev:开发环境）来定义不同的日志输出，在 logback-spring.xml中使用 springProfile 节点来定义，方法如下：
    
    文件名称不是logback.xml，想使用spring扩展profile支持，要以logback-spring.xml命名
    
    ![Spring Boot干货系列：（七）默认日志框架配置][Spring Boot 7]
    
    可以启动服务的时候指定 profile （如不指定使用默认），如指定prod 的方式为：
    
    java -jar xxx.jar --spring.profiles.active=prod
    
    关于多环境配置可以参考
    
    [Spring Boot干货系列：（二）配置文件解析][Spring Boot 8]  
    
    
    # 总结 #
    
    到此为止终于介绍完日志框架了，平时使用的时候推荐用自定义logback-spring.xml来配置，代码中使用日志也很简单，类里面添加private Logger logger = LoggerFactory.getLogger(this.getClass());即可。
    
    # 源码下载 #
    
    (￣︶￣)↗\[相关示例完整代码\]
    
    https://github.com/tengj/SpringBootDemo/tree/master
    
    用心写作跟不用心写作相信大家都看的出来，在这信息爆炸的时代，获取信息的来源很多，唯一用来刻量的标准就是所花费的时间，博主一直希望自己写的教程能节省你们的时间，一直以看我一篇就够的态度要求自己。
    
    如果你觉得博主这篇教程还不错，可以下面几种方式来支持下博主：
    
     *

[Java]: http://lib.csdn.net/base/java
[Spring Boot]: http://p3.pstatp.com/large/1af00003fe944d9375b3
[Link 1]: http://lib.csdn.net/base/embeddeddevelopment
[hibernate]: http://lib.csdn.net/base/javaee
[Spring Boot 1]: http://p3.pstatp.com/large/1af90003e226c961c1f5
[Spring Boot 2]: http://p9.pstatp.com/large/1af60003f857b07a455a
[Spring Boot 3]: http://p3.pstatp.com/large/1af10003fdea92d59fd6
[Spring Boot 4]: /images/20220605/513c2855c6644811bdb5836791178a38.png
[Spring Boot 5]: http://p3.pstatp.com/large/1af10003fe932f500c3c
[Spring Boot 6]: http://p9.pstatp.com/large/1af10003fefd55323086
[Link 2]: http://lib.csdn.net/base/softwaretest
[Spring Boot 7]: http://p3.pstatp.com/large/1af20003e4dfb7a65f6f
[Spring Boot 8]: http://m.toutiao.com/i6392145028591911425/?group_id=6392140402656805122&group_flags=0

Springboot+logback

发表评论取消回复

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

相关阅读