如何有效地记录 Java SQL 日志(转)
在常規(guī)項目的開發(fā)中可能最容易出問題的地方就在于對數(shù)據(jù)庫的處理了,在大部分的環(huán)境下,我們對數(shù)據(jù)庫的操作都是使用流行的框架,比如 Hibernate 、 MyBatis 等。由于各種原因,我們有時會想知道在這些框架下實際執(zhí)行的 SQL 究竟是什么。
雖然 Hibernate 可以在配置文件中打開 SHOW SQL 的功能, MyBatis 則可以在 Log4j 的配置文件中配置 SQL 語句的輸出,但這些輸出是類似這樣的 INSERT … ? ? ? 語句,并不是一個完整可以運行的 SQL ,要想知道完整的 SQL 需要手動把參數(shù)補齊,如果要調(diào)試這樣的 SQL 無疑非常痛苦。
Log4jdbc 是一個開源 SQL 日志框架,它使用代理模式實現(xiàn)對常用的 JDBC Driver( Oracle , Derby , MySQL , PostgreSQL , H2 , HSQLDB , …)操作的攔截,記錄真實 SQL ,可以將占位符與參數(shù)全部合并在一起顯示,方便直接拷貝 SQL 在 MySQL 等客戶端直接執(zhí)行,加快調(diào)試速度。本文主要介紹如何使用 Log4jdbc 這個可以直接顯示完整 SQL 的日志框架,希望對大家能有所幫助。
Log4jdbc 的特點:
Log4jdbc 的官方主頁是?https://github.com/arthurblake/log4jdbc?,它具有以下特點:
-
完全支持 JDBC3 和 JDBC4
-
配置簡單,在大多數(shù)情況下,只需要將 JDBC 驅(qū)動類改成 net.sf.log4jdbc.DriverSpy ,同時將 jdbc:log4jdbc 添加到現(xiàn)有的 JDBC URL 之前,最后配置日志記錄的種類即可
-
將 Prepared Statements 中的綁定參數(shù)自動插入到對應(yīng)的位置。在大多數(shù)情況下極大改善了可讀性及調(diào)試工作
-
SQL 的耗時信息能被獲取從而幫助判斷哪些語句執(zhí)行得過慢,同時這些信息可以被工具識別得到一個關(guān)于慢 SQL 的報表
-
SQL 連接信息也可以獲取從而幫助診斷關(guān)于連接池或線程的問題
-
兼容任何 JDBC 驅(qū)動,需要 JDK1.4 及以上與 Slf4j1.x
-
開源軟件,使用 Apache 2.0 License
使用 Log4jdbc 的步驟:
感興趣的朋友可以去 Log4jdbc 的項目主頁看它的使用方法,如果單純使用 Log4jdbc ,不會對 ResultSet 以表格方式呈現(xiàn),在這里我們使用擴展自 Log4jdbc 的日志框架 Log4jdbc-log4j2 ,它增加了對 ResultSet 以表格方式呈現(xiàn)的處理,項目主頁是:?https://code.google.com/p/log4jdbc-log4j2/?。它的使用步驟如下:
1、決定使用哪個版本的 JAR 包:
如果使用 JDK1.5 , 應(yīng)該使用 JDBC3 版本的 JAR 包即 log4jdbc-log4j2-jdbc3.jar 。
如果使用 JDK1.6 , 應(yīng)該使用 JDBC4 版本的 JAR 包即 log4jdbc-log4j2-jdbc4.jar (即使實際使用的 JDBC 驅(qū)動是 JDBC3 的甚至更老)。
如果使用 JDK1.7 , 應(yīng)該使用 JDBC4.1 版本的 JAR 包即 log4jdbc-log4j2-jdbc4.1.jar (即使實際使用的 JDBC 驅(qū)動是 JDBC3 的甚至更老)。
2、將 JAR 包添加進(jìn)項目:
將 JAR 包添加進(jìn)項目有兩種方式,第一種是直接將 Log4jdbc-log4j2 和 Slf4j 的 JAR 包添加進(jìn) CLASSPATH 中,第二種是使用 MAVEN 方式引入 JAR 包,這里我們主要說明第二種方式。在 pom.xml 文件中,根據(jù)使用的 JDBC 驅(qū)動的版本來替換 log4jdbc-log4j2-jdbcXX (比如 log4jdbc-log4j2-jdbc4.1 , 或者 log4jdbc-log4j2-jdbc4 , 或者 log4jdbc-log4j2-jdbc3 )。該框架需要配合 Slf4j 一起使用,MAVEN 配置如下:
<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 驅(qū)動類改成 net.sf.log4jdbc.sql.jdbcapi.DriverSpy 。
4、將 jdbc:log4 添加到現(xiàn)有的 JDBC URL 之前:
例如原來的 JDBC URL 是
jdbc:mysql://localhost:3306/MyDatabase,則應(yīng)該改成:
jdbc:log4jdbc:mysql://localhost:3306/MyDatabase5、配置日志記錄的種類:
Log4jdbc 用以下幾個可以配置的日志種類:
-
jdbc.sqlonly : 僅記錄 SQL
-
jdbc.sqltiming :記錄 SQL 以及耗時信息
-
jdbc.audit :記錄除了 ResultSet 之外的所有 JDBC 調(diào)用信息,會產(chǎn)生大量的記錄,有利于調(diào)試跟蹤具體的 JDBC 問題
-
jdbc.resultset :會產(chǎn)生更多的記錄信息,因為記錄了 ResultSet 的信息
-
jdbc.connection :記錄連接打開、關(guān)閉等信息,有利于調(diào)試數(shù)據(jù)庫連接相關(guān)問題
以上日志種類都可以設(shè)置為 DEBUG , INFO 或 ERROR 級別。當(dāng)設(shè)置為 FATAL 或 OFF 時,意味關(guān)閉記錄。
以下是一個采用 Log4j 作為具體日志系統(tǒng)的典型配置,將這些配置到 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=OFF6、添加 log4jdbc.log4j2.properties 文件:
這是最后一步,在項目的 CLASSPATH 路徑下創(chuàng)建一個 log4jdbc.log4j2.properties 文件,告訴 Log4jdbc-log4j2 使用的是 Slf4j 來記錄和打印日志,在該配置文件里增加:
log4jdbc.spylogdelegator.name=net.sf.log4jdbc.log.slf4j.Slf4jSpyLogDelegator最后,運行一下項目,看看效果。
效果:
上圖可以看出,兩個 SELECT 語句的執(zhí)行時間分別是 117 和 552 毫秒,這對于開發(fā)調(diào)試還是很有幫助的。現(xiàn)在很多項目的壓測時和上線后,基本都在使用?OneAPM?,它的數(shù)據(jù)庫監(jiān)控分析功能更強大一些,不僅可以記錄 SQL 日志,還可以定位到操作 SQL 的?Java?代碼行,直接在網(wǎng)頁上就可以看到效果,使用體驗還是不錯的。
?
http://www.cnblogs.com/oneapm/p/4828243.html
總結(jié)
以上是生活随笔為你收集整理的如何有效地记录 Java SQL 日志(转)的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Sendmail+dovecot+sas
- 下一篇: java读取XML文件的四种方式