使用log4jdbc输出sql操作

前言

log4jdbc 是一个 JDBC 驱动器，能够记录 SQL 日志和 SQL 执行时间等信息。log4jdbc 使用 SLF4J（Simple Logging Facade）作为日志系统。

特性

1. 支持 JDBC3 和 JDBC4 。
2. 支持现有大部分 JDBC 驱动。
3. 易于配置（在大部分情况下，只需要改变驱动类名并在 jdbc url 中加上:log4jdbc，设置好日志输出级别）。
4. 能够自动把 SQL 变量值加到 SQL 输出日志中，改进易读性和方便调试。
5. 能够以表格形式输出查询操作所涉及到的数据结果集。
6. 能够快速标识出应用程序中执行比较慢的 SQL 语句。
7. 能够生成 SQL 连接数信息帮助识别连接池或线程问题。

配置

依赖

在 pom.xml 中加入：

<dependency>
    <groupId>org.bgee.log4jdbc-log4j2</groupId>
    <artifactId>log4jdbc-log4j2-jdbc4.1</artifactId>
    <version>1.16</version>
</dependency>

配置 application

将 application.properties 或者 application.yml 做出如下修改：

# 修改前
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=UTF-8

# 修改后
spring.datasource.driver-class-name=net.sf.log4jdbc.sql.jdbcapi.DriverSpy
spring.datasource.url=jdbc:log4jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=UTF-8
logging.config=classpath:logback.xml

logging.config 输出日志格式的配置文件

添加 log4jdbc.log4j2.properties

向 resources 文件夹下添加 log4jdbc.log4j2.properties 文件：

# 设置的值为项目应用程序的包的部分或全部的前缀
log4jdbc.debug.stack.prefix=blog
# spy日志处理类
log4jdbc.spylogdelegator.name=net.sf.log4jdbc.log.slf4j.Slf4jSpyLogDelegator
# 自动选择最佳jdbc驱动
log4jdbc.auto.load.popular.drivers=false
# jdbc驱动（这里对应的mysql驱动版本为8.x）
log4jdbc.drivers=com.mysql.cj.jdbc.Driver
# 当该值为 false 时，boolean 值显示为 0 和 1 ，为 true 时 boolean 值显示为 true 和 false
log4jdbc.dump.booleanastruefalse=true
# 是否在 SQL 的行末添加一个分号
log4jdbc.dump.sql.addsemicolon=true

添加 logback.xml

向 resources 文件夹下添加 logback.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="30 seconds" debug="false">
    <contextName>BLOG</contextName>
    <property name="LOG_HOME" value="logs/%d{yyyy-MM,aux}/"/>
    <property name="LOG_" value="logs/"/>
    <property name="log.charset" value="utf-8"/>
    <property name="log.pattern"
              value="%black(%contextName-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger{36}) - %gray(%msg%n)"/>
    <!--输出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
            <charset>${log.charset}</charset>
        </encoder>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/server.%d{yyyy-MM-dd-HH}.log</FileNamePattern>
            <MaxHistory>60</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
            <charset>${log.charset}</charset>
        </encoder>
    </appender>

    <appender name="redis" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/redis.%d{yyyy-MM-dd-HH}.log</FileNamePattern>
            <MaxHistory>60</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
            <charset>${log.charset}</charset>
        </encoder>
    </appender>


    <!--    监控sql日志输出-->
    <!--  如想看到表格数据，将OFF改为INFO  -->
    <logger name="jdbc.resultsettable" level="INFO" additivity="false">
        <appender-ref ref="console"/>
    </logger>
    <!--    包含 SQL 语句实际的执行时间 及sql语句（与jdbc.sqlonly功能重复）   -->
    <logger name="jdbc.sqltiming" level="INFO" additivity="false">
        <appender-ref ref="console"/>
    </logger>
    <!--      仅仅记录 SQL 语句，会将占位符替换为实际的参数-->
    <logger name="jdbc.sqlonly" level="OFF" additivity="false">
        <appender-ref ref="console"/>
    </logger>
    <!--  包含 ResultSet 的信息，输出篇幅较长  -->
    <logger name="jdbc.resultset" level="ERROR" additivity="false">
        <appender-ref ref="console"/>
    </logger>
    <!-- 输出了 Connection 的 open、close 等信息  -->
    <logger name="jdbc.connection" level="OFF" additivity="false">
        <appender-ref ref="console"/>
    </logger>
    <!--    除了 ResultSet 之外的所有JDBC调用信息，篇幅较长 -->
    <logger name="jdbc.audit" level="OFF" additivity="false">
        <appender-ref ref="console"/>
    </logger>

    <!--普通日志输出到控制台-->
    <root level="info">
        <!-- 开发环境日志只输出到控制台，不输出到文件 -->
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
        <appender-ref ref="redis"/>
    </root>
</configuration>