常用的JPA标记 (转)
Table
Table用來定義entity主表的name，catalog，schema等屬性。
元數據屬性說明：
- name: 表名
- catalog: 對應關系數據庫中的catalog
- schema：對應關系數據庫中的schema
- UniqueConstraints:定義一個UniqueConstraint數組，指定需要建唯一約束的列
@Table(name="tbl_sky",
? uniqueConstraints = {@UniqueConstraint(columnNames={"month", "day"})})
如果是單一字段約束可以用
@Table(name="tbl_sky",
? uniqueConstraints = {@UniqueConstraint(columnNames="month")})
SecondaryTable
一個entity class可以映射到多表，SecondaryTable用來定義單個從表的名字，主鍵名字等屬性。
元數據屬性說明：
- name: 表名
- catalog: 對應關系數據庫中的catalog
- schema：對應關系數據庫中的schema
- pkJoin: 定義一個PrimaryKeyJoinColumn數組，指定從表的主鍵列
- UniqueConstraints:定義一個UniqueConstraint數組，指定需要建唯一約束的列
下面的代碼說明Customer類映射到兩個表，主表名是CUSTOMER，從表名是CUST_DETAIL，從表的主鍵列和主表的主鍵列類型相同，列名為CUST_ID。
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數組，指定每個從表的屬性。
UniqueConstraint
UniqueConstraint定義在Table或SecondaryTable元數據里，用來指定建表時需要建唯一約束的列。
元數據屬性說明：
- columnNames:定義一個字符串數組，指定要建唯一約束的列名。
Column
Column元數據定義了映射到數據庫的列的所有屬性：列名，是否唯一，是否允許為空，是否允許更新等。
元數據屬性說明：
- name:列名。
- unique: 是否唯一
- nullable: 是否允許為空
- insertable: 是否允許插入
- updatable: 是否允許更新
- columnDefinition: 定義建表時創建此列的DDL
- secondaryTable: 從表名。如果此列不建在主表上（默認建在主表），該屬性定義該列所在從表的名字。
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的列。
1 public class Custom { 2 3 @OneToOne 4 @JoinColumn( 5 name="CUST_ID", referencedColumnName="ID", unique=true, nullable=true, updatable=true) 6 public Order getOrder() { 7 return order; 8 }JoinColumns
如果在entity class的field上定義了關系（one2one或one2many等），并且關系存在多個JoinColumn，用JoinColumns定義多個JoinColumn的屬性。
元數據屬性說明：
- value: 定義JoinColumn數組，指定每個JoinColumn的屬性。
下面的代碼說明Custom和Order是一對一關系。在Order對應的映射表建兩列，一列名為CUST_ID，該列作為外鍵指向Custom對應表中名為ID的列,另一列名為CUST_NAME，該列作為外鍵指向Custom對應表中名為NAME的列。
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。)
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的類名
? ?
1 public class EmployeePK implements java.io.Serializable{ 2 String empName; 3 Integer empAge; 4 5 public EmployeePK(){} 6 public boolean equals(Object obj){ ......} 7 public int hashCode(){......} 8 } 9 10 @IdClass(value=com.acme.EmployeePK.class) 11 @Entity(access=FIELD) 12 public class Employee { 13 @Id String empName; 14 @Id Integer empAge; 15 }?
? ??
MapKey
在一對多，多對多關系中，我們可以用Map來保存集合對象。默認用主鍵值做key，如果使用復合主鍵，則用id class的實例做key，如果指定了name屬性，就用指定的field的值做key。
元數據屬性說明：
- name: 用來做key的field名字
下面的代碼說明Person和Book之間是一對多關系。Person的books字段是Map類型，用Book的isbn字段的值作為Map的key。
1 @Table(name = "PERSON") 2 public class Person { 3 4 @OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person") 5 @MapKey(name = "isbn") 6 private Map books = new HashMap(); 7 }OrderBy
在一對多，多對多關系中，有時我們希望從數據庫加載出來的集合對象是按一定方式排序的，這可以通過OrderBy來實現，默認是按對象的主鍵升序排列。
元數據屬性說明：
- value: 字符串類型，指定排序方式。格式為"fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],......",排序類型可以不指定，默認是ASC。
下面的代碼說明Person和Book之間是一對多關系。集合books按照Book的isbn升序，name降序排列。
1 @Table(name = "MAPKEY_PERSON") 2 public class Person { 3 4 @OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person") 5 @OrderBy(name = "isbn ASC, name DESC") 6 private List books = new ArrayList(); 7 }PrimaryKeyJoinColumn
在三種情況下會用到PrimaryKeyJoinColumn。
- 繼承。
- entity class映射到一個或多個從表。從表根據主表的主鍵列（列名為referencedColumnName值的列），建立一個類型一樣的主鍵列，列名由name屬性定義。
- one2one關系，關系維護端的主鍵作為外鍵指向關系被維護端的主鍵，不再新建一個外鍵列。
元數據屬性說明：
- name:列名。
- referencedColumnName:該列引用列的列名
- columnDefinition: 定義建表時創建此列的DDL
下面的代碼說明Customer映射到兩個表，主表CUSTOMER,從表CUST_DETAIL，從表需要建立主鍵列CUST_ID，該列和主表的主鍵列id除了列名不同，其他定義一樣。
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。
1 @Table(name = "Employee") 2 public class Employee { 3 @OneToOne 4 @PrimaryKeyJoinColumn(name = "id", referencedColumnName="INFO_ID") 5 EmployeeInfo info; 6 } ?PrimaryKeyJoinColumns
如果entity class使用了復合主鍵，指定單個PrimaryKeyJoinColumn不能滿足要求時，可以用PrimaryKeyJoinColumns來定義多個PrimaryKeyJoinColumn。
元數據屬性說明：
- value: 一個PrimaryKeyJoinColumn數組，包含所有PrimaryKeyJoinColumn。
下面的代碼說明了Employee和EmployeeInfo是一對一關系。他們都使用復合主鍵，建表時需要在Employee表建立一個外鍵，從Employee的主鍵列id,name指向EmployeeInfo的主鍵列INFO_ID和INFO_NAME.
1 @Entity 2 @IdClass(EmpPK.class) 3 @Table(name = "EMPLOYEE") 4 public class Employee { 5 6 private int id; 7 8 private String name; 9 10 private String address; 11 12 @OneToOne(cascade = CascadeType.ALL) 13 @PrimaryKeyJoinColumns({ 14 @PrimaryKeyJoinColumn(name="id", referencedColumnName="INFO_ID"), 15 @PrimaryKeyJoinColumn(name="name" , referencedColumnName="INFO_NAME")}) 16 EmployeeInfo info; 17 } 18 19 @Entity 20 @IdClass(EmpPK.class) 21 @Table(name = "EMPLOYEE_INFO") 22 public class EmployeeInfo { 23 24 @Id 25 @Column(name = "INFO_ID") 26 private int id; 27 28 @Id 29 @Column(name = "INFO_NAME") 30 private String name; 31 }Transient
Transient用來注釋entity的屬性，指定的這些屬性不會被持久化，也不會為這些屬性建表。
1 @Transient 2 private String name;Version
Version指定實體類在樂觀事務中的version屬性。在實體類重新由EntityManager管理并且加入到樂觀事務中時，保證完整性。每一個類只能有一個屬性被指定為version，version屬性應該映射到實體類的主表上。
下面的代碼說明versionNum屬性作為這個類的version，映射到數據庫中主表的列名是OPTLOCK。
1 @Version 2 @Column("OPTLOCK") 3 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類型的屬性。
1 @Lob 2 @Column(name="PHOTO" columnDefinition="BLOB NOT NULL") 3 protected JPEGImage picture; 4 5 @Lob(fetch=EAGER, type=CLOB) 6 @Column(name="REPORT") 7 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。
1 @JoinTable( 2 table=@Table(name=CUST_PHONE), 3 joinColumns=@JoinColumn(name="CUST_ID", referencedColumnName="ID"), 4 inverseJoinColumns=@JoinColumn(name="PHONE_ID", referencedColumnName="ID") 5 ) ?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。
1 @Entity public class Employee { 2 ... 3 @TableGenerator(name="empGen", 4 table=@Table(name="ID_GEN"), 5 pkColumnName="GEN_KEY", 6 valueColumnName="GEN_VALUE", 7 pkColumnValue="EMP_ID", 8 allocationSize=1) 9 @Id(generate=TABLE, generator="empGen") 10 public int id; 11 ... 12 } 13 14 @Entity public class Address { 15 ... 16 @TableGenerator(name="addressGen", 17 table=@Table(name="ID_GEN"), 18 pkColumnValue="ADDR_ID") 19 @Id(generate=TABLE, generator="addressGen") 20 public int id; 21 ... 22 } ?SequenceGenerator
SequenceGenerator定義一個主鍵值生成器，在Id這個元數據的generator屬性中可以使用生成器的名字。生成器可以在類、方法或者屬性上定義。生成器是數據庫支持的sequence對象。
元數據屬性說明：
- name:生成器的唯一名字，可以被Id元數據使用。
- sequenceName:數據庫中，sequence對象的名稱。如果不指定，會使用提供商指定的默認名稱。
- initialValue:id值的初始值。
- allocationSize:id值的增量。
下面的代碼定義了一個使用提供商默認名稱的sequence生成器。
1 @SequenceGenerator(name="EMP_SEQ", allocationSize=25) ?DiscriminatorColumn
DiscriminatorColumn定義在使用SINGLE_TABLE或JOINED繼承策略的表中區別不繼承層次的列。
元數據屬性說明：
- name:column的名字。默認值為TYPE。
- columnDefinition:生成DDL的sql片斷。
- length:String類型的column的長度，其他類型使用默認值10。
下面的代碼定義了一個列名為DISC，長度為20的String類型的區別列。
1 @Entity 2 @Table(name="CUST") 3 @Inheritance(strategy=SINGLE_TABLE, 4 discriminatorType=STRING, 5 discriminatorValue="CUSTOMER") 6 @DiscriminatorColumn(name="DISC", length=20) 7 public class Customer { ... }?
轉載于:https://www.cnblogs.com/javaleon/p/4015001.html
總結
以上是生活随笔為你收集整理的常用的JPA标记 (转)的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 亲历腾讯WEB前端开发三轮面试经历及面试
- 下一篇： block传值 链接