美文网首页
Spring Boot日志框架

Spring Boot日志框架

作者: wencai | 来源:发表于2018-07-08 12:25 被阅读0次

    日志的选取需要考虑以下几个因素:
    1)性能和易用性
    2)容错性:日志的运行应该不影响系统的正常运行
    3)规范化:日志是否能分级别打印、日志打印信息是否完善

    一、常见日志框架

    抽象框架SLF4J--Simple Logging Facade For Java,定义了统一的日志抽象接口,真正的日志实现是在运行时决定的。
    实现框架Log4j,Log4j2,Logback,JCL(Jakarta Commons Logging API)。其中SLF4J、Log4j、Logback都是由一个人所写,Logback是Log4j的升级版,而Log4j2则是Apache借用Log4j的名出的日志框架。Spring框架默认使用JCL。

    二、Spring Boot默认日志框架

      Spring Boot默认使用Logback来记录日志,并用INFO级别输出到控制台。程序启动时即可看到打印的信息:



    上图可看出日志的组成结构:

    • 时间日期:精确到毫秒
    • 日志级别:ERROR、WARN、INFO、DEBUG、TRACE
    • 进程ID
    • 分隔符: ---标识实际日志的开始
    • 线程名
    • Logger名:通常使用源代码的类名
    • 日志内容
      再看类关系图:



      因为spring-boo-starter中包含了spring-boot-starter-logging,所以不需要特别引入日志包。

    三、简单用法

      在类中要使用Logback只需调用以下代码:

    private Logger logger = LoggerFactory.getLogger(getClass());//注意引入的是SLF4J的包
    

    通过在xx.application文件中直接配置即可实现的功能

    1.控制台输出

    debug=true//核心Logger(嵌入器、spring等)会输出更多内容,但是你自己应用的日志并不会输出DEBUG级别
    

    2.文件输出

    logging.file:设置日志文件,可以是相对路径,也可以是绝对路径。如logging.file=my.log
    logging.path:设置日志目录,会在该目录下创建spring.log文件。如logging.path=/app/logs
      二者同时使用时,只有logging.file生效。默认情况下,日志文件大小达到10MB时会切分一次,产生新的日志文件。

    3.级别控制

    使用格式为:logging.level.=LEVEL
    logging.level:日志级别控制前缀,
    为包名或Logger名
    LEVEL:选型有TRACE,DEBUG,INFO,WARN,ERROR等
    示例:

    logging.level.oracle=INFO    //oracle日志以warn级别输出
    logging.level.com.mytest=DEBUG    //com.mytest包下所有class以DEBUG级别输出
    

    四、自定义日志配置文件

    1.配置文件详解

    以logback-spring为例

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration  scan="true" scanPeriod="60 seconds" debug="false">
        <contextName>wcintegrate</contextName>
        <property name="log.path" value="d:/my_logs/wcintegrate" />
    
        <!--<encoder>表示对日志进行编码:
        %d{HH: mm:ss.SSS}——日志输出时间
        %thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
        %-5level——日志级别,并且使用5个字符靠左对齐
        %logger{36}——日志输出者的名字
        %msg——日志消息
        %n——平台的换行符-->
    
        <!--输出到控制台-->
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            <!-- ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR
            级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志-->
            <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                 <level>ERROR</level>
             </filter>-->
            <encoder>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </encoder>
        </appender>
    
        <!--输出到文件-->
        <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
            </rollingPolicy>
            <!--RollingFileAppender用于切分文件日志:
            <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>定义
            了日志的切分方式——把每一天的日志归档到一个文件中,<maxHistory>30</maxHistory>表
            示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可以使用%d{yyyy-MM-dd_HH-mm}
            来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>用来指定日志文件的
            上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
            补:如果你想把日志直接放到当前项目下,把${log.path}/去掉即可。-->
            <encoder>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </encoder>
        </appender>
    
        <root level="info">
            <appender-ref ref="console" />
            <appender-ref ref="file" />
        </root>
    
        <!-- logback为java中的包 -->
        <logger name="com.app.controller"/>
        <!--logback.LogbackDemo:类的全路径 -->
        <logger name="com.app.controller.testController" level="WARN" additivity="false">
            <appender-ref ref="console"/>
        </logger>
    </configuration>
    
    1)根节点<configuration>的属性
    • scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
    • scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
    • debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
      根节点<configuration>下共有两个属性,三个子节点。
    2)属性一:上下文名称<contextName>

      主要作用是打印时显示,用于区分是用哪个logger打印的,可不设置。

    3)属性二:变量<property>

      用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。

    4)子节点一:<appender>

      appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

    5)子节点二:<root>

      root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。

    • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。可以包含零个或多个元素,标识这个appender将会添加到这个logger。
    6)子节点三:<logger>

      <logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。

    • name:用来指定受此logger约束的某一个包或者具体的某一个类。
    • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特殊值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger将会继承上级的级别。
    • addtivity:是否向上级logger传递打印信息。默认是true。
      root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。

    2.配置文件区别

    logback.xml和logback-spring.xml都可作为日志框架配置文件正常使用。区别如下:

    • logback.xml:直接就被日志框架识别了;
    • logback-spring.xml:日志框架不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能。

    3.多环境配置

      如下所示,在不同环境下使用不同的日志输出格式:

    <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level%logger{50} ‐ %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level
        %logger{50} ‐ %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>
    

    五、常见问题

    1.一个项目中多日志框架

      Spring Boot能自动适配所有的日志,底层使用sl4j+logback的方式记录日志,如果引入其他框架时,一定要把这个框架的默认日志实现依赖移除掉。如Spring默认使用java.commons.logging。

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

    六、文献

    https://blog.csdn.net/J080624/article/details/80632121
    http://tengj.top/2017/04/05/springboot7/
    https://blog.csdn.net/wujianmin577/article/details/68922545

    相关文章

      网友评论

          本文标题:Spring Boot日志框架

          本文链接:https://www.haomeiwen.com/subject/rcqouftx.html