[转]实体类注解
@Entity //继承策略。另一个类继承本类，那么本类里的属性应用到另一个类中 @Inheritance(strategy = InheritanceType.JOINED ) @Table(name="INFOM_TESTRESULT") public class TestResult extends IdEntity{}
1
@Entity(name="EntityName")
必须
name为可选,对应数据库中一的个表
2
@Table(name="",catalog="",schema="")
可选,通常和@Entity配合使用,只能标注在实体的class定义处,表示实体对应的数据库表的信息
<br><strong>name</strong>:可选,表示表的名称.默认地,表名和实体名称一致,只有在不一致的情况下才需要指定表名
<br><strong>catalog</strong>:可选,表示Catalog名称,默认为Catalog("").
<br><strong>schema</strong>:可选,表示Schema名称,默认为Schema("").</font></p>
3
@id
必须
@id定义了映射到数据库表的主键的属性,一个实体只能有一个属性被映射为主键.置于getXxxx()前.
4
@GeneratedValue(strategy=GenerationType,generator="")
可选
<br><strong>strategy</strong>:表示主键生成策略,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4种,分别表示让ORM框架自动选择,
<br>根据数据库的Identity字段生成,根据数据库表的Sequence字段生成,以有根据一个额外的表生成主键,默认为AUTO
<br><strong>generator</strong>:表示主键生成器的名称,这个属性通常和ORM框架相关,例如,Hibernate可以指定uuid等主键生成方式.
<br>示例: </font></p>
@Id @GeneratedValues(strategy=StrategyType.SEQUENCE) public int getPk() { return pk; }
5
@Basic(fetch=FetchType,optional=true)
可选
<br><strong>@Basic</strong>表示一个简单的属性到数据库表的字段的映射,对于没有任何标注的getXxxx()方法,默认即为@Basic
<br><strong>fetch</strong>: 表示该属性的读取策略,有EAGER和LAZY两种,分别表示主支抓取和延迟加载,默认为EAGER.
<br><strong>optional</strong>:表示该属性是否允许为null,默认为true
<br>示例:</font> </p>
@Basic(optional=false) public String getAddress() { return address; }
6
@Column
可选
<br><strong>@Column</strong>描述了数据库表中该字段的详细定义,这对于根据JPA注解生成数据库表结构的工具非常有作用.
<br><strong>name</strong>:表示数据库表中该字段的名称,默认情形属性名称一致
<br><strong>nullable</strong>:表示该字段是否允许为null,默认为true
<br><strong>unique</strong>:表示该字段是否是唯一标识,默认为false
<br><strong>length</strong>:表示该字段的大小,仅对String类型的字段有效
<br><strong>insertable</strong>:表示在ORM框架执行插入操作时,该字段是否应出现INSETRT语句中,默认为true
<br><strong>updateable</strong>:表示在ORM框架执行更新操作时,该字段是否应该出现在UPDATE语句中,默认为true.对于一经创建就不可以更改的字段,该属性非常有用,如对于birthday字段.
<br><strong>columnDefinition</strong>:表示该字段在数据库中的实际类型.通常ORM框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是
<br><strong>TIMESTAMP</strong>.此外,String的默认映射类型为VARCHAR,如果要将String类型映射到特定数据库的BLOB或TEXT字段类型,该属性非常有用.
<br>示例:</font> </p>
@Column(name="BIRTH",nullable="false",columnDefinition="DATE") public String getBithday() { return birthday; }
7
@Transient
可选
<br><strong>@Transient</strong>表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性.
<br>如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic
<br>示例:</font> </p>
//根据birth计算出age属性 @Transient public int getAge() { return getYear(new Date()) - getYear(birth); }
8
@ManyToOne(fetch=FetchType,cascade=CascadeType)
可选
<br><strong>@ManyToOne</strong>表示一个多对一的映射,该注解标注的属性通常是数据库表的外键
<br><strong>optional</strong>:是否允许该字段为null,该属性应该根据数据库表的外键约束来确定,默认为true
<br><strong>fetch</strong>:表示抓取策略,默认为FetchType.EAGER
<br><strong>cascade</strong>:表示默认的级联操作策略,可以指定为ALL,PERSIST,MERGE,REFRESH和REMOVE中的若干组合,默认为无级联操作 （见最后cascade属性取值）
<br><strong>targetEntity</strong>:表示该属性关联的实体类型.该属性通常不必指定,ORM框架根据属性类型自动判断targetEntity.
<br>示例:</font> </p>
//订单Order和用户User是一个ManyToOne的关系 //在Order类中定义 @ManyToOne() @JoinColumn(name="USER") public User getUser() { return user; }
9
@JoinColumn
可选
<br><strong>@JoinColumn</strong>和@Column类似,介量描述的不是一个简单字段,而一一个关联字段,例如.描述一个@ManyToOne的字段.
<br><strong>name</strong>:该字段的名称.由于@JoinColumn描述的是一个关联字段,如ManyToOne,则默认的名称由其关联的实体决定.
<br>例如,实体Order有一个user属性来关联实体User,则Order的user属性为一个外键,
<br>其默认的名称为实体User的名称+下划线+实体User的主键名称
<br>示例:
<br> 见<strong>@ManyToOne</strong></font></p>
10
@OneToMany(fetch=FetchType,cascade=CascadeType)
可选
<br><strong>@OneToMany</strong>描述一个一对多的关联,该属性应该为集体类型,在数据库中并没有实际字段.
<br><strong>fetch</strong>:表示抓取策略,默认为FetchType.LAZY,因为关联的多个对象通常不必从数据库预先读取到内存
<br><strong>cascade</strong>:表示级联操作策略,对于OneToMany类型的关联非常重要,通常该实体更新或删除时,其关联的实体也应当被更新或删除
<br>例如:实体User和Order是OneToMany的关系,则实体User被删除时,其关联的实体Order也应该被全部删除
<br>示例:</font> </p>
@OneTyMany(cascade=ALL) public List getOrders() { return orders; }
@OneToOne(fetch=FetchType,cascade=CascadeType)
可选
<br><strong>@OneToOne</strong>描述一个一对一的关联
<br><strong>fetch</strong>:表示抓取策略,默认为FetchType.LAZY
<br><strong>cascade</strong>:表示级联操作策略
<br>示例:</font> </p>
@OneToOne(fetch=FetchType.LAZY) public Blog getBlog() { return blog; }
12
@ManyToMany
可选
<br><strong>@ManyToMany</strong> 描述一个多对多的关联.多对多关联上是两个一对多关联,但是在ManyToMany描述中,中间表是由ORM框架自动处理
<br><strong>targetEntity</strong>:表示多对多关联的另一个实体类的全名,例如:package.Book.class
<br><strong>mappedBy</strong>:表示多对多关联的另一个实体类的对应集合属性名称
<br>示例:</font> </p>
//User实体表示用户,Book实体表示书籍,为了描述用户收藏的书籍,可以在User和Book之间建立ManyToMany关联 @Entity public class User { private List books; @ManyToMany(targetEntity=package.Book.class) public List getBooks() { return books; } public void setBooks(List books) { this.books=books; } }@Entity </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">class</span><span style="color: #000000"> Book { </span><span style="color: #0000ff">private</span><span style="color: #000000"> List users; @ManyToMany(targetEntity</span>=<span style="color: #0000ff">package</span>.Users.<span style="color: #0000ff">class</span>, mappedBy="books"<span style="color: #000000">) </span><span style="color: #0000ff">public</span><span style="color: #000000"> List getUsers() { </span><span style="color: #0000ff">return</span><span style="color: #000000"> users; } </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">void</span><span style="color: #000000"> setUsers(List users) { </span><span style="color: #0000ff">this</span>.users=<span style="color: #000000">users; } }</span></pre>
两个实体间相互关联的属性必须标记为@ManyToMany,并相互指定targetEntity属性,
需要注意的是,有且只有一个实体的@ManyToMany注解需要指定mappedBy属性,指向targetEntity的集合属性名称
<br>利用ORM工具自动生成的表除了User和Book表外,还自动生成了一个User_Book表,用于实现多对多关联</font></p>
13
@MappedSuperclass
可选
<br><strong>@MappedSuperclass</strong>可以将超类的JPA注解传递给子类,使子类能够继承超类的JPA注解
<br>示例:</font></p>
@MappedSuperclass public class Employee() { .... }@Entity </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">class</span> Engineer <span style="color: #0000ff">extends</span><span style="color: #000000"> Employee { ..... } @Entity </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">class</span> Manager <span style="color: #0000ff">extends</span><span style="color: #000000"> Employee { ..... }</span></pre>
14
@Embedded
可选
<br><strong>@Embedded</strong>将几个字段组合成一个类,并作为整个Entity的一个属性.
<br>例如User包括id,name,city,street,zip属性.
<br>我们希望city,street,zip属性映射为Address对象.这样,User对象将具有id,name和address这三个属性.
<br>Address对象必须定义为@Embededable
<br>示例:</font> </p>
@Embeddable public class Address {city,street,zip} @Entity public class User { @Embedded public Address getAddress() { .......... } }
Hibernate验证注解
<td width="100" valign="top"><font color="#000000">适用类型</font></td>
<td width="210" valign="top"><font color="#000000">说明</font></td>
<td width="216" valign="top"><font color="#000000">示例</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Pattern</font></td>
<td width="100" valign="top"><font color="#000000">String</font></td>
<td width="210" valign="top"><font color="#000000">通过正则表达式来验证字符串</font></td>
<td width="216" valign="top"><font color="#000000">@Pattern(regex=”[a-z]{6}”)</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Length</font></td>
<td width="100" valign="top"><font color="#000000">String</font></td>
<td width="210" valign="top"><font color="#000000">验证字符串的长度</font></td>
<td width="216" valign="top"><font color="#000000">@length(min=3,max=20)</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Email</font></td>
<td width="100" valign="top"><font color="#000000">String</font></td>
<td width="210" valign="top"><font color="#000000">验证一个Email地址是否有效</font></td>
<td width="216" valign="top"><font color="#000000">@email</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Range</font></td>
<td width="100" valign="top"><font color="#000000">Long</font></td>
<td width="210" valign="top"><font color="#000000">验证一个整型是否在有效的范围内</font></td>
<td width="216" valign="top"><font color="#000000">@Range(min=0,max=100)</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Min</font></td>
<td width="100" valign="top"><font color="#000000">Long</font></td>
<td width="210" valign="top"><font color="#000000">验证一个整型必须不小于指定值</font></td>
<td width="216" valign="top"><font color="#000000">@Min(value=10)</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Max</font></td>
<td width="100" valign="top"><font color="#000000">Long</font></td>
<td width="210" valign="top"><font color="#000000">验证一个整型必须不大于指定值</font></td>
<td width="216" valign="top"><font color="#000000">@Max(value=20)</font></td>
</tr>
<tr>
<td width="100" valign="top"><font color="#000000">@Size</font></td>
<td width="100" valign="top"><font color="#000000">集合或数组</font></td>
<td width="210" valign="top"><font color="#000000">集合或数组的大小是否在指定范围内</font></td>
<td width="216" valign="top"><font color="#000000">@Size(min=1,max=255)</font></td>
</tr>
| 注解 |
以上来源网址Hibernate 实体类注解
附：cascade属性取值
1、none：忽略其他关联的对象，默认值。
2、save-update：当session通过save(),update(),saveOrUpdate()方法来保存或更新对象时，级联保存所有关联的新建的临时对象，并且级联更新所有关联的游离对象。
3、persist：当session通过persist()方法来保存当前对象时，会级联保存所有关联的新建的临时对象。
4、merge：通过Session的merge()方法来保存当前对象时，会级联融合所有关联的游离对象。
5、delete：通过delete()删除当前对象时，会级联删除所有关联的对象。
6、lock：通过lock()把当前游离对象加入session缓存时，会把所有的游离对象也加入Session缓存中。
7、replicate:通过replicate()复制当前对象时，会级联复制所有关联的对象。
8、evict:通过evict()清除session缓存中对象时，会级联清除所有关联的对象。
9、refresh:通过refresh()刷新当前对象时，会级联刷新所有关联的对象。(刷新是指同步更新session缓存中数据)
10、all:save-update(),persist(),merge(),delete(),lock(),replicate(),evict()及refresh()的行为。
11、delete-orphan,删除所有和当前对象时，解除关联行为的对象。
12、all-delete-orphan; 通过delete()删除当前对象时，会级联删除所有关联的对象。
