SpringBoot日志系统

SLF4J类似于Commons Logging，也是一个日志接口，而Logback类似于Log4j，是一个日志的实现。
logback主要包含三个组成部分：Loggers（日志记录器）、Appenders（输出目的在）、Layouts（日志输出格式）
logback 主要分为三个模块，分别是：

  • logback-core：提供基础功能，是其他两个模块的基础
  • logback-classic ： log4j的升级，实现了self4j api
  • logback-access：用于与sevlet容器进行集成、提供网络访问日志的功能

logback加载filepath配置文件顺序：
logback.groovy、logback-test.xml、logback.xml

添加依赖

spring-boot-starter中已经存在slf4j依赖，不需要额外添加

配置文件

配置logback.xml文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  3.     <property name="FILE_ERROR_PATTERN"
  4.               value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} %file:%line: %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
  5.     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
  6.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  7.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  8.             <level>INFO</level>
  9.         </filter>
  10.         <encoder>
  11.             <pattern>${CONSOLE_LOG_PATTERN}</pattern>
  12.             <charset>UTF-8</charset>
  13.         </encoder>
  14.     </appender>
  16.     <appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
  17.         <!--如果只是想要 Info 级别的日志，只是过滤 info 还是会输出 Error 日志，因为 Error 的级别高， 所以我们使用下面的策略，可以避免输出 Error 的日志-->
  18.         <!--        <filter class="ch.qos.logback.classic.filter.LevelFilter">-->
  19.         <!--            &lt;!&ndash;过滤 Error&ndash;&gt;-->
  20.         <!--            <level>ERROR</level>-->
  21.         <!--            &lt;!&ndash;匹配到就禁止&ndash;&gt;-->
  22.         <!--            <onMatch>DENY</onMatch>-->
  23.         <!--            &lt;!&ndash;没有匹配到就允许&ndash;&gt;-->
  24.         <!--            <onMismatch>ACCEPT</onMismatch>-->
  25.         <!--        </filter>-->
  26.         <!--日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天的日志改名为今天的日期。即，<File> 的日志都是当天的。-->
  27.         <!--<File>logs/info.spring-boot-demo-logback.log</File>-->
  28.         <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
  29.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  30.             <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间-->
  31.             <FileNamePattern>spring-boot-demo-logging/logs/spring-boot-demo-logback/info.created_on_%d{yyyy-MM-dd}.part_%i.log</FileNamePattern>
  32.             <!--只保留最近90天的日志-->
  33.             <maxHistory>90</maxHistory>
  34.             <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
  35.             <!--<totalSizeCap>1GB</totalSizeCap>-->
  36.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  37.                 <!-- maxFileSize:这是活动文件的大小，默认值是10MB -->
  38.                 <maxFileSize>2MB</maxFileSize>
  39.             </timeBasedFileNamingAndTriggeringPolicy>
  41.         </rollingPolicy>
  42.         <!--<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">-->
  43.         <!--<maxFileSize>1KB</maxFileSize>-->
  44.         <!--</triggeringPolicy>-->
  45.         <encoder>
  46.             <pattern>${FILE_LOG_PATTERN}</pattern>
  47.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  48.         </encoder>
  49.     </appender>
  51. <!--    <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">-->
  52. <!--        &lt;!&ndash;如果只是想要 Error 级别的日志，那么需要过滤一下，默认是 info 级别的，ThresholdFilter&ndash;&gt;-->
  53. <!--        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">-->
  54. <!--            <level>Error</level>-->
  55. <!--        </filter>-->
  56. <!--        &lt;!&ndash;日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天的日志改名为今天的日期。即，<File> 的日志都是当天的。&ndash;&gt;-->
  57. <!--        &lt;!&ndash;<File>logs/error.spring-boot-demo-logback.log</File>&ndash;&gt;-->
  58. <!--        &lt;!&ndash;滚动策略，按照时间滚动 TimeBasedRollingPolicy&ndash;&gt;-->
  59. <!--        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">-->
  60. <!--            &lt;!&ndash;文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间&ndash;&gt;-->
  61. <!--            <FileNamePattern>logs/spring-boot-demo-logback/error.created_on_%d{yyyy-MM-dd}.part_%i.log</FileNamePattern>-->
  62. <!--            &lt;!&ndash;只保留最近90天的日志&ndash;&gt;-->
  63. <!--            <maxHistory>90</maxHistory>-->
  64. <!--            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">-->
  65. <!--                &lt;!&ndash; maxFileSize:这是活动文件的大小，默认值是10MB,本篇设置为1KB，只是为了演示 &ndash;&gt;-->
  66. <!--                <maxFileSize>2MB</maxFileSize>-->
  67. <!--            </timeBasedFileNamingAndTriggeringPolicy>-->
  68. <!--        </rollingPolicy>-->
  69. <!--        <encoder>-->
  70. <!--            <pattern>${FILE_ERROR_PATTERN}</pattern>-->
  71. <!--            <charset>UTF-8</charset> &lt;!&ndash; 此处设置字符集 &ndash;&gt;-->
  72. <!--        </encoder>-->
  73. <!--    </appender>-->
  75.     <root level="info">
  76.         <appender-ref ref="CONSOLE"/>
  77.         <appender-ref ref="FILE_INFO"/>
  78. <!--        <appender-ref ref="FILE_ERROR"/>-->
  79.     </root>
  80. </configuration>

添加AOP日志

添加依赖

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-aop</artifactId>
  4. </dependency>

添加AOP代码

  1. package online.yuluo.springbootdemo.aspectj;
  3. import com.alibaba.fastjson.JSON;
  4. import com.alibaba.fastjson.JSONObject;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.aspectj.lang.JoinPoint;
  7. import org.aspectj.lang.ProceedingJoinPoint;
  8. import org.aspectj.lang.annotation.*;
  9. import org.springframework.stereotype.Component;
  10. import org.springframework.web.context.request.RequestContextHolder;
  11. import org.springframework.web.context.request.ServletRequestAttributes;
  13. import javax.servlet.http.HttpServletRequest;
  14. import java.util.Map;
  15. import java.util.Objects;
  17. /**
  18.  * @author yuluo
  19.  */
  20. @Component
  21. @Aspect
  22. @Slf4j
  23. public class AopLog {
  24.     private static final String START_TIME = "request-start";
  26.     @Pointcut("execution(public * online.yuluo.springbootdemo.controller.*Controller.*(..))")
  27.     public void log() {
  29.     }
  31.     @Before("log()")
  32.     public void beforeLog(JoinPoint joinPoint) {
  33.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  34.         HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
  35.         log.info("<<<<<<<请求URL：{}", request.getRequestURL());
  36.         log.info("<<<<<<<请求IP：{}", request.getRemoteAddr());
  37.         log.info("<<<<<<<请求开始：{}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
  38.         Map<String, String[]> parameterMap = request.getParameterMap();
  39.         log.info("<<<<<<<请求参数：{}", JSON.toJSONString(parameterMap));
  40.         Long start = System.currentTimeMillis();
  41.         request.setAttribute(START_TIME, start);
  42.     }
  43.     @Around("log()")
  44.     public Object aroundLog(ProceedingJoinPoint joinPoint) throws Throwable {
  45.         Object result = joinPoint.proceed();
  46.         log.info("<<<<<<<返回值：{}", JSON.toJSONString(result));
  47.         return result;
  48.     }
  50.     /**
  51.      * 后置操作
  52.      */
  53.     @AfterReturning("log()")
  54.     public void afterReturning() {
  55.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  56.         HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
  58.         Long start = (Long) request.getAttribute(START_TIME);
  59.         Long end = System.currentTimeMillis();
  60.         log.info("<<<<<<<请求耗时：{}毫秒", end - start);
  61.     }
  63. }

源码阅读

添加sql执行日志

本次引入了p6spy

添加依赖

  1. <!--   Spring Aop     -->
  2. <dependency>
  3.   <groupId>org.springframework.boot</groupId>
  4.   <artifactId>spring-boot-starter-aop</artifactId>
  5. </dependency>
  6. <dependency>
  7.   <groupId>com.github.gavlyukovskiy</groupId>
  8.   <artifactId>p6spy-spring-boot-starter</artifactId>
  9.   <version>1.6.1</version>
  10. </dependency>

修改application配置文件

url driver-class-name

  1. spring:
  2.   datasource:
  3.     url: jdbc:p6spy:mysql://eurekaserver01.com:2333/demo?useSSL=false&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai&useSSL=false # 数据库URL
  4.     username: demo # 数据库用户名
  5.     password: EanD5NhsdCWLs6zs # 数据库密码
  6.     driver-class-name: com.p6spy.engine.spy.P6SpyDriver

添加spy.properties文件

  1. #mybatis 3.2.1以上使用
  2. modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
  3. #mybatis 3.2.1以下使用或者不配置
  4. #modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
  5. # 自定义日志打印
  6. logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
  7. #日志输出到控制台
  8. #appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
  9. # 使用日志系统记录 sql
  10. appender=com.p6spy.engine.spy.appender.Slf4JLogger
  11. # 设置 p6spy driver 代理
  12. deregisterdrivers=true
  13. # 取消JDBC URL前缀
  14. useprefix=true
  15. # 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
  16. excludecategories=info,debug,result,commit,resultset
  17. # 日期格式
  18. dateformat=yyyy-MM-dd HH:mm:ss
  19. # 实际驱动可多个
  20. driverlist=com.mysql.cj.jdbc.Driver
  21. # 是否开启慢SQL记录
  22. outagedetection=true
  23. # 慢SQL记录标准 2 秒
  24. outagedetectioninterval=2

到此，p6spy会打印执行脚本。

AOP打印详细信息

  1. @Component
  2. @Slf4j
  3. @Aspect
  4. public class SqlAspectj {
  5.     @Pointcut("execution(public * online.yuluo.springbootdemo.mapper.*Mapper.*(..))")
  6.     public void log() {
  7.     }
  9.     @Around("log()")
  10.     public Object sqlLogAround(ProceedingJoinPoint joinPoint) throws Throwable {
  11.         String name = "-";
  12.         String result = "Y";
  13.         long start = System.currentTimeMillis();
  14.         try {
  15.             name = joinPoint.getSignature().toShortString();
  16.             return joinPoint.proceed();
  17.         } catch (Throwable throwable) {
  18.             result = "N";
  19.             throw throwable;
  20.         } finally {
  21.             // 执行方法名称，执行时间，执行是否成功
  22.             long end = System.currentTimeMillis();
  23.             log.info("name:[{}];result:[{}];time:[{}ms]", name, result, end - start);
  24.         }
  25.     }
  26.     // 返回值
  27.     @AfterReturning(pointcut = "log()", returning = "returnValue")
  28.     public void afterReturning(JoinPoint joinPoint, Object returnValue) {
  29.         log.info("return value is " + returnValue);
  30.     }
  31. }

源码阅读