hibernate将本地SQL查询结果封装成对象

hibernate将本地SQL查询结果封装成对象

不知道大家有没有碰过这种情况，迫于很多情况只能用native SQL来查询（如：复杂统计等），然而使用native查询后，结果会被放到object里，要想拿到对应的数据只能由object来强制转换，真的好烦人。因为工作原因，笔者(sourcefour)正在做大量的统计而每次都要进行强制转换，这其实是很麻烦的。我在想如果native SQL查询结果也能够封装对象就好了，于是狠狠的查看了hibernate文档，终于发现了一件令人高兴的事情——native SQL查询的结果也是可以封装成对象滴（具体请看hibernate文档【第16章】）。这种情况不得不高兴啊，于是动手做实验，结果还是令人兴奋的----成功了（^_^）于是将实验结果整理以备以后用。

1.     适用对象

可以将以下几种查询结果用Bean封装起来。通俗点说就是查询出来之后就直接将内容放到了Bean实体里。

总的来说，使用本地SQL查询出来的结果也可以直接放到Bean里，如以下情况（只能想到这么多）：

直接使用本地(native)SQL查询(废话，说的不就是使用native sql嘛^_^)

2.     具体实现步骤

2.1. 实体Bean

实体Bean的写法和对象Bean的写法是一样的。区别在于该实体Bean是不需要做Hibernate映射的。

我例子中的Bean如下：

1. package com.sourcefour.bean;
2. /**
3. * 这里说明一下，该Bean中的field没必要一定是数据表中的field。
4. * 而应该是DAO中要查询字段的别名，具体请看例子NativeSqlDao，
5. * 我想你会明白的
6. *
7. * @author sourcefour
8. */
9. public class NativeSqlBean {
10. private double maxMos;
11. private double minMos;
12. private double avgMos;
13. private int userCount;
14. private String name;
15. public double getMaxMos() {
16. return maxMos;
17. }
18. public void setMaxMos(double maxMos) {
19. this.maxMos = maxMos;
20. }
21. public double getMinMos() {
22. return minMos;
23. }
24. public void setMinMos(double minMos) {
25. this.minMos = minMos;
26. }
27. public double getAvgMos() {
28. return avgMos;
29. }
30. public void setAvgMos(double avgMos) {
31. this.avgMos = avgMos;
32. }
33. public int getUserCount() {
34. return userCount;
35. }
36. public void setUserCount(int userCount) {
37. this.userCount = userCount;
38. }
39. public String getName() {
40. return name;
41. }
42. public void setName(String name) {
43. this.name = name;
44. }
45. }

2.2.  Dao操作

直接上代码：

1. package com.sourcefour.dao.base;
2. import java.sql.SQLException;
3. import java.util.List;
4. import javax.annotation.Resource;
5. import org.hibernate.HibernateException;
6. import org.hibernate.Query;
7. import org.hibernate.SQLQuery;
8. import org.hibernate.Session;
9. import org.hibernate.SessionFactory;
10. import org.hibernate.transform.Transformers;
11. import org.springframework.orm.hibernate3.HibernateCallback;
12. import org.springframework.orm.hibernate3.support.HibernateDaoSupport;
13. import org.springframework.transaction.annotation.Propagation;
14. import org.springframework.transaction.annotation.Transactional;
15. /**
16. * @author sourcefour
17. */
18. @SuppressWarnings("unchecked")
19. @Transactional
20. public abstract class BaseDaoSupport<T> extends HibernateDaoSupport {
21. @Resource(name = "sessionFactory")
22. public void setSuperSessionFactory(SessionFactory sessionFactory) {
23. super.setSessionFactory(sessionFactory);
24. }
25. /**
26. * 使用sql语句进行分页查询
27. *
28. * @param sql
29. *            sql语句
30. * @param values
31. *            参数
32. * @param offSet
33. *            第一条记录序号 >-1
34. * @param pageSize
35. *            每页要显示的记录数 >0
36. * @param beanClass
37. *            将查询结果转换为<tt>T</tt>对象
38. * @param fieldList
39. *            查询Bean的成员变量名称
40. */
41. @Transactional(readOnly = true, propagation = Propagation.NOT_SUPPORTED)
42. public List<T> list(final String sql, final Object[] values, final int offSet, final int pageSize,
43. final Class<T> beanClass, final List<String> fieldList) {
44. List<T> list = getHibernateTemplate().executeFind(new HibernateCallback() {
45. public Object doInHibernate(Session session) throws HibernateException, SQLException {
46. SQLQuery sqlQuery = session.createSQLQuery(sql);
47. // 添加要查询字段的标量
48. AddScalar.addSclar(sqlQuery, beanClass, fieldList);
49. Query query = sqlQuery;
50. // 转换查询结果为T
51. if (beanClass != null) {
52. query.setResultTransformer(Transformers.aliasToBean(beanClass));
53. }
54. if ((values != null) && values.length > 0) {
55. int i = 0;
56. for (Object obj : values) {
57. query.setParameter(i++, obj);
58. }
59. }
60. if (offSet > -1) {
61. query.setFirstResult(offSet);
62. }
63. if (pageSize > 0) {
64. query.setMaxResults(pageSize);
65. }
66. return query.list();
67. }
68. });
69. return list;
70. }
71. }

亮点在代码中注释的两句。其中AddScalar.addSclar是自己写的，具体请看代码：

1. package com.sourcefour.dao.base;
2. import java.lang.reflect.Field;
3. import java.util.Date;
4. import java.util.List;
5. import org.hibernate.Hibernate;
6. import org.hibernate.SQLQuery;
7. /**
8. * @author sourcefour
9. */
10. public class AddScalar {
11. /**
12. * 将field type 和 Hibernate的类型进行了对应。这里其实不是多余的，如果不进行一定的对应可能会有问题。
13. * 问题有两个：
14. *  1. 在oracle中我们可能把一些字段设为NUMBER(%)，而在Bean中的字段定的是long。那么查询时可能会报：
15. *     java.math.BeigDecimal不能转换成long等错误
16. *  2. 如果不这样写的话，可能Bean中的field就得是大写的，如：name就得写成NAME,userCount就得写成USERCOUNT
17. *     这样是不是很扯(V_V)
18. *
19. * @param <T>
20. * @param sqlQuery
21. *            SQLQuery
22. * @param clazz
23. *            T.class
24. * @param fieldList
25. *            要查询的成员变量名称
26. */
27. public static <T> void addSclar(SQLQuery sqlQuery, Class<T> clazz, List<String> fieldList) {
28. if (clazz == null) {
29. throw new NullPointerException("[clazz] could not be null!");
30. }
31. if ((fieldList != null) && (fieldList.size() > 0)) {
32. Field[] fields = clazz.getDeclaredFields();
33. for (String fieldName : fieldList) {
34. for (Field field : fields) {
35. if (fieldName.equals(field.getName())) {
36. if ((field.getType() == long.class) || (field.getType() == Long.class)) {
37. sqlQuery.addScalar(field.getName(), Hibernate.LONG);
38. } else if ((field.getType() == int.class) || (field.getType() == Integer.class)) {
39. sqlQuery.addScalar(field.getName(), Hibernate.INTEGER);
40. } else if ((field.getType() == char.class) || (field.getType() == Character.class)) {
41. sqlQuery.addScalar(field.getName(), Hibernate.CHARACTER);
42. } else if ((field.getType() == short.class) || (field.getType() == Short.class)) {
43. sqlQuery.addScalar(field.getName(), Hibernate.SHORT);
44. } else if ((field.getType() == double.class) || (field.getType() == Double.class)) {
45. sqlQuery.addScalar(field.getName(), Hibernate.DOUBLE);
46. } else if ((field.getType() == float.class) || (field.getType() == Float.class)) {
47. sqlQuery.addScalar(field.getName(), Hibernate.FLOAT);
48. } else if ((field.getType() == boolean.class) || (field.getType() == Boolean.class)) {
49. sqlQuery.addScalar(field.getName(), Hibernate.BOOLEAN);
50. } else if (field.getType() == String.class) {
51. sqlQuery.addScalar(field.getName(), Hibernate.STRING);
52. } else if (field.getType() == Date.class) {
53. sqlQuery.addScalar(field.getName(), Hibernate.TIMESTAMP);
54. }
55. }
56. }
57. }
58. }
59. }
60. }

所有的准备工作都做好了，那么就看我们的具体的DAO操作及单元测试。

具体DAO：

1. package com.sourcefour.dao;
2. import java.util.ArrayList;
3. import java.util.List;
4. import org.springframework.stereotype.Repository;
5. import com.sourcefour.bean.NativeSqlBean;
6. import com.sourcefour.dao.base.BaseDaoSupport;
7. /**
8. * @author sourcefour
9. */
10. @Repository
11. public class NativeSqlDao extends BaseDaoSupport<NativeSqlBean> {
12. public List<NativeSqlBean> listAll(int offSet, int pageSize) {
13. String sql = "SELECT MAX(t.mos) maxMos, MIN(t.mos) minMos, AVG(t.mos) avgMos, COUNT(t.id) userCount FROM t_native_sql t";
14. List<String> fieldList = new ArrayList<String>();
15. fieldList.add("maxMos");
16. fieldList.add("minMos");
17. fieldList.add("avgMos");
18. fieldList.add("userCount");
19. return super.list(sql, new Object[] {}, offSet, pageSize, NativeSqlBean.class, fieldList);
20. }
21. }

说明：sql语句中的别名就是我们Bean中的字段

Junit测试代码：

1. package com.sourcefour.test.dao;
2. import java.util.List;
3. import org.junit.Assert;
4. import org.junit.BeforeClass;
5. import org.junit.Test;
6. import org.springframework.context.ApplicationContext;
7. import org.springframework.context.support.ClassPathXmlApplicationContext;
8. import com.sourcefour.bean.NativeSqlBean;
9. import com.sourcefour.dao.NativeSqlDao;
10. /**
11. * @author sourcefour
12. */
13. public class NativeSqlDaoTest {
14. private static NativeSqlDao nativeSqlDao;
15. private static ApplicationContext applicationContext;
16. @BeforeClass
17. public static void setUp() {
18. applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
19. nativeSqlDao = (NativeSqlDao) applicationContext.getBean("nativeSqlDao");
20. }
21. @Test
22. public void testListIntInt() {
23. List<NativeSqlBean> list = nativeSqlDao.listAll(-1, -1);
24. Assert.assertNotNull(list);
25. for (NativeSqlBean nativeSqlBean : list) {
26. System.out.println("maxMos: " + nativeSqlBean.getMaxMos());
27. }
28. }
29. }

运行结果：

到了这里应该说一切OK鸟。

完整的文档，SQL，工程下载地址：CSDN下载

说明：本说明是关于资源附件的，在资源中附件名称叫做 ‘hibernate将本地SQL查询结果封装成对象（最终）’，其实只有一版，这里只所以叫最终版是因为该附件我上传了好几天传不上去，到最后报告说‘资源已经存在’，但我确实没有看到附件。所以没办法只能改个名字了…………