Hibernate
一. 序
本文是转载，在此感谢原著作者。
作者：BlueDavy
来源：www.blogjava.net/BlueDavy
二. 开发环境
Hibernate 开发环境的搭建非常的简单，不过为了提高基于Hibernate开发的效率，通常都需要使用一些辅助工具，如xdoclet、middlegen等。
尽管Hibernate已经封装提供了很简单的进行持久的方法，但在实际项目的使用中基本还是要提供一些通用的代码，以便在进行持久的相关操作的时候能够更加的方便。
2.1. lib
2.1.1. Hibernate lib
Hibernate 相关的 lib 自然是开发环境中首要的问题，这部分可以从 Hibernate 的官方网站进行下载，在其官方网站中同时提供了对于 Hibernate 所必须依赖的 lib 以及其他可选 lib 的介绍。
2.2. xdoclet
Hibernate 作为ORM工具，从名字上就能看出它需要一个从O à R 的Mapping的描述，而这个描述就是在使用Hibernate时常见的hbm.xml，在没有工具支持的情况下，需要在编写持久层对象的同时手写这个文件，甚为不便。
在jdk 5.0未推出之前，xdoclet支持的在javadoc中编写注释生成相关配置文件的方式大受欢迎，减少了编写hibernate映射文件的复杂性，手写一个完整的hibernate映射文件出错几率比较的高，再加上手写容易造成编写出来的风格相差很大，因此，基于xdoclet来生成hbm.xml的方式被大量的采用，基于xdoclet来编写能够基于我们在持久层对象上编写的javadoc来生成hbm.xml文件，非常的方便。
2.2.1. Hibernate template
如果没记错的话，大概在 04 年的时候 javaeye 上有位同仁整理了一个这样的 template 文件， ^_^ ，非常感谢，我一直都在用着，呵呵。
这个文件的方便就是把它导入 eclipse 后，在 javadoc 中我们可以直接写 hibid ，然后按 eclipse 的代码辅助键 (alt+/) 来生成整个 hibernate.id 的相关的格式，呵呵，免得在写 hibernate.id 这些东西的时候过于麻烦， ^_^ ，这个 template 文件我稍微做了修改，可在这里下载：
http://www.blogjava.net/Files/BlueDavy/templates-eclipse-tags.rar
当然，你也可以选择直接用 xdoclet 提供的 template 文件，不过 xdoclet 官方网站上好像只提供了可直接导入 idea 的模板文件。
关于注释上的 hibernate.id 这些东西具体请参见 xdoclet 官方网站的说明。
如果你的项目采用的是 jdk 5 ，那么就可以直接使用 hibernate annotation 了，那就更为方便。
2.2.2. Ant task build
Eclipse 里没有集成 xdoclet 的插件，你也可以去安装一个 jboss ide 的插件，里面有 xdoclet 的插件，反正我是觉得太麻烦了。
在项目中我仍然采用 ant task 的方式来生成 hbm.xml ， target 如下所示：
<path id="app.classpath">
<pathelement path="${java.class.path}"/>
<fileset dir="${xdoclib.dir}">
<include name="*.jar"/>
</fileset>
</path>
<target name="hbm" description=" 生成映射文件 ">
<tstamp>
<format property="TODAY" pattern="yy-MM-dd"/>
</tstamp>
<taskdef name="hibernatedoclet" classname="xdoclet.modules.hibernate.HibernateDocletTask" classpathref="app.classpath"/>
<hibernatedoclet destdir="src/java" force="true" verbose="true" excludedtags="@version,@author,@todo">
<fileset dir="src/java">
<include name="**/po/**/*.java"/>
</fileset>
<hibernate version ="3.0"/>
</hibernatedoclet>
</target>
这个文件请根据项目情况以及环境稍做修改， ^_^ ，其中需要通过 properties 文件指明 xdocletlib.dir ，类似 xdocletlib.dir=c:\xdocletlib ，里面放置 xdoclet 的相关 jar 文件。
在搭建好了这样的环境后，就可以在直接在 eclipse 中运行 ant 文件中的这个 target 来生成 hbm.xml 。
2.3. Hibernate3 Tools
如果采用Hibernate 3，则可以直接下载Hibernate 3 Tools的Eclipse Plugin，那就可以类似在PL/SQL里执行sql一样在eclipse里执行hql，^_^
2.4. HibernateUtil
为了方便项目中Hibernate的使用，一般来说都会提供HibernateUtil这样的类，这个类的作用主要是创建sessionFactory和管理session，在Hibernate 3以前采用的是在这里建立ThreadLocal来存放session，在Hibernate 3以后则可以直接使用SessionFactory.getCurrentSession来获取session，而session的获取方式则可通过在hibernate.cfg.xml中执行current_session_context_class的属性来决定是采用thread或jta或自定义的方式来产生session。
2.5. CommonDao
在持久层部分目前采用的较多的仍然是dao模式，Hibernate作为ORM工具已经提供了CRUD的封装，类如可以使用session.save()；session.persist()这样简单的方式来完成CRUD的操作，但在实际的项目中还是需要提供一个通用的Dao，来简化对于事务、异常处理以及session的操作，同时提供一些项目中需要的相关操作。
三. 开发
在完成了Hibernate的开发环境的搭建后，就可以基于Hibernate进行持久层的开发了，对于持久层开发来说，会涉及到实体的编写、实体的维护以及实体的查询三个部分。
3.1. 实体的编写
Hibernate 的一个明显的优点就是在于可透明化的对对象进行持久，这也就意味着持久对象根本就不需要依赖任何的东西，可以采用POJO的方式来编写，在Hibernate 3以上版本还提供了对于Map、XML的方式的持久的支持，就更方便了，在项目中，更多采用的仍然是POJO的方式。
在实体的编写上应该说不会有什么问题，只要仔细查看xdoclet关于hibernatedoclet部分的说明即可完成。
这块需要学习的主要是普通的值类型注释的编写、id字段注释的编写、关联注释的编写，这些部分xdoclet均提供了较详细的说明。
3.2. 实体的维护
3.2.1. 新增 / 编辑 / 删除
新增 / 编辑 / 删除是持久操作中最常使用的维护性操作，基于 Hibernate 做这样的维护就比采用 sql 的方式简单多了，通过上面 CommonDao ，就可以直接完成 dao.save 、 dao.update 、 dao.delete 的操作，而且在 Hibernate 3 也支持了批量的 insert 、 update 和 delete 。
这个部分中需要注意的是 Hibernate 对于对象的三种状态的定义：
u Transient
很容易理解，就是从未与 session 发生过关系的对象， ^_^ ，例如在代码中直接 User user=new User() ；这样形成的 user 对象，就称为 Transient 对象了。
u Detached
同样很容易理解，就是与 session 发生过关系的对象，但 session 已经关闭了的情况下存在的对象，例如：
User user=new User();
user.setName(“bluedavy”);
session.save(user);
session.close();
在 session.close() 后这个时候的 user 对象就处于 Detached 状态之中了，如果想将这个对象变为 Persistent 状态，可以通过 session.merge 或 session.saveOrUpdate() 等方式来实现。
Detached 状态的对象在实际的应用中最常采用，从概念上我们可以这么理解，处于 Detached 状态的对象可以看做是一个 DTO ，而不是 PO ，这从很大程度上就方便了 PO 在实际项目中的使用了。
u Persistent
Persistent 状态就是指和 Session 发生了关系的对象，并且此时 session 未关闭，举例如下：
User user=new User();
user.setName(“bluedavy”);
session.save(user);
user.getName();
在 session.save 后 user 就处于 Persistent 状态，此时如果通过 session 根据 user 的 id 去获取 user 对象，则可发现获取的对象和之前的 user 是同一个对象，这是 session 一级缓存所起的作用了，当然，也可以强制的刷新 session 的一级缓存，让 session 从数据库中重新获取，只需要在获取前执行 session.evict(user) 或 session.clear() 。
3.2.2. 关联维护
关联维护在 Hibernate 中表现出来可能会让熟悉使用 sql 的人有些的不熟，但其实以对象的观点去看是会觉得很正常的。
在 Hibernate 的关联维护中，最重要的是 inverse 和 cascade 两个概念。
u inverse
inverse 从词义上看过去可能不是那么容易理解，其实它的意思就是由谁来控制关联关系的自动维护，当 inverse=true 就意味着当前对象是不能自动维护关联关系，当 inverse=false 就意味着当前对象可自动维护关联关系，还是举例来说：
假设 Org 和 User 一对多关联，
当 org 中 getUsers 的 inverse=false 的情况：
org.getUsers().add(user);
dao.save(org);
这样执行后将会看到数据库中 user 这条记录中的 orgId 已经被设置上去了。
当 inverse=true 的情况下，执行上面的代码，会发现在数据库中 user 这条记录中的 orgId 没有被设置上去。
^_^ ， inverse 的作用这样可能看的不是很明显，在下面的一对多中会加以描述。
u cascade
cascade 的概念和数据库的 cascade 概念是基本一致的， cascade 的意思形象的来说就是当当前对象执行某操作的情况下，其关联的对象也执行 cascade 设置的同样的操作。
例如当 org.getUsers 的 cascade 设置为 delete 时，当删除 org 时，相应的 users 也同样被删除了，但这个时候要注意， org.getUsers 这个集合是被删除的 user 的集合，也就是说如果这个时候数据库中新增加了一个 user 给 org ，那么这个 user 是不会被删除的。
cascade 的属性值详细见《 Hibernate reference 》。
3.2.2.1. 一对一
一对一的关联维护在实际项目中使用不多，一对一在Hibernate中可采用两种方式来构成，一种是主键关联，一种是外键关联。
一对一的使用推荐使用主键关联，具体配置方法请参见《Hibernate Reference》。
3.2.2.2. 一对多/多对一
一对多/多对一的关联维护在实际项目中使用是比较多的，在Hibernate中可采用多种方式来配置一对多的关联，如采用Set、List、Bag、Map等，具体在《Hibernate Reference》中都有详细说明。
在这里我想说的一点就是关于inverse的设置，在一对多的情况下建议将一端的inverse设为true，而由多端去自动维护关联关系，为什么这样做其实挺容易理解的，假设org和user为一对多的关联，org.getUsers的inverse设置为false，org.getUsers().add(user);dao.update(org);当update的时候org所关联的所有user的orgId都会更新一次，可想而知这个效率，而如果改为在多端维护(多端设置为inverse=false)，则是这样：user.setOrg(org);dao.update(user);当update的时候就仅仅是更新user这一条记录而已。
另外一点就是合理的设置cascade，这个要根据需求来实际决定。
3.2.2.3. 多对多
多对多的关联维护在实际项目中其实也是比较多的，尽管在《Hibernate Reference》中认为多对多的情况其实很多时候都是设计造成的。
多对多的关联也同样可以采用Set、List等多种方式来配置，具体在《Hibernate Reference》中也有详细的说明。
多对多的关联维护上没有什么需要多说的，在实践过程中来看这块不会出什么太多问题，唯一需要注意的是合理设置cascade，这个要根据项目的实际情况而定。
3.3. 实体的查询
Hibernate 提供了多种方式来支持实体的查询，如对于原有熟悉sql的人可以继续使用sql，符合对象语言的对象查询语句(HQL)以及条件查询API(Criteria)。
在熟练使用hql或criteria的情况下，我相信你会觉得Hibernate的查询方式会比采用sql的方式更加简便。
3.3.1. 符合对象语言的查询语句
Hibernate 提供了一种符合对象语言的查询语句，称为 HQL ，这种语句的好处是能够避免使用 sql 的情况下依赖数据库特征的情况出现，同时它带来的最大的好处就是我们能够根据 OO 的习惯去进行实体的查询。
对于 HQL 没有什么多讲的，如果熟悉 sql 的人应该也是能够很快就学会 HQL ，而如果不熟悉 sql 的人那也没关系， HQL 的上手是非常容易的，具体请参考《 Hibernate Reference 》。
3.3.2. 占位符式的查询
占位符式的查询 ( 就是采用 ? 替换查询语句中的变量 ) 是在采用 sql 的情况下经常使用的一种查询方式，也是查询时推荐使用的一种方式。
Hibernate 中的查询参数主要有两种类型：值类型和实体类型，值类型就是指一个切实的值 ( 如 String 、 int 、 List 这些 ) ，实体类型就是一个具体的实体，如编写的 User 、 Organization 等，值类型的查询和普通 sql 几乎一样，而实体类型的查询就体现了 Hibernate 的强项， ^_^ ，可以起到简化 sql 的作用，并且使得查询语句更加容易理解。
3.3.2.1. 值类型
3.3.2.1.1. 简单值
举例如下：
from User u where u.name=:username and u.yearold=:yearold
这就是一个常见的简单值的占位符式的查询，通过这样的方式就可以把值注入到参数中：
query.setParameter(“username”,”bluedavy”);
query.setParameter(“yearold”,25);
同样， hibernate 也支持和 sql 完全相同的 ? 的方式，那么上面的语句以及注入参数的方式就变为了：
from User u where u.name=? and u.yearold=?
query.setParameter(0,”bluedavy”);
query.setParameter(1,25);
推荐使用第一种，那样参数的意义更容易被理解。
3.3.2.1.2. in 查询
in 查询也是经常被使用到的一种查询，在 Hibernate 中表现出来会稍有不同，不过如果按照对象观点去看就很容易理解了，例如下面这句：
from User u where u.name in (:usernameList)
在 Hibernate 中通过这样的方式将值注入到这个参数中：
List list=new ArrayList();
list.add(“jerry”);
list.add(“bluedavy”);
query.setParameterList(“usernameList”,list);
在 sql 中通常是组装一个由 , 连接的值来构成 in 中的参数值，而在 Hibernate 中则依照对象转化为采用 list 了， ^_^ ，是不是更方便些。
3.3.2.2. 实体类型
在Hibernate中关联采用的都是对象形式，表现对外就是隐藏了数据库的外键的部分，这也就对习惯使用sql查询的人带来一个问题，因为无法再操作外键字段，那么在涉及到关联的实体的查询时应该怎么做呢，我把它分为单实体和实体集合两种情况来说说。
3.3.2.2.1. 单实体
单实体的查询对应到 sql 情况通常是在一对多的情况下通过多端查询同时结合一端的一些过滤条件，在 sql 中通常采用 join 的方式来实现这个，而在 Hibernate 中要实现这点就更容易了，举例如下：
User 和 Organization 是一对多，现在要查询属于组织机构名称为 ”Blogjava” 以及用户年龄大于 20 的用户：
from User u where u.org.name=:orgname and u.yearold>:yearold
query.setParameter(“orgname”,”Blogjava”);
query.setParameter(“yearold”,20);
可以看到这样的查询语句比 sql 更简单多了，同时也更容易
评论