Table
Table用來定義entity主表的name,catalog,schema等屬性。
元數(shù)據(jù)屬性說明:
- name: 表名
- catalog: 對應(yīng)關(guān)系數(shù)據(jù)庫中的catalog
- schema:對應(yīng)關(guān)系數(shù)據(jù)庫中的schema
- UniqueConstraints:定義一個(gè)UniqueConstraint數(shù)組,指定需要建唯一約束的列(具體參看UniqueConstraint)
@Entity
@Table(name="CUST")
public class Customer { ... }
SecondaryTable
一個(gè)entity class可以映射到多表,SecondaryTable用來定義單個(gè)從表的名字,主鍵名字等屬性。
元數(shù)據(jù)屬性說明:
- name: 表名
- catalog: 對應(yīng)關(guān)系數(shù)據(jù)庫中的catalog
- schema:對應(yīng)關(guān)系數(shù)據(jù)庫中的schema
- pkJoin: 定義一個(gè)PrimaryKeyJoinColumn數(shù)組,指定從表的主鍵列(具體參看PrimaryKeyJoinColumn)
- UniqueConstraints:定義一個(gè)UniqueConstraint數(shù)組,指定需要建唯一約束的列(具體參看UniqueConstraint)
下面的代碼說明Customer類映射到兩個(gè)表,主表名是CUSTOMER,從表名是CUST_DETAIL,從表的主鍵列和主表的主鍵列類型相同,列名為CUST_ID。
@Entity
@Table(name="CUSTOMER")
@SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"))
public class Customer { ... }
SecondaryTables
當(dāng)一個(gè)entity class映射到一個(gè)主表和多個(gè)從表時(shí),用SecondaryTables來定義各個(gè)從表的屬性。
元數(shù)據(jù)屬性說明:
- value: 定義一個(gè)SecondaryTable數(shù)組,指定每個(gè)從表的屬性。
@Table(name = "CUSTOMER")
@SecondaryTables( value = {
@SecondaryTable(name = "CUST_NAME", pkJoin = { @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }),
@SecondaryTable(name = "CUST_ADDRESS", pkJoin = { @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }) })
public class Customer {}
UniqueConstraint
UniqueConstraint定義在Table或SecondaryTable元數(shù)據(jù)里,用來指定建表時(shí)需要建唯一約束的列。
元數(shù)據(jù)屬性說明:
- columnNames:定義一個(gè)字符串?dāng)?shù)組,指定要建唯一約束的列名。
@Entity
@Table(name="EMPLOYEE",
uniqueConstraints={@UniqueConstraint(columnNames={"EMP_ID", "EMP_NAME"})}
)
public class Employee { ... }
Column
Column元數(shù)據(jù)定義了映射到數(shù)據(jù)庫的列的所有屬性:列名,是否唯一,是否允許為空,是否允許更新等。
元數(shù)據(jù)屬性說明:
- name:列名。
- unique: 是否唯一
- nullable: 是否允許為空
- insertable: 是否允許插入
- updatable: 是否允許更新
- columnDefinition: 定義建表時(shí)創(chuàng)建此列的DDL
- secondaryTable: 從表名。如果此列不建在主表上(默認(rèn)建在主表),該屬性定義該列所在從表的名字。
public class Person {
@Column(name = "PERSONNAME", unique = true, nullable = false, updatable = true)
private String name;
@Column(name = "PHOTO", columnDefinition = "BLOB NOT NULL", secondaryTable="PER_PHOTO")
private byte[] picture;
JoinColumn
如果在entity class的field上定義了關(guān)系(one2one或one2many等),我們通過JoinColumn來定義關(guān)系的屬性。JoinColumn的大部分屬性和Column類似。
元數(shù)據(jù)屬性說明:
- name:列名。
- referencedColumnName:該列指向列的列名(建表時(shí)該列作為外鍵列指向關(guān)系另一端的指定列)
- unique: 是否唯一
- nullable: 是否允許為空
- insertable: 是否允許插入
- updatable: 是否允許更新
- columnDefinition: 定義建表時(shí)創(chuàng)建此列的DDL
- secondaryTable: 從表名。如果此列不建在主表上(默認(rèn)建在主表),該屬性定義該列所在從表的名字。
下面的代碼說明Custom和Order是一對一關(guān)系。在Order對應(yīng)的映射表建一個(gè)名為CUST_ID的列,該列作為外鍵指向Custom對應(yīng)表中名為ID的列。
public class Custom {
@OneToOne
@JoinColumn(
name="CUST_ID", referencedColumnName="ID", unique=true, nullable=true, updatable=true)
public Order getOrder() {
return order;
}
JoinColumns
如果在entity class的field上定義了關(guān)系(one2one或one2many等),并且關(guān)系存在多個(gè)JoinColumn,用JoinColumns定義多個(gè)JoinColumn的屬性。
元數(shù)據(jù)屬性說明:
- value: 定義JoinColumn數(shù)組,指定每個(gè)JoinColumn的屬性。
下面的代碼說明Custom和Order是一對一關(guān)系。在Order對應(yīng)的映射表建兩列,一列名為CUST_ID,該列作為外鍵指向Custom對應(yīng)表中名為ID的列,另一列名為CUST_NAME,該列作為外鍵指向Custom對應(yīng)表中名為NAME的列。
public class Custom {
@OneToOne
@JoinColumns({
@JoinColumn(name="CUST_ID", referencedColumnName="ID"),
@JoinColumn(name="CUST_NAME", referencedColumnName="NAME")
})
public Order getOrder() {
return order;
}
Id
聲明當(dāng)前field為映射表中的主鍵列。id值的獲取方式有五種:TABLE, SEQUENCE, IDENTITY, AUTO, NONE。Oracle和DB2支持SEQUENCE,SQL Server和Sybase支持IDENTITY,mysql支持AUTO。所有的數(shù)據(jù)庫都可以指定為AUTO,我們會根據(jù)不同數(shù)據(jù)庫做轉(zhuǎn)換。NONE(默認(rèn))需要用戶自己指定Id的值。Table類型詳見TableGenerator的介紹。
元數(shù)據(jù)屬性說明:
- generate():主鍵值的獲取類型
- generator():TableGenerator的名字(當(dāng)generate=GeneratorType.TABLE才需要指定該屬性)
下面的代碼聲明Task的主鍵列id是自動(dòng)增長的。(Oracle和DB2從默認(rèn)的SEQUENCE取值,SQL Server和Sybase該列建成IDENTITY,mysql該列建成auto increment。)
@Entity
@Table(name = "OTASK")
public class Task {
@Id(generate = GeneratorType.AUTO)
public Integer getId() {
return id;
}
}
IdClass
當(dāng)entity class使用復(fù)合主鍵時(shí),需要定義一個(gè)類作為id class。id class必須符合以下要求:類必須聲明為public,并提供一個(gè)聲明為public的空構(gòu)造函數(shù)。必須實(shí)現(xiàn)Serializable接,覆寫equals()和hashCode()方法。entity class的所有id field在id class都要定義,且類型一樣。
元數(shù)據(jù)屬性說明:
public class EmployeePK implements java.io.Serializable{
String empName;
Integer empAge;
public EmployeePK(){}
public boolean equals(Object obj){ ......}
public int hashCode(){......}
}
@IdClass(value=com.acme.EmployeePK.class)
@Entity(access=FIELD)
public class Employee {
@Id String empName;
@Id Integer empAge;
}
MapKey
在一對多,多對多關(guān)系中,我們可以用Map來保存集合對象。默認(rèn)用主鍵值做key,如果使用復(fù)合主鍵,則用id class的實(shí)例做key,如果指定了name屬性,就用指定的field的值做key。
元數(shù)據(jù)屬性說明:
下面的代碼說明Person和Book之間是一對多關(guān)系。Person的books字段是Map類型,用Book的isbn字段的值作為Map的key。
@Table(name = "PERSON")
public class Person {
@OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")
@MapKey(name = "isbn")
private Map<String, Book> books = new HashMap<String, Book>();
}
OrderBy
在一對多,多對多關(guān)系中,有時(shí)我們希望從數(shù)據(jù)庫加載出來的集合對象是按一定方式排序的,這可以通過OrderBy來實(shí)現(xiàn),默認(rèn)是按對象的主鍵升序排列。
元數(shù)據(jù)屬性說明:
- value: 字符串類型,指定排序方式。格式為"fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],......",排序類型可以不指定,默認(rèn)是ASC。
下面的代碼說明Person和Book之間是一對多關(guān)系。集合books按照Book的isbn升序,name降序排列。
@Table(name = "MAPKEY_PERSON")
public class Person {
@OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")
@OrderBy(name = "isbn ASC, name DESC")
private List<Book> books = new ArrayList<Book>();
}
PrimaryKeyJoinColumn
在三種情況下會用到PrimaryKeyJoinColumn。
- 繼承(詳見Inheritance)。
- entity class映射到一個(gè)或多個(gè)從表。從表根據(jù)主表的主鍵列(列名為referencedColumnName值的列),建立一個(gè)類型一樣的主鍵列,列名由name屬性定義。
- one2one關(guān)系,關(guān)系維護(hù)端的主鍵作為外鍵指向關(guān)系被維護(hù)端的主鍵,不再新建一個(gè)外鍵列(與JoinColumn不同)。
元數(shù)據(jù)屬性說明:
- name:列名。
- referencedColumnName:該列引用列的列名
- columnDefinition: 定義建表時(shí)創(chuàng)建此列的DDL
下面的代碼說明Customer映射到兩個(gè)表,主表CUSTOMER,從表CUST_DETAIL,從表需要建立主鍵列CUST_ID,該列和主表的主鍵列id除了列名不同,其他定義一樣。
@Entity
@Table(name="CUSTOMER")
@SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID",referencedColumnName="id"))
public class Customer {
@Id(generate = GeneratorType.AUTO)
public Integer getId() {
return id;
}
}
下面的代碼說明Employee和EmployeeInfo是一對一關(guān)系,Employee的主鍵列id作為外鍵指向EmployeeInfo的主鍵列INFO_ID。
@Table(name = "Employee")
public class Employee {
@OneToOne
@PrimaryKeyJoinColumn(name = "id", referencedColumnName="INFO_ID")
EmployeeInfo info;
}
PrimaryKeyJoinColumns
如果entity class使用了復(fù)合主鍵,指定單個(gè)PrimaryKeyJoinColumn不能滿足要求時(shí),可以用PrimaryKeyJoinColumns來定義多個(gè)PrimaryKeyJoinColumn。
元數(shù)據(jù)屬性說明:
- value: 一個(gè)PrimaryKeyJoinColumn數(shù)組,包含所有PrimaryKeyJoinColumn。
下面的代碼說明了Employee和EmployeeInfo是一對一關(guān)系。他們都使用復(fù)合主鍵,建表時(shí)需要在Employee表建立一個(gè)外鍵,從Employee的主鍵列id,name指向EmployeeInfo的主鍵列INFO_ID和INFO_NAME.
@Entity
@IdClass(EmpPK.class)
@Table(name = "EMPLOYEE")
public class Employee {
private int id;
private String name;
private String address;
@OneToOne(cascade = CascadeType.ALL)
@PrimaryKeyJoinColumns({
@PrimaryKeyJoinColumn(name="id", referencedColumnName="INFO_ID"),
@PrimaryKeyJoinColumn(name="name" , referencedColumnName="INFO_NAME")})
EmployeeInfo info;
}
@Entity
@IdClass(EmpPK.class)
@Table(name = "EMPLOYEE_INFO")
public class EmployeeInfo {
@Id
@Column(name = "INFO_ID")
private int id;
@Id
@Column(name = "INFO_NAME")
private String name;
}
Transient
Transient用來注釋entity的屬性,指定的這些屬性不會被持久化,也不會為這些屬性建表。
@Transient
private String name;
Version
Version指定實(shí)體類在樂觀事務(wù)中的version屬性。在實(shí)體類重新由EntityManager管理并且加入到樂觀事務(wù)中時(shí),保證完整性。每一個(gè)類只能有一個(gè)屬性被指定為version,version屬性應(yīng)該映射到實(shí)體類的主表上。
下面的代碼說明versionNum屬性作為這個(gè)類的version,映射到數(shù)據(jù)庫中主表的列名是OPTLOCK。
@Version
@Column("OPTLOCK")
protected int getVersionNum() { return versionNum; }
Lob
Lob指定一個(gè)屬性作為數(shù)據(jù)庫支持的大對象類型在數(shù)據(jù)庫中存儲。使用LobType這個(gè)枚舉來定義Lob是二進(jìn)制類型還是字符類型。
LobType枚舉類型說明:
- BLOB 二進(jìn)制大對象,Byte[]或者Serializable的類型可以指定為BLOB。
- CLOB 字符型大對象,char[]、Character[]或String類型可以指定為CLOB。
元數(shù)據(jù)屬性說明:
- fetch: 定義這個(gè)字段是lazy loaded還是eagerly fetched。數(shù)據(jù)類型是FetchType枚舉,默認(rèn)為LAZY,即lazy loaded.
- type: 定義這個(gè)字段在數(shù)據(jù)庫中的JDBC數(shù)據(jù)類型。數(shù)據(jù)類型是LobType枚舉,默認(rèn)為BLOB。
下面的代碼定義了一個(gè)BLOB類型的屬性和一個(gè)CLOB類型的屬性。
@Lob
@Column(name="PHOTO" columnDefinition="BLOB NOT NULL")
protected JPEGImage picture;
@Lob(fetch=EAGER, type=CLOB)
@Column(name="REPORT")
protected String report;
JoinTable
JoinTable在many-to-many關(guān)系的所有者一邊定義。如果沒有定義JoinTable,使用JoinTable的默認(rèn)值。
元數(shù)據(jù)屬性說明:
- table:這個(gè)join table的Table定義。
- joinColumns:定義指向所有者主表的外鍵列,數(shù)據(jù)類型是JoinColumn數(shù)組。
- inverseJoinColumns:定義指向非所有者主表的外鍵列,數(shù)據(jù)類型是JoinColumn數(shù)組。
下面的代碼定義了一個(gè)連接表CUST和PHONE的join table。join table的表名是CUST_PHONE,包含兩個(gè)外鍵,一個(gè)外鍵是CUST_ID,指向表CUST的主鍵ID,另一個(gè)外鍵是PHONE_ID,指向表PHONE的主鍵ID。
@JoinTable(
table=@Table(name=CUST_PHONE),
joinColumns=@JoinColumn(name="CUST_ID", referencedColumnName="ID"),
inverseJoinColumns=@JoinColumn(name="PHONE_ID", referencedColumnName="ID")
)
TableGenerator
TableGenerator定義一個(gè)主鍵值生成器,在Id這個(gè)元數(shù)據(jù)的generate=TABLE時(shí),generator屬性中可以使用生成器的名字。生成器可以在類、方法或者屬性上定義。
生成器是為多個(gè)實(shí)體類提供連續(xù)的ID值的表,每一行為一個(gè)類提供ID值,ID值通常是整數(shù)。
元數(shù)據(jù)屬性說明:
- name:生成器的唯一名字,可以被Id元數(shù)據(jù)使用。
- table:生成器用來存儲id值的Table定義。
- pkColumnName:生成器表的主鍵名稱。
- valueColumnName:生成器表的ID值的列名稱。
- pkColumnValue:生成器表中的一行數(shù)據(jù)的主鍵值。
- initialValue:id值的初始值。
- allocationSize:id值的增量。
下面的代碼定義了兩個(gè)生成器empGen和addressGen,生成器的表是ID_GEN。
@Entity public class Employee {
...
@TableGenerator(name="empGen",
table=@Table(name="ID_GEN"),
pkColumnName="GEN_KEY",
valueColumnName="GEN_VALUE",
pkColumnValue="EMP_ID",
allocationSize=1)
@Id(generate=TABLE, generator="empGen")
public int id;
...
}
@Entity public class Address {
...
@TableGenerator(name="addressGen",
table=@Table(name="ID_GEN"),
pkColumnValue="ADDR_ID")
@Id(generate=TABLE, generator="addressGen")
public int id;
...
}
SequenceGenerator
SequenceGenerator定義一個(gè)主鍵值生成器,在Id這個(gè)元數(shù)據(jù)的generator屬性中可以使用生成器的名字。生成器可以在類、方法或者屬性上定義。生成器是數(shù)據(jù)庫支持的sequence對象。
元數(shù)據(jù)屬性說明:
- name:生成器的唯一名字,可以被Id元數(shù)據(jù)使用。
- sequenceName:數(shù)據(jù)庫中,sequence對象的名稱。如果不指定,會使用提供商指定的默認(rèn)名稱。
- initialValue:id值的初始值。
- allocationSize:id值的增量。
下面的代碼定義了一個(gè)使用提供商默認(rèn)名稱的sequence生成器。
@SequenceGenerator(name="EMP_SEQ", allocationSize=25)
DiscriminatorColumn
DiscriminatorColumn定義在使用SINGLE_TABLE或JOINED繼承策略的表中區(qū)別不繼承層次的列。
元數(shù)據(jù)屬性說明:
- name:column的名字。默認(rèn)值為TYPE。
- columnDefinition:生成DDL的sql片斷。
- length:String類型的column的長度,其他類型使用默認(rèn)值10。
下面的代碼定義了一個(gè)列名為DISC,長度為20的String類型的區(qū)別列。
@Entity
@Table(name="CUST")
@Inheritance(strategy=SINGLE_TABLE,
discriminatorType=STRING,
discriminatorValue="CUSTOMER")
@DiscriminatorColumn(name="DISC", length=20)
public class Customer { ... }