log4j2实战--将MyBatis执行SQL记录到文件，按天分存

港控/mmm° 2022-05-14 06:50 213阅读 0赞

`需求：`将Mybatis的执行SQL，按天存日志文件。项目使用的是log4j2。

原先项目，都是将所有日志通通打印到控制台。现在需要将系统接收用户请求后，Mybatis的执行SQL，按天存日志文件。

当时在想：  
把Mybatis的SQL打印到控制台容易实现，  
日志按Level级别 按天存文件也容易实现，  
但如何单独把Mybatis的SQL，按天存日志文件呢？

于是找了MyBatis日志配置说明  
[http://www.mybatis.org/mybatis-3/zh/logging.html][http_www.mybatis.org_mybatis-3_zh_logging.html]

> Mybatis 的内置日志工厂提供日志功能，内置日志工厂将日志交给以下其中一种工具作代理：
> 
>  *  SLF4J
>  *  Apache Commons Logging
>  *  Log4j 2
>  *  Log4j
>  *  JDK logging

MyBatis 内置日志工厂基于运行时自省机制选择合适的日志工具。它会使用第一个查找得到的工具（按上文列举的顺序查找）。如果一个都未找到，日志功能就会被禁用。

可以在mybatis-config.xml 中，设定使用的日志组件。

logImpl 可选的值有：SLF4J、LOG4J、LOG4J2、JDK\_LOGGING、COMMONS\_LOGGING、STDOUT\_LOGGING、NO\_LOGGING，或者是实现了接口`org.apache.ibatis.logging.Log` 的，且构造方法是以字符串为参数的类的完全限定名。

**通过学习发现：**Mybatis 中 SQL 语句的日志级别被设为DEBUG（JDK 日志设为 FINE），SQL执行结果的日志级别为 TRACE（JDK 日志设为 FINER)。

所以，如果某些查询可能会返回庞大的结果集，此时只想记录其执行的 SQL 语句而不想记录结果该怎么办，只要将日志级别调整为 DEBUG 即可达到目的。

可见：无论使用哪个日志组件、无论打印什么内容，均是按日志级别进行输出的。所以在本需求中，Mybatis的SQL按debug级别输出到指定地方即可。

无论是Mybatis框架，还是Spring、Java Mail框架，如果想看到框架底层运行的日志信息，配置日志级别为debug即可。

再次说明下，Mybatis 内置日志工厂将日志交给其中一种日志工具作代理。具体怎么做，由使用的日志工具决定，因此本需求MyBatis执行SQL的文件保存，是取决于使用的log4j2日志组件实现。

**下面就来看一下log4j2具体的配置。**

在log4j2中， 共有8个输出级别，按照从低到高为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF。

log4j2 的配置文件支持 xml、json、jsn 三种格式，默认情况下由系统自动加载，其要在classpath 可加载到的目录下。

日志配置文件主要配置2大类  
1、配置输出源<Appenders>：日志输出到哪里。如控制台、file等  
2、具体的日志配置<Loggers>：配置name，启用哪个Appender，以及日志级别等。

下面给出本需求的简单配置实现：

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="ERROR" monitorInterval="600">
        
        
    
        <Properties>
            <property name="pattern">%d{yyyy/MM/dd HH:mm:ss.SSS} [%p] %t %c %m%n</property>
            <property name="basePath">/Users/lijianhua/Documents/my-log</property>
        </Properties>
    
        
        <Appenders>
    
            <Console name="console" target="SYSTEM_OUT">
                <PatternLayout pattern="${pattern}"/>
            </Console>
    
            <RollingRandomAccessFile name="fileLogger"
                                     fileName="${basePath}/mybatis-sql.log"
                                     filePattern="${basePath}/mybatis-sql-%d{yyyy-MM-dd}.log"
                                     append="true">
                <PatternLayout pattern="${pattern}"/>
    
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                    <SizeBasedTriggeringPolicy size="100MB"/>
                </Policies>
            </RollingRandomAccessFile>
        </Appenders>
    
        
        <Loggers>
            <Logger name="com.ljheee.app.dao" level="debug" additivity="true">
                <appender-ref ref="fileLogger" level="debug"/>
            </Logger>
    
            <Root level="info" additivity="false">
                <appender-ref ref="console"/>
            </Root>
        </Loggers>
    </Configuration>

通常log4j 采用properties文件配置。log4j2 采用xml文件配置。

log4j2 的xml文件配置，根节点是<Configuration>，它有2个可选属性：

*  status 为设置日志输出级别，级别如下：OFF 、FATAL 、ERROR、WARN、INFO、DEBUG、TRACE 、ALL
 *  monitorInterval 监控间隔 指log4j2每隔600秒（10分钟），自动监控该配置文件是否有变化，如果变化，则自动根据文件内容重新配置。

### 1、配置输出源<Appenders>： ###

配置日志输出到哪里。如控制台、file等。

<Appenders>下通常有一个<Console> 表示日志都输出到控制台，方便开发期间进行查看。

另一个是<RollingRandomAccessFile>，按时间和文件大小滚动(rollover)的RollingRandomAccessFile Appender，名字真是够长，但不光只是名字长，相比RollingFileAppender有很大的性能提升，官网宣称是20-200%。

rollover的意思是当满足一定条件(如文件达到了指定的大小，达到了指定的时间)后，就重命名原日志文件进行归档，并生成新的日志文件用于log写入。如果还设置了一定时间内允许归档的日志文件的最大数量，将对过旧的日志文件进行删除操作。

这里说的“满足一定条件”，是需要触发的，需要配置基于时间的、或基于日志文件大小的触发策略，也就是如下配置：

关键点在于 filePattern后的日期格式，以及TimeBasedTriggeringPolicy的interval，日期格式精确到哪一位，interval也精确到哪一个单位。在本示例中，filePattern最小单位是天，interval=1也就是一天一个日志文件。

TimeBasedTriggeringPolicy基于时间的触发策略

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>interval</td> 
   <td>（integer）该属性是相对 RollingFile.filePattern 中的 %d{yyyy-MM-dd}值,例：filePattern=”xxx%d{yyyy-MM-dd}xx” interval=”2” 表示将2天一个日志文件；filePattern=”xxx%d{yyyy-MM-dd-HH}xx” interval=”1”表示一个小时一个日志文件</td> 
  </tr> 
  <tr> 
   <td>modulate</td> 
   <td>（boolean）以0点为边界进行偏移计算</td> 
  </tr> 
 </tbody> 
</table>

### 2、具体的日志配置<Loggers>： ###

配置name，启用哪个Appender，以及日志级别等。

重点说明

MyBatis支持多种粒度的日志记录：

1、可以记录某个映射器接口的日志  
将name设为name="com.ljheee.app.dao.UserMapper"  
就会记录 com.ljheee.app.dao.UserMapper 的详细执行操作，且仅记录应用中其它类的错误信息（若有）。

2、还可以将日志的记录方式从接口级别切换到语句级别，从而实现更细粒度的控制。如下配置只对 select 语句记录日志：  
将name设为name="com.ljheee.app.dao.UserMapper.select"

3、当然也可以按实例配置到包级别，在DAO层，将包下所有MyBatis的mapper接口均使用日志记录。

小结：

log4j2 是Apache开发的一款log4j的升级产品，在某些特定的场景上面，甚至可以比之前的速度快上10倍。在保证log的组件更加快速的同时，同时所需的内存更加少。

上面在说RollingRandomAccessFile时，也说到性能很高，因为log4j2 内部使用了Disruptor高性能并发框架，输出日志采用异步输出，极高地提升了日志输出性能，因此也建议将后续的应用日志方式，切换到log4j2。

log4j2 配置示例[https://howtodoinjava.com/log4j2/log4j-2-xml-configuration-example/][https_howtodoinjava.com_log4j2_log4j-2-xml-configuration-example]  
log4j2文档[https://logging.apache.org/log4j/2.x/manual/appenders.html][https_logging.apache.org_log4j_2.x_manual_appenders.html]

[http_www.mybatis.org_mybatis-3_zh_logging.html]: http://www.mybatis.org/mybatis-3/zh/logging.html
[https_howtodoinjava.com_log4j2_log4j-2-xml-configuration-example]: https://howtodoinjava.com/log4j2/log4j-2-xml-configuration-example/
[https_logging.apache.org_log4j_2.x_manual_appenders.html]: https://logging.apache.org/log4j/2.x/manual/appenders.html