JPA @Id 和 @GeneratedValue 註解詳解
JPA @Id 和 @GeneratedValue 註解詳解
https://blog.csdn.net/coding1994/article/details/79597057
@Id:
@Id 標註用於宣告一個實體類的屬性對映為資料庫的主鍵列。該屬性通常置於屬性宣告語句之前,可與宣告語句同行,也可寫在單獨行上。
@Id標註也可置於屬性的getter方法之前。
@GeneratedValue:
@GeneratedValue 用於標註主鍵的生成策略,通過strategy 屬性指定。預設情況下,JPA 自動選擇一個最適合底層資料庫的主鍵生成策略:SqlServer對應identity,MySQL 對應 auto increment。
在javax.persistence.GenerationType中定義了以下幾種可供選擇的策略:
–IDENTITY:採用資料庫ID自增長的方式來自增主鍵欄位,Oracle 不支援這種方式;
–AUTO:
–SEQUENCE:通過序列產生主鍵,通過@SequenceGenerator 註解指定序列名,MySql不支援這種方式
–TABLE:通過表產生主鍵,框架藉由表模擬序列產生主鍵,使用該策略可以使應用更易於資料庫移植。
推薦的兩種寫法:
屬性之上:
-
@Table(name="CUSTOMERS")
-
@Entity
-
public class Customer {
-
@GeneratedValue(strategy=GenerationType.AUTO)
-
@Id
-
private Integer id;
-
private String name;
-
private String email;
-
private int age;
-
-
public Integer getId() {
-
return id;
-
}
-
public void setId(Integer id) {
-
this.id = id;
-
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
getter方法之上:
-
@Table(name="CUSTOMERS")
-
@Entity
-
public class Customer {
-
private Integer id;
-
private String name;
-
private String email;
-
private int age;
-
-
@GeneratedValue(strategy=GenerationType.AUTO)
-
@Id
-
public Integer getId() {
-
return id;
-
}
-
public void setId(Integer id) {
-
this.id = id;
-
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
但是不能某個註解在屬性之上,某個註解在getter之上,將丟擲異常,對其他註解也相同
-
@Table(name="CUSTOMERS")
-
@Entity
-
public class Customer {
-
@Id
-
private Integer id;
-
private String name;
-
private String email;
-
private int age;
-
-
@GeneratedValue(strategy=GenerationType.AUTO)
-
public Integer getId() {
-
return id;
-
}
-
public void setId(Integer id) {
-
this.id = id;
-
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
上面的寫法是錯誤的
一、JPA通用策略生成器
通過annotation來對映hibernate實體的,基於annotation的hibernate主鍵標識為@Id,
其生成規則由@GeneratedValue設定的.這裡的@id和@GeneratedValue都是JPA的標準用法,
JPA提供四種標準用法,由@GeneratedValue的原始碼可以明顯看出.
- @Target({METHOD,FIELD})
- @Retention(RUNTIME)
- public @interface GeneratedValue{
- GenerationType strategy() default AUTO;
- String generator() default "";
- }
其中GenerationType:
Java程式碼
- public enum GenerationType{
- TABLE,
- SEQUENCE,
- IDENTITY,
- AUTO
- }
JPA提供的四種標準用法為TABLE,SEQUENCE,IDENTITY,AUTO.
TABLE:使用一個特定的資料庫表格來儲存主鍵。
SEQUENCE:根據底層資料庫的序列來生成主鍵,條件是資料庫支援序列。
IDENTITY:主鍵由資料庫自動生成(主要是自動增長型)
AUTO:主鍵由程式控制。
1、TABLE
Java程式碼
- @Id
- @GeneratedValue(strategy = GenerationType.TABLE, generator="payablemoney_gen")
- @TableGenerator(name = "pk_gen",
- table="tb_generator",
- pkColumnName="gen_name",
- valueColumnName="gen_value",
- pkColumnValue="PAYABLEMOENY_PK",
- allocationSize=1
- )
這裡應用表tb_generator,定義為
Sql程式碼
- CREATE TABLE tb_generator (
- id NUMBER NOT NULL,
- gen_name VARCHAR2(255) NOT NULL,
- gen_value NUMBER NOT NULL,
- PRIMARY KEY(id)
- )
插入紀錄,供生成主鍵使用,
Sql程式碼
- INSERT INTO tb_generator(id, gen_name, gen_value) VALUES (1,PAYABLEMOENY_PK', 1);
在主鍵生成後,這條紀錄的value值,按allocationSize遞增。
@TableGenerator的定義:
Java程式碼
- @Target({TYPE, METHOD, FIELD})
- @Retention(RUNTIME)
- public @interface TableGenerator {
- String name();
- String table() default "";
- String catalog() default "";
- String schema() default "";
- String pkColumnName() default "";
- String valueColumnName() default "";
- String pkColumnValue() default "";
- int initialValue() default 0;
- int allocationSize() default 50;
- UniqueConstraint[] uniqueConstraints() default {};
- }
其中屬性說明:
name屬性表示該表主鍵生成策略的名稱,它被引用在@GeneratedValue中設定的“generator”值中。
table屬性表示表生成策略所持久化的表名,例如,這裡表使用的是資料庫中的“tb_generator”。
catalog屬性和schema具體指定表所在的目錄名或是資料庫名。
pkColumnName屬性的值表示在持久化表中,該主鍵生成策略所對應鍵值的名稱。例如在“tb_generator”中將“gen_name”作為主鍵的鍵值
valueColumnName屬性的值表示在持久化表中,該主鍵當前所生成的值,它的值將會隨著每次建立累加。例如,在“tb_generator”中將“gen_value”作為主鍵的值
pkColumnValue屬性的值表示在持久化表中,該生成策略所對應的主鍵。例如在“tb_generator”表中,將“gen_name”的值為“CUSTOMER_PK”。
initialValue表示主鍵初識值,預設為0。
allocationSize表示每次主鍵值增加的大小,例如設定成1,則表示每次建立新記錄後自動加1,預設為50。
UniqueConstraint與@Table標記中的用法類似。
2、SEQUENCE
Java程式碼
- @Id
- @GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")
- @SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")
@SequenceGenerator定義
Java程式碼
- @Target({TYPE, METHOD, FIELD})
- @Retention(RUNTIME)
- public @interface SequenceGenerator {
- String name();
- String sequenceName() default "";
- int initialValue() default 0;
- int allocationSize() default 50;
- }
name屬性表示該表主鍵生成策略的名稱,它被引用在@GeneratedValue中設定的“generator”值中。
sequenceName屬性表示生成策略用到的資料庫序列名稱。
initialValue表示主鍵初識值,預設為0。
allocationSize表示每次主鍵值增加的大小,例如設定成1,則表示每次建立新記錄後自動加1,預設為50。
3、IDENTITY
Java程式碼
- @Id
- @GeneratedValue(strategy = GenerationType.IDENTITY)
4、AUTO
Java程式碼
- @Id
- @GeneratedValue(strategy = GenerationType.AUTO)
在指定主鍵時,如果不指定主鍵生成策略,預設為AUTO。
Java程式碼
- @Id
跟下面的定義是一樣的。
Java程式碼
- @Id
- @GeneratedValue(strategy = GenerationType.AUTO)
二、hibernate主鍵策略生成器
hibernate提供多種主鍵生成策略,有點是類似於JPA,有的是hibernate特有:
native: 對於 oracle 採用 Sequence 方式,對於MySQL 和 SQL Server 採用identity(自增主鍵生成機制),native就是將主鍵的生成工作交由資料庫完成,hibernate不管(很常用)。
uuid: 採用128位的uuid演算法生成主鍵,uuid被編碼為一個32位16進位制數字的字串。佔用空間大(字串型別)。
hilo: 使用hilo生成策略,要在資料庫中建立一張額外的表,預設表名為hibernate_unique_key,預設欄位為integer型別,名稱是next_hi(比較少用)。
assigned: 在插入資料的時候主鍵由程式處理(很常用),這是 元素沒有指定時的預設生成策略。等同於JPA中的AUTO。
identity: 使用SQL Server 和 MySQL 的自增欄位,這個方法不能放到 Oracle 中,Oracle 不支援自增欄位,要設定sequence(MySQL 和 SQL Server 中很常用)。
等同於JPA中的INDENTITY。
select: 使用觸發器生成主鍵(主要用於早期的資料庫主鍵生成機制,少用)。
sequence: 呼叫底層資料庫的序列來生成主鍵,要設定序列名,不然hibernate無法找到。
seqhilo: 通過hilo演算法實現,但是主鍵歷史儲存在Sequence中,適用於支援 Sequence 的資料庫,如 Oracle(比較少用)
increment: 插入資料的時候hibernate會給主鍵新增一個自增的主鍵,但是一個hibernate例項就維護一個計數器,所以在多個例項執行的時候不能使用這個方法。
foreign: 使用另外一個相關聯的物件的主鍵。通常和聯合起來使用。
guid: 採用資料庫底層的guid演算法機制,對應MYSQL的uuid()函式,SQL Server的newid()函式,ORACLE的rawtohex(sys_guid())函式等。
uuid.hex: 看uuid,建議用uuid替換。
sequence-identity: sequence策略的擴充套件,採用立即檢索策略來獲取sequence值,需要JDBC3.0和JDK4以上(含1.4)版本
hibernate提供了多種生成器供選擇,基於Annotation的方式通過@GenericGenerator實現.
hibernate每種主鍵生成策略提供介面org.hibernate.id.IdentifierGenerator的實現類,如果要實現自定義的主鍵生成策略也必須實現此介面.
Java程式碼
- public interface IdentifierGenerator {
- public static final String ENTITY_NAME = "entity_name";
- public Serializable generate(SessionImplementor session, Object object)
- throws HibernateException;
- }
IdentifierGenerator提供一generate方法,generate方法返回產生的主鍵.
三、@GenericGenerator
自定義主鍵生成策略,由@GenericGenerator實現。
hibernate在JPA的基礎上進行了擴充套件,可以用一下方式引入hibernate獨有的主鍵生成策略,就是通過@GenericGenerator加入的。
比如說,JPA標準用法
Java程式碼
- @Id
- @GeneratedValue(GenerationType.AUTO)
就可以用hibernate特有以下用法來實現
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")
@GenericGenerator的定義:
Java程式碼
- @Target({PACKAGE, TYPE, METHOD, FIELD})
- @Retention(RUNTIME)
- public @interface GenericGenerator {
- String name();
- String strategy();
- Parameter[] parameters() default {};
- }
name屬性指定生成器名稱。
strategy屬性指定具體生成器的類名。
parameters得到strategy指定的具體生成器所用到的引數。
對於這些hibernate主鍵生成策略和各自的具體生成器之間的關係,在org.hibernate.id.IdentifierGeneratorFacto ry中指定了,
Java程式碼
- static {
- GENERATORS.put("uuid", UUIDHexGenerator.class);
- GENERATORS.put("hilo", TableHiLoGenerator.class);
- GENERATORS.put("assigned", Assigned.class);
- GENERATORS.put("identity", IdentityGenerator.class);
- GENERATORS.put("select", SelectGenerator.class);
- GENERATORS.put("sequence", SequenceGenerator.class);
- GENERATORS.put("seqhilo", SequenceHiLoGenerator.class);
- GENERATORS.put("increment", IncrementGenerator.class);
- GENERATORS.put("foreign", ForeignGenerator.class);
- GENERATORS.put("guid", GUIDGenerator.class);
- GENERATORS.put("uuid.hex", UUIDHexGenerator.class); //uuid.hex is deprecated
- GENERATORS.put("sequence-identity", SequenceIdentityGenerator.class);
- }
上面十二種策略,加上native,hibernate一共預設支援十三種生成策略。
1、native
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "native")
2、uuid
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "uuid")
3、hilo
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "hilo")
4、assigned
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")
5、identity
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "identity")
6、select
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name="select", strategy="select",
- parameters = { @Parameter(name = "key", value = "idstoerung") })
7、sequence
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "sequence",
- parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })
8、seqhilo
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",
- parameters = { @Parameter(name = "max_lo", value = "5") })
9、increment
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "increment")
10、foreign
Java程式碼
- @GeneratedValue(generator = "idGenerator")
- @GenericGenerator(name = "idGenerator", strategy = "foreign",
- parameters = { @Parameter(name = "property", value = "employee") })
注意:直接使用@PrimaryKeyJoinColumn 報錯(?)
Java程式碼
- @OneToOne(cascade = CascadeType.ALL)
- @PrimaryKeyJoinColumn
例如
Java程式碼
- @Entity
- public class Employee {
- @Id Integer id;
- @OneToOne @PrimaryKeyJoinColumn
- EmployeeInfo info;
- ...
- }
應該為
Java程式碼
- @Entity
- public class Employee {
- @Id
- @GeneratedValue(generator = "idGenerator")
- @GenericGenerator(name = "idGenerator", strategy = "foreign",
- parameters = { @Parameter(name = "property", value = "info") })
- Integer id;
- @OneToOne
- EmployeeInfo info;
- ...
- }
11、guid
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "guid")
12、uuid.hex
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "uuid.hex")
13、sequence-identity
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",
- parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })
四、通過@GenericGenerator自定義主鍵生成策略
如果實際應用中,主鍵策略為程式指定了就用程式指定的主鍵(assigned),沒有指定就從sequence中取。
明顯上面所討論的策略都不滿足,只好自己擴充套件了,整合assigned和sequence兩種策略。
Java程式碼
- public class AssignedSequenceGenerator extends SequenceGenerator implements
- PersistentIdentifierGenerator, Configurable {
- private String entityName;
- public void configure(Type type, Properties params, Dialect dialect) throws MappingException {
- entityName = params.getProperty(ENTITY_NAME);
- if (entityName==null) {
- throw new MappingException("no entity name");
- }
- super.configure(type, params, dialect);
- }
- public Serializable generate(SessionImplementor session, Object obj)
- throws HibernateException {
- Serializable id = session.getEntityPersister( entityName, obj )
- .getIdentifier( obj, session.getEntityMode() );
- if (id==null) {
- id = super.generate(session, obj);
- }
- return id;
- }
- }
實際應用中,定義同sequence。
Java程式碼
- @GeneratedValue(generator = "paymentableGenerator")
- @GenericGenerator(name = "paymentableGenerator", strategy = "AssignedSequenceGenerator",
- parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })
四種資料庫的支援情況如下:
資料庫名稱 |
支援的id策略 |
mysql |
GenerationType.TABLE GenerationType.AUTO GenerationType.IDENTITY 不支援GenerationType.SEQUENCE |
oracle |
strategy=GenerationType.AUTO GenerationType.SEQUENCE GenerationType.TABLE 不支援GenerationType.IDENTITY |
postgreSQL |
GenerationType.TABLE GenerationType.AUTO GenerationType.IDENTITY GenerationType.SEQUENCE 都支援 |
kingbase |
GenerationType.TABLE GenerationType.SEQUENCE GenerationType.IDENTITY GenerationType.AUTO 都支援 |
JPA的@GeneratedValue註解,在JPA中,@GeneratedValue註解存在的意義主要就是為一個實體生成一個唯一標識的主鍵(JPA要求每一個實體Entity,必須有且只有一個主鍵),@GeneratedValue提供了主鍵的生成策略。@GeneratedValue註解有兩個屬性,分別是strategy和generator,其中generator屬性的值是一個字串,預設為"",其聲明瞭主鍵生成器的名稱(對應於同名的主鍵生成器@SequenceGenerator和@TableGenerator)。
JPA為開發人員提供了四種主鍵生成策略,其被定義在列舉類GenerationType中,包括GenerationType.TABLE,GenerationType.SEQUENCE,GenerationType.IDENTITY和GenerationType.AUTO。下面分別介紹這四種主鍵生成策略。
1.GenerationType.TABLE
使用一個特定的資料庫表格來儲存主鍵,持久化引擎通過關係資料庫的一張特定的表格來生成主鍵,這種策略的好處就是不依賴於外部環境和資料庫的具體實現,在不同資料庫間可以很容易的進行移植,但由於其不能充分利用資料庫的特性,所以不會優先使用。該策略一般與另外一個註解一起使用@TableGenerator,@TableGenerator註解指定了生成主鍵的表(可以在實體類上指定也可以在主鍵欄位或屬性上指定),然後JPA將會根據註解內容自動生成一張表作為序列表(或使用現有的序列表)。如果不指定序列表,則會生成一張預設的序列表,表中的列名也是自動生成,資料庫上會生成一張名為sequence的表(SEQ_NAME,SEQ_COUNT)。序列表一般只包含兩個欄位:第一個欄位是該生成策略的名稱,第二個欄位是該關係表的最大序號,它會隨著資料的插入逐漸累加。類似於
[java] view plain copy- @Id
- @GeneratedValue(strategy = GenerationType.TABLE, generator = "roleSeq")
- @TableGenerator(name = "roleSeq", allocationSize = 1, table = "seq_table", pkColumnName = "seq_id", valueColumnName = "seq_count")
- private Integer id;
2.GenerationType.SEQUENCE
在某些資料庫中,不支援主鍵自增長,比如Oracle,其提供了一種叫做"序列(sequence)"的機制生成主鍵。此時,GenerationType.SEQUENCE就可以作為主鍵生成策略。該策略的不足之處正好與TABLE相反,由於只有部分資料庫(Oracle,PostgreSQL,DB2)支援序列物件,所以該策略一般不應用於其他資料庫。類似的,該策略一般與另外一個註解一起使用@SequenceGenerator,@SequenceGenerator註解指定了生成主鍵的序列.然後JPA會根據註解內容建立一個序列(或使用一個現有的序列)。如果不指定序列,則會自動生成一個序列SEQ_GEN_SEQUENCE。類似於
[java] view plain copy- @Id
- @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "menuSeq")
- @SequenceGenerator(name = "menuSeq", initialValue = 1, allocationSize = 1, sequenceName = "MENU_SEQUENCE")
- private Integer id;
3.GenerationType.IDENTITY
此種主鍵生成策略就是通常所說的主鍵自增長,資料庫在插入資料時,會自動給主鍵賦值,比如MYSQL可以在建立表時宣告"auto_increment" 來指定主鍵自增長。該策略在大部分資料庫中都提供了支援(指定方法或關鍵字可能不同),但還是有少數資料庫不支援,所以可移植性略差。使用自增長主鍵生成策略是隻需要宣告strategy = GenerationType.IDENTITY即可。類似於
[java] view plain copy- @Id
- @GeneratedValue(strategy = GenerationType.IDENTITY)
- private Integer id;
4.GenerationType.AUTO
把主鍵生成策略交給持久化引擎(persistence engine),持久化引擎會根據資料庫在以上三種主鍵生成策略中選擇其中一種。此種主鍵生成策略比較常用,由於JPA預設的生成策略就是GenerationType.AUTO,所以使用此種策略時.可以顯式的指定@GeneratedValue(strategy = GenerationType.AUTO)也可以直接@GeneratedValue
類似於
[java] view plain copy- @GeneratedValue(strategy = GenerationType.AUTO)
- private Integer id;
- @GeneratedValue
- private Integer id;
參考資料:
http://xiaoyaocao.iteye.com/blog/1874412
http://www.ibm.com/developerworks/cn/java/j-lo-jpaprimarykey/
http://www.oracle.com/technetwork/cn/middleware/ias/toplink-jpa-annotations-100895-zhs.html#
測試例項
http://download.csdn.net/detail/u012493207/9456135