学步园

• name：表名
• catalog：对应关系数据库中的catalog
• schema：对应关系数据库中的schema
• UniqueConstraints：定义一个UniqueConstraint数组，指定需要建唯一约束的列

Java代码  

1. @Entity  
2. @Table(name="CUST")  
3. public class Customer { ... }  

@SecondaryTable 
一个entity class可以映射到多表，SecondaryTable用来定义单个从表的名字，主键名字等属性。 
属性说明： 

• name：表名
• catalog：对应关系数据库中的catalog
• pkJoin：定义一个PrimaryKeyJoinColumn数组，指定从表的主键列
• UniqueConstraints：定义一个UniqueConstraint数组，指定需要建唯一约束的列

下面的代码说明Customer类映射到两个表，主表名是CUSTOMER，从表名是CUST_DETAIL，从表的主键列和主表的主键列类型相同，列名为CUST_ID。 

Java代码  

1. @Entity  
2. @Table(name="CUSTOMER")  
3. @SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"))  
4. public class Customer { ... }  

@SecondaryTables 
当一个entity class映射到一个主表和多个从表时，用SecondaryTables来定义各个从表的属性。 
属性说明： 

• value：定义一个SecondaryTable数组，指定每个从表的属性。

Java代码  

1. @Table(name = "CUSTOMER")  
2. @SecondaryTables( value = {  
3. @SecondaryTable(name = "CUST_NAME", pkJoin = { @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }),  
4. @SecondaryTable(name = "CUST_ADDRESS", pkJoin = { @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }) })  
5. public class Customer {}  

@UniqueConstraint 
UniqueConstraint定义在Table或SecondaryTable元数据里，用来指定建表时需要建唯一约束的列。 
属性说明： 

• columnNames：定义一个字符串数组，指定要建唯一约束的列名。

Java代码  

1. @Entity  
2. @Table(name="EMPLOYEE",uniqueConstraints={@UniqueConstraint(columnNames={"EMP_ID", "EMP_NAME"})})  
3. public class Employee { ... }  

@Column 
Column元数据定义了映射到数据库的列的所有属性：列名，是否唯一，是否允许为空，是否允许更新等。 
属性说明： 

• unique：是否唯一
• nullable：是否允许为空
• insertable：是否允许插入
• updatable：是否允许更新
• columnDefinition：定义建表时创建此列的DDL
• secondaryTable：从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。

Java代码  

1. public class Person {  
2.     @Column(name = "PERSONNAME", unique = true, nullable = false, updatable = true)  
3.     private String name;  
4.     @Column(name = "PHOTO", columnDefinition = "BLOB NOT NULL", secondaryTable="PER_PHOTO")  
5.     private byte[] picture;  

@JoinColumn 
如果在entity class的field上定义了关系（one2one或one2many等），我们通过JoinColumn来定义关系的属性。JoinColumn的大部分属性和Column类似。 
属性说明： 

• unique：是否唯一
• referencedColumnName：该列指向列的列名（建表时该列作为外键列指向关系另一端的指定列）
• nullable：是否允许为空
• insertable：是否允许插入
• updatable：是否允许更新
• columnDefinition：定义建表时创建此列的DDL
• secondaryTable：从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。

下面的代码说明Custom和Order是一对一关系。在Order对应的映射表建一个名为CUST_ID的列，该列作为外键指向Custom对应表中名为ID的列。 

Java代码  

1. public class Custom {  
2.     @OneToOne  
3.     @JoinColumn(name="CUST_ID", referencedColumnName="ID", unique=true, nullable=true, updatable=true)  
4.     public Order getOrder() {  
5.     return order;  
6.     }  

@JoinColumns 
如果在entity class的field上定义了关系（one2one或one2many等），并且关系存在多个JoinColumn，用JoinColumns定义多个JoinColumn的属性。 
属性说明： 

• value：定义JoinColumn数组，指定每个JoinColumn的属性。

下面的代码说明Custom和Order是一对一关系。在Order对应的映射表建两列，一列名为CUST_ID，该列作为外键指向Custom对应表中名为ID的列,另一列名为CUST_NAME，该列作为外键指向Custom对应表中名为NAME的列。 

Java代码  

1. public class Custom {  
2.     @OneToOne  
3.     @JoinColumns({  
4.         @JoinColumn(name="CUST_ID", referencedColumnName="ID"),  
5.         @JoinColumn(name="CUST_NAME", referencedColumnName="NAME")  
6.     })  
7.     public Order getOrder() {  
8.     return order;  
9.     }  

@Id 
声明当前field为映射表中的主键列。id值的获取方式有五种：TABLE, SEQUENCE, IDENTITY, AUTO, NONE。Oracle和DB2支持SEQUENCE，SQL Server和Sybase支持IDENTITY,mysql支持AUTO。所有的数据库都可以指定为AUTO，我们会根据不同数据库做转换。NONE(默认)需要用户自己指定Id的值。 
属性说明： 

• generate：主键值的获取类型
• generator：TableGenerator的名字（当generate=GeneratorType.TABLE才需要指定该属性）

下面的代码声明Task的主键列id是自动增长的。(Oracle和DB2从默认的SEQUENCE取值，SQL Server和Sybase该列建成IDENTITY，mysql该列建成auto increment。) 

Java代码  

1.  @Entity  
2.  @Table(name = "OTASK")  
3.  public class Task {  
4. @Id(generate = GeneratorType.AUTO)  
5. public Integer getId() {  
6.  return id;  
7. }  
8.  }  

  

@IdClass 
当entity class使用复合主键时，需要定义一个类作为id class。id class必须符合以下要求:类必须声明为public，并提供一个声明为public的空构造函数。必须实现Serializable接，覆写equals()和hashCode（）方法。entity class的所有id field在id class都要定义，且类型一样。 
属性说明： 

• value：id class的类名

下面的代码声明Task的主键列id是自动增长的。(Oracle和DB2从默认的SEQUENCE取值，SQL Server和Sybase该列建成IDENTITY，mysql该列建成auto increment。) 

Java代码  

1. public class EmployeePK implements java.io.Serializable{  
2.    String empName;  
3.    Integer empAge;  
4. public EmployeePK(){}  
5. public boolean equals(Object obj){ ......}  
6. public int hashCode(){......}  
7. }  
8. @IdClass(value=com.acme.EmployeePK.class)  
9. @Entity(access=FIELD)  
10. public class Employee {  
11.     @Id String empName;  
12.     @Id Integer empAge;  
13. }  

@MapKey 
在一对多，多对多关系中，我们可以用Map来保存集合对象。默认用主键值做key，如果使用复合主键，则用id class的实例做key，如果指定了name属性，就用指定的field的值做key。 
属性说明： 

• name：用来做key的field名字

下面的代码说明Person和Book之间是一对多关系。Person的books字段是Map类型，用Book的isbn字段的值作为Map的key。 

Java代码  

1.    @Table(name = "PERSON")  
2.    public class Person {  
3. @OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")  
4. @MapKey(name = "isbn")  
5. private Map books = new HashMap();  
6.    }  

@MappedSuperclass 
使用@MappedSuperclass指定一个实体类从中继承持久字段的超类。当多个实体类共享通用的持久字段或属性时，这将是一个方便的模式。 

您可以像对实体那样使用任何直接和关系映射批注（如 @Basic 和 @ManyToMany）对该超类的字段和属性进行批注，但由于没有针对该超类本身的表存在，因此这些映射只适用于它的子类。继承的持久字段或属性属于子类的表。 

可以在子类中使用@AttributeOverride或@AssociationOverride来覆盖超类的映射配置。 
@MappedSuperclass没有属性。 

Java代码  

1. //如何将Employee指定为映射超类  
2. @MappedSuperclass  
3. public class Employee {  
4.     @Id  
5.     protected Integer empId;  
6.   
7.     @Version  
8.     protected Integer version;  
9.   
10.     @ManyToOne  
11.     @JoinColumn(name="ADDR")  
12.     protected Address address;  
13. }  
14.   
15. //如何在实体类中使用@AttributeOverride以覆盖超类中设置的配置。  
16. @Entity  
17. @AttributeOverride(name="address", column=@Column(name="ADDR_ID"))  
18. public class PartTimeEmployee extends Employee {  
19.     @Column(name="WAGE")  
20.     protected Float hourlyWage;  
21. }  

@PrimaryKeyJoinColumn 
在三种情况下会用到@PrimaryKeyJoinColumn 

• 继承。
• entity class映射到一个或多个从表。从表根据主表的主键列（列名为referencedColumnName值的列），建立一个类型一样的主键列，列名由name属性定义。
• one2one关系，关系维护端的主键作为外键指向关系被维护端的主键，不再新建一个外键列。

属性说明： 

• name：列名。
• referencedColumnName：该列引用列的列名
• columnDefinition：定义建表时创建此列的DDL

下面的代码说明Customer映射到两个表，主表CUSTOMER,从表CUST_DETAIL，从表需要建立主键列CUST_ID，该列和主表的主键列id除了列名不同，其他定义一样。 

Java代码  

1.    @Entity  
2.    @Table(name="CUSTOMER")  
3. @SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"，referencedColumnName="id"))  
4.    public class Customer {   
5.        @Id(generate = GeneratorType.AUTO)  
6.        public Integer getId() {  
7.     return id;  
8. }  
9.    }  

下面的代码说明Employee和EmployeeInfo是一对一关系，Employee的主键列id作为外键指向EmployeeInfo的主键列INFO_ID。 

Java代码  

1.             
2.    @Table(name = "Employee")  
3.    public class Employee {  
4. @OneToOne  
5. @PrimaryKeyJoinColumn(name = "id", referencedColumnName="INFO_ID")  
6. EmployeeInfo info;  
7.    }  

    
    

@PrimaryKeyJoinColumns 
如果entity class使用了复合主键，指定单个PrimaryKeyJoinColumn不能满足要求时，可以用PrimaryKeyJoinColumns来定义多个PrimaryKeyJoinColumn 
属性说明： 

• value： 一个PrimaryKeyJoinColumn数组，包含所有PrimaryKeyJoinColumn

下面的代码说明了Employee和EmployeeInfo是一对一关系。他们都使用复合主键，建表时需要在Employee表建立一个外键，从Employee的主键列id,name指向EmployeeInfo的主键列INFO_ID和INFO_NAME 

Java代码  

1.    @Entity  
2.    @IdClass(EmpPK.class)  
3.    @Table(name = "EMPLOYEE")  
4.    public class Employee {  
5. private int id;  
6. private String name;  
7. private String address;  
8. @OneToOne(cascade = CascadeType.ALL)  
9. @PrimaryKeyJoinColumns({  
10. @PrimaryKeyJoinColumn(name="id", referencedColumnName="INFO_ID"),  
11. @PrimaryKeyJoinColumn(name="name" , referencedColumnName="INFO_NAME")})