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

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

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

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

package com.lgdlgd.hibernate;

import java.lang.reflect.Field;
import java.util.List;

import org.hibernate.HibernateException;
import org.hibernate.property.ChainedPropertyAccessor;
import org.hibernate.property.PropertyAccessor;
import org.hibernate.property.PropertyAccessorFactory;
import org.hibernate.property.Setter;
import org.hibernate.transform.ResultTransformer;

import com.esc.common.baseclass.BaseModel;

/**
 * 自定义的数据库字库转换成POJO
 */
public class EscColumnToBean implements ResultTransformer {
	private static final long serialVersionUID = 1L;
	private final Class<? extends BaseModel> resultClass;
	private Setter[] setters;
	private PropertyAccessor propertyAccessor;
	
	public EscColumnToBean(Class<? extends BaseModel> resultClass) {
		if(resultClass==null) throw new IllegalArgumentException("resultClass cannot be null");
		this.resultClass = resultClass;
		propertyAccessor = new ChainedPropertyAccessor(new PropertyAccessor[] { PropertyAccessorFactory.getPropertyAccessor(resultClass,null), PropertyAccessorFactory.getPropertyAccessor("field")}); 		
	}

	//结果转换时，HIBERNATE调用此方法
	public Object transformTuple(Object[] tuple, String[] aliases) {
		Object result;
		
		try {
			if(setters==null) {//首先初始化，取得目标POJO类的所有SETTER方法
				setters = new Setter[aliases.length];
				for (int i = 0; i < aliases.length; i++) {
					String alias = aliases[i];
					if(alias != null) {
						//我的逻辑主要是在getSetterByColumnName方法里面，其它都是HIBERNATE的另一个类中COPY的
						//这里填充所需要的SETTER方法
						setters[i] = getSetterByColumnName(alias);
					}
				}
			}
			result = resultClass.newInstance();
			
			//这里使用SETTER方法填充POJO对象
			for (int i = 0; i < aliases.length; i++) {
				if(setters[i]!=null) {
					setters[i].set(result, tuple[i], null);
				}
			}
		} catch (InstantiationException e) {
			throw new HibernateException("Could not instantiate resultclass: " + resultClass.getName());
		} catch (IllegalAccessException e) {
			throw new HibernateException("Could not instantiate resultclass: " + resultClass.getName());
		}
		
		return result;
	}

	//根据数据库字段名在POJO查找JAVA属性名，参数就是数据库字段名，如：USER_ID
	private Setter getSetterByColumnName(String alias) {
		//取得POJO所有属性名
		Field[] fields = resultClass.getDeclaredFields();
		if(fields==null || fields.length==0){
			throw new RuntimeException("实体"+resultClass.getName()+"不含任何属性");
		}
		//把字段名中所有的下杠去除
		String proName = alias.replaceAll("_", "").toLowerCase();
		for (Field field : fields) {
			if(field.getName().toLowerCase().equals(proName)){//去除下杠的字段名如果和属性名对得上，就取这个SETTER方法
				return propertyAccessor.getSetter(resultClass, field.getName());
			}
		}
		throw new RuntimeException("找不到数据库字段 ："+ alias + " 对应的POJO属性或其getter方法，比如数据库字段为USER_ID或USERID，那么JAVA属性应为userId");
	}

	@SuppressWarnings("unchecked")
	public List transformList(List collection) {
		return collection;
	}

}

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

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

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

Query query = this.getSession().createSQLQuery(queryString).addEntity(pojoClass);

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

//刷屏

评论

12 楼 寻找 2012-02-20  

我想看封装的分页应用，可以发到我邮箱吗？[e-mail] ,对我真的很有用处！顶！

11 楼 nt1327 2011-09-29  

BaseModel怎么写啊?

10 楼 nt1327 2011-09-29  

BaseModel是什么

9 楼 lgdlgd 2010-08-03  

还有一种解决方法，上面给出的EscColumnToBean类中
if(field.getName().toLowerCase().equals(proName))｛。。。｝
这里只判断了方法名，你可以根据你的情况，对方法的参数类型也加以判断，可以从根本上解决问题，这样setAge(int) 和 setAge(BigDecimal)可以并存

8 楼 lgdlgd 2010-08-03  

还要把原来的setAge(int i)去除，否则循环时不知道会取到哪一个set方法

7 楼 lgdlgd 2010-08-03  

zhxsup 写道

你好，在转化数据时报灵下错（包装类型和基本类型），请问怎么解决

你的age字段在JAVA类里面是int类型，然而Hibernate给你传入的是BigDecimal类型是吗？如果是这样的话，根据原因可能是你的数据库字段长度弄得太大了，不合理，Hibernate将其封装成BigDecimal了，年龄改小成三位足够了，
当然你可增加一个setAge(BigDecimal b)方法就解决问题了，不需要改数据库

6 楼 zhxsup 2010-08-03  

你好，在转化数据时报灵下错（包装类型和基本类型），请问怎么解决
ERROR [main] (BasicPropertyAccessor.java:118)(2010-08-03 17:36:09) - IllegalArgumentException in class: com.entity.SysUser, setter method of property: age
ERROR [main] (BasicPropertyAccessor.java:122)(2010-08-03 17:36:09) - expected type: java.lang.Integer, actual value: java.math.BigDecimal


ERROR [main] (BasicPropertyAccessor.java:118)(2010-08-03 17:41:56) - IllegalArgumentException in class: com.entity.SysUser, setter method of property: age
ERROR [main] (BasicPropertyAccessor.java:122)(2010-08-03 17:41:56) - expected type: int, actual value: java.math.BigDecimal

5 楼 liushu1234 2010-03-09  

恩，这是我看过的解决未映射SQL查询的最好办法了，不过每个多要配一下，其实也蛮麻烦的。嘿嘿。谢谢楼主分享。

4 楼 lgdlgd 2009-11-13  

....tianya 写道

哥们，你用的是哪个版本的hibernate阿，我怎么就找不到你写的方法呢

不论是org.hibernate.classic.Session
还是org.hibernate.Session
它们createSQLQuery(sql).addEntity(arg0,arg1) ;

都是2个参数的阿，你怎么就能用一个参数呢。。。。。。

还有，我也没找到你的
query.setResultTransformer(new EscColumnToBean(pojoClass));

这个方法是你自己封装的么？？？

如果看到留言希望能够给与解答！

我的版本是3.25
两个方法都是org.hibernate.SQLQuery接口的方法，不是我自定义的

3 楼 fucktianya 2009-11-09  

哥们，你用的是哪个版本的hibernate阿，我怎么就找不到你写的方法呢

不论是org.hibernate.classic.Session
还是org.hibernate.Session
它们createSQLQuery(sql).addEntity(arg0,arg1) ;

都是2个参数的阿，你怎么就能用一个参数呢。。。。。。

还有，我也没找到你的
query.setResultTransformer(new EscColumnToBean(pojoClass));

这个方法是你自己封装的么？？？

如果看到留言希望能够给与解答！

2 楼 lgdlgd 2009-10-29  

雁行 写道

如果pojo类根本就没有数据库表相对应，只是想方便数据检索，不用object数组，而是 对象方式访问，这样，是否就不能在hql里实现如下方式？

select new MyPojo(u,t) from Sysuser as U,Sysdep as t

我试过，报无法定位MyPojo类

不能，HQL要求必须要有映射的表可以，否则，HIBERNATE也不知道去查哪个表啊。

1 楼 雁行 2009-10-29  

如果pojo类根本就没有数据库表相对应，只是想方便数据检索，不用object数组，而是 对象方式访问，这样，是否就不能在hql里实现如下方式？

select new MyPojo(u,t) from Sysuser as U,Sysdep as t

我试过，报无法定位MyPojo类