因为cointrader中用到非常多的hibernate来做持久化,orm。所以不得不知道其注解知识。这里我拷贝一篇我个人觉得很好的文章。
出处:http://blog.sina.com.cn/s/blog_935ebb670101dnre.html
1.类级别注解
@entity 映射实体类
@table 映射数句库表
@entity(name="tablename") - 必须,注解将一个类声明为一个实体bean。
属性:
name - 可选,对应数据库中的一个表。若表名与实体类名相同,则可以省略。
@table(name="",catalog="",schema="") - 可选,通常和@entity 配合使用,只能标注在实 体的 class 定义处,表示实体对应的数据库表的信息。
name - 可选,表示表的名称,默认地,表名和实体名称一致,只有在不一致的情况下才需 要指定表名
catalog - 可选,表示catalog名称,默认为 catalog("").
schema - 可选 , 表示 schema 名称 , 默认为schema("").
@id 映射生成主键
@version 定义乐观锁
@column 映射表的列
@transient 定义暂态属性
@id - 必须,定义了映射到数据库表的主键的属性,一个实体只能有一个属性被映射为主 键,置于 getxxxx()前。
@generatedvalue(strategy=generationtype,generator="") - 可选,用于定义主键生成策略。
strategy - 表示主键生成策略,取值有:
generationtype.auto - 根据底层数据库自动选择(默认),若数据库支持自动 增 长类型,则为自动增长。
generationtype.indentity - 根据数据库的identity字段生成,支持db2、mysql、 ms、sql
server、sybase与hyperanoicsql数据库的identity 类型主键。
generationtype.sequence - 使用sequence来决定主键的取值,适合oracle、db2等 支持sequence的数据库,一般结合@sequencegenerator使用。
(oracle没有自动增长类型,只能用sequence)
generationtype.table - 使用指定表来决定主键取值,结合@tablegenerator使用。
如:
@id
@tablegenerator(name="tab_cat_gen",allocationsize=1)
@generatedvalue(strategy=generationtype.table)
generator - 表示主键生成器的名称,这个属性通常和orm框架相关 , 例如:
hibernate 可以指定 uuid 等主键生成方式
@sequencegenerator — 注解声明了一个数据库序列。
name - 表示该表主键生成策略名称,它被引用在@generatedvalue中设置的“gernerator”值中。
sequencename - 表示生成策略用到的数据库序列名称。
initialvalue - 表示主键初始值,默认为0.
allocationsize - 每次主键值增加的大小,例如设置成1,则表示每次创建新记录后自动加1,默认为50.
示例 :
@id
@generatedvalues(strategy=strategytype.sequence)
public int getpk() {
return pk;
}
hibernate的访问类型为field时,在字段上进行注解声;
访问类型为property时,在getter方法上进行注释声明。
@version - 可以在实体bean中使用@version注解,通过这种方式可添加对乐观锁定的支持
@basic - 用于声明属性的存取策略:
@basic(fetch=fetchtype.eager) 即时获取(默认的存取策略)
@basic(fetch=fetchtype.lazy) 延迟获取
@temporal - 用于定义映射到数据库的时间精度:
@temporal(temporaltype=date) 日期
@temporal(temporaltype=time) 时间
@temporal(temporaltype=timestamp) 两者兼具
@column - 可将属性映射到列,使用该注解来覆盖默认值,@column描述了数据库表中 该字段的详细定义,这对于根据 jpa 注解生成数据库表结构的工具非常有作用。
name - 可选,表示数据库表中该字段的名称,默认情形属性名称一致
nullable - 可选,表示该字段是否允许为 null,默认为 true
unique - 可选,表示该字段是否是唯一标识,默认为 false
length - 可选,表示该字段的大小,仅对 string 类型的字段有效,默认值255.
insertable - 可选,表示在orm框架执行插入操作时,该字段是否应出现insetrt 语句中,默认为 true
updateable - 可选,表示在orm 框架执行更新操作时,该字段是否应该出现在 update 语句中,默认为 true. 对于一经创建就不可以更改的字段,该 属性非常有用,如对于 birthday字段。
columndefinition - 可选,表示该字段在数据库中的实际类型。通常orm 框架可以根 据属性类型自动判断数据库中字段的类型,但是对于date 类型仍无法确定数据 库中字段类型究竟是 date,time 还是timestamp. 此外 ,string 的默认映射类型为 varchar, 如果要将 string 类型映射到特定数据库的 blob或 text 字段类型,该属性非常有用。
@column(name="birth",nullable="false",columndefinition="date")
public string getbithday() {
return birthday;
}
@transient - 可选,表示该属性并非一个到数据库表的字段的映射,orm框架将忽略该属性,如果一个属性并非数据库表的字段映射,就务必将其标示为@transient,否则orm 框架默认其注解为 @basic
// 根据 birth 计算出 age 属性
@transient
public int getage() {
return getyear(new date()) - getyear(birth);
如果属性为单一类型,则映射为@basic,
否则,如果属性对应的类型定义了@embeddable注解,则映射为@embedded,
否则,如果属性对应的类型实现了serializable, 则属性被映射为@basic并在一个列中保存该对象的serialized版本,
否则,如果该属性的类型为java.sql.clob 或 java.sql.blob,则作为@lob并映射到适当的lobtype.。
@inheritance注解来定义所选择的策略. 这个注解需要在每个类层次结构(class
hierarchy) 最顶端的实体类上使用
单向一对多:一方有集合属性,包含多个多方,而多方没有一方的引用。用户--->电子邮件
单向多对一:多方有一方的引用,一方没有多方的引用。论文类别---> 类别
双向一对多:两边都有多方的引用,方便查询。班级---> 学生
双向多对一:两边都有多方的引用,方便查询。
单向多对多:需要一个中间表来维护两个实体表。论坛--->文章
单向一对一:数据唯一,数据库数据也是一对一。舰船---> 水手
主键相同的一对一:使用同一个主键,省掉外键关联。客户---> 地址
单向:关系写哪边,就由谁管理。
双向:一般由多方管理。
@onetomany(mappedby="对方") //反向配置,对方管理。
@onetoone、@onetomany、@manytoone、manytomany的共有属性:
fetch - 配置加载方式。取值有
fetch.eager - 及时加载,多对一默认是fetch.eager
fetch.lazy - 延迟加载,一对多默认是fetch.lazy
cascade - 设置级联方式,取值有:
cascadetype.persist - 保存
cascadetype.remove - 删除
cascadetype.merge - 修改
cascadetype.refresh - 刷新
cascadetype.all - 全部
targetentity - 配置集合属性类型,如:@onetomany(targetentity=book.class)
@joincolumn - 可选,用于描述一个关联的字段。
@joincolumn和@column类似,介量描述的不是一个简单字段,而是一个关联字段,例如描述一个 @manytoone 的字段。
name - 该字段的名称,由于@joincolumn描述的是一个关联字段,如manytoone, 则默认的名称由其关联的实体决定。
例如,实体 order 有一个user 属性来关联实体 user, 则 order 的 user 属性为一个外键 ,
其默认的名称为实体user的名称 + 下划线 + 实体user的主键名称
@onetoone – 表示一个一对一的映射
1.主表类a与从表类b的主键值相对应。
主表:@onetoone(cascade = cascadetype.all)
@primarykeyjoincolumn
public b getb(){
return b;
从表:无
2.主表a中有一个从表属性是b类型的b
主表:@onetoone(cascade = cascadetype.all)
@joincolumn(name="主表外键") //这里指定的是数据库中的外键字段。
public b getb(){
return b;
}
3.主表a中有一个从表属性是b类型的b,同时,从表b中有一个主表属性是a类型的a
从表:@onetoone(mappedby = "主表类中的从表属性")
public 主表类 get主表类(){
return 主表对象
}
注意:@joincolumn是可选的。默认值是从表变量名+"_"+从表的主键(注意,这里加的是主键。而不是主键对应的变量)。
@manytoone - 表示一个多对一的映射,该注解标注的属性通常是数据库表的外键。
1.单向多对一:多方有一方的引用,一方没有多方的引用。
在多方
@manytoone(targetentity=xxxx.class) //指定关联对象
@joincolumn(name="") //指定产生的外键字段名
2.双向多对一:配置方式同双向一对多。
// 订单 order 和用户 user 是一个 manytoone 的关系
// 在 order 类中定义
@manytoone()
@joincolumn(name="user")
public user getuser() {
return user;
}
@onetomany - 描述一个一对多的关联,该属性应该为集合类型,在数据库中并没有实际字段。
1.单向一对多:一方有集合属性,包含多个多方,而多方没有一方的引用。
@onetomany 默认会使用连接表做一对多关联
添加@joincolumn(name="xxx_id") 后,就会使用外键关联,而不使用连接表了。
2.双向一对多
1)在多方
@manytoone
@joincolumn(name="自己的数据库外键列名")
2)在一方
@onetomany(mappedby="多端的关联属性名")
@joincolumn(name="对方的数据库外键列名")
@manytomany - 可选,描述一个多对多的关联。
targetentity - 表示多对多关联的另一个实体类的全名,例如:package.book.class
mappedby - 用在双向关联中,把关系的维护权翻转。
1.单向多对多关联:
在主控方加入@manytomany注解即可。
2.双向多对多关联:
两个实体间互相关联的属性必须标记为@manytomany,并相互指定targetentity属性。有且只有一个实体的@manytomany注解需要指定mappedby属性,指向targetentity的集合属性名称。