你的位置:首页 > Java教程

[Java教程]hibernate 注释说明

 1 * @Entity —— 将一个类声明为一个实体 bean(即一个持久化 POJO 2 类) 3 * @Id —— 注解声明了该实体 bean 的标识属性(对应表中的主 4 键)。 5 * @Table —— 注解声明了该实体 bean 映射指定的表(table),目录 6 (catalog)和 schema 的名字 7 * @Column —— 注解声明了属性到列的映射。该注解有如下的属 8 性 9 * name 可选,列名(默认值是属性名) 10 * unique 可选,是否在该列上设置唯一约束(默认值 false) 11 * nullable 可选,是否设置该列的值可以为空(默认值 false) 12 * insertable 可选,该列是否作为生成的 insert 语句中的一个列(默认 13 值 true) 14 * updatable 可选,该列是否作为生成的 update 语句中的一个列(默认 15 值 true) 16 * columnDefinition 可选,为这个特定列覆盖 sql ddl 片段(这可能导 17 致无法在不同数据库间移植) 18 * table 可选,定义对应的表(默认为主表) 19 * length 可选,列长度(默认值 255) 20 * precision 可选,列十进制精度(decimal precision)(默认值 21 0) 22 * scale 可选,如果列十进制数值范围(decimal scale)可用,在此设 23 置(默认值 0) 24 * @GeneratedValue —— 注解声明了主键的生成策略。该注解有如下属 25 性 26 * strategy 指定生成的策略(JPA 定义的),这是一个 GenerationType。 27 默认是 GenerationType. AUTO 28 * GenerationType.AUTO 主键由程序控制 29 * GenerationType.TABLE 使用一个特定的数据库表格来保存主键 30 * GenerationType.IDENTITY 主键由数据库自动生成(主要是自动增长类 31 型) 32 * GenerationType.SEQUENCE 根据底层数据库的序列来生成主键,条件是 33 数据库支持序列。(这个值要与 generator 一起使用) 34 * generator 指定生成主键使用的生成器(可能是 orcale 中的序 35 列)。 36 * @SequenceGenerator —— 注解声明了一个数据库序列。该注解有如 37 下属性 38 * name 表示该表主键生成策略名称,它被引用在@GeneratedValue 中设 39 置的“gernerator”值中 40 * sequenceName 表示生成策略用到的数据库序列名称。 41 * initialValue 表示主键初始值,默认为 0. 42 * allocationSize 每次主键值增加的大小,例如设置成 1,则表示每次 43 创建新记录后自动加 1,默认为 50. 44 * @GenericGenerator —— 注解声明了一个 hibernate 的主键生成策略。 45 支持十三种策略。该注解有如下属性 46 * name 指定生成器名称 47 * strategy 指定具体生成器的类名(指定生成策略)。 48 * parameters 得到 strategy 指定的具体生成器所用到的参数。 49 * 其十三种策略(strategy 属性的值)如下: 50 * 1.native 对于 orcale 采用 Sequence 方式,对于 MySQL 和 51 SQL Server 采用 identity(处境主键生成机制), 52 * native 就是将主键的生成工作将由数据库完成,hibernate 不 53 管(很常用) 54 * 例: 55 @GeneratedValue(generator = "paymentableGenerator") 56 * @GenericGenerator(name = "paymentableGenera 57 tor", strategy = "native") 58 * 2.uuid 采用 128 位的 uuid 算法生成主键,uuid 被编码为 59 一个 32 位 16 进制数字的字符串。占用空间大(字符串类型)。 60 * 例: 61 @GeneratedValue(generator = "paymentableGenerator") 62 * @GenericGenerator(name = "paymentableGenera 63 tor", strategy = "uuid") 64 * 3.hilo 要在数据库中建立一张额外的表,默认表名为 65 hibernate_unque_key,默认字段为 integer 类型,名称是 next_hi(比较 66 少用) 67 * 例: 68 @GeneratedValue(generator = "paymentableGenerator") 69 * @GenericGenerator(name = "paymentableGen 70 erator", strategy = "hilo") 71 * 4.assigned 在插入数据的时候主键由程序处理(很常用), 72 这是<generator>元素没有指定时的默认生成策略。等同于 JPA 中的 73 AUTO。 74 * 例: 75 @GeneratedValue(generator = "paymentableGenerator") 76 * @GenericGenerator(name = "paymentableGenera 77 tor", strategy = "assigned") 78 * 5.identity 使用 SQL Server 和 MySQL 的自增字段,这个 79 方法不能放到 Oracle 中,Oracle 不支持自增字段,要设定 sequence(MySQL 80 和 SQL Server 中很常用)。等同于 JPA 中的 IDENTITY 81 * 例: 82 @GeneratedValue(generator = "paymentableGenerator") 83 * @GenericGenerator(name = "paymentableGenera 84 tor", strategy = "identity") 85 * 6.select 使用触发器生成主键(主要用于早期的数据库主 86 键生成机制,少用) 87 * 例: 88 @GeneratedValue(generator = "paymentableGenerator") 89 * @GenericGenerator(name = "paymentableGenera 90 tor", strategy = "select") 91 * 7.sequence 调用谨慎数据库的序列来生成主键,要设定序 92 列名,不然 hibernate 无法找到。 93 * 例: 94 @GeneratedValue(generator = "paymentableGenerator") 95 * @GenericGenerator(name = "paymentableGenerator", strat 96 egy = "sequence", 97 * parameters = { @Parameter(name = "sequence", value 98 = "seq_payablemoney") }) 99 * 8.seqhilo 通过 hilo 算法实现,但是主键历史保存在 Sequence 中,100 适用于支持 Sequence 的数据库,如 Orcale(比较少用)101 * 例:102 @GeneratedValue(generator = "paymentableGenerator")103 * @GenericGenerator(name = "paymentableGenerator", strat104 egy = "seqhilo",105 * parameters = { @Parameter(name = "max_lo", value =106 "5") })107 * 9.increnment 插入数据的时候 hibernate 会给主键添加一个自增108 的主键,但是一个 hibernate 实例就维护一个计数器,所以在多个实例运行109 的时候不能使用这个方法。110 * 例:111 @GeneratedValue(generator = "paymentableGenerator")112 * @GenericGenerator(name = "paymentableGenera113 tor", strategy = "increnment")114 * 10.foreign 使用另一个相关的对象的主键。通常和<one-115 to-one>联合起来使用。116 * 例:@Id117 * @GeneratedValue(generator = "idGenerator")118 * @GenericGenerator(name = "idGenerator", strategy = "119 foreign",120 * parameters = { @Parameter(name = "property121 ", value = "info") })122 * Integer id;123 * @OneToOne124 * EmployeeInfo info;125 * 11.guid 采用数据库底层的 guid 算法机制,对应 MySQL 的 uuid()126 函数,SQL Server 的 newid()函数,ORCALE 的 rawtohex(sys_guid())函数127 等128 * 例:129 @GeneratedValue(generator = "paymentableGenerator")130 * @GenericGenerator(name = "paymentableGenerator", strat131 egy = "guid")132 * 12.uuid.hex 看 uudi,建议用 uuid 替换133 * 例:134 @GeneratedValue(generator = "paymentableGenerator")135 * @GenericGenerator(name = "paymentableGenerator", strat136 egy = "uuid.hex")137 * 13.sequence-identity sequence 策略的扩展,采用立即检索策略138 来获取 sequence 值,需要 JDBC3.0 和 JDK4 以上(含 1.4)版本139 * 例:140 @GeneratedValue(generator = "paymentableGenerator")141 * @GenericGenerator(name = "paymentableGenerator", strat142 egy = "sequence-identity",143 * parameters = { @Parameter(name = "sequence144 ", value = "seq_payablemoney") })145 *146 * @OneToOne 设置一对一个关联。cascade 属性有五个值(只有147 CascadeType.ALL 好用?很奇怪),分别是 CascadeType.PERSIST(级联新建),148 CascadeType.REMOVE(级联删除),CascadeType.REFRESH(级联刷新),149 CascadeType.MERGE(级联更新),CascadeType.ALL(全部四项)150 * 方法一151 * 主表: ?@OneToOne(cascade = CascadeType.ALL)152 * @PrimaryKeyJoinColumn153 * public 从表类 get 从表类(){return 从表对象}154 * 从表:没有主表类。155 * 注意:这种方法要求主表与从表的主键值想对应。156 * 方法二157 * 主表:?@OneToOne(cascade = CascadeType.ALL)158 * @JoinColumn(name="主表外键") //这里指定的是159 数据库中的外键字段。160 * public 从表类 get 从表类(){return 从表161 类}162 * 从表:@OneToOne(mappedBy = "主表类中的从表属性")//163 例主表 User 中有一个从表属性是 Heart 类型的 heart,这里就填164 heart165 * public 主表类 get 主表类(){return 主表对166 象}167 * 注意:@JoinColumn 是可选的。默认值是从表变量名+"_"+从168 表的主键(注意,这里加的是主键。而不是主键对应的变量)。169 * 方法三170 * 主表:@OneToOne(cascade=CascadeType.ALL)171 * @JoinTable( name="关联表名",172 * joinColumns = @JoinColumn(name="主表外键"),173 * inverseJoinColumns = @JoinColumns(name="从表外键174 ")175 * )176 * 从表:@OneToOne(mappedBy = "主表类中的从表属性")//177 例主表 User 中有一个从表属性是 Heart 类型的 heart,这里就填178 heart179 * public 主表类 get 主表类(){return 主表对180 象}181 * @ManyToOne 设置多对一关联182 * 方法一183 * @ManyToOne(cascade={CasCadeType.PERSIST,CascadeType.MERGE184 })185 * @JoinColumn(name="外键")186 * public 主表类 get 主表类(){return 主表对象}187 * 方法二188 * @ManyToOne(cascade={CascadeType.PERSIST,CascadeType.MERGE189 })190 * @JoinTable(name="关联表名",191 * joinColumns = @JoinColumn(name="主表外键"),192 * inverseJoinColumns = @JoinColumns(name="从表外键")193 * )194 * @OneToMany 设置一对多关联。cascade 属性指定关联级别,参考195 @OneToOne 中的说明。fetch 指定是否延迟加载,值为 FetchType.LAZY 表示196 延迟,为 FetchType.EAGER 表示立即加载197 * 方法一 使用这种配置,在为“一端”添加“多端”时,198 不会修改“多端”的外键。在“一端”加载时,不会得到“多端”。如果使199 用延迟加载,在读“多端”列表时会出异常,立即加载在得到多端时,是一200 个空集合(集合元素为 0)。201 * “一端”配置202 * @OneToMany(mappedBy="“多端”的属性")203 * public List<“多端”类> get“多端”列表(){return “多204 端”列表}205 * “多端”配置参考@ManyToOne.206 * 方法二207 * “一端”配置208 * @OneToMany(mappedBy="“多端”的属性")209 * @MapKey(name="“多端”做为 Key 的属性")210 * public Map<“多端”做为 Key 的属性的类,主表类> get“多端”211 列表(){return “多端”列表}212 * “多端”配置参考@ManyToOne.213 * 方法三 使用这种配置,在为“一端”添加“多端”时,可以修214 改“多端”的外键。215 * “一端”配置216 * @OneToMany217 * @JoinColumn(name="“多端”外键")218 * public List<“多端”类> get“多端”列表(){return “多219 端”列表}