Springboot + MyBatis 进行日志输出

项目在配置 Springboot + MyBatis 进行日志输出时需要的问题

生而为活

8310人浏览 · 2023-06-14 10:33:09

生而为活 · 2023-06-14 10:33:09 发布

问题

书接上回，咱们处理完成druid数据源连接池日志后，所有执行sql的日志都可以打印出来了，但是问题也是接踵而来，日志文件中密密麻麻都是日志，而当我想要查看某个dao的sql或者想要通过sql找到其所在dao是非常困难的，通过考虑决定，将druid日志输出到一个单独的日志文件中，方便后续在排查某个时间段某个线程中执行的所有的生气了，将持久层日志打印到控制台和主日志文件中，以便通过持久层的sql日志协助我们进行问题排查！
mybatis日志如何配置？按照我们的惯例依然是查看mybatis官网 | mybatis官网中文，在官网Logging章节我们找打答案。虽然官网说的很清楚，但是我在具体实践过程中我遇到了各种问题（ps.问题前任留下的坑，跟自己半毛钱关系可能有一点…咳咳咳…）其中遇到的主要问题就是系统中存在使用sqlSession写sql进行数据操作的情况。导致loggerName与日志配置文件中配置的loggerName不同导致。根据sqlSession调用过程中的statement,在日志文件中增加loggerName配置即可。如示例中调用我们只需配置 logger name = Select即可。sqlSession调用示例：

this.sqlSession.selectList("Select.w7HNMGotGtKCgNQzphL09ne1/XNVzam6ZrhqBWMR05k=", param);

在实际开发中还遇到的一个问题是，系统使用多模块开发，导致系统中的dao分布在各个模块中，出现一下情况：

com.example.demo.a.dao
com.example.demo.b.dao
com.example.demo.b.dao

此时我们如果在配置logger时使用如下配置是不生效的，主要是日志配置文件中logger name 不支持通配符。

<logger name="com.example.demo.*.dao" level="debug" additivity="false">
	<appender-ref ref="console"/>
	<appender-ref ref="demo_log"/>
</logger>

故我们可以这么配置，弊端项目下所有日志打印都会使用debug级别进行输出。

<logger name="com.example.demo" level="debug" additivity="false">
	<appender-ref ref="console"/>
	<appender-ref ref="demo_log"/>
</logger>

也可以这么配置

<logger name="com.example.demo.a.dao" level="debug" additivity="false">
	<appender-ref ref="console"/>
	<appender-ref ref="demo_log"/>
</logger>
<logger name="com.example.demo.b.dao" level="debug" additivity="false">
	<appender-ref ref="console"/>
	<appender-ref ref="demo_log"/>
</logger>
<logger name="com.example.demo.c.dao" level="debug" additivity="false">
	<appender-ref ref="console"/>
	<appender-ref ref="demo_log"/>
</logger>

总结

本次主要遇到两个问题：

日志配置文件中配置logger name 时不支持通配符，自己想当然的任务其支持，没有做到小心假设大胆求证。
系统中特殊调用的情况需要特殊处理

经验做法

当遇到自己想打印的sql没有输出时，我们可以在sql调用前打断点，然后再去你使用的mybatis具体日志实现类中打断点，得到自己想要的logger 。位置示例：
在这里插入图片描述

不收费的参考示例

application配置

server:
  port: 4000
spring:
  datasource:
    druid:
      driver-class-name: org.postgresql.Driver
      url: jdbc:postgresql://000.000.000.000:5432/demo
      username: postgres
      password: postgres
      filters: slf4j
      filter:
        slf4j:
          enabled: true
          statement-create-after-log-enabled: false
          statement-close-after-log-enabled: false
          result-set-open-after-log-enabled: false
          result-set-close-after-log-enabled: false
mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.example.demo.entities
  configuration:
    map-underscore-to-camel-case: true
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl

logback.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>demo</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->
    <property name="log.path" value="${log.home:-.}"/>
    <!--0. 日志格式和颜色渲染 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <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([%thread]){faint} %clr(%-40.40logger{39}){cyan} %L %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 全部日志，时间滚动输出  -->
    <appender name="demo_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${log.path}/demo.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}/demo-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>
    <!-- 2.2 druid sql 日志文件，时间滚动输出  -->
    <appender name="druid_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${log.path}/druid.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}/druid-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </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"/>
    -->
    
    <logger name="org.springframework.scheduling.quartz" level="error" additivity="false"/>
    
    <!-- mybatis 日志输出 -->
    <logger name="com.example.demo.dao" level="debug" additivity="false">
        <appender-ref ref="console"/>
        <appender-ref ref="demo_log"/>
    </logger>
    
   <!-- druid 日志输出-->
    <logger name="druid.sql.Statement" level="debug" additivity="false">
        <appender-ref ref="druid_log"/>
    </logger>
    <!--
        root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
        level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG
        可以包含零个或多个元素，标识这个appender将会添加到这个logger。
    -->
    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="demo_log"/>
    </root>
</configuration>

日志示例

2023-06-14 10:23:25.682 DEBUG 17680 --- [main] com.example.demo.dao.UserDao.selectById  135 : ==>  Preparing: SELECT * FROM sys_user WHERE id = ?
2023-06-14 10:23:25.695 DEBUG 17680 --- [main] com.example.demo.dao.UserDao.selectById  135 : ==> Parameters: 1(Long)
2023-06-14 10:23:25.792 DEBUG 17680 --- [main] com.example.demo.dao.UserDao.selectById  135 : <==      Total: 1