JPA註解大全詳解參考手冊

阿新 • • 發佈：2019-01-09

JPA註釋詳解參考手冊

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",[email protected](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;
    }

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。)

    @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",
    [email protected](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",
    [email protected](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驗證註解

註解	適用型別	說明	示例
@Pattern	String	通過正則表示式來驗證字串	@attern(regex=”[a-z]{6}”)
@Length	String	驗證字串的長度	@length(min=3,max=20)
@Email	String	驗證一個Email地址是否有效	@email
@Range	Long	驗證一個整型是否在有效的範圍內	@Range(min=0,max=100)
@Min	Long	驗證一個整型必須不小於指定值	@Min(value=10)
@Max	Long	驗證一個整型必須不大於指定值	@Max(value=20)
@Size	集合或陣列	集合或陣列的大小是否在指定範圍內	@Size(min=1,max=255)

以上每個註解都可能性有一個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標記同時使用，它們所表示的含義不同。