以参数值的形式输出hibernate的sql

---

好久没有时间折腾点东西了，现在的项目里面“严重”使用到了hibernate，好吧，想着琢磨琢磨它show出来的sql语句，想将其输出的sql中的参数？以值的方式输出来，抛费了好多时间，终于找了一个好的解决办法，以下是一些废话开始。
      今天刚下载的hibernate-release-4.3.5.Final版本，新建了一个maven工程，配置好hibernate环境，环境准备就绪，test函数从save数据走起，一步一步debug，终于发现在业务逻辑不知道有多深的地方藏着这个类：

 hibernate的输出sql类：

/*

 * Hibernate, Relational Persistence for Idiomatic Java

 *

 * Copyright (c) 2010, Red Hat Inc. or third-party contributors as

 * indicated by the @author tags or express copyright attribution

 * statements applied by the authors.  All third-party contributions are

 * distributed under license by Red Hat Inc.

 *

 * This copyrighted material is made available to anyone wishing to use, modify,

 * copy, or redistribute it subject to the terms and conditions of the GNU

 * Lesser General Public License, as published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY

 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License

 * for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License

 * along with this distribution; if not, write to:

 * Free Software Foundation, Inc.

 * 51 Franklin Street, Fifth Floor

 * Boston, MA  02110-1301  USA

 */

package org.hibernate.engine.jdbc.spi;

import org.hibernate.engine.jdbc.internal.FormatStyle;

import org.hibernate.engine.jdbc.internal.Formatter;

import org.hibernate.internal.CoreLogging;

import org.jboss.logging.Logger;

/**

 * Centralize logging for SQL statements.

 *

 * @author Steve Ebersole

 */

public class SqlStatementLogger {

    private static final Logger LOG = CoreLogging.logger( "org.hibernate.SQL" );

    private boolean logToStdout;

    private boolean format;

    /**

     * Constructs a new SqlStatementLogger instance.

     */

    public SqlStatementLogger() {

        this( false, false );

    }

    /**

     * Constructs a new SqlStatementLogger instance.

     *

     * @param logToStdout Should we log to STDOUT in addition to our internal logger.

     * @param format Should we format the statements prior to logging

     */

    public SqlStatementLogger(boolean logToStdout, boolean format) {

        this.logToStdout = logToStdout;

        this.format = format;

    }

    /**

     * Are we currently logging to stdout?

     *

     * @return True if we are currently logging to stdout; false otherwise.

     */

    public boolean isLogToStdout() {

        return logToStdout;

    }

    /**

     * Enable (true) or disable (false) logging to stdout.

     *

     * @param logToStdout True to enable logging to stdout; false to disable.

     */

    public void setLogToStdout(boolean logToStdout) {

        this.logToStdout = logToStdout;

    }

    public boolean isFormat() {

        return format;

    }

    public void setFormat(boolean format) {

        this.format = format;

    }

    /**

     * Log a SQL statement string.

     *

     * @param statement The SQL statement.

     */

    public void logStatement(String statement) {

        // for now just assume a DML log for formatting

        logStatement( statement, FormatStyle.BASIC.getFormatter() );

    }

    /**

     * Log a SQL statement string using the specified formatter

     *

     * @param statement The SQL statement.

     * @param formatter The formatter to use.

     */

    public void logStatement(String statement, Formatter formatter) {

        if ( format ) {

            if ( logToStdout || LOG.isDebugEnabled() ) {

                statement = formatter.format( statement );

            }

        }

        LOG.debug( statement );

        if ( logToStdout ) {

            System.out.println( "Hibernate: " + statement );

        }

    }

}

        可以发现在org.hibernate.engine.jdbc.spi.SqlStatementLogger类中的logStatement函数就是用于输出sql语句的，参数statement就是sql字符串，formatter指的是格式化相关的，LOG.debug( statement );，那么现在有个解决办法就是在这里能获取到sql，然后再想办法获取当前传递的参数对象，然后一一匹配上之后再替换sql以日志的形式输出，但是这个日志输出类无法拿到参数对象（找个原因是业务嵌套太深了，短时间内实在是没得找），也无法修改别的调用的地方将参数集传递过来，因为在这么个庞大的工程里面做这个不实际，好多好多hibernate的操作函数，可能都需要这么做，而对于实现这么一个小辅助的功能，实在是划不来，不过可以考虑在封装HibernateBaseDao的时候，将当前的参数集存储在ThreadLocal类中，如此再在这里判断这个ThreadLocal中有没有值，如果有值则自己再将sql处理一下输出即可（只是理论上说说可以这么实现而已）；还有一种方式就是在spring的拦截器中，拦截所有dao层函数，再来做相关处理，反正这种解决办法涉及更改的太多了，意义不大，于是找了下往上的资料，发现了p6spy这个组件，就是做这个事情的，于是试试吧，将其实现下。

关于p6spy组件：     
       p6spy组件可以在http://sourceforge.net/projects/p6spy这个地址下载，下载下来的文件p6spy-install.jar需要注意下里面包含了一些帮助说明文档、p6spy.war、p6spy.jar等，可以在项目中导入p6spy.jar，我没有直接导入，而是在pom.xml添加了此jar包，发现2.0.1和2.0.0都不对，打开相关的jar文件看了下，发现如果使用pom.xml加载的jar应该导入1.3的版本，测试此版本是正确的，只是输出的sql信息部分有点多呀（其实我就只关心新的sql部分而已）。下面中的介绍下此版本的集成实现吧。
1、修改hibernate.cfg.xml中的

<property name="connection.driver_class">com.mysql.jdbc.Driver</property>

 将其修改为： 

<property name="connection.driver_class">com.p6spy.engine.spy.P6SpyDriver</property>

 其实加上了这个组件，hibernate自身的show_sql与format_sql也就可以不用为true了。
2、修改 spy.properties
先在大概45行的位置加上 

 # mysql Connector/J driver
realdriver=com.mysql.jdbc.Driver
这里的是mysql数据库真正的驱动，与第一部是相对的，第一步是替换mysql的驱动。 

 在大概68行的位置
#explicitily deregister the realdrivers
deregisterdrivers=true 
这里是将原来的false修改为true，应该是使其注册为驱动 ，其他的参数也都过一过吧。
3、写了一个junit的程序，包括了使用hibernate的save函数，Criteria查询，HQL语句查询3中情况，分别试试输出的sql语句，发现都支持友好。先贴上运行代码，再贴上运行结果吧。

运行代码如下：

package com.test.user;

import org.hibernate.Criteria;

import org.hibernate.Session;

import org.hibernate.Transaction;

import org.hibernate.criterion.Projections;

import org.hibernate.criterion.Restrictions;

import org.junit.Test;

import com.frame.model.Account;

import com.test.util.HibernateUtil;

public class TestUserService {

    @Test

    public void testAddUser() throws Exception {

        Session session = HibernateUtil.getSessionFactory().openSession();

        System.out.println("执行save输出的sql：");

        Transaction transaction = session.beginTransaction();

        Account account = new Account();

        account.setUsername("admin");

        account.setPassword("admin123");

        account.setStatus(1);

        session.save(account);

        transaction.commit();

        

        System.out.println("执行Criteria查询输出的sql：");

        Criteria crit = session.createCriteria(Account.class);

        crit.setProjection(Projections.rowCount());

        crit.add(Restrictions.between("id", 1, 100));

        crit.add(Restrictions.like("username", "admin"));

        crit.list();

        

        System.out.println("执行hql语句输出的sql：");

        String hql = "from Account where id > ? ";

        session.createQuery(hql).setParameter(0, 1).list();

    }

}

 运行结果截图：

        另外，可以注意下由于使用的hibernate4的最新版本，里面的获取sessionFactory的方式有更改了，可以看下HibernateUtil.java类，里面有获取Session相关的封装。

@2014-12-15
        今天稍微改造了一下示例，将hibernate工程换成spring-hibernate工程，其中spring版本为4.0.2.RELEASE；hibernate版本则不变。 在集成的过程中，由于使用的都是4.X的版本，报了一个错误，故修改了hibernate.cfg.xml中的这一个配置项：

 

<property name="current_session_context_class">thread</property>

，在此备注记录一下，修改方式参考的如下地址：http://sqgme.iteye.com/blog/1005761。
        另外说一下：运行此例子需要先新建一个数据库，数据库名称为：hibernate_test，附上项目代码结构图，如下：

注意： 
        此例子的源码中并非官网的原jar，找了篇文章看其修改后的效果，是在http://zhuhonghao.iteye.com/blog/95774下载的。
源码下载：
        老规矩，将上图的运行结果截图另存为本地，再使用360软件工具打开，即可看到工程源码，可直接导入MyEclipse，数据库表无需准备，由于学习使用，配置了hibernate.hbm2ddl.auto属性。
        有的时候发现源码内涵图打开不了，应该是QQ空间相册的问题，在上传时没有选择上传原图导致，它把我的图片压缩了，猜的。附上最新的修改代码的附件，源码下载已失效。 

 点赞

---

 发表评论

---

 评论列表

---