用Hibernate框架把hql生成可执行的sql语句-Oracle方言

　　引言:为什么这样的需求,源自公司项目需要,公司的项目使用java的struts2+spring2.5+oracle中间件tuxedo,数据库用的是Oracle,但由于不直接连接数据库，用中间件处理的方式，又不希望有太多服务，所以就开始网络找资料整理编码了。大概花了一个多星期完成了这个任务，现在整理出来与大家分享，也是自己知识的梳理。

　　1.需要导入相关的jar包: [按字母顺序排列]

antlr-2.7.5H3.jar　　　　　　　　　　 语言转换工,Hibernate利用它实现 HQL 到 SQL的转换

asm.jar　　　　　　　　　　　　　　　ASM 字节转换库

cglib-2.1.2.jar  　　　　　　　　　　　高效的代码生成工具, Hibernate用它在运行时扩展 Java类和实现 Java 接口

classes12.jar  　　　　　　　　　　　 Oracle数据库驱动

commons-collections-2.1.1.jar   　　 Apache 的工具集,用来增强Java对集合的处理能力

commons-logging-1.0.4.jar   　　　  Apache 软件基金组所提供的日志工具

dom4j-1.6.1.jar     　　　　　　　　  dom4j XML 解析器

hibernate.jar       　　　　　　　　　  Hibernate的核心库

jta.jar     　　　　　　　　　　　　     标准的 JAVA 事务处理接口

2. 在项目src 下加入 hibernate.cfg.xml ,并配置

 配置数据库方言dialect,和实体映射文件mapping,其他属性可以不用配置,因为不需要用到,注意:数据库连接url 不要加,因为加了后,程序会试图去连接。

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE hibernate-configuration PUBLIC
          "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
          "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">

<!-- Generated by MyEclipse Hibernate Tools.                   -->
<hibernate-configuration>
<session-factory>        
    <!--  因为项目只需用Hibernate把hql转换成sql,包括无参数,有参数及需要格式化的参数
    <property name="connection.url">
        jdbc:oracle:thin:@127.0.0.1:1521:javacrm
    </property> 
    <property name="connection.username">scott</property>
    <property name="connection.password">tiger</property>    
    <property name="connection.driver_class">
        oracle.jdbc.driver.OracleDriver
    </property> 
    <property name="show_sql">true</property>
    <property name="format_sql">true</property>    
    -->    
    <!-- 数据库方言 -->
    <property name="dialect">
        org.hibernate.dialect.Oracle10gDialect
    </property>
    <!-- 实体映射文件 -->
    <mapping resource="com/test/bean/Student.hbm.xml"/>
    <mapping resource="com/test/bean/BasDicConstant.hbm.xml"/>
    
</session-factory>
</hibernate-configuration>

3. 编写获取Session公共类 DbUtil.java

package com.test.util;

import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;

public class DbUtil {

    private static final SessionFactory sessionFactory;
    public static final ThreadLocal session = new ThreadLocal();

    static {
        try {
            sessionFactory = new Configuration().configure()
                    .buildSessionFactory();
        } catch (Throwable ex) {
            ex.printStackTrace();
            throw new ExceptionInInitializerError(ex);
        }
    }

    public static Session currentSession() throws HibernateException {
        Session s = (Session) session.get();
        if (s == null || !s.isOpen()) {
            s = sessionFactory.openSession();
            session.set(s);
        }
        return s;
    }

    public static void closeSession() throws HibernateException {
        Session s = (Session) session.get();
        session.set(null);
        if (s != null)
            s.close();
    }

    public SessionFactory getSessionFactory() {
        return sessionFactory;
    }
    
}

4. 编写核心转换类 HqlToSql.java

package com.test.hqlc;

import java.util.Collections;
import java.util.List;

import org.hibernate.Session;
import org.hibernate.hql.ast.QueryTranslatorImpl;
import org.hibernate.impl.SessionFactoryImpl;

import com.test.util.DbUtil;

/**
 * 传入hql语句,参数值列表,返回可执行的sql语句
 * @author xiufen.huang by 2014-07-03 
 */
public class HqlToSql {    
    
    /**
     * 处理结果信息,成功:为空,失败:错误信息
     */
    private static String resultMsg = "" ;
    private static final String nullMsg = "传入的hql为null或空!";
    
    /**
     * 获取处理结果信息,成功:为空,失败:错误信息
     * @return 处理结果信息
     */
    public static String getResultMsg() {
        return resultMsg;
    }    
    
    /**
     * 将hql语句转换为sql语句,无参数
     * @param hql 要转换的hql语句
     * @return 可执行的sql语句,当返回null,可以通过getResultMsg()方法查看处理结果信息
     */
    public static String transHqlToSql(String hql){
        // 当hql为null或空时,直接返回null
        if (hql == null || hql.equals("")) {
            resultMsg = nullMsg;
            return null;            
        }
        // 获取当前session
        Session session = DbUtil.currentSession();
        // 得到session工厂实现类
        SessionFactoryImpl sfi = (SessionFactoryImpl)session.getSessionFactory();
        // 得到Query转换器实现类
        QueryTranslatorImpl queryTranslator = new QueryTranslatorImpl(hql, hql, Collections.EMPTY_MAP, sfi);
        queryTranslator.compile(Collections.EMPTY_MAP, false);  
        // 得到sql
        String sql = queryTranslator.getSQLString();
        // 关闭session
        DbUtil.closeSession();
        return sql;  
    }
    
    /**
     * 将hql语句转换为sql语句,不需要格式化参数的情况
     * @param hql 要转换的hql语句
     * @param paramValues hql参数值列表,注意与参数的顺序一致
     * @return 可执行的sql语句,当返回null,可以通过getResultMsg()方法查看处理结果信息
     */
    public static String transHqlToSql(String hql,List paramValues){
        // 要返回的sql语句
        String sql = transHqlToSql(hql);
        // 当为null或空时,返回null
        if (sql == null || sql.equals("")) {
            resultMsg = nullMsg;
            return null;
        }
        
        // 赋参数值
        if (paramValues != null && paramValues.size() > 0) {            
            for (int i = 0; i < paramValues.size(); i++) {
                sql = sql.replaceFirst("\\?", "\\'"+paramValues.get(i).toString()+"\\'");
            }
        }
        return sql;
    }
    
    /**
     * 将hql语句转换为sql语句,有日期,Char等需要格式化参数的情况
     * @param hql 要转换的hql语句
     * @param paramValues hql参数值列表,注意与参数的顺序一致
     * @return 可执行的sql语句,当返回null,可以通过getResultMsg()方法查看处理结果信息
     */
    public static String formatHqlToSql(String hql,List<TransTemp> paramValues){
        // 要返回的sql语句
        String sql = transHqlToSql(hql);
        // 当为null或空时,返回null
        if (sql == null || sql.equals("")) {
            resultMsg = nullMsg;
            return null;
        }
        
        // 赋参数值
        if (paramValues != null && paramValues.size() > 0) {
            for (int i = 0; i < paramValues.size(); i++) {
                TransTemp tt = paramValues.get(i);
                sql = sql.replaceFirst("\\?", tt.getOracleFormatString());
            }
        }        
        return sql;
    }
    
}

5.测试实例 HqlToSqlTest.java

package com.test.hqlc;

import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.sql.Types;

import org.hibernate.Query;
import org.hibernate.Session;

import com.test.bean.Student;
import com.test.bean.BasDicConstant;
import com.test.util.DbUtil;

public class HqlToSqlTest {

    public static void main(String[] args) {
        
//        String hql = "from Student";
        String hql = "from Student where studentName like :stuName and birthDay between :dat1 and :dat2";

        
        List vals = new ArrayList();
        vals.add("%L%");        
        vals.add("1990-02-28 00:00:00");
        vals.add("1992-02-28 23:59:59");
        
        String sql1 = HqlToSql.transHqlToSql(hql);
        System.out.println("hql转换成sql无参数:"+sql1);
        
        String sql2 = HqlToSql.transHqlToSql(hql, vals);
        
        System.out.println("hql转换成sql有参数:"+sql2);
        System.out.println("转换结果信息: "+HqlToSql.getResultMsg());    
        
        // 有格式化字符串
        List<TransTemp> list = new ArrayList<TransTemp>();
        
        // 构造参数
        TransTemp tt1 = new TransTemp();
        tt1.setParamSqlType(Types.VARCHAR);
        tt1.setParamValue("%L%");
        list.add(tt1);
        
        TransTemp tt2 = new TransTemp(Types.TIME,"1990-02-28 00:00:00");
        list.add(tt2);
        
        TransTemp tt3 = new TransTemp(Types.DATE,new Date(),"yyyy-mm-dd hh24:mi:ss");
        list.add(tt3);
        
        String tSql = HqlToSql.formatHqlToSql(hql, list);
        System.out.println("hql转换成格式化参数的sql: "+tSql);        
        
    }
}

6.测试结果:

hql转换成sql无参数:select student0_.student_id as student1_0_, student0_.student_name as student2_0_, student0_.student_age as student3_0_, student0_.status as status0_, student0_.birth_Day as birth5_0_ from students student0_ where (student0_.student_name like ?) and (student0_.birth_Day between ? and ?)
hql转换成sql有参数:select student0_.student_id as student1_0_, student0_.student_name as student2_0_, student0_.student_age as student3_0_, student0_.status as status0_, student0_.birth_Day as birth5_0_ from students student0_ where (student0_.student_name like '%L%') and (student0_.birth_Day between '1990-02-28 00:00:00' and '1992-02-28 23:59:59')
转换结果信息: 
hql转换成格式化参数的sql: select student0_.student_id as student1_0_, student0_.student_name as student2_0_, student0_.student_age as student3_0_, student0_.status as status0_, student0_.birth_Day as birth5_0_ from students student0_ where (student0_.student_name like '%L%') and (student0_.birth_Day between to_date('1990-02-28 00:00:00','yyyy-mm-dd hh24:mi:ss') and to_date('2014-07-24 17:21:38','yyyy-mm-dd hh24:mi:ss'))

 7. 参考资料:

http://coffeelover.iteye.com/blog/462139
http://blog.csdn.net/w_l_j/article/details/7064416
http://www.cnblogs.com/yql1986/archive/2011/09/30/2196621.html?ADUIN=416455569&ADSESSION=1404434624&ADTAG=CLIENT.QQ.5329_.0&ADPUBNO=26349

8.源码 Hibernate02.rar