2. 程式人生 > >JPA註解“@GeneratedValue”詳解

JPA註解“@GeneratedValue”詳解

阿新 • • 發佈：2017-11-19
建立 說明 getprop ... ger div 創建 算法 運行

轉載

一、JPA通用策略生成器

通過annotation來映射hibernate實體的，基於annotation的hibernate主鍵標識為@Id，

其生成規則是由@GeneratedValue設定的。這裏的@id和@GeneratedValue都是JPA的標準用法。

JPA提供四種標準用法，由@GeneratedValue的源代碼可以明顯看出：

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

其中GenerationType:

[java] view plain copy
  1. public enum GenerationType{
  2. TABLE,
  3. SEQUENCE,
  4. IDENTITY,
  5. AUTO
  6. }


JPA提供的四種標準用法為TABLE，SEQUENCE，IDENTITY，AUTO。


a，TABLE：使用一個特定的數據庫表格來保存主鍵。
b，SEQUENCE：根據底層數據庫的序列來生成主鍵，條件是數據庫支持序列。
c，IDENTITY：主鍵由數據庫自動生成（主要是自動增長型）
d，AUTO：主鍵由程序控制。

1、TABLE

[java] view plain copy
  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，定義為：

[sql] view plain copy
  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. )

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

[sql] view plain copy
  1. INSERT INTO tb_generator(id, gen_name, gen_value) VALUES (1,PAYABLEMOENY_PK‘, 1);

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


@TableGenerator的定義：

[java] view plain copy
  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

[java] view plain copy
  1. @Id
  2. @GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")
  3. @SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")

@SequenceGenerator定義：

[java] view plain copy
  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

[java] view plain copy
  1. @Id
  2. @GeneratedValue(strategy = GenerationType.IDENTITY)

4、AUTO

@Id
@GeneratedValue(strategy = GenerationType.AUTO)

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

例：

[java] view plain copy
  1. @Id

此時主鍵生成策略，為默認值AUTO。

以下指定主鍵生成策略為AUTO，效果同上：

[java] view plain copy
  1. @Id
  2. @GeneratedValue(strategy = GenerationType.AUTO)
[java] view plain copy
  1. </pre><pre name="code" class="java">

二、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的實現類，如果要實現自定義的主鍵生成策略也必須實現此接口。

[java] view plain copy
  1. public interface IdentifierGenerator {
  2. /**
  3. * The configuration parameter holding the entity name
  4. */
  5. public static final String ENTITY_NAME = "entity_name";
  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標準用法：

[java] view plain copy
  1. @Id
  2. @GeneratedValue(GenerationType.AUTO)

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

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")

@GenericGenerator的定義：

[java] view plain copy
  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中指定了：

[java] view plain copy
  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

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "native")

2、uuid

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "uuid")


3、hilo

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "hilo")

4、assigned

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")

5、identity

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "identity")

6、select

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name="select", strategy="select", parameters = { @Parameter(name = "key", value = "idstoerung") })

7、sequence

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "sequence", parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

8、seqhilo

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo", parameters = { @Parameter(name = "max_lo", value = "5") })

9、increment

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "increment")

10、foreign

[java] view plain copy
  1. @GeneratedValue(generator = "idGenerator")
  2. @GenericGenerator(name = "idGenerator", strategy = "foreign", parameters = { @Parameter(name = "property", value = "employee") })

註意：直接使用@PrimaryKeyJoinColumn 報錯（?）

@OneToOne(cascade = CascadeType.ALL)

@PrimaryKeyJoinColumn

例：

[java] view plain copy
  1. @Entity
  2. public class Employee {
  3. @Id Integer id;
  5. @OneToOne @PrimaryKeyJoinColumn
  6. EmployeeInfo info;
  7. ...
  8. }

以上代碼將會報錯，應該改為：

[java] view plain copy
  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;
  9. @OneToOne
  10. EmployeeInfo info;
  11. ...
  12. }

11、guid

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "guid")

12、uuid.hex

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "uuid.hex")

13、sequence-identity

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

四、通過@GenericGenerator自定義主鍵生成策略

如果實際應用中，主鍵策略為程序指定了就用程序指定的主鍵（assigned），沒有指定就從sequence中取。

明顯上面所討論的策略都不滿足，只好自己擴展了，集成assigned和sequence兩種策略。

[java] view plain copy
  1. public class AssignedSequenceGenerator extends SequenceGenerator implements
  2. PersistentIdentifierGenerator, Configurable {
  3. private String entityName;
  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. }
  11. super.configure(type, params, dialect);
  12. }
  14. public Serializable generate(SessionImplementor session, Object obj)
  15. throws HibernateException {
  17. Serializable id = session.getEntityPersister( entityName, obj )
  18. .getIdentifier( obj, session.getEntityMode() );
  20. if (id==null) {
  21. id = super.generate(session, obj);
  22. }
  24. return id;
  25. }
  26. }

實際應用中，定義同sequence。

[java] view plain copy
  1. @GeneratedValue(generator = "paymentableGenerator")
  2. @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”詳解

建立 說明 getprop ... ger div 創建 算法 運行 轉載 一、JPA通用策略生成器 通過annotation來映射hibernate實體的，基於annotation的hibernate主鍵標識為@Id， 其生成規則是由@GeneratedValue設定的

JPA註解大全詳解參考手冊

JPA註釋詳解參考手冊 JPA和Hibernate的關係 JPA（Java Persistence API），是Java EE 5的標準ORM介面，也是ejb3規範的一部分。 Hibernate是之前很流行的ORM框架，也是JPA的一個實現，其它還

SpringMVC原理及非註解配置詳解

ges 控制器 sof 靈活 size 實現 query -c requests 1. Spring介紹 　　Spring MVC是Spring提供的一個強大而靈活的web框架。借助於註解，Spring MVC提供了幾乎是POJO的開發模式，使得控制器的開發和測試更加簡單

spring AOP解析之註解方式詳解

parser 分享 pro asp mes aop log space spec 命名空間處理器是AopNamespaceHandler，我們可以看到這裏註冊了幾個解析器，第一個我們知道是xml形式的解析，接下來我們看AspectJAutoProxyBeanDefiniti

Java中的註解的詳解

oca 目的 它的 解包 log 重寫 XML variable ted 詳解Java中的註解 在Java中，註解(Annotation)引入始於Java5，用來描述Java代碼的元信息，通常情況下註解不會直接影響代碼的執行，盡管有些註解可以用來做到影響代碼執行。 註解

Spring Boot中使用MyBatis註解配置詳解（1）

sql type .org 實體 sch 整合 PE 匯總 同傳 之前在Spring Boot中整合MyBatis時，采用了註解的配置方式，相信很多人還是比較喜歡這種優雅的方式的，也收到不少讀者朋友的反饋和問題，主要集中於針對各種場景下註解如何使用，下面就對幾種常見的情況舉

Java 基礎之--註解Annotation詳解

註解 java 基礎 time span face 自定義註解 div ace rtu 自定義註解入門： public @interface Annotation01 { //set default value ""; String value() de

6. Spring：Java註解技術詳解

6. Spring：Java註解技術詳解 自定義註解示例：https://blog.csdn.net/wangpengzhi19891223/article/details/78131137/ Java註解技術基本概念 Annotation是Java5開始引入的新特徵。中文

springboot中使用Mybatis註解配置詳解

版權宣告：本文為博主原創文章，未經博主允許不得轉載。    https://blog.csdn.net/Winter_chen001/article/details/78623700 之前寫了關於Spring boot Mybatis 整合（註解版） 中使用了簡單的註解

Spring註解標籤詳解@Autowired @Qualifier

@Autowired spring2.1中允許使用者通過@Autowired註解對Bean的屬性變數.屬性Setter方法以及建構函式進行標註,配合AutowiredAnnotationBeanProcessor完成Bean的自動配置。使用@Autowired註釋進行byType注入。 在a

spring bean註解使用詳解

@Bean 的用法 @Bean是一個方法級別上的註解，主要用在@Configuration註解的類裡，也可以用在@Component註解的類裡。新增的bean的id為方法名 定義bean 下面是@Configuration裡的一個例子 @Configuration publi

Spring 註解@Value詳解

一 配置方式 @value需要引數，這裡引數可以是兩種形式： @Value("#{configProperties['t1.msgname']}")或者@Value("${t1.msgname}")； 這兩形式，在配置上有什麼區別： 1、@Value("#{configPrope

ioc註解原理詳解

一、@Autowired     作為一個spring開發者對@Autowired註解必定是非常瞭解了, 顧名思義自動裝配，應該是Spring會自動將我們標記為@Autowired的元素裝配好，與其猜測不如看看它的定義： @Target({ElementType.CONSTRUCTOR, 

Spring註解標籤詳解@Autowired @Qualifier等 @Slf4j

 @Slf4j @Slf4j註解實現日誌輸出       自己寫日誌的時候，肯定需要: private final Logger logger = LoggerFactory.getLogger(LoggerTest.class);1每次寫新的類

springmvc常用註解標籤詳解

1、@Controller 在SpringMVC 中，控制器Controller 負責處理由DispatcherServlet 分發的請求，它把使用者請求的資料經過業務處理層處理之後封裝成一個Model ，然後再把該Model 返回給對應的View 進行展示。在Spring

Spring Boot中使用MyBatis註解配置詳解

   轉自翟永超 之前在Spring Boot中整合MyBatis時，採用了註解的配置方式，相信很多人還是比較喜歡這種優雅的方式的，也收到不少讀者朋友的反饋和問題，主要集中於針對各種場景下註解如何使用，下面就對幾種常見的情況舉例說明用法。 在做下面的示例之前，先準備一

註解用法詳解——@SuppressWarnings

作為一名有強迫症的程式設計師最見不得的事情之一就是程式裡有警告出現，還有一大困擾就是在eclipse IDE中，起碼前面有警告時會無法加入斷點。一般來講大多數警告是程式碼不規範或安全警告，這些警告基本都

Spring 註解@Transactional詳解

在service類前加上@Transactional，宣告這個service所有方法需要事務管理。每一個業務方法開始時都會開啟一個事務。 Spring預設情況下會對執行期例外(RunTimeException)進行事務回滾。這個例外是unchecked如果遇到checked意外

註解用法詳解——@Override

一、前言   現在有Son和Parent兩個類，且型別Son將會重寫型別Parent的getName函式。但不幸的是由於碼農大意，寫成如下程式碼： public class Parent{ public String getName(){ return "

Java魔法堂：註解用法詳解——@Override

一、前言　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　   現在有Son和Parent兩個類，且型別Son將會重寫型別Parent的getName函式。但不幸的是由於碼農大意，寫成如下程式碼： public class Parent{ public String g