Hibernate作为Java ORM框架,提供了丰富的注解用于简化对象关系映射。以下是一些Hibernate中常用的注解列表及其简要说明:
-
类级别的注解:
@Entity
: 标记在Java类上,表示该类是一个持久化类,将会映射到数据库中的一个表。@Embeddable
: 标记在嵌入式类上,表示这个类可以作为其他实体类的一部分存储在数据库中。@MappedSuperclass
: 标记在父类上,表明这个类中的属性会被子类继承,但自身不会成为一个数据库表。
-
表映射注解:
@Table
: 用于指定实体类与数据库表的映射关系,可以指定表名、schema、catalog等信息。
-
主键注解:
@Id
: 标记在实体类的属性上,表示该属性是数据库表的主键。@GeneratedValue
: 与@Id搭配使用,用于指定主键生成策略,如AUTO、IDENTITY、SEQUENCE、TABLE等。
-
字段注解:
@Column
: 用于映射实体类属性到数据库表的列,可以指定列名、长度、是否可为空、唯一性等属性。@Temporal
: 用于标记日期/时间类型的属性,指定日期/时间的精度,如DATE、TIME、TIMESTAMP。
-
关系注解:
@OneToOne
: 映射一对一关系,可以指定关联关系的方向和外键信息。@OneToMany
: 映射一对多关系,通常与mappedBy
属性一起使用来指定关系的拥有方。@ManyToOne
: 映射多对一关系。@ManyToMany
: 映射多对多关系,可能需要中间表或集合来映射关系。
-
其他注解:
@Transient
: 标记在属性上,表示该属性并非数据库表中的列,不应该被持久化。@Lob
: 标记大文本、大对象字段,如CLOB、BLOB类型的数据。@JoinColumn
: 用于定义关联关系中的外键列,通常在双向关联中指定。@NotFound(action = NotFoundAction.IGNORE)
或@NotFound(action = NotFoundAction.EXCEPTION)
: 设置找不到关联对象时的行为。@Version
: 标记版本字段,用于乐观锁控制。@Access(AccessType.FIELD|PROPERTY)
: 指定实体属性的访问方式,默认通过getter和setter方法(PROPERTY),也可以改为直接访问字段(FIELD)。
以上只是部分常用注解,还有其他如@Cascade
(级联操作)、@Formula
(派生属性)、@AttributeOverride
和@AssociationOverride
(覆盖默认映射)等注解,用于满足更复杂的需求。
常见注解的使用示例:
1. 定义实体类 (Entity) 及其主键 (@Id)
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String username;
private String password;
// 构造函数、getters、setters...
}
在这个例子中,User
类被声明为一个实体 (@Entity
) 并且它的 id
属性被标记为主键 (@Id
),使用自动增长策略 (GenerationType.IDENTITY
)。
2. 映射列 (@Column)
@Column(name = "user_name", nullable = false, length = 50)
private String username;
这里,username
字段被映射到名为 user_name
的数据库列,不允许为空 (nullable = false
),并且最大长度为 50
个字符。
3. 一对一关系 (@OneToOne)
@Entity
public class UserProfile {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
// ...
@OneToOne(mappedBy = " userProfile")
private User user;
}
@Entity
public class User {
// ...
@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name = "profile_id")
private UserProfile userProfile;
}
在上述示例中,User
和 UserProfile
之间存在一对一的关系。UserProfile
中的 user
属性通过 mappedBy
指定了它是关系的被动端,
而 User
类中的 userProfile
使用 @JoinColumn
明确指出了连接到 UserProfile
表的外键是 profile_id
,
并且当 User
对象发生持久化操作时,这些操作也会传播到关联的 UserProfile
实例上。
4. 多对一关系 (@ManyToOne)
@Entity
public class Address {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
// ...
private String street;
private String city;
@ManyToOne
@JoinColumn(name = "user_id")
private User user;
}
在这个例子中,Address
类有一个指向 User
的多对一关系,通过 @JoinColumn
指定了外键 user_id
。
另外也可以用xml方式配置映射关系(不推荐)