所有文章 分类 标签 笔记 文档 关于 简体中文

目录

JPA @Id 和 @GeneratedValue 注解详解

KKKPSJKEY 收录于 Back 笔记
   约 6493 字   预计阅读 13 分钟    次阅读  
/jpa-id-gnrtvlu/featured-image.jpg

解释

@Id

@Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前，可与声明语句同行，也可写在单独行上。 @Id标注也可置于属性的getter方法之前。

@GeneratedValue

@GeneratedValue 用于标注主键的生成策略，通过strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer对应identity，MySQL 对应 auto increment。 在javax.persistence.GenerationType中定义了以下几种可供选择的策略：

  • IDENTITY：采用数据库ID自增长的方式来自增主键字段，Oracle 不支持这种方式；
  • AUTO： JPA自动选择合适的策略，是默认选项；
  • SEQUENCE：通过序列产生主键，通过@SequenceGenerator 注解指定序列名，MySql不支持这种方式
  • TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

推荐的两种写法：

属性之上：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

@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;
    }

getter方法之上：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

@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;
    }

注意

但是不能某个注解在属性之上，某个注解在getter之上，将抛出异常，对其他注解也相同

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

@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;
    }

上面的写法是错误的

一、JPA通用策略生成器

通过annotation来映射hibernate实体的,基于annotation的hibernate主键标识为@Id, 其生成规则由@GeneratedValue设定的.这里的@id和@GeneratedValue都是JPA的标准用法, JPA提供四种标准用法,由@GeneratedValue的源代码可以明显看出.

Java代码

1
2
3
4
5
6

@Target({METHOD,FIELD})    
    @Retention(RUNTIME)    
    public @interface GeneratedValue{    
        GenerationType strategy() default AUTO;    
        String generator() default "";    
    }

1、GenerationType:

Java代码

1
2
3
4
5
6
7
8
9

@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代码

1
2
3
4
5
6

CREATE TABLE  tb_generator (  
  id NUMBER NOT NULL,  
  gen_name VARCHAR2(255) NOT NULL,  
  gen_value NUMBER NOT NULL,  
  PRIMARY KEY(id)  
)

插入纪录，供生成主键使用，

Sql代码

1

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

在主键生成后，这条纪录的value值，按allocationSize递增。

@TableGenerator的定义：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

@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代码

1
2
3

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

@SequenceGenerator定义

Java代码

1
2
3
4
5
6
7
8

@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代码

1
2

@Id 
@GeneratedValue(strategy = GenerationType.IDENTITY)

4、AUTO

Java代码

1
2

@Id 
@GeneratedValue(strategy = GenerationType.AUTO)

在指定主键时，如果不指定主键生成策略，默认为AUTO。

Java代码

1

@Id

跟下面的定义是一样的。

Java代码

1
2

@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代码

1
2
3
4
5

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代码

1
2

@Id 
@GeneratedValue(GenerationType.AUTO)

就可以用hibernate特有以下用法来实现

Java代码

1
2

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

@GenericGenerator的定义:

Java代码

1
2
3
4
5
6
7

@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代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

**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代码

1
2

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

2、uuid

Java代码

1
2

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

3、hilo

Java代码

1
2

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

4、assigned

Java代码

1
2

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

5、identity

Java代码

1
2

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

6、select

Java代码

1
2
3

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

7、sequence

Java代码

1
2
3

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

8、seqhilo

Java代码

1
2
3

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

9、increment

Java代码

1
2

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

10、foreign

Java代码

1
2
3

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

注意：直接使用@PrimaryKeyJoinColumn 报错（?）

Java代码

1
2

@OneToOne(cascade = CascadeType.ALL)  
@PrimaryKeyJoinColumn

例如

Java代码

1
2
3
4
5
6
7

@Entity 
**public** **class** Employee { 
 @Id Integer id; 
 @OneToOne @PrimaryKeyJoinColumn 
 EmployeeInfo info; 
 ... 
}

应该为

Java代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

@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代码

1
2

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

12、uuid.hex

Java代码

1
2

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

13、sequence-identity

Java代码

1
2
3

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

四、通过@GenericGenerator自定义主键生成策略

如果实际应用中，主键策略为程序指定了就用程序指定的主键（assigned），没有指定就从sequence中取。 明显上面所讨论的策略都不满足，只好自己扩展了，集成assigned和sequence两种策略。

Java代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

**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代码

1
2
3

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

四种数据库的支持情况如下：

数据库名称 支持的id策略
mysql GenerationType.TABLEGenerationType.AUTOGenerationType.IDENTITY**不支持GenerationType.SEQUENCE* *
oracle strategy=GenerationType.AUTOGenerationType.SEQUENCEGenerationType.TABLE**不支持GenerationType.IDENTITY* *
postgreSQL GenerationType.TABLEGenerationType.AUTOGenerationType.IDENTITYGenerationType.*SEQUENCE都支持 *
kingbase GenerationType.TABLEGenerationType.SEQUENCEGenerationType.IDENTITYGenerationType.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代码

1
2
3
4

@Id 
@GeneratedValue(strategy = GenerationType.TABLE, generator = "roleSeq") 
@TableGenerator(name = "roleSeq", allocationSize = 1, table = "seq_table", pkColumnName = "seq_id", valueColumnName = "seq_count") 
**private** Integer id;

在以上例子中,roleSeq唯一的标识了该生成器,在@GeneratedValue注解中的generator属性可以根据此标识来声明主键生成器。

2.GenerationType.SEQUENCE

在某些数据库中,不支持主键自增长,比如Oracle,其提供了一种叫做"序列(sequence)“的机制生成主键。此时,GenerationType.SEQUENCE就可以作为主键生成策略。该策略的不足之处正好与TABLE相反,由于只有部分数据库(Oracle,PostgreSQL,DB2)支持序列对象,所以该策略一般不应用于其他数据库。类似的,该策略一般与另外一个注解一起使用@SequenceGenerator,@SequenceGenerator注解指定了生成主键的序列.然后JPA会根据注解内容创建一个序列(或使用一个现有的序列)。如果不指定序列,则会自动生成一个序列SEQ_GEN_SEQUENCE。类似于

Java代码

1
2
3
4

@Id 
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "menuSeq") 
@SequenceGenerator(name = "menuSeq", initialValue = 1, allocationSize = 1, sequenceName = "MENU_SEQUENCE") 
**private** Integer id;

同样,在以上例子中,menuSeq唯一的标识了该生成器,@SequenceGenerator可以理解为将数据库中存在的序列进行了一个映射,在@GeneratedValue注解中的generator属性可以根据此标识来声明主键生成器。

3.GenerationType.IDENTITY

此种主键生成策略就是通常所说的主键自增长,数据库在插入数据时,会自动给主键赋值,比如MYSQL可以在创建表时声明"auto_increment” 来指定主键自增长。该策略在大部分数据库中都提供了支持(指定方法或关键字可能不同),但还是有少数数据库不支持,所以可移植性略差。使用自增长主键生成策略是只需要声明strategy = GenerationType.IDENTITY即可。类似于

Java代码

1
2
3

@Id 
@GeneratedValue(strategy = GenerationType.IDENTITY) 
**private** Integer id;

需要注意的是,同一张表中自增列最多只能有一列。

4.GenerationType.AUTO

把主键生成策略交给持久化引擎(persistence engine),持久化引擎会根据数据库在以上三种主键生成策略中选择其中一种。此种主键生成策略比较常用,由于JPA默认的生成策略就是GenerationType.AUTO,所以使用此种策略时.可以显式的指定@GeneratedValue(strategy = GenerationType.AUTO)也可以直接@GeneratedValue

类似于

Java代码

1
2

@GeneratedValue(strategy = GenerationType.AUTO) 
**private** Integer id;

或

Java代码

1
2

@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

更新于 2021-07-16
阅读原始文档
 Java, Jpa
返回 | 主页