spring整合logback

1 场景

spring中整合logback。

logback官网：http://logback.qos.ch/

self4j官网：http://www.slf4j.org/

1.1 版本说明

jdk版本：1.8

spring版本：5.2.2.RELEASE

logback版本：1.2.3

1.2 代码地址

https://github.com/yjhcpdd/mymvc

1.3 项目结构

--java
--resources
    --conf
    --properties
    -logback.xml***[1]

java外层包路径为：com.demo.cs

2 整合步骤

2.1 配置maven依赖

<!-- ==========【日志类】========== -->
<!-- logback依赖包(初始化内容，是通过System.out控制台的方式) -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<!-- commons-logging日志桥接器(日志输出重定向到SLF4J) -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.30</version>
</dependency>
<!-- log4j日志桥接器(日志输出重定向到SLF4J) -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.30</version>
</dependency>
<!-- logback集成spring（可以不集成，集成后，可在web.xml中进行配置） -->
<dependency>
    <groupId>org.logback-extensions</groupId>
    <artifactId>logback-ext-spring</artifactId>
    <version>0.1.5</version>
</dependency>

2.2 配置web.xml

此步可以跳过，经过校验，不进行此配置，logback和spring也能正常整合。如果没有必要，可以跳过此步骤。

<!-- logback日志配置(不需 要配置)
    此配置用于：
    (1)替换logbackConfigLocation内容中的占位符${}[用于不同环境引用不同的配置文件]，默认即会进行替换；
    (2)JUL桥接到SLF4J[已在pom中进行了桥接，此处不再需要]；） -->
<context-param>
    <param-name>logbackConfigLocation</param-name>
    <param-value>classpath:logback.xml</param-value>
</context-param>
<listener>
    <listener-class>ch.qos.logback.ext.spring.web.LogbackConfigListener</listener-class>
</listener>

2.3 logback配置

在resources主目录下，创建并配置配置文件：logback.xml[1]，参数说明已在注释中。

配置文件的主要结构（伪代码）如下：

<configuration>
    <!-- 全局参数 -->
    <property />
    
    <!-- 日志输出源(控制台) -->
    <appender class="ch.qos.logback.core.ConsoleAppender"/>
    <!-- 日志输出源(滚动输出到文件，可过滤日志级别) -->
    <appender class="ch.qos.logback.core.rolling.RollingFileAppender"/>
    <!-- 日志输出原(异步输出，保证效率) -->
    <appender class="ch.qos.logback.classic.AsyncAppender">
        <!-- 关联的具体日志输出源(滚动输出到文件) -->
        <appender-ref ref="xxx"/>
    </appender>
    
    <!-- 全局日志管理 -->
    <root level="xxx">
        <!-- 全局日志输出源 -->
        <appender-ref ref="xxx"/>
        <appender-ref ref="xxx"/>
    </root>
    
    <!-- 定制日志输出源(用于定制输出“指定类”或者“指定接口”的日志) -->
    <logger name="com.xxx.xxx.xxx" level="xxx" additivity="false">
        <appender-ref ref="xxx"/>
    </logger>
</configuration>

以下配置文件实现了如下功能：
（1）控制台输出日志级别DEBUG、WARN、ERROR的日志信息
（2）DEBUG、WARN、ERROR级别的日志，分别滚动打印到tomcat目录下logback-logs文件夹下的指定文件中。一天一个日志文件夹，文件保留10天，每天的文件大小超过100MB，会产生新的日志文件，文件名包括当天文件序号和文件的创建时间。
（3）可通过注释掉的logger节点，在线配置某个包或者某个类下的日志级别和输出源。
（4）配置文件可在线更改，60s自动检测一次后生效。

此配置可做生产使用：

<?xml version="1.0" encoding="UTF-8"?>
<!--【configuration属性配置】
    （1）scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
    （2）scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
    （3）debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 上下文名称，默认default -->
    <!--<contextName>default</contextName>-->
    
    <!-- 定义变量：通用日志输出格式
     %d:日期；%thread：线程名；%-5level：左对齐5个字符显示日志级别；%logger：日志位置；%msg：日志消息；%n：换行符；-->
    <property name="COMMON_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] [%-5level] %logger - %msg%n" />
    <!-- 定义变量：日志文件输出路径(只可定义绝对路径，${catalina.home}为环境变量中的tomcat根目录) -->
    <property name="LOG_HOME" value="${catalina.home}/logback-logs" />
    
    <!-- 日志写到控制台（appender：负责写日志的组件） -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 输出格式化 -->
            <pattern>${COMMON_LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- ==========DEBUG级别日志配置========== -->
    <!-- DEBUG输出到文件（每天生成带日期文件，文件大小最大1k） -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志过滤器，只过滤需要的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>  
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 按照日期和大小循环生成日志 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 文件名格式 -->
            <fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/debug.%d{yyyy-MM-dd}.(%i).%d{HHmmss}.log</fileNamePattern>
            <!-- 每个文件最大 -->
            <maxFileSize>100MB</maxFileSize>
            <!-- 日志最大的历史 10天 -->
            <maxHistory>10</maxHistory>
        </rollingPolicy>
        <encoder>
            <!-- 输出格式化 -->
            <pattern>${COMMON_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 异步DEBUG输出到文件（使用异步日志，先写入阻塞队列，再写入磁盘。避免日志记录时会占用大量的CPU和IO资源） -->
    <appender name="ASYNC_DEBUG_FILE" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 默认当BlockingQueue还有20%容量，将丢弃TRACE、DEBUG和INFO级别的event，只保留WARN和ERROR级别的event。为了保持所有的events，设置该值为0。 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 队列大小，默认256，该值会影响性能 -->
        <queueSize>1024</queueSize>
        <!-- 关联appender -->
        <appender-ref ref="DEBUG_FILE"/>
    </appender>

    <!-- ==========WARN级别日志配置========== -->
    <!-- WARN输出到文件（每天生成带日期文件，文件大小最大1k） -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志过滤器，只过滤需要的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 按照日期和大小循环生成日志 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 文件名格式 -->
            <fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/warn.%d{yyyy-MM-dd}.(%i).%d{HHmmss}.log</fileNamePattern>
            <!-- 每个文件最大 -->
            <maxFileSize>100MB</maxFileSize>
            <!-- 日志最大的历史 10天 -->
            <maxHistory>10</maxHistory>
        </rollingPolicy>
        <encoder>
            <!-- 输出格式化 -->
            <pattern>${COMMON_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 异步WARN输出到文件（使用异步日志，先写入阻塞队列，再写入磁盘。避免日志记录时会占用大量的CPU和IO资源） -->
    <appender name="ASYNC_WARN_FILE" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 默认当BlockingQueue还有20%容量，将丢弃TRACE、DEBUG和INFO级别的event，只保留WARN和ERROR级别的event。为了保持所有的events，设置该值为0。 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 队列大小，默认256，该值会影响性能 -->
        <queueSize>1024</queueSize>
        <!-- 关联appender -->
        <appender-ref ref="WARN_FILE"/>
    </appender>

    <!-- ==========ERROR级别日志配置========== -->
    <!-- ERROR输出到文件（每天生成带日期文件，文件大小最大1k） -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志过滤器，只过滤需要的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 按照日期和大小循环生成日志 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 文件名格式 -->
            <fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/error.%d{yyyy-MM-dd}.(%i).%d{HHmmss}.log</fileNamePattern>
            <!-- 每个文件最大 -->
            <maxFileSize>100MB</maxFileSize>
            <!-- 日志最大的历史 10天 -->
            <maxHistory>10</maxHistory>
        </rollingPolicy>
        <encoder>
            <!-- 输出格式化 -->
            <pattern>${COMMON_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 异步ERROR输出到文件（使用异步日志，先写入阻塞队列，再写入磁盘。避免日志记录时会占用大量的CPU和IO资源） -->
    <appender name="ASYNC_ERROR_FILE" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 默认当BlockingQueue还有20%容量，将丢弃TRACE、DEBUG和INFO级别的event，只保留WARN和ERROR级别的event。为了保持所有的events，设置该值为0。 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 队列大小，默认256，该值会影响性能 -->
        <queueSize>1024</queueSize>
        <!-- 关联appender -->
        <appender-ref ref="ERROR_FILE"/>
    </appender>

    <!-- ==========CUSTOM级别日志配置========== -->
    <!-- CUSTOM输出到文件（每天生成带日期文件，文件大小最大1k） -->
    <appender name="CUSTOM_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 按照日期和大小循环生成日志 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 文件名格式 -->
            <fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/custom/custom.%d{yyyy-MM-dd}.(%i).%d{HHmmss}.log</fileNamePattern>
            <!-- 每个文件最大 -->
            <maxFileSize>100MB</maxFileSize>
            <!-- 日志最大的历史 10天 -->
            <maxHistory>10</maxHistory>
        </rollingPolicy>
        <encoder>
            <!-- 输出格式化 -->
            <pattern>${COMMON_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 异步CUSTOM输出到文件（使用异步日志，先写入阻塞队列，再写入磁盘。避免日志记录时会占用大量的CPU和IO资源） -->
    <appender name="ASYNC_CUSTOM_FILE" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 默认当BlockingQueue还有20%容量，将丢弃TRACE、DEBUG和INFO级别的event，只保留WARN和ERROR级别的event。为了保持所有的events，设置该值为0。 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 队列大小，默认256，该值会影响性能 -->
        <queueSize>1024</queueSize>
        <!-- 关联appender -->
        <appender-ref ref="CUSTOM_FILE"/>
    </appender>
    
    <!-- “根”日志的记录器（root日志记录器的默认level是DEBUG），最多一个root元素
     日志级别：TRACE<DEBUG<INFO<WARN<ERROR
     日志级别定义在类：ch.qos.logback.classic.Level-->
    <root level="WARN">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DEBUG_FILE"/>
        <appender-ref ref="ASYNC_WARN_FILE"/>
        <appender-ref ref="ASYNC_ERROR_FILE"/>
    </root>
    
    <!-- 指定包打印日志（一般用于定制输出日志）。
        name：用来指定某个包或者某个类的日志打印（包名可以是类的全路径，也可以是部分包名）
        value：最小日志级别
        additivity：（false：子logger只在自己的appender中输出；true：logger不止会在自己的appender里输出，还会在root的logger的appender里输出）
         -->
    <!-- 
    <logger name="com.demo.cs.template.controller" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="ASYNC_CUSTOM_FILE"/>
    </logger>
    -->
</configuration>

3 其他配置

3.1 管理mybatis日志

如果spring中整合了mybatis，想要设置mybatis的日志也受logback进行日志管理。

可以将mybatis的日志实现交由slf4j，由slf4j的实现logback来实现相应的日志管理。

在mybatis中进行如下配置：

<settings>
    <!-- 指定 MyBatis 所用日志的具体实现，未指定时将自动查找 -->
    <setting name="logImpl" value="SLF4J"/>
</settings>

3.2 常用扩展

logback有两个特点：

（1）可以设置logback配置文件的刷新时间，在线更改配置文件，一定时间间隔内自动生效，无需重启项目
（2）可以配置logger节点，将关注的某个类或者某个包下的指定日志级别的日志，输出到指定文件中

这两个特点，可以快速在线上调试日志，方便热点找问题