让JDBC查询日志变得简单

原创 2004年08月24日 22:15:00

    JDBC java.sql.PreparedStatement接口的简单扩展可以使查询日志更少犯错,同时整理您的代码。在本文中,IBM电子商务顾问Jens Wyke向您介绍如何应用基本的封装技术(“通过封装来实现扩展”也称为Decorator设计模式)来获得最满意的结果。

  在大多数情况下,JDBC PreparedStatements 使执行数据库查询更简便并可以显著提升您整体应用程序的性能。当谈到日志查询语句时PreparedStatement接口就显得有些不足了。PreparedStatement的优势在于其可变性,但是一个好的日志条目必须正确描述如何将SQL发送到数据库,它将密切关注用实际的参数值来替换所有参数占位符。虽然有多种方法可以解决这一难题,但没有任何一种易于大规模实施并且大部分将扰乱您的程序代码。

   在本文中,您将了解到如何扩展JDBC PreparedStatement接口来进行查询日志。LoggableStatement类实现PreparedStatement接口,但添加用于获得查询字符串的方法,使用一种适用于记录的格式。使用LoggableStatement类可以减少日志代码中发生错误的几率,生成简单且易于管理的代码。

  注意:本文假设您有丰富的JDBC和PreparedStatement类经验。

  典型日志解决方案  

  表1介绍了数据库查询时通常是如何使用PreparedStatement(虽然忽略了初始化和错误处理)。在本文中,我们将使用SQL query SELECT做为例子,但讨论使用其它类型的SQL语句,如DELETE、UPDATE和INSERT。

  表1:一个典型的SQL数据库查询



  表1中一个好的查询日志条目看起来应与下面有几分类似:



  下面是查询的日志代码的一个例子。注意:表1中的问号已经被每个参数的值替换。



  一种更好的方法是创建方法,我们称之为replaceFirstQuestionMark,它读取查询字符串并用参数值替换问号,如表2所示。这类方法的使用无需创建复制的字符串来描述SQL语句。

  表 2:使用replaceFirstQuestionMark来进行字符串替换



  虽然这些解决方案都易于实施,但没有一种是完美的。问题是在更改SQL模板的同时也必须更改日志代码。您将在某一点上犯错几乎是不可避免的。查询将更改但您忘记了更新日志代码,您将结束与将发送到数据库的查询不匹配的日志条目 -- 调试恶梦。

  我们真正需要的是一种使我们能够一次性使用每个参数变量(在我们的实例中为fooValue和barValue)的设计方案。我们希望有一种方法,它使我们能够获得查询字符串,并用实际的参数值替换参数占位符。由于java.sql.PreparedStatement没有此类方法,我们必须自己实现。

  定制解决方案

  我们的PreparedStatement定制实施将做为围绕JDBC驱动器提供的“真实语句(real statement)”的封装器(Wrapper)。封装器语句将转发所有方法调用(例如setLong(int, long)和setString(int,String)) 到“真实语句”。在这样做之前它将保存相关的参数值,从而它们可以用于生成日志输出结果。

  表3介绍了LoggableStatement类如何实现java.sql.PreparedStatement,以及它如何使用JDBC连接和SQL模板作为输入来构建。

  表3:LoggableStatement实现java.sql.PreparedStatement



  LoggableStatement如何工作

  表4介绍了LoggableStatement如何向saveQueryParamValue()方法添加一个调用,以及在方法setLong和setString的“真实语句”上调用相应的方法。我们采用与用于参数设置的所有方法(例如setChar、setLong、setRef和setObj)相同的方式来增加saveQueryParamValue()调用。表4还显示了在不调用saveQueryParamValue()的情况下如何封装方法executeQuery,因为它不是一个“参数设置”方法。

  表4:LoggableStatement 方法



  表5中显示了saveQueryParamValue()方法。它把每个参数值转换成String表示,保存以便getQueryString方法日后使用。缺省情况下,一个对象使用其 toString方法将被转换成String,但如果对象是String或Date,它将用单引号('')表示。getQueryString()方法使您能够从日志复制大多数查询并进行粘贴,无需修改交互式SQL处理器就可进行测试和调试。您可以根据需要修订该方法来转换其它类的参数值。

  表5:saveQueryParamValue()方法



  当我们使用标准方法来设置所有参数时,我们在LoggableStatement中简单调用getQueryString()方法来获得查询字符串。所有问号都将被真正的参数值替换,它准备输出到我们选定的日志目的地。

  使用LoggableStatement

  表6显示如何更改表1和表2中的代码来使用 LoggableStatement。将LoggableStatement引入到我们的应用程序代码中可以解决复制的参数变量问题。如果改变了SQL模板,我们只需更新PreparedStatement上的参数设置调用(例如添加一个pstmt.setString(3,"new-param-value"))。这一更改将在日志输出结果中反映出,无需任何记录代码的手工更新。

  表6:使用LoggableStatement

  


  结束语

  使用本文介绍的非常简单的步骤,您可以为查询记录扩展JDBC PreparedStatement接口。我们在此处使用的技术可以被视为“通过封装来实现扩展”,或作为Decorator设计模式的一个实例(见参考资料)。通过封装来实现扩展在当您必须扩展API但subclassing不是一项可选功能时极其有用。

  您将在参考资料部分找到LoggableStatement类的源代码。您可以按原样使用它,或者进行定制以满足您的数据库应用程序的特殊需求。

  参考资料

  ◆ 下载LoggableStatement类的
源代码

  ◆ 您将在Roman Vichr的
提示和技巧:JDBC 提示 (developerWorks, 2002年10月)中找到使用PreparedStatements的简要介绍.

  ◆ Lennart Jorelid的“
Use JDBC for industrial-strength performance ”(developerWorks,2000年1月)是一篇不错的在JDBC中设计模式的两部分介绍性文章。

  ◆ Josh Heidebrecht撰写的“
JDBC 3.0新特性 ”(developerWorks,2001年7月)提供JDBC 3.0的概述。

  ◆ 您可以从
java.sun.com 下载Java platform, Standard Edition和JDBC 3.0 API规范。

  ◆ David Gallardo的“
Java设计模式101 ”(developerWorks,2002年1月)是Gang of Four模板不错的介绍。

  ◆ Paul Monday的“
Java设计模式 201”(developerWorks,2002年4月)为高级学员提供了Java设计模式更具概念性的说明。

  ◆ Vince Huston的
Design Patterns site 是另外一个了解设计模式不错的资源。

  ◆ Brian Goetz的“Java 理论与实践:
性能管理 — 您有规划吗? ” (developerWorks,2003年3月)阐述了一些您可以实施用来提升Java应用程序整体性能的措施。

通过JDBC进行简单的增删改查(以MySQL为例)

通过JDBC进行简单的增删改查(以MySQL为例) 前言:什么是JDBC   维基百科的简介: Java 数据库连接,(Java Database Connectivity,简称JDBC)是Ja...
  • u011526340
  • u011526340
  • 2014年12月29日 11:07
  • 1818

Java日志框架——查看“完整的执行的SQL语句”

项目开发中,在调试的时候,经常会有查看“完整的执行的SQL语句”的需求。 假如我们采用"SLF4J+Logback"的日志框架解决方案,那么该如何配置Logback,使得能够记录“完整的执行的SQL语...
  • DSLZTX
  • DSLZTX
  • 2015年08月15日 16:10
  • 5661

怎样在控制台或者日志打印输出JDBC执行的sql语句

今天用jdbc preparestatement 写sql语句查询,但是在执行的过程中实际查询出的结果和预期的结果不一致,然后就在想有什么办法能够在控制台或者Log4j日志输出最终执行的SQL语句,以...
  • hu1991die
  • hu1991die
  • 2015年03月13日 18:08
  • 8412

利用java jdbc从hive数据库提取日志数据进行简单处理

##基于hive和spark的日志处理 [TOC] ####从hive中读取数据 * 通过java中的jdbc方式连接hive         利用java中的java.sql.DriverM...
  • MyNameIsObama
  • MyNameIsObama
  • 2017年11月01日 10:00
  • 1

让中文TeX套装变得更简单

  • 2009年08月08日 09:55
  • 381KB
  • 下载

十种技巧让工作变得简单高效

  • 2008年09月04日 13:42
  • 43KB
  • 下载

APIHOOK框架,使拦截API变得更简单

  • 2009年02月10日 11:05
  • 49KB
  • 下载

十种 技巧 让 工作 变得 简单 高效

  • 2008年12月18日 22:46
  • 13KB
  • 下载

智能百度浏览器 加速 让抢小米手机 变得简单

  • 2014年01月20日 23:33
  • 1.49MB
  • 下载

你的脸在我的记忆里变得模糊不清:伤感日志

你的脸在我的记忆里变得模糊不清:伤感日志 — 你的脸在我的记忆里变得模糊不清:伤感日志 [自导自演,这样的自己] 黑色旋律着忧伤,如同记忆一样被冰封。 似乎我们都一样,在看故...
  • z9z2exrw3y88
  • z9z2exrw3y88
  • 2012年10月19日 17:24
  • 2169
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:让JDBC查询日志变得简单
举报原因:
原因补充:

(最多只允许输入30个字)