JPA和Hibernate的關係
JPA（Java Persistence API），是Java EE 5的標準ORM接口，也是ejb3規範的一部分。
Hibernate是之前很流行的ORM框架，也是JPA的一個實現，其它還有Toplink之類的ROM框架。
JPA和Hibernate之間的關係，可以簡單的理解爲JPA是標準接口，Hibernate是實現。
Hibernate主要是通過三個組件來實現的：
- hibernate-core：Hibernate的核心實現，提供了Hibernate所有的核心功能。
- hibernate-entitymanager：Hibernate實現了標準的JPA，可以把它看成hibernate-core和JPA之間的適配器，它並不直接提供ORM的功能，而是對hibernate-core進行封裝，使得Hibernate符合JPA的規範。
- hibernate-annotation：Hibernate支持annotation方式配置的基礎，它包括了標準的JPA annotation以及Hibernate自身特殊功能的annotation。
Entity
@Entity說明這個class是實體類，並且使用默認的orm規則，即class名對應數據庫表中表名，class字段名即表中的字段名。
（如果想改變這種默認的orm規則，就要使用@Table來改變class名與數據庫中表名的映射規則，@Column來改變class中字段名與db中表的字段名的映射規則）
元數據屬性說明：
• name: 表名
下面的代碼說明,Customer類對應數據庫中的Customer表，其中name爲可選，缺省類名即表名！
@Entity(name=”Customer”)
public class Customer { ... }
Table
Table用來定義entity主表的name，catalog，schema等屬性。
元數據屬性說明：
• name: 表名
• catalog: 對應關係數據庫中的catalog
• schema：對應關係數據庫中的schema
• UniqueConstraints:定義一個UniqueConstraint數組，指定需要建唯一約束的列
@Entity
@Table(name="CUST")
public class Customer { ... }
SecondaryTable
一個entity class可以映射到多表，SecondaryTable用來定義單個從表的名字，主鍵名字等屬性。
元數據屬性說明：
• name: 表名
• catalog: 對應關係數據庫中的catalog
• schema：對應關係數據庫中的schema
• pkJoin: 定義一個PrimaryKeyJoinColumn數組，指定從表的主鍵列
• UniqueConstraints: 定義一個UniqueConstraint數組，指定需要建唯一約束的列
下面的代碼說明Customer類映射到兩個表，主表名是CUSTOMER，從表名是CUST_DETAIL，從表的主鍵列和主表的主鍵列類型相同，列名爲CUST_ID。
@Entity
@Table(name="CUSTOMER")
@SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"))
public class Customer { ... }
SecondaryTables
當一個entity class映射到一個主表和多個從表時，用SecondaryTables來定義各個從表的屬性。
元數據屬性說明：
• value： 定義一個SecondaryTable數組，指定每個從表的屬性。
@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元數據裏，用來指定建表時需要建唯一約束的列。
元數據屬性說明：
• columnNames:定義一個字符串數組，指定要建唯一約束的列名。
@Entity
@Table(name="EMPLOYEE",
uniqueConstraints={@UniqueConstraint(columnNames={"EMP_ID", "EMP_NAME"})}
)
public class Employee { ... }
Column
Column元數據定義了映射到數據庫的列的所有屬性：列名，是否唯一，是否允許爲空，是否允許更新等。
元數據屬性說明：
• name:列名。
• unique: 是否唯一
• nullable: 是否允許爲空
• insertable: 是否允許插入
• updatable: 是否允許更新
• columnDefinition: 定義建表時創建此列的DDL
• secondaryTable: 從表名。如果此列不建在主表上（默認建在主表），該屬性定義該列所在從表的名字。
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;
OneToOne
@OneToOne描述一個 一對一的關聯
元數據屬性說明：
• fetch：表示抓取策略，默認爲FetchType.LAZY
• cascade：表示級聯操作策略
@OneToOne(fetch=FetchType,cascade=CascadeType)
ManyToOne
@ManyToOne表示一個多對一的映射,該註解標註的屬性通常是數據庫表的外鍵.
元數據屬性說明：
• optional：是否允許該字段爲null，該屬性應該根據數據庫表的外鍵約束來確定，默認爲true
• fetch：表示抓取策略，默認爲FetchType.EAGER
• cascade：表示默認的級聯操作策略，可以指定爲ALL，PERSIST，MERGE，REFRESH和REMOVE中的若干組合，默認爲無級聯操作
• targetEntity：表示該屬性關聯的實體類型。該屬性通常不必指定，ORM框架根據屬性類型自動判斷targetEntity。
@ManyToOne(fetch=FetchType,cascade=CascadeType)
OneToMany
@OneToMany描述一個 一對多的關聯,該屬性應該爲集體類型,在數據庫中並沒有實際字段。
元數據屬性說明：
• fetch：表示抓取策略,默認爲FetchType.LAZY,因爲關聯的多個對象通常不必從數據庫預先讀取到內存
• cascade：表示級聯操作策略,對於OneToMany類型的關聯非常重要,通常該實體更新或刪除時,其關聯的實體也應當被更新或刪除
例如：
實體User和Order是OneToMany的關係，則實體User被刪除時，其關聯的實體Order也應該被全部刪除
@OneToMany(fetch=FetchType,cascade=CascadeType)
ManyToMany
@ManyToMany 描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM框架自動處理
元數據屬性說明：
• targetEntity:表示多對多關聯的另一個實體類的全名,例如:package.Book.class
• mappedBy:表示多對多關聯的另一個實體類的對應集合屬性名稱
兩個實體間相互關聯的屬性必須標記爲@ManyToMany,並相互指定targetEntity屬性,
需要注意的是,有且只有一個實體的@ManyToMany註解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱
利用ORM工具自動生成的表除了User和Book表外,還自動生成了一個User_Book表,用於實現多對多關聯
JoinColumn
如果在entity class的field上定義了關係（one2one或one2many等），我們通過JoinColumn來定義關係的屬性。JoinColumn的大部分屬性和Column類似。
元數據屬性說明：
• name:列名。
• referencedColumnName:該列指向列的列名（建表時該列作爲外鍵列指向關係另一端的指定列）
• unique: 是否唯一
• nullable: 是否允許爲空
• insertable: 是否允許插入
• updatable: 是否允許更新
• columnDefinition: 定義建表時創建此列的DDL
• secondaryTable: 從表名。如果此列不建在主表上（默認建在主表），該屬性定義該列所在從表的名字。
下面的代碼說明Custom和Order是一對一關係。在Order對應的映射表建一個名爲CUST_ID的列，該列作爲外鍵指向Custom對應表中名爲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上定義了關係（one2one或one2many等），並且關係存在多個JoinColumn，用JoinColumns定義多個JoinColumn的屬性。
元數據屬性說明：
• value: 定義JoinColumn數組，指定每個JoinColumn的屬性。
下面的代碼說明Custom和Order是一對一關係。在Order對應的映射表建兩列，一列名爲CUST_ID，該列作爲外鍵指向Custom對應表中名爲ID的列,另一列名爲CUST_NAME，該列作爲外鍵指向Custom對應表中名爲NAME的列。
public class Custom {
@OneToOne
@JoinColumns({
@JoinColumn(name="CUST_ID", referencedColumnName="ID"),
@JoinColumn(name="CUST_NAME", referencedColumnName="NAME")
})
public order getOrder() {
return order;
}
聲明當前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。)
@Entity
@Table(name = "OTASK")
public class Task {
@Id(generate = GeneratorType.AUTO)
public Integer getId() {
return id;
}
}
IdClass
當entity class使用複合主鍵時，需要定義一個類作爲id class。
id class必須符合以下要求:
類必須聲明爲public，並提供一個聲明爲public的空構造函數。
必須實現Serializable接口，覆寫 equals() 和 hashCode()方法。
entity class的所有id field在id class都要定義，且類型一樣。
元數據屬性說明：
• value: id class的類名
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
在一對多，多對多關係中，我們可以用Map來保存集合對象。默認用主鍵值做key，如果使用複合主鍵，則用id class的實例做key，如果指定了name屬性，就用指定的field的值做key。
元數據屬性說明：
• name: 用來做key的field名字
下面的代碼說明Person和Book之間是一對多關係。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 books = new HashMap();
}
OrderBy
在一對多，多對多關係中，有時我們希望從數據庫加載出來的集合對象是按一定方式排序的，這可以通過OrderBy來實現，默認是按對象的主鍵升序排列。
元數據屬性說明：
• value: 字符串類型，指定排序方式。
格式爲”fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],……”,排序類型可以不指定，默認是ASC。
下面的代碼說明Person和Book之間是一對多關係。集合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 books = new ArrayList();
}
PrimaryKeyJoinColumn
在三種情況下會用到PrimaryKeyJoinColumn。
• 繼承。
• entity class映射到一個或多個從表。從表根據主表的主鍵列（列名爲referencedColumnName值的列），建立一個類型一樣的主鍵列，列名由name屬性定義。
• one2one關係，關係維護端的主鍵作爲外鍵指向關係被維護端的主鍵，不再新建一個外鍵列。
元數據屬性說明：
• name:列名。
• referencedColumnName:該列引用列的列名
• columnDefinition: 定義建表時創建此列的DDL
下面的代碼說明Customer映射到兩個表，主表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是一對一關係，Employee的主鍵列id作爲外鍵指向EmployeeInfo的主鍵列INFO_ID。
@Table(name = "Employee")
public class Employee {
@OneToOne
@PrimaryKeyJoinColumn(name = "id", referencedColumnName="INFO_ID")
EmployeeInfo info;
}
PrimaryKeyJoinColumns
如果entity class使用了複合主鍵，指定單個PrimaryKeyJoinColumn不能滿足要求時，可以用PrimaryKeyJoinColumns來定義多個PrimaryKeyJoinColumn。
元數據屬性說明：
• value: 一個PrimaryKeyJoinColumn數組，包含所有PrimaryKeyJoinColumn。
下面的代碼說明了Employee和EmployeeInfo是一對一關係。他們都使用複合主鍵，建表時需要在Employee表建立一個外鍵，從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表示該屬性並不是一個到數據庫表的字段的映射，指定的這些屬性不會被持久化，ORM框架將忽略該屬性。
如果一個屬性並非數據庫表的字段映射。就務必將其標示爲@Transient。否則，ORM框架默認其註解爲@Basic
@Transient
private String name;
Version
Version指定實體類在樂觀事務中的version屬性。在實體類重新由EntityManager管理並且加入到樂觀事務中時，保證完整性。每一個類只能有一個屬性被指定爲version，version屬性應該映射到實體類的主表上。
下面的代碼說明versionNum屬性作爲這個類的version，映射到數據庫中主表的列名是OPTLOCK。
@Version
@Column("OPTLOCK")
protected int getVersionNum() { return versionNum; }
Lob
Lob指定一個屬性作爲數據庫支持的大對象類型在數據庫中存儲。使用LobType這個枚舉來定義Lob是二進制類型還是字符類型。
LobType枚舉類型說明：
• BLOB 二進制大對象，Byte[]或者Serializable的類型可以指定爲BLOB。
• CLOB 字符型大對象，char[]、Character[]或String類型可以指定爲CLOB。
元數據屬性說明：
• fetch： 定義這個字段是lazy loaded還是eagerly fetched。數據類型是FetchType枚舉，默認爲LAZY,即lazy loaded.
• type： 定義這個字段在數據庫中的JDBC數據類型。數據類型是LobType枚舉，默認爲BLOB。
下面的代碼定義了一個BLOB類型的屬性和一個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關係的所有者一邊定義。如果沒有定義JoinTable，使用JoinTable的默認值。
元數據屬性說明：
• table:這個join table的Table定義。
• joinColumns:定義指向所有者主表的外鍵列，數據類型是JoinColumn數組。
• inverseJoinColumns:定義指向非所有者主表的外鍵列，數據類型是JoinColumn數組。
下面的代碼定義了一個連接表CUST和PHONE的join table。join table的表名是CUST_PHONE，包含兩個外鍵，一個外鍵是CUST_ID，指向表CUST的主鍵ID，另一個外鍵是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定義一個主鍵值生成器，在Id這個元數據的generate＝TABLE時，generator屬性中可以使用生成器的名字。生成器可以在類、方法或者屬性上定義。
生成器是爲多個實體類提供連續的ID值的表，每一行爲一個類提供ID值，ID值通常是整數。
元數據屬性說明：
• name:生成器的唯一名字，可以被Id元數據使用。
• table:生成器用來存儲id值的Table定義。
• pkColumnName:生成器表的主鍵名稱。
• valueColumnName:生成器表的ID值的列名稱。
• pkColumnValue:生成器表中的一行數據的主鍵值。
• initialValue:id值的初始值。
• allocationSize:id值的增量。
下面的代碼定義了兩個生成器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定義一個主鍵值生成器，在Id這個元數據的generator屬性中可以使用生成器的名字。生成器可以在類、方法或者屬性上定義。生成器是數據庫支持的sequence對象。
元數據屬性說明：
• name:生成器的唯一名字，可以被Id元數據使用。
• sequenceName:數據庫中，sequence對象的名稱。如果不指定，會使用提供商指定的默認名稱。
• initialValue:id值的初始值。
• allocationSize:id值的增量。
下面的代碼定義了一個使用提供商默認名稱的sequence生成器。
@SequenceGenerator(name="EMP_SEQ", allocationSize=25)
DiscriminatorColumn
DiscriminatorColumn定義在使用SINGLE_TABLE或JOINED繼承策略的表中區別不繼承層次的列。
元數據屬性說明：
• name:column的名字。默認值爲TYPE。
• columnDefinition:生成DDL的sql片斷。
• length:String類型的column的長度，其他類型使用默認值10。
下面的代碼定義了一個列名爲DISC，長度爲20的String類型的區別列。
@Entity
@Table(name="CUST")
@Inheritance(strategy=SINGLE_TABLE,
discriminatorType=STRING,
discriminatorValue="CUSTOMER")
@DiscriminatorColumn(name="DISC", length=20)
public class Customer { ... }
Hibernate驗證註解
以上每個註解都可能性有一個message屬性，用於在驗證失敗後向用戶返回的消息
總結
@JoinColumn
@OneToOne註釋只能確定實體與實體的關係是一對一的關係，不能指定數據庫表中的保存的關聯字段。所以此時要結合@JoinColumn標記來指定保存實體關係的配置。
@JoinColumn與本書上一章講述的@Column註釋類似，它的定義如下代碼所示。
@Target({METHOD, FIELD})
@Retention(RUNTIME)
String name() default "";
String referencedColumnName() default "";
boolean unique() default false;
boolean nullable() default true;
boolean insertable() default true;
boolean updatable() default true;
String columnDefinition() default "";
String table() default "";
}
在使用@JoinColumn註釋時，應注意以下幾個問題：
1、 @JoinColumn與@Column標記一樣，是用於註釋表中的字段的。它的屬性與@Column屬性有很多相同之處，這裏就不詳細講述。請讀者參閱5.2.2小節中有關@Column屬性的部分。
2、@JoinColumn與@Column相區別的是：@JoinColumn註釋的是保存表與表之間關係的字段，它要標註在實體屬性上。而@Column標註的是表中不包含表關係的字段。
3、與@Column標記一樣，name屬性是用來標識表中所對應的字段的名稱。
例如customer表中存在字段addr_id，標識的代碼如下所示。
@OneToOne
@JoinColumn(name = "addr_id")
public AddressEO getAddress() {
return address;
}
若此時，不設置name的值，則在默認情況下，name的取值遵循以下規則：
name=關聯表的名稱+“_”+ 關聯表主鍵的字段名
例如，CustomerEO實體中，如果不指定name的值，默認將對應name=address_id；
因爲@JoinColumn註釋在實體 AddressEO屬性上，實體AddressEO對應的表名爲“address”；表address的主鍵是“id”，所以此時對應的默認的字段名稱爲 “address_id”。
提示：
此規則只適用於與@OneToOne標記同時使用時。若與@ManyToOne或@ManyToMany標記同時使用時，將遵循其他的規則。
1、默認情況下，關聯的實體的主鍵一般是用來做外鍵的。但如果此時不想主鍵作爲外鍵，則需要設置referencedColumnName屬性。
例如，將address表中增加一個字段“ref_id”，address表的建表SQL變爲以下所示。
CREATE TABLE address (
id int(20) NOT NULL auto_increment,
ref_id int int(20) NOT NULL,
province varchar(50) ,
city varchar(50) ,
postcode varchar(50) ,
detail varchar(50) ,
PRIMARY KEY (id)
)
此時，通過customer表中的“address_id”字段關聯的是address表中的“ref_id”，而“ref_id”並不是address表中的主鍵，則實體中標註如代碼下所示。
@OneToOne
@JoinColumn(name = "address_id",referencedColumnName="ref_id")
public AddressEO getAddress() {
return address;
}
屬性referencedColumnName標註的是所關聯表中的字段名，若不指定則使用的所關聯表的主鍵字段名作爲外鍵。
JoinColumn標記不僅能夠與@OneToOne使用，也可以@ManyToOne或@ManyToMany標記同時使用，它們所表示的含義不同。