hibernate annotation的注意事项

在以前，我们在Java源代码中使用特殊的JavaDOC标签定义ORMapping规则，然后使用xDoclet生成映射规则文件（.hbm.xml）文件。现在有了Hibernate Annotation，连映射规则文件也不需要了，使用更加方便了。这里说说使用Hibernate Annotation时需要注意的一些地方。这些内容分散在Hiernate Annotation Reference文档和example中，与spring相关的部分则出现在Spring的文档中，这里把它们整理在一起。对我自己来说是起到备网的作用，对于其它Hibernate Annotation的用户，系统也能起到帮助查询的作用。

1. AnnotationConfiguration及配置映射规则。
在没有使用Hibnerate Annotation的使用，我们一般是使用org.hibernate.cfg.Configuration来配置和生成SessionFactory，使用Hibernate Annotation以后，要使用org.hibernate.cfg.AnnotationConfiguration类。该类在hibernate-annotation.jar，而不是hibernate3.jar中。

如果使用Spring + Hibernate的架构，要在Spring的配置文件里配置LocalSessionFactoryBean的时候，要记得定义property configurationClass。对于使用Annotation定义映射规则的类，在hibernate.cfg.xml文件中不能使用<mapping resource="..." />的形式，而要使用<mapping class="..." />的形式。LocalSessionFactoryBean的mappingResources不能调用AnnotationConfiguration的addClass和addPackage方法，因此使用Annotation定义映射规则的类，仍然要通过hibernate.cfg.xml文件来使AnnotationCongiguration载入它们的映射规则。使用Spring + Hibernate + Hibernate Annotation的情况下，LocalSessionFactoryBean的定义一般应该是：
    <bean id="mySessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"
         autowire="no" >
        <property name="configurationClass" value="org.hibernate.cfg.AnnotationConfiguration" />
        <property name="dataSource" ref="myDataSource"/>
        <property name="configLocation" value="classpath:hibernate.cfg.xml" />
    </bean>

2. <mapping package="..." /> 与<mapping class="..." />
前一种形式只是载入制定包中package-info.java文件中定义的Annotation，而该包下的所有持久化类仍然需要通过后一种形式逐一载入它们的映射规则。

3. 使用sequence生成id
使用sequence生成id时，id属性的Annotation应该是：
    @Id
    @GeneratedValue (strategy=GenerationType.SEQUENCE, generator="SEQ_BOOK_ID")
需要注意的是，GeneratedValue中的generator不是sequence的名字，而是一个另外定义的SequenceGenerator的名字。这个SequenceGenerator应该定义在类的级别，因此比较完整的代码是想这个样子的:

@Entity
@AccessType("property")
@Table(name="BOOK")
@SequenceGenerator (name="SEQ_BOOK_ID", sequenceName="SEQ_BOOK_ID")
public class Book {

    private Long id;
   
    @Id
    @GeneratedValue (strategy=GenerationType.SEQUENCE, generator="SEQ_BOOK_ID")
    public Long getId() {
        return id;
    }

    ......
} 


成功配置：

@SequenceGenerator(name="generator",sequenceName = "SEQ_SYSMGR_LOGIN_LOG")@Id @GeneratedValue(strategy=GenerationType.SEQUENCE, generator="generator")

4. AccessType
如果要Hibnerate使用get/set方法存取属性的话，一定要在类级别加上：
@AccessType("property")


5. NamedNativeQuery
使用NamedNativeQuery定义native SQL query的时候，即使只返回一个字段，也需要定义SqlResultSetMapping，见下面的例子：
@SqlResultSetMapping(name="keyWords", columns=@ColumnResult (name="key_word"))
@NamedNativeQuery (name="listKeyWords",
                   query="select distinct key_word from key_words order by key_word",
                   resultSetMapping="keyWords")