Hibernate3查询返回Map探秘

 －源于我对它的一个误会

    sparta-紫杉 2010-4-14 9:02 

    开发环境： eclipse3.4.2 + weblogic10.3 + jdk1.6.0_13 + Struts2.1.8 + Spring3.0.1 + Hiberante3.3.2

    初识Hibernate3的查询结果返回Map的功能是非常高兴的，因为我第一印象认为它能够解决类似以下的问题：

    从角色表SysRoles中，得到以Role_Id（角色ID）为Key， 以Role_Desc（角色描述）为Value的Map。

    要知道在以前，我通常采用如下的传统方式解决此类问题：

 public HashMap getRolesMap() {
        try {

                List<SysRoles> results =  getHibernateTemplate().find("from SysRoles");

                Map hashMap = new HashMap(0);
            
            for( SysRoles role : results ){
                    hashMap.put( role.getRoleId(), role.getRoleDesc());
                }

                return hashMap;
        } catch (RuntimeException re) {

                throw re;
        }
    }

     代码虽也不多，短短5行代码，但在代码里面需要经过一次提取，一次加工的过程也有点繁琐，程序员嘛，要本着一个“代码简洁、清晰”的原则。

    有无更好的方法呢？那么在知道Hibernate3能够从查询结果中返回Map的功能后，我很自然的写下如下的代码，以为能节省一个加工的过程：

 public HashMap getPermissionMap() {
        try {    

                HashMap hashMap = (HashMap)getSession()
                        .createSQLQuery("select role_Id, role_Desc  from Sys_Roles").setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP);
            
                return hashMap;
        } catch (RuntimeException re) {

                throw re;
        }
    }

哈哈，只有两行代码便能解决这种问题，看起来似乎是理想的选择，赶快试试吧。

运行后，在jsp偌大的空白页面上，一行异常代码分外刺眼： org.hibernate.impl.SQLQueryImpl cannot be cast to java.util.HashMap.

看来setResultTransformer是不能直接返回Map的，它是返回一个封装了所有Map的List。

看来我还真是太草率了，对上面语句中的“Transformers.ALIAS_TO_ENTITY_MAP”迷感了双眼。

看来事情并不那么简单，还需要探索，既然已经开始了，索性探索个明白吧！在经过对代码、对查询方法进行几次修订后，成为如下代码：

 public HashMap getPermissionMap() {
        try {
            
                 List list = getHibernateTemplate()
                                 .find("select new Map(sysRoles.roleId as roleId, sysRoles.roleDesc as roleDesc) from SysRoles sysRoles");

             for( Object map : list){
                     hashMap.putAll( (Map) map );

                 }

                 return (HashMap) hashMap;
        } catch (RuntimeException re) {

                throw re;
        }
    }

    修改完成之后，我不禁哑然失笑，之前坚持的所谓的“代码简洁、清晰”原则已经荡然无存。但反观代码，似乎有些道理，同时，对java的使用也有了更进一步的理解，对浪费的时光也不再那么怜惜了。

    可惜事情总不能如你所愿，通过对代码的执行发现，数据库里面有多条数据，但是那个返回的hashMap的size却始终是一条。

    我通过下面代码对返回的hashMap进行循环打印，发现仅能打印一条，并且内容始终是一样：

 for( Map.Entry map : hashMap.entrySet() ) {
        System.out.println("#### map1.getKey() = " + map1.getKey() + ", map1.getValue()=" + map1.getValue());
}

唉，还是找找相关的“从Hibernate的查询结果中返回Map”的原理吧，看来我们多少得为我们的草率付出点代价。

下面是我从Hibernate的教程中得到的相关信息，一个说得比较清楚的是javaEye(现在为itEye)的蔡华江，请原谅使用了你的文章：

//////////////////////////////////////////////////// 摘抄开始 ///////////////////////////////////////////

在问答里和论坛中，经常看到有人问，怎样将使用本地SQL查询出来的结果映射为值对象的问题，这里就Hibernate中提供的方法做个结论。
前提，这里没有使用属性的延迟加载技术。

假设有个值对像，如下：

 package　test; 
 
 public　 class　Person　 {
　　 private　Long　id;
　　 private　String　name;
　　 private　Long　age;
　　 private　Long　phone;
　　 private　String　address;

　 public　Person(Long　id,　String　name,　Long　age,　Long　phone,　String　address)　{
　　　　 this.id　=　id;
　　　　 this.name　=　name;
　　　　 this.age　=　age;
　　　　 this.phone　=　phone;
　　　　 this.address　=　address;
        }

　　 public　Long　getId()　{
　　　　 return　id;
　　 }

　　 public　void　setId(Long　id)　{
　　　　 this.id　=　id;
　　 }

　　 public　String　getName()　{
　　　　 return　name;
　　 }

　　 public　void　setName(String　name)　{
　　　　 this.name　=　name;
　　 }

　　 public　Long　getAge()　{
　　　　 return　age;
　　 }

　　 public　void　setAge(Long　age)　{
　　　　 this.age　=　age;
　　 }

　　 public　Long　getPhone()　{
　　　　 return　phone;
　　 }

　　 public　void　setPhone(Long　phone)　{
　　　　 this.phone　=　phone;
　　 }

　　 public　String　getAddress()　{
　　　　 return　address;
　　 }

　　 public　void　setAddress(String　address)　{
　　　　 this.address　=　address;
　　 }
}

如果查询全部五列记录的话，那么只要

List　list　=　getHibernateTemplate().loadAll(Person. class);

如果只需要查询id,name,age三列记录呢？那么就要新增构造方法了，

 public　Person(Long　id,　String　name,　Long　age)　 {
　     this.id　=　id;
　     this.name　=　name;
　     this.age　=　age;
}

然后呢，就可以通过HQL来进行查询。

List　list　=　getHibernateTemplate().find("select　new　test.Person(id,name,age)　from　Person");

这个方法通常可以满足需要了，只是如果，只需要查询id,name,phone三列记录的话，还新增构造方法？不行了，会出现构造方法冲突了。有个办法：

List　list　=　getSession().createQuery("select　id,name,phone　from　person") 
　　　                         .addScalar("id",Hibernate.Long).addScalar("name").addScalar("phone",Hibernate.Long) 
　　　                         .addEntity(Person. class);

但是，这个只适用于存在Person实体的，如果Hibernate中没有进行Person映射的呢，系统中只存在一个JavaBean。

List　list　=　getSession().createSQLQuery("select　id　\"id\",name　\"name\",phone　\"phone\"　from　person") 
　　　                     .addScalar("id",Hibernate.Long).addScalar("name").addScalar("phone",Hibernate.Long) 
　　　                     .setResultTransformer(Transformers.aliasToBean(Person. class)));

    那么Hibernate就会自动将查出来的三列内容组装到VO对象中去，只是代码量有点大，而且名称都需要重新定义为小写的，在Oracle中查出来的列都默认为大写的（不知道其它数据库怎么样），这个办法就不依赖于构造方法了，只需要定义私有变量，设置getter/setter方法就行了。

不过如果更猛点的，根本就没有JavaBean对象可以填充怎么办，Hibernate可以将查出来的列组装到集合类中去。如Map。

List　list　=　getSession().createSQLQuery("select　*　from　person") 
　　　　　　　　　　 .setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP);

//sparta-紫杉 注：这个ALIAS_TO_ENTITY_MAP的含义是指以数据库里的字段为key，以字段内容为Value的Map。有几个字段就会生成几个Map，然后将所有的Map组装到List中。

除了这个Transformers还可以将列转化为List。

List　list　=　getSession().createSQLQuery("select　*　from　person") 
　　　　　　　             .setResultTransformer(Transformers.T0_LIST);

到此，还可以通过继承Transformers将结果映射为其它对象，不累述了，基本功能够用了。

//////////////////////////////////////////////////// 摘抄结束 ///////////////////////////////////////////

    哈哈，各位达人，看完上面这篇文章之后，豁然开朗了吧？

    请注意在上面文章中笔者注释的一段文字就会明白：在hibernate从查询结果返回Map中，是以字段为key，以字段的内容为Value的Map，而不是我想象的假设我在查询中仅提供两个字段，那么Hibernate就会自然地以我的第一个字段的内容为key，以第二个字段的内容为Value生成Map列表。

    那么我也终于明白为什么在我的执行结果中仅有一条数据的原因了，因为在我的代码中返回的list里面，虽然有很多条数据，但是我们应该明白一点：
当我使用Map的putAll时，由于在Map中，均是以字段名称作为key的，那么在数据库中无论有多少条的记录，字段名始终是相同的，也就是说，在Map中重复的key会被反复覆盖，仅保留最后的一条。 它是返回一个封装了所有Map的List，在使用时，只有迭代该List，提取各Map进行使用才不会导致重复覆盖。

    什么样的应用场景赋予我们什么样的想象力，误会有时源于无知，但更多源于我们的无限想象力，有时异想天开的灵感确实能为我们提供打开另一扇未知知识大门的钥匙。
    难道不是吗？ 本次误会让我对Hibernate的理解又深入了一层，无论是原理还是应用场景。再者，不妨将牛吹大一点吧：希望Hibernate团队能够从我的这个误会中吸取点灵感，开发出一个能够返回以前后两个字段的内容分别为key和value的Map的方法来，以方便各位使用Hibernate的程序达人，似乎也未尝不可吧？ 哈哈！