使用 log4jdbc 记录 SQL 日志

2019-08-14

平时开发使用的 Ibatis，Hibernate，Spring jdbc 的 SQL 日志信息，有一个缺点是占位符与参数是分开打印的，如果想要拷贝 SQL 语句至 PLSQL Developer 客户端直接执行，需要自己拼凑完整的 SQL。如果程序用的是原始的 jdbc 和 PreparedStatement 的话，甚至都不会有 SQL 日志打印出来，这给我们在调试程序的时候带来了很大的不便。

log4jdbc 是工作在 jdbc 层的一个日志框架，能够记录 SQL 及数据库连接执行的信息，它可以把参数直接放在 SQL 语句对应的占位符上，打印出能够直接拷贝执行的 SQL，非常方便，能加快调试速度。

下面是应用 log4jdbc 的一个小栗子。

Step 1

首先需要导入 log4jdbc 相关的 jar 包，如下。

Step 2

新建两个配置文件：log4j.properties 和 dbconfig.properties。

log4j.properties 配置如下：

log4j.logger.jdbc.sqlonly=DEBUG,console
log4j.appender.console=org.apache.log4j.ConsoleAppender 
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} %m%n%n
log4j.logger.jdbc.sqltiming=INFO,console  
log4j.logger.jdbc.connection=INFO,console

dbconfig.properties 配置如下：

url:jdbc:log4jdbc:oracle:thin:@192.168.1.44:1521:orcl
driverClassName:net.sf.log4jdbc.DriverSpy
username:csbase
password:ora123
filters:stat
maxActive:200
initialSize:20
maxWait:60000
minIdle:10
timeBetweenEvictionRunsMillis:60000
minEvictableIdleTimeMillis:300000
validationQuery:SELECT 'x'
testWhileIdle:true
testOnBorrow:false
testOnReturn:false
removeAbandoned:false
removeAbandonedTimeout:1800
logAbandoned:true

不同的数据库有不同的 url 和 driverClassName，上面的配置对应 Oracle 数据库。MySQL 对应的配置如下：

1 2	url:jdbc:log4jdbc:mysql://localhost:3306/testbase driverClassName:net.sf.log4jdbc.DriverSpy

Step 3

测试程序：

/**
 * 
 */
package com.test;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.SQLException;

/**
 * @description 用 log4jdbc 打印完整 SQL 日志
 * @author Daniel Ge
 * @version 1.0
 * @date 2019-8-14
 */
public class Test {

	public static void main(String[] args) {

		// 这些数据库连接参数当然也可以从配置文件中读取
		String DRIVER   = "net.sf.log4jdbc.DriverSpy";
		String URL      = "jdbc:log4jdbc:oracle:thin:@192.168.1.44:1521:orcl";
		String USER     = "csbase";
		String PASSWORD = "ora123";

		Connection pConn          = null;
		PreparedStatement preStmt = null;
		boolean autoCommit        = false;

		StringBuffer sql = new StringBuffer(
				"insert into MY_USER(t_id, t_name, t_code, t_pass)")
				.append(" values(?, ?, ?, ?)");

		String insertSql = sql.toString();

		try {
			Class.forName(DRIVER);
			pConn = DriverManager.getConnection(URL, USER, PASSWORD);

			autoCommit = pConn.getAutoCommit();
			pConn.setAutoCommit(false);
			preStmt = pConn.prepareStatement(insertSql);

			preStmt.setString(1, "2");
			preStmt.setString(2, "葛小伦");
			preStmt.setString(3, "admin");
			preStmt.setString(4, "123456");

			preStmt.execute();
			pConn.commit();

		} catch (Exception e) {
			if (pConn != null) {
				try {
					pConn.rollback();
				} catch (SQLException e1) {
					e1.printStackTrace();
				}
			}
			e.printStackTrace();

		} finally {
			if (pConn != null) {
				try {
					pConn.setAutoCommit(autoCommit);
					pConn.close();
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
		}
	}

}

运行结果：