Hibernate Annotation（注释)

在过去几年里，Hibernate不断发展，几乎成为Java数据库持久性的事实标准。它非常强大、灵活，而且具备了优异的性能。在本文中，我们将了解如何使用Java 5 注释来简化Hibernate代码，并使持久层的编码过程变得更为轻松。
传统上，Hibernate的配置依赖于外部 XML 文件：数据库映射被定义为一组 XML 映射文件，并且在启动时进行加载。创建这些映射有很多方法，可以从已有数据库模式或Java类模型中自动创建，也可以手工创建。无论如何，您最终将获得大量的 Hibernate 映射文件。此外，还可以使用工具，通过javadoc样式的注释生成映射文件，尽管这样会给您的构建过程增加一个步骤。
在最近发布的几个Hibernate版本中，出现了一种基于 Java 5 注释的更为巧妙的新方法。借助新的 Hibernate Annotation 库，即可一次性地分配所有旧映射文件——一切都会按照您的想法来定义——注释直接嵌入到您的 Java 类中，并提供一种强大及灵活的方法来声明持久性映射。籍由自动代码完成和语法突出显示功能，最近发布的Java IDE也为其提供了有力的支持。
Hibernate Annotation还支持新的 EJB 3 持久性规范。这些规范旨在提供一种标准化的 Java 持久性机制。由于 Hibernate 3 还提供了一些扩展，因此您可以十分轻松地遵从这些标准，并使用 EJB 3 编程模型来对 Hibernate 持久层进行编码。
现在，让我们来动手使用Hibernate Annotation。
安装 Hibernate Annotation
要使用 Hibernate Annotation，您至少需要具备 Hibernate 3.2和Java 5。可以从 Hibernate 站点 下载 Hibernate 3.2 和 Hibernate Annotation库。除了标准的 Hibernate JAR 和依赖项之外，您还需要 Hibernate Annotations .jar 文件（hibernate-annotations.jar）、Java 持久性 API （lib/ejb3-persistence.jar）。如果您正在使用 Maven，只需要向 POM 文件添加相应的依赖项即可，如下所示：

xml 代码?

1. ...?? <dependency>??
2. ??<groupId>org.hibernate</groupId>?? ??<artifactId>hibernate</artifactId>??
3. ??<version>3.2.1.ga</version>?? </dependency>??
4. <dependency>?? ??<groupId>org.hibernate</groupId>??
5. ??<artifactId>hibernate-annotations</artifactId>?? ??<version>3.2.0.ga</version>??
6. </dependency>?? <dependency>??
7. ??<groupId>javax.persistence</groupId>?? ??<artifactId>persistence-api</artifactId>??
8. ??<version>1.0</version>?? </dependency>??
9. ...??

下一步就是获取 Hibernate 会话工厂。尽管无需惊天的修改，但这一工作与使用 Hibernate Annotations有所不同。您需要使用 AnnotationConfiguration 类来建立会话工厂：
sessionFactory = newAnnotationConfiguration().buildSessionFactory();
尽管通常使用 <mapping> 元素来声明持久性类，您还是需要在 Hibernate 配置文件（通常是 hibernate.cfg.xml）中声明持久性类：
xml 代码?

1. <!DOCTYPE?hibernate-configuration?PUBLIC?? ????"-//Hibernate/Hibernate?Configuration?DTD?3.0//EN"??
2. ????"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">?? ????????<hibernate-configuration>??
3. ??????????<session-factory>?? ????????????<mapping?class="com.onjava.modelplanes.domain.PlaneType"/>??
4. ????????????<mapping?class="com.onjava.modelplanes.domain.ModelPlane"/>?? ??????????</session-factory>??
5. ????????</hibernate-configuration>?? 　　近期的许多?Java?项目都使用了轻量级的应用框架，例如?Spring。如果您正在使用?Spring?框架，可以使用?AnnotationSessionFactoryBean?类轻松建立一个基于注释的?Hibernate?会话工厂，如下所示：??
6. <!--?Hibernate?session?factory?-->?? ??<bean?id="sessionFactory"??
7. ????????class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">?? ???<property?name="dataSource">??
8. ?????<ref?bean="dataSource"/>?? ???</property>??
9. ???<property?name="hibernateProperties">?? ?????<props>??
10. ???????<prop?key="hibernate.dialect">org.hibernate.dialect.DerbyDialect</prop>?? ???????<prop?key="hibernate.hbm2ddl.auto">create</prop>??
11. ???????...?? ?????</props>??
12. ???</property>?? ???<property?name="annotatedClasses">??
13. ?????<list>?? ???????<value>com.onjava.modelplanes.domain.PlaneType</value>??
14. ???????<value>com.onjava.modelplanes.domain.ModelPlane</value>?? ???????...??
15. ?????</list>?? ???</property>??
16. ?</bean>??

第一个持久性类
既然已经知道了如何获得注释所支持的 Hibernate 会话，下面让我们来了解一下带注释的持久性类的情况：
像在其他任何 Hibernate应用程序中一样，带注释的持久性类也是普通 POJO。差不多可以说是。您需要向 Java 持久性 API （javax.persistence.*）添加依赖项，如果您正在使用任何特定于 Hibernate的扩展，那很可能就是 Hibernate Annotation 程序包（org.hibernate.annotations.*），但除此之外，它们只是具备了持久性注释的普通 POJO 。下面是一个简单的例子：
java 代码?

1. @Entity?? public?class?ModelPlane?{??
2. ????private?Long?id;?? ????private?String?name;??
3. ????@Id?? ????public?Long?getId()?{??
4. ????????return?id;?? ????}??
5. ????public?void?setId(Long?id)?{?? ????????this.id?=?id;??
6. ????}?? ????public?String?getName()?{??
7. ????????return?name;?? ????}??
8. ????public?void?setName(String?name)?{?? ????????this.name?=?name;??
9. ????}?? }??

正像我们所提到的，这非常简单。@Entity 注释声明该类为持久类。@Id 注释可以表明哪种属性是该类中的独特标识符。事实上，您既可以保持字段（注释成员变量），也可以保持属性（注释getter方法）的持久性。后文中将使用基于属性的注释。基于注释的持久性的优点之一在于大量使用了默认值（最大的优点就是 “惯例优先原则（convention over configuration）”）。例如，您无需说明每个属性的持久性——任何属性都被假定为持久的，除非您使用 @Transient 注释来说明其他情况。这简化了代码，相对使用老的 XML 映射文件而言也大幅地减少了输入工作量。

生成主键
Hibernate 能够出色地自动生成主键。Hibernate/EBJ 3 注释也可以为主键的自动生成提供丰富的支持，允许实现各种策略。下面的示例说明了一种常用的方法，其中 Hibernate 将会根据底层数据库来确定一种恰当的键生成策略：

java 代码
java 代码?

1. @Id???? @GeneratedValue(strategy=GenerationType.AUTO)????
2. ??public?Long?getId()?{???? ??????return?id;????
3. ??}????

定制表和字段映射
默认情况下，Hibernate 会将持久类以匹配的名称映射到表和字段中。例如，前一个类可以与映射到以如下代码创建的表中：

?

?

sql 代码

1. CREATE?TABLE?MODELPLANE?? (??
2. ????ID?long,?? ????NAME?varchar??
3. )??

如果您是自己生成并维护数据库，那么这种方法很有效，通过省略代码可以大大简化代码维护。然而，这并不能满足所有人的需求。有些应用程序需要访问外部数据库，而另一些可能需要遵从公司的数据库命名惯例。如果有必要，您可以使用 @Table 和 @Column 注释来定制您自己的持久性映射，如下所示：
java 代码

1. @Entity?? @Table(name="T_MODEL_PLANE")??
2. public?class?ModelPlane?{?? ????private?Long?id;??
3. ????private?String?name;?? ????@Id??
4. ????@Column(name="PLANE_ID")?? ????public?Long?getId()?{??
5. ????????return?id;?? ????}??
6. ????public?void?setId(Long?id)?{?? ????????this.id?=?id;??
7. ????}?? ????@Column(name="PLANE_NAME")??
8. ????public?String?getName()?{?? ????????return?name;??
9. ????}?? ????public?void?setName(String?name)?{??
10. ????????this.name?=?name;?? ????}??
11. }??

该内容将映射到下表中：
sql 代码

1. CREATE?TABLE?T_MODEL_PLANE?? (??
2. ????PLANE_ID?long,?? ????PLANE_NAME?varchar??
3. )??

也可以使用其他图和列的属性来定制映射。这使您可以指定诸如列长度、非空约束等详细内容。Hibernate支持大量针对这些注释的属性。下例中就包含了几种属性：
java 代码

1. ...?? @Column(name="PLANE_ID",?length=80,?nullable=true)??
2. public?String?getName()?{?? ????return?name;??
3. }?? ...??

映射关系
Java 持久性映射过程中最重要和最复杂的一环就是确定如何映射表间的关系。像其他产品一样， Hibernate 在该领域中提供了高度的灵活性，但却是以复杂度的增加为代价。我们将通过研究几个常见案例来了解如何使用注释来处理这一问题。
其中一种最常用的关系就是多对一的关系。假定在以上示例中每个 ModelPlane 通过多对一的关系（也就是说，每个飞机模型只与一种飞机类型建立联系，尽管指定的飞机类型可以与七种飞机模型建立联系）来与 PlaneType 建立联系。可如下进行映射：
java 代码

1. @ManyToOne(?cascade?=?{CascadeType.PERSIST,?CascadeType.MERGE}?)?? public?PlaneType?getPlaneType()?{??
2. ????????????????return?planeType;?? ??????}??

CascadeType 值表明 Hibernate 应如何处理级联操作。
另一种常用的关系与上述关系相反：一对多再对一关系，也称为集合。在老式的 Hibernate 版本中进行映射或使用注释时，集合令人头疼，这里我们将简要加以探讨，以使您了解如何处理集合，例如，在以上示例中每个 PlaneType 对象都可能会包含一个 ModelPlanes 集合。可映射如下：
java 代码

1. @OneToMany(mappedBy="planeType",?? ??????????????????cascade=CascadeType.ALL,??
2. ??????????????????fetch=FetchType.EAGER)?? ???@OrderBy("name")??
3. ???public?List<ModelPlane>?getModelPlanes()?{?? ???????return?modelPlanes;??
4. ???}??

命名查询
Hibernate 最优秀的功能之一就在于它能够在您的映射文件中声明命名查询。随后即可通过代码中的名称调用此类查询，这使您可以专注于查询，而避免了 SQL 或者 HQL 代码分散于整个应用程序中的情况。
也可以使用注释来实现命名查询，可以使用 @NamedQueries 和 @NamedQuery 注释，如下所示：
java 代码

1. @NamedQueries(?? ?{??????????
2. ??@NamedQuery(?? ????name="planeType.findById",??
3. ????query="select?p?from?PlaneType?p?left?join?fetch?p.modelPlanes?where?id=:id"?? ??),??
4. ??@NamedQuery(?? ????name="planeType.findAll",??
5. ????query="select?p?from?PlaneType?p"?? ??),??
6. ??@NamedQuery(?? ??????????name="planeType.delete",??
7. ??????????query="delete?from?PlaneType?where?id=:id"?? ????????)???
8. ?}?? )??

一旦完成了定义，您就可以像调用其他任何其他命名查询一样来调用它们。
结束语
Hibernate 3 注释提供了强大而精致的 API，简化了 Java 数据库中的持久性代码，本文中只进行了简单的讨论。您可以选择遵从标准并使用 Java 持久性 API，也可以利用特定于 Hibernate的扩展，这些功能以损失可移植性为代价提供了更为强大的功能和更高的灵活性。无论如何，通过消除对 XML 映射文件的需求，Hibernate 注释将简化应用程序的维护，同时也可以使您对EJB 3 有初步认识。来试试吧！