經常使用的JPA annotation

Table

Table用來定義entity主表的name,catalog,schema等屬性。 java

元數據屬性說明: mysql

  • name: 表名
  • catalog: 對應關係數據庫中的catalog
  • schema:對應關係數據庫中的schema
  • UniqueConstraints:定義一個UniqueConstraint數組,指定須要建惟一約束的列
 @Entity @Table(name="CUST") public class Customer { ... }   

SecondaryTable

一個entity class能夠映射到多表,SecondaryTable用來定義單個從表的名字,主鍵名字等屬性。 sql

元數據屬性說明: 數據庫

  • 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來定義各個從表的屬性。 app

元數據屬性說明: 函數

  • 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元數據裏,用來指定建表時須要建惟一約束的列。 fetch

元數據屬性說明: spa

  • columnNames:定義一個字符串數組,指定要建惟一約束的列名。
 @Entity @Table(name="EMPLOYEE", uniqueConstraints={@UniqueConstraint(columnNames={"EMP_ID", "EMP_NAME"})} ) public class Employee { ... } 

Column

Column元數據定義了映射到數據庫的列的全部屬性:列名,是否惟一,是否容許爲空,是否容許更新等。 code

元數據屬性說明:

  • 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; 

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 Mapbooks = 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 Listbooks = 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用來註釋entity的屬性,指定的這些屬性不會被持久化,也不會爲這些屬性建表。

 @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 { ... }
相關文章
相關標籤/搜索