SpringBoot整合logback封装日志打印

1.背景

在后端服务开发框架搭建时，通常需要在日志模块进行统一封装，方便日志统一规范输出、后期接入类似ELK日志分析框架、以及开发过程中的日志打印；

springboot默认整合好了logback，我们只需要添加lombok依赖，可以帮助我们通过注解的形式调用到日志的api（更加方便）；

同时配置日志输出规范及清理策略和分支差异打印就可满足我们日常开发需要了。

2.集成与配置

集成lombok（注解方式打印日志，引入依赖即可）：

<!--lombok依赖-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.10</version>
</dependency>

配置日志输出（logback-spring.xml）：放在项目resources目录下即可

 

<?xml version="1.0" encoding="UTF-8"?>
<configuration  scan="true" scanPeriod="10 seconds">
    <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
    <!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
    <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
    <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->

    <contextName>logback</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
    <property name="log.path" value="/data/apps/qcloud-resources-admin/log" />
    <!--配置规则类的位置-->
    <!--<conversionRule conversionWord="ip" converterClass="com.bylz.api.config.IPLogConfig" />-->
    <!-- 彩色日志 -->
    <!-- 配置格式变量：CONSOLE_LOG_PATTERN 彩色日志格式 -->
    <!-- magenta:洋红 -->
    <!-- boldMagenta:粗红-->
    <!-- cyan:青色 -->
    <!-- white:白色 -->
    <!-- magenta:洋红 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/>


    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <!-- 例如：如果此处配置了INFO级别，则后面其他位置即使配置了DEBUG级别的日志，也不会被输出 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--输出到文件-->

    <!-- 时间滚动输出 level为 INFO 日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_info.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${log.path}/info/log-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>

    <!-- 时间滚动输出 level为 WARN 日志 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/warn/log-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>


    <!-- 时间滚动输出 level为 ERROR 日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_error.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/log-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，
              如果未设置此属性，那么当前logger将会继承上级的级别。
    -->
    <!--
        使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
        第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
        第二种就是单独给mapper下目录配置DEBUG模式，代码如下，这样配置sql语句会打印，其他还是正常DEBUG级别：
     -->
    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <!--可以输出项目中的debug日志，包括mybatis的sql日志-->
        <!--<logger name="com.bylz.api.dao" level="DEBUG" />-->
        <!--<logger name="com.bylz.api.controller.feign" level="DEBUG" />-->

        <!--
            root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
            level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，默认是DEBUG
            可以包含零个或多个appender元素。
        -->
        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="ERROR_FILE" />
        </root>
    </springProfile>

    <!--测试环境:输出到文件-->
    <springProfile name="test">

        <!--可以输出项目中的debug日志，包括mybatis的sql日志-->
        <!--<logger name="com.bylz.api.dao" level="DEBUG" />-->
        <!--<logger name="com.bylz.api.controller.feign" level="DEBUG" />-->

        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="ERROR_FILE" />
        </root>
    </springProfile>

    <!--生产环境:输出到文件-->
    <springProfile name="prod">

        <!--可以输出项目中的debug日志，包括mybatis的sql日志-->
        <!--<logger name="com.bylz.api.dao" level="DEBUG" />-->
        <!--<logger name="com.bylz.api.controller.feign" level="DEBUG" />-->

        <root level="INFO">
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="INFO_FILE" />
        </root>
    </springProfile>

</configuration>

3.打印日志示例

 在需要打印日志类上加@Slf4j注解，即可使用log调用debug，error，info等方法打印了，具体示例如下：

package com.bylz.common.exception;

import cn.dev33.satoken.exception.NotLoginException;
import cn.dev33.satoken.exception.NotPermissionException;
import com.bylz.common.CommonEnum;
import com.bylz.common.ResponseData;
import lombok.extern.slf4j.Slf4j;
import org.omg.CORBA.Object;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;

/**
 * Author: lizhi
 * Date: 2021-08-27
 * Describe: 全局异常捕获
 */
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 处理自定义的业务异常
     * @param req
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(value = BizException.class)
    @ResponseBody
    public ResponseData<Object> bizExceptionHandler(HttpServletRequest req, BizException e){
        log.error("发生业务异常！原因是：{}", e.getErrorMsg());
        return ResponseData.failed(e.getErrorCode(), e.getErrorMsg());
    }

    /**
     * 处理用户未登录异常
     * @param req
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(value = NotLoginException.class)
    @ResponseBody
    public ResponseData<Object> notLoginExceptionHandler(HttpServletRequest req, NotLoginException e){
        log.error("用户未登录：{}", e.getMessage());
        return ResponseData.failed(CommonEnum.UN_AUTH.getResultCode(), CommonEnum.UN_AUTH.getResultMsg());
    }

    /**
     * 处理用户无权限异常
     * @param req
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(value = NotPermissionException.class)
    @ResponseBody
    public ResponseData<Object> notPermissionExceptionHandler(HttpServletRequest req, NotPermissionException e){
        log.error("用户无权限：{}", e.getMessage());
        return ResponseData.failed(CommonEnum.UN_AUTHORIZED.getResultCode(), CommonEnum.UN_AUTHORIZED.getResultMsg());
    }

    /**
     * 处理参数校验异常
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public ResponseData<Object> bindExceptionHandler(BindException e) {
        log.error("参数错误bind：{}", e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
        return ResponseData.failed(CommonEnum.FAILED.getResultCode(), e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
    }

    /**
     * 处理参数校验异常
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public ResponseData<Object> methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        log.error("参数错误not valid：{}", e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
        return ResponseData.failed(CommonEnum.FAILED.getResultCode(), e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
    }

    /**
     * 处理参数校验异常
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public ResponseData<Object> constraintViolationExceptionHandler(ConstraintViolationException e) {
        log.error("参数错误not valid：{}", ((ConstraintViolation)e.getConstraintViolations().toArray()[0]).getMessage());
        return ResponseData.failed(CommonEnum.FAILED.getResultCode(), ((ConstraintViolation)e.getConstraintViolations().toArray()[0]).getMessage());
    }

    /**
     * 处理其他异常
     * @param req
     * @param e
     * @return ResponseData
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ResponseData<Object> exceptionHandler(HttpServletRequest req, Exception e){
        log.error("系统异常！原因是: ", e);
        return ResponseData.error(CommonEnum.ERROR.getResultCode(), CommonEnum.ERROR.getResultMsg(), e.getMessage());
    }

}