Spring Boot入门系列（十三）统一日志处理！

2020-07-06 00:36:19

前面介绍了Spring Boot 异常处理，今天主要讲解Spring Boot中的日志收集，日志是追踪错误定位问题的关键，特别在生产环境中，我们需要通过日志快速定位解决问题。

Springboot的日志的框架比较丰富，而且Springboot本身就内置了日志功能，不过实际项目中会出现：只记录想要的日志，日志输出到磁盘，按天归档，日志信息同步到其他系统等功能。这些是Springboot本身就内置了日志功能不具备的。所以我推荐使用logback。下面我们就以logback讲讲Spring Boot中的日志收集。

为什么要统一日志

前面我们说了Springboot 本身就可以日志功能，为什么还需要统一规范日志？

1、日志统一，方便查阅管理。
2、日志分割归档功能。
3、日志持久化功能。
4、方便日志系统（ELK）收集。

配置日志

在resource下创建logback-spring.xml文件，以下直接贴出配置信息，介绍信息可以直接参考备注。

<?xml version="1.0" encoding="UTF-8"?><!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 --><!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true --><!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。                 当scan为true时，此属性生效。默认的时间间隔为1分钟。 --><!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 --><configuration  scan="true" scanPeriod="10 seconds">    <contextName>logback</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->    <property name="log.path" value="D:/Documents/logs/edu" />
    <!--0. 日志格式和颜色渲染 -->    <!-- 彩色日志依赖的渲染类 -->    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />    <!-- 彩色日志格式 -->    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    <!--1. 输出到控制台-->    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">        <!--此日志appender是为开发使用，只配置底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">            <level>debug</level>        </filter>        <encoder>            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>            <!-- 设置字符集 -->            <charset>UTF-8</charset>        </encoder>    </appender>
    <!--2. 输出到文档-->    <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <!-- 正在记录的日志文档的路径及文档名 -->        <file>${log.path}/edu_debug.log</file>        <!--日志文档输出格式-->        <encoder>            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>            <charset>UTF-8</charset> <!-- 设置字符集 -->        </encoder>        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <!-- 日志归档 -->            <fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>100MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <!--日志文档保留天数-->            <maxHistory>15</maxHistory>        </rollingPolicy>        <!-- 此日志文档只记录debug级别的 -->        <filter class="ch.qos.logback.classic.filter.LevelFilter">            <level>debug</level>            <onMatch>ACCEPT</onMatch>            <onMismatch>DENY</onMismatch>        </filter>    </appender>
    <!-- 2.2 level为 INFO 日志，时间滚动输出  -->    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <!-- 正在记录的日志文档的路径及文档名 -->        <file>${log.path}/edu_info.log</file>        <!--日志文档输出格式-->        <encoder>            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>            <charset>UTF-8</charset>        </encoder>        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <!-- 每天日志归档路径以及格式 -->            <fileNamePattern>${log.path}/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>100MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <!--日志文档保留天数-->            <maxHistory>15</maxHistory>        </rollingPolicy>        <!-- 此日志文档只记录info级别的 -->        <filter class="ch.qos.logback.classic.filter.LevelFilter">            <level>info</level>            <onMatch>ACCEPT</onMatch>            <onMismatch>DENY</onMismatch>        </filter>    </appender>
    <!-- 2.3 level为 WARN 日志，时间滚动输出  -->    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <!-- 正在记录的日志文档的路径及文档名 -->        <file>${log.path}/edu_warn.log</file>        <!--日志文档输出格式-->        <encoder>            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>            <charset>UTF-8</charset> <!-- 此处设置字符集 -->        </encoder>        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <fileNamePattern>${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>100MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <!--日志文档保留天数-->            <maxHistory>15</maxHistory>        </rollingPolicy>        <!-- 此日志文档只记录warn级别的 -->        <filter class="ch.qos.logback.classic.filter.LevelFilter">            <level>warn</level>            <onMatch>ACCEPT</onMatch>            <onMismatch>DENY</onMismatch>        </filter>    </appender>
    <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <!-- 正在记录的日志文档的路径及文档名 -->        <file>${log.path}/edu_error.log</file>        <!--日志文档输出格式-->        <encoder>            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>            <charset>UTF-8</charset> <!-- 此处设置字符集 -->        </encoder>        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <fileNamePattern>${log.path}/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>100MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <!--日志文档保留天数-->            <maxHistory>15</maxHistory>        </rollingPolicy>        <!-- 此日志文档只记录ERROR级别的 -->        <filter class="ch.qos.logback.classic.filter.LevelFilter">            <level>ERROR</level>            <onMatch>ACCEPT</onMatch>            <onMismatch>DENY</onMismatch>        </filter>    </appender>
    <!--        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、        以及指定<appender>。<logger>仅有一个name属性，        一个可选的level和一个可选的addtivity属性。        name:用来指定受此logger约束的某一个包或者具体的某一个类。        level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，              还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。              如果未设置此属性，那么当前logger将会继承上级的级别。        addtivity:是否向上级logger传递打印信息。默认是true。        <logger name="org.springframework.web" level="info"/>        <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>    -->
    <!--        使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：        种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息        第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：        【logging.level.org.mybatis=debug logging.level.dao=debug】     -->
    <!--        root节点是必选节点，用来指定基础的日志输出级别，只有一个level属性        level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，        不能设置为INHERITED或者同义词NULL。默认是DEBUG        可以包含零个或多个元素，标识这个appender将会添加到这个logger。    -->
    <!-- 4. 终的策略 -->    <!-- 4.1 开发环境:打印控制台-->    <springProfile name="dev">        <logger name="com.cms" level="info"/>        <root level="info">            <appender-ref ref="CONSOLE" />            <appender-ref ref="DEBUG_FILE" />            <appender-ref ref="INFO_FILE" />            <appender-ref ref="WARN_FILE" />            <appender-ref ref="ERROR_FILE" />        </root>    </springProfile>

    <!-- 4.2 生产环境:输出到文档-->    <springProfile name="pro">        <logger name="com.cms" level="warn"/>        <root level="info">            <appender-ref ref="ERROR_FILE" />            <appender-ref ref="WARN_FILE" />        </root>    </springProfile>
</configuration>

注意

日志的环境即spring.profiles.acticve，跟随项目启动。
启动后，即可到自定目录查找到生成的日志文件。
官方推荐使用的xml名字的格式为：logback-spring.xml而不是logback.xml。

配置application.properties

在application.properties配置logback

############################################################## logback 配置,日志管理##############################################################日志配置,输出到文本，logging.config=classpath:logback-spring.xml#idea控制台默认日志级别修改# 指定输出日志的文件名，默认输出至当前项目目录下#logging.file.path=springboot.log

收集异常日志

上一篇文章已经讲过统一异常处理，请看这篇文章《SpringBoot入门系列（十一）统一异常处理的实现》。修改统一异常处理器GlobalExceptionHandler类，将异常方法中的直接打印改为日志输入并打印：

@ExceptionHandler(value = Exception.class)    public Object errorHandler(HttpServletRequest reqest,             HttpServletResponse response, Exception e) throws Exception {                //e.printStackTrace();        // 记录日志        logger.error(ExceptionUtils.getMessage(e));        // 是否ajax请求        if (isAjax(reqest)) {            return JSONResult.errorException(e.getMessage());        } else {            ModelAndView mav = new ModelAndView();            mav.addObject("exception", e);            mav.addObject("url", reqest.getRequestURL());            mav.setViewName(ERROR_VIEW);            return mav;        }    }

程序中记录日志

在com.weiz.controller 中创建LoggingController 控制器

package com.weiz.controller;
import com.weiz.utils.JSONResult;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;
@RestController@RequestMapping("/log")public class LoggingController {    Logger logger = LoggerFactory.getLogger(getClass());
    @RequestMapping("/write")    public JSONResult  writeLog(){        // 级别由低到高 trace<debug<info<warn<error        logger.trace("这是一个trace日志");        logger.debug("这是一个debug日志");        logger.info("这是一个info日志");        logger.warn("这是一个warn日志");        logger.error("这是一个error日志");        return JSONResult.ok("write log success");    }}