Log4jdbc开源SQL日志框架.md · zhongxu/MyLean

Log4jdbc 是一个开源 SQL 日志框架，它使用代理模式实现对常用的 JDBC Driver（ Oracle , Derby , MySQL , PostgreSQL , H2 , HSQLDB , …）操作的拦截，记录真实 SQL ，可以将占位符与参数全部合并在一起显示，方便直接拷贝 SQL 在 MySQL 等客户端直接执行，加快调试速度。

本文主要介绍如何使用 Log4jdbc 这个可以直接显示完整 SQL 的日志框架，希望对大家能有所帮助。

###   Log4jdbc 的特点

[ Log4jdbc 的官方主页 ]( https://github.com/arthurblake/log4jdbc )

(1)完全支持 JDBC3 和 JDBC4；配置简单，在大多数情况下，只需要将 JDBC 驱动类改成 net.sf.log4jdbc.DriverSpy ，同时将 jdbc:log4jdbc 添加到现有的 JDBC URL 之前，最后配置日志记录的种类即可将 Prepared Statements 中的绑定参数自动插入到对应的位置。

(2)在大多数情况下极大改善了可读性及调试工作SQL 的耗时信息能被获取从而帮助判断哪些语句执行得过慢，同时这些信息可以被工具识别得到一个关于慢 SQL 的报表,SQL 连接信息也可以获取从而帮助诊断关于连接池或线程的问题

(3)兼容任何 JDBC 驱动，需要 JDK1.4 及以上与 Slf4j1.x，开源软件，使用 Apache 2.0 License

### 使用 Log4jdbc 的步骤

感兴趣的朋友可以去 Log4jdbc 的项目主页看它的使用方法，如果单纯使用 Log4jdbc ，不会对 ResultSet 以表格方式呈现，在这里我们使用扩展自 Log4jdbc 的日志框架 Log4jdbc-log4j2 ，它增加了对 ResultSet 以表格方式呈现的处理，项目主页是： https://code.google.com/p/log4jdbc-log4j2/ 3 。它的使用步骤如下：

1、决定使用哪个版本的 JAR 包：

如果使用 JDK1.5 , 应该使用 JDBC3 版本的 JAR 包即 log4jdbc-log4j2-jdbc3.jar

如果使用 JDK1.6 , 应该使用 JDBC4 版本的 JAR 包即 log4jdbc-log4j2-jdbc4.jar (即使实际使用的 JDBC 驱动是 JDBC3 的甚至更老)。

如果使用 JDK1.7 , 应该使用 JDBC4.1 版本的 JAR 包即 log4jdbc-log4j2-jdbc4.1.jar (即使实际使用的 JDBC 驱动是 JDBC3 的甚至更老)。

2、将 JAR 包添加进项目：

将 JAR 包添加进项目有两种方式，第一种是直接将 Log4jdbc-log4j2 和 Slf4j 的 JAR 包添加进 CLASSPATH 中，第二种是使用 MAVEN 方式引入 JAR 包，这里我们主要说明第二种方式。在 pom.xml 文件中，根据使用的 JDBC 驱动的版本来替换 log4jdbc-log4j2-jdbcXX (比如 log4jdbc-log4j2-jdbc4.1 , 或者 log4jdbc-log4j2-jdbc4 , 或者 log4jdbc-log4j2-jdbc3 )。该框架需要配合 Slf4j 一起使用，MAVEN 配置如下：

```XML
<dependency>
    <groupId>org.bgee.log4jdbc-log4j2</groupId>
    <artifactId>log4jdbc-log4j2-jdbcXX</artifactId>
    <version>1.16</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.2</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.2</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.2</version>
</dependency>
```

3、将项目的配置文件中的 JDBC 驱动类改成

```JAVA
net.sf.log4jdbc.sql.jdbcapi.DriverSpy 
```

4、 jdbc:log4 添加到现有的 JDBC URL 之前:

例如原来的 JDBC URL 是

```
 jdbc:mysql://localhost:3306/MyDatabase
```

，则应该改成：

```properties
 jdbc:log4jdbc:mysql://localhost:3306/MyDatabase=
```

5、配置日志记录的种类：

Log4jdbc 用以下几个可以配置的日志种类：

1.jdbc.sqlonly : 仅记录 SQL

2.jdbc.sqltiming ：记录 SQL 以及耗时信息

3.jdbc.audit ：记录除了 ResultSet 之外的所有 JDBC 调用信息，会产生大量的记录，有利于调试跟踪具体的 JDBC 问题

4.jdbc.resultset ：会产生更多的记录信息，因为记录了 ResultSet 的信息

5.jdbc.connection ：记录连接打开、关闭等信息，有利于调试数据库连接相关问题

以上日志种类都可以设置为 DEBUG , INFO 或 ERROR 级别。当设置为 FATAL 或 OFF 时，意味关闭记录。

以下是一个采用 Log4j 作为具体日志系统的典型配置，将这些配置到

log4j.properties 里面：

```
log4j.logger.jdbc.sqlonly=OFF log4j.logger.jdbc.sqltiming=INFO   log4j.logger.jdbc.audit=OFF log4j.logger.jdbc.resultset=OFF log4j.logger.jdbc.connection=OFF
```

6、添加 log4jdbc.log4j2.properties 文件：

这是最后一步，在项目的 CLASSPATH 路径下创建一个 log4jdbc.log4j2.properties 文件，告诉 Log4jdbc-log4j2 使用的是 Slf4j 来记录和打印日志，在该配置文件里增加：

```properties
log4jdbc.spylogdelegator.name=net.sf.log4jdbc.log.slf4j.Slf4jSpyLogDelegator
```

最后，运行一下项目，看看效果。

**效果**

![img](https://mmbiz.qpic.cn/mmbiz_jpg/R5ic1icyNBNd4S9UxbgM1hfwibqibKicKHD10W4EtDicFSV8P1goYuGhj8uguialepD1ARH3zVzzSwzx2ibcsUSUsU2uUQ/640?wx_fmt=jpeg&tp=webp&wxfrom=5&wx_lazy=1&wx_co=1)

上图可以看出，两个 SELECT 语句的执行时间分别是 117 和 552 毫秒，这对于开发调试还是很有帮助的。现在很多的项目压测时和上线后，基本都在使用 OneAPM ，它的数据库监控 2分析功能更强大一些，不仅可以记录 SQL 日志，还可以定位到操作 SQL 的 Java 代码行，直接在网页上就可以看到效果，使用体验还是不错的。

zhongxu/MyLean

简介

发行版

贡献者

近期动态