@GeneratedValue

本文轉載自查看原文 2016-09-11 00:52 1568 GeneratedValue/ java

一、JPA通用策略生成器
通過annotation來映射hibernate實體的,基於annotation的hibernate主鍵標識為@Id,
其生成規則由@GeneratedValue設定的.這里的@id和@GeneratedValue都是JPA的標准用法,
JPA提供四種標准用法,由@GeneratedValue的源代碼可以明顯看出.

1     @Target({METHOD,FIELD})    
2         @Retention(RUNTIME)    
3         public @interface GeneratedValue{    
4             GenerationType strategy() default AUTO;    
5             String generator() default "";    
6         }

其中GenerationType:

1     public enum GenerationType{    
2         TABLE,    
3         SEQUENCE,    
4         IDENTITY,    
5         AUTO   
6     }

JPA提供的四種標准用法為TABLE,SEQUENCE,IDENTITY,AUTO.
TABLE：使用一個特定的數據庫表格來保存主鍵。
SEQUENCE：根據底層數據庫的序列來生成主鍵，條件是數據庫支持序列。
IDENTITY：主鍵由數據庫自動生成（主要是自動增長型）
AUTO：主鍵由程序控制。

1、TABLE

1     @Id  
2     @GeneratedValue(strategy = GenerationType.TABLE, generator="payablemoney_gen")  
3     @TableGenerator(name = "pk_gen",  
4         table="tb_generator",  
5         pkColumnName="gen_name",  
6         valueColumnName="gen_value",  
7         pkColumnValue="PAYABLEMOENY_PK",  
8         allocationSize=1  
9     )

這里應用表tb_generator，定義為

1     CREATE TABLE  tb_generator (  
2       id NUMBER NOT NULL,  
3       gen_name VARCHAR2(255) NOT NULL,  
4       gen_value NUMBER NOT NULL,  
5       PRIMARY KEY(id)  
6     )

插入紀錄，供生成主鍵使用，

1     INSERT INTO tb_generator(id, gen_name, gen_value) VALUES (1,PAYABLEMOENY_PK', 1);

在主鍵生成后，這條紀錄的value值，按allocationSize遞增。

@TableGenerator的定義：

 1     @Target({TYPE, METHOD, FIELD})   
 2     @Retention(RUNTIME)  
 3     public @interface TableGenerator {  
 4       String name();  
 5       String table() default "";  
 6       String catalog() default "";  
 7       String schema() default "";  
 8       String pkColumnName() default "";  
 9       String valueColumnName() default "";  
10       String pkColumnValue() default "";  
11       int initialValue() default 0;  
12       int allocationSize() default 50;  
13       UniqueConstraint[] uniqueConstraints() default {};  
14     }

其中屬性說明：
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

1     @Id  
2     @GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")  
3     @SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")

@SequenceGenerator定義

1     @Target({TYPE, METHOD, FIELD})   
2     @Retention(RUNTIME)  
3     public @interface SequenceGenerator {  
4      String name();  
5      String sequenceName() default "";  
6      int initialValue() default 0;  
7      int allocationSize() default 50;  
8     }

name屬性表示該表主鍵生成策略的名稱，它被引用在@GeneratedValue中設置的“generator”值中。
sequenceName屬性表示生成策略用到的數據庫序列名稱。
initialValue表示主鍵初識值，默認為0。
allocationSize表示每次主鍵值增加的大小，例如設置成1，則表示每次創建新記錄后自動加1，默認為50。

3、IDENTITY

1     @Id  
2     @GeneratedValue(strategy = GenerationType.IDENTITY)

4、AUTO

1     @Id  
2     @GeneratedValue(strategy = GenerationType.AUTO)

在指定主鍵時，如果不指定主鍵生成策略，默認為AUTO。

1     @Id

跟下面的定義是一樣的。

1     @Id  
2     @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: 在插入數據的時候主鍵由程序處理（很常用），這是 <generator>元素沒有指定時的默認生成策略。等同於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: 使用另外一個相關聯的對象的主鍵。通常和<one-to-one>聯合起來使用。
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的實現類,如果要實現自定義的主鍵生成策略也必須實現此接口.

 1     public interface IdentifierGenerator {  
 2         /** 
 3          * The configuration parameter holding the entity name 
 4          */  
 5         public static final String ENTITY_NAME = "entity_name";  
 6           
 7       /** 
 8        * Generate a new identifier. 
 9        * @param session 
10        * @param object the entity or toplevel collection for which the id is being generated 
11        * 
12        * @return a new identifier 
13        * @throws HibernateException 
14        */  
15       public Serializable generate(SessionImplementor session, Object object)   
16         throws HibernateException;  
17     }

IdentifierGenerator提供一generate方法,generate方法返回產生的主鍵.

三、@GenericGenerator
自定義主鍵生成策略，由@GenericGenerator實現。
hibernate在JPA的基礎上進行了擴展，可以用一下方式引入hibernate獨有的主鍵生成策略，就是通過@GenericGenerator加入的。
比如說，JPA標准用法

1     @Id  
2     @GeneratedValue(GenerationType.AUTO)

就可以用hibernate特有以下用法來實現

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")

@GenericGenerator的定義:

 1     @Target({PACKAGE, TYPE, METHOD, FIELD})  
 2     @Retention(RUNTIME)  
 3     public @interface GenericGenerator {  
 4      /** 
 5       * unique generator name 
 6       */  
 7      String name();  
 8      /** 
 9       * Generator strategy either a predefined Hibernate 
10       * strategy or a fully qualified class name. 
11       */  
12      String strategy();  
13      /** 
14       * Optional generator parameters 
15       */  
16      Parameter[] parameters() default {};  
17     }

name屬性指定生成器名稱。
strategy屬性指定具體生成器的類名。
parameters得到strategy指定的具體生成器所用到的參數。

對於這些hibernate主鍵生成策略和各自的具體生成器之間的關系,在org.hibernate.id.IdentifierGeneratorFactory中指定了,

 1     static {  
 2       GENERATORS.put("uuid", UUIDHexGenerator.class);  
 3       GENERATORS.put("hilo", TableHiLoGenerator.class);  
 4       GENERATORS.put("assigned", Assigned.class);  
 5       GENERATORS.put("identity", IdentityGenerator.class);  
 6       GENERATORS.put("select", SelectGenerator.class);  
 7       GENERATORS.put("sequence", SequenceGenerator.class);  
 8       GENERATORS.put("seqhilo", SequenceHiLoGenerator.class);  
 9       GENERATORS.put("increment", IncrementGenerator.class);  
10       GENERATORS.put("foreign", ForeignGenerator.class);  
11       GENERATORS.put("guid", GUIDGenerator.class);  
12       GENERATORS.put("uuid.hex", UUIDHexGenerator.class); //uuid.hex is deprecated  
13       GENERATORS.put("sequence-identity", SequenceIdentityGenerator.class);  
14     }

上面十二種策略，加上native，hibernate一共默認支持十三種生成策略。

1、native

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "native")

2、uuid

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "uuid")

3、hilo

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "hilo")

4、assigned

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")

5、identity

1  @GeneratedValue(generator = "paymentableGenerator")    
2 @GenericGenerator(name = "paymentableGenerator", strategy = "identity")

6、select

1     @GeneratedValue(generator = "paymentableGenerator")  
2     @GenericGenerator(name="select", strategy="select",  
3          parameters = { @Parameter(name = "key", value = "idstoerung") })

7、sequence

1  @GeneratedValue(generator = "paymentableGenerator")  
2 @GenericGenerator(name = "paymentableGenerator", strategy = "sequence",   
3          parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

8、seqhilo

1     @GeneratedValue(generator = "paymentableGenerator")  
2     @GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",   
3              parameters = { @Parameter(name = "max_lo", value = "5") })

9、increment

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "increment")

10、foreign

1     @GeneratedValue(generator = "idGenerator")  
2     @GenericGenerator(name = "idGenerator", strategy = "foreign",   
3              parameters = { @Parameter(name = "property", value = "employee") })

注意：直接使用@PrimaryKeyJoinColumn 報錯

1     @OneToOne(cascade = CascadeType.ALL)   
2     @PrimaryKeyJoinColumn

例如

1     @Entity  
2     public class Employee {  
3       @Id Integer id;  
4           
5       @OneToOne @PrimaryKeyJoinColumn  
6       EmployeeInfo info;  
7       ...  
8     }

應該為

 1     @Entity  
 2     public class Employee {  
 3       @Id   
 4       @GeneratedValue(generator = "idGenerator")  
 5       @GenericGenerator(name = "idGenerator", strategy = "foreign",   
 6              parameters = { @Parameter(name = "property", value = "info") })   
 7       Integer id;  
 8           
 9       @OneToOne  
10       EmployeeInfo info;  
11       ...  
12     }

11、guid

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "guid")

12、uuid.hex

1     @GeneratedValue(generator = "paymentableGenerator")    
2     @GenericGenerator(name = "paymentableGenerator", strategy = "uuid.hex")

13、sequence-identity

1     @GeneratedValue(generator = "paymentableGenerator")  
2     @GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",   
3              parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

四、通過@GenericGenerator自定義主鍵生成策略
如果實際應用中，主鍵策略為程序指定了就用程序指定的主鍵（assigned），沒有指定就從sequence中取。
明顯上面所討論的策略都不滿足，只好自己擴展了，集成assigned和sequence兩種策略。

 1     public class AssignedSequenceGenerator extends SequenceGenerator implements   
 2      PersistentIdentifierGenerator, Configurable {  
 3      private String entityName;  
 4         
 5      public void configure(Type type, Properties params, Dialect dialect) throws MappingException {  
 6       entityName = params.getProperty(ENTITY_NAME);  
 7       if (entityName==null) {  
 8        throw new MappingException("no entity name");  
 9       }  
10         
11       super.configure(type, params, dialect);    
12      }  
13        
14      public Serializable generate(SessionImplementor session, Object obj)   
15       throws HibernateException {  
16         
17       Serializable id = session.getEntityPersister( entityName, obj )   
18         .getIdentifier( obj, session.getEntityMode() );  
19         
20       if (id==null) {  
21        id = super.generate(session, obj);  
22       }  
23         
24       return id;  
25      }  
26     }

實際應用中，定義同sequence。

1     @GeneratedValue(generator = "paymentableGenerator")  
2     @GenericGenerator(name = "paymentableGenerator", strategy = "AssignedSequenceGenerator",   
3          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 都支持

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 hibernate中的@GeneratedValue與@GenericGenerator @GeneratedValue和@GenericGenerator(轉) JPA之@GeneratedValue注解(轉) @GeneratedValue源碼解析 JPA @Id 和 @GeneratedValue 注解詳解 java springboot@GeneratedValue 注解 JPA @Id 和 @GeneratedValue 注解詳解如何使用通用Mapper及@GeneratedValue(generator = "JDBC") 理解JPA注解@GeneratedValue的使用方法 JPA 自動建表（3）- @Id，@GeneratedValue 與 @GenericGenerator 設置主鍵生成策略