使用HIBERNATE的SQL查询并将结果集自动转换成POJO



使用HIBERNATE的SQL查询并将结果集自动转换成POJO在某些场合下,我们可能想使用HIBERNATE的框架提供的SQL查询接口,但是,由于实体没有做映射,HIBERNATE不能把结果集转换成你想要的List<POJO>,本文讨论如何在这种情况下让HIBERNATE直接返回你想的结果。下面是简单的查询封装方法

Java代码  收藏代码
  1. public List<?> findObjectBySql(String queryString,Class<?> pojoClass){
  2.                   //使用SQL构造查询对象,此SQL是可以被JDBC接受的SQL,如SELECT * FROM XXX_TABLE
  3.         Query query = this.getSession().createSQLQuery(queryString);
  4.                   //设置结果集转换器,这是本文重点所在
  5.         query.setResultTransformer(new EscColumnToBean(pojoClass));
  6.                   //返回查询结果
  7.         return query.list();

上面这个方法很简单,如果查的是USER表,并且pojoClass参数传入的就是USER.class的话,那么返回结果集的就是List<User>。当然在我的应用中还有查询条件封装,分页和自动查询总行数等逻辑,不想把主题分散,所以给省略了。
下面是结果集转换器的完整代码

Java代码  收藏代码
  1. package com.lgdlgd.hibernate;
  2. import java.lang.reflect.Field;
  3. import java.util.List;
  4. import org.hibernate.HibernateException;
  5. import org.hibernate.property.ChainedPropertyAccessor;
  6. import org.hibernate.property.PropertyAccessor;
  7. import org.hibernate.property.PropertyAccessorFactory;
  8. import org.hibernate.property.Setter;
  9. import org.hibernate.transform.ResultTransformer;
  10. import com.esc.common.baseclass.BaseModel;
  11. /**
  12.  * 自定义的数据库字库转换成POJO
  13.  */
  14. public class EscColumnToBean implements ResultTransformer {
  15.     private static final long serialVersionUID = 1L;
  16.     private final Class<? extends BaseModel> resultClass;
  17.     private Setter[] setters;
  18.     private PropertyAccessor propertyAccessor;
  19.     public EscColumnToBean(Class<? extends BaseModel> resultClass) {
  20.         if(resultClass==null) throw new IllegalArgumentException(“resultClass cannot be null”);
  21.         this.resultClass = resultClass;
  22.         propertyAccessor = new ChainedPropertyAccessor(new PropertyAccessor[] { PropertyAccessorFactory.getPropertyAccessor(resultClass,null), PropertyAccessorFactory.getPropertyAccessor(“field”)});
  23.     }
  24.     //结果转换时,HIBERNATE调用此方法
  25.     public Object transformTuple(Object[] tuple, String[] aliases) {
  26.         Object result;
  27.         try {
  28.             if(setters==null) {//首先初始化,取得目标POJO类的所有SETTER方法
  29.                 setters = new Setter[aliases.length];
  30.                 for (int i = 0; i < aliases.length; i++) {
  31.                     String alias = aliases[i];
  32.                     if(alias != null) {
  33.                         //我的逻辑主要是在getSetterByColumnName方法里面,其它都是HIBERNATE的另一个类中COPY的
  34.                         //这里填充所需要的SETTER方法
  35.                         setters[i] = getSetterByColumnName(alias);
  36.                     }
  37.                 }
  38.             }
  39.             result = resultClass.newInstance();
  40.             //这里使用SETTER方法填充POJO对象
  41.             for (int i = 0; i < aliases.length; i++) {
  42.                 if(setters[i]!=null) {
  43.                     setters[i].set(result, tuple[i], null);
  44.                 }
  45.             }
  46.         } catch (InstantiationException e) {
  47.             throw new HibernateException(“Could not instantiate resultclass: ” + resultClass.getName());
  48.         } catch (IllegalAccessException e) {
  49.             throw new HibernateException(“Could not instantiate resultclass: ” + resultClass.getName());
  50.         }
  51.         return result;
  52.     }
  53.     //根据数据库字段名在POJO查找JAVA属性名,参数就是数据库字段名,如:USER_ID
  54.     private Setter getSetterByColumnName(String alias) {
  55.         //取得POJO所有属性名
  56.         Field[] fields = resultClass.getDeclaredFields();
  57.         if(fields==null || fields.length==0){
  58.             throw new RuntimeException(“实体”+resultClass.getName()+”不含任何属性”);
  59.         }
  60.         //把字段名中所有的下杠去除
  61.         String proName = alias.replaceAll(“_”, ”").toLowerCase();
  62.         for (Field field : fields) {
  63.             if(field.getName().toLowerCase().equals(proName)){//去除下杠的字段名如果和属性名对得上,就取这个SETTER方法
  64.                 return propertyAccessor.getSetter(resultClass, field.getName());
  65.             }
  66.         }
  67.         throw new RuntimeException(“找不到数据库字段 :”+ alias + ” 对应的POJO属性或其getter方法,比如数据库字段为USER_ID或USERID,那么JAVA属性应为userId”);
  68.     }
  69.     @SuppressWarnings(“unchecked”)
  70.     public List transformList(List collection) {
  71.         return collection;
  72.     }
  73. }

我这个转换器工作的前提是数据库的字段名除了可以含有下杠外,不能再含有其它 POJO对应属性中没有的字符,如USER_ID 对应POJO的userId。
扩展点:
1、可以自定义数据库与POJO属性的对应关系,在查询方法中构造转换器时,通过参数把转换关系传入进来,这样就可实现自由转换了,但请注意这种转换关系只有非常通用才有价值(上面的转换规则就是:字段名去除下杠 = JAVA属性名),反之如果每个实体都有自己特有的转换关系,那就还不如编写一个HIBERNATE的映射文件了。
2、本类没有考虑关联,即自定义的对象属性,但这些都不难实现,有兴趣的朋友可结合我的第一篇文章来实现。

注意:HIBERNATE3.25以前(后面的没看),对SQL查询的CHAR类型字段处理不好,只返回一位,且是JAVA的CHAR类型,要修改CharacterType类的代码以返回该类型字段的全值

后记:有朋友说到,HIBERNATE本身也支持这种封装,直接使用HIBERNATE原有的封装:

Java代码  收藏代码
  1. Query query = this.getSession().createSQLQuery(queryString).addEntity(pojoClass);


这样后面就不需要设置结果转换器了,但是这样做的前提是实体必须要有映射

Java代码  收藏代码
  1. //刷屏