JPA 注解及主键生成策略使用指南2-阿里云开发者社区

@OneToMany

描述一个一对多的关联，该属性应该为集体类型，在数据库中并没有实际字段。

属性说明：

fetch：表示抓取策略，默认为FetchType.LAZY，因为关联的多个对象通常不必从数据库预先读取到内存

cascade：表示级联操作策略,对于OneToMany类型的关联非常重要，通常该实体更新或删除时，其关联的实体也应当被更新或删除

例如：实体User和Order是OneToMany的关系，则实体User被删除时，其关联的实体Order也应该被全部删除

@ManyToOne、@ManyToMany

@ManyToOne

表示一个多对一的映射，该注解标注的属性通常是数据库表的外键

属性说明：

optional：是否允许该字段为null，该属性应该根据数据库表的外键约束来确定，默认为true

fetch：表示抓取策略，默认为FetchType.EAGER

cascade：表示默认的级联操作策略，可以指定为ALL，PERSIST，MERGE，REFRESH和REMOVE中的若干组合，默认为无级联操作

targetEntity：表示该属性关联的实体类型。该属性通常不必指定，ORM框架根据属性类型自动判断 targetEntity

@ManyToMany

描述一个多对多的关联。多对多关联上是两个一对多关联，但是在ManyToMany描述中，中间表是由ORM框架自动处理

属性说明：

targetEntity：表示多对多关联的另一个实体类的全名，例如：package.Book.class

mappedBy：表示多对多关联的另一个实体类的对应集合属性名称

两个实体间相互关联的属性必须标记为@ManyToMany，并相互指定targetEntity属性，需要注意的是，有且只有一个实体的@ManyToMany注解需要指定mappedBy属性，指向targetEntity的集合属性名称，利用ORM工具自动生成的表除了User和Book表外，还自动生成了一个User_Book表，用于实现多对多关联

@NamedStoredProcedureQuery

定义在一个实体上面声明存储过程。有多个存储过程，可以用@NamedStoredProcedureQueries。

name：自定义存储过程在java中的唯一别名，调用时使用；

procedureName：数据库中的存储过程名；

parameters：存储过程的参数

@StoredProcedureParameter：定义存储过程的参数属性

name：参数名。和数据库里的参数名字一样

mode：参数模式。ParameterMode.IN、OUT、INOUT、REF_CURSOR

type：参数数据类型。String.class、Integer.class，Long.class等

@JsonFormat、@DateTimeFormat

@JsonFormat

后端到前端的时间格式的转换。注意：该注解并非 JPA 注解。

// 出参时间格式化
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime;

也可以在配置文件中配置进行时间戳统一转换：

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

@DateTimeFormat

前端到后端的时间格式的转换。注意：该注解并非 JPA 注解。

// 入参出参时间格式化。请求报文只需要传入"yyyy-MM-dd HH:mm:ss"格式字符串进来，则自动转换为Date类型数据
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm")
private Date createTime;

主键生成策略

通用策略

@GeneratedValue 注解介绍

参考：JPA注解之“@GeneratedValue”详解

通过 annotation 来映射 hibernate 实体，基于 annotation 的 hibernate 主键标识 @Id，由 @GeneratedValue 设定其生成规则。

@GeneratedValue 注解用于标注主键的生成策略，通过 strategy 属性指定。

默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：

SqlServer 对应 identity

MySQL 对应 auto increment 。

源码定义：

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

其中GenerationType：

public enum GenerationType{    
    TABLE,    
    SEQUENCE,    
    IDENTITY,    
    AUTO   
}

JPA 提供的四种标准用法为：

AUTO：JPA 自动选择合适的策略，是默认选项

IDENTITY：采用数据库ID自增长的方式来自增主键字段。Oracle 不支持这种方式

TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植

SEQUENCE：通过序列产生主键，通过@SequenceGenerator 注解指定序列名。MySql不支持这种方式

AUTO、IDENTITY、SEQUENCE 策略

AUTO 策略
用法：

// 指定主键
@Id
// 指定主键生成策略，默认为 AUTO 
@GeneratedValue(strategy = GenerationType.AUTO)

IDENTITY 策略

用法：

@Id  
@GeneratedValue(strategy = GenerationType.IDENTITY)

SEQUENCE 策略

用法：

// 使用示例
@Id  
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator="aaa")  
@SequenceGenerator(name="aaa", sequenceName="seq_payment")

@SequenceGenerator 源码定义：

@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

TABLE 策略

用法示例：

@Id  
@GeneratedValue(strategy = GenerationType.TABLE, generator="pk_gen")  
@TableGenerator(
    name = "pk_gen",  
    table="tb_generator",  
    pkColumnName="gen_name",  
    valueColumnName="gen_value",  
    pkColumnValue="PAYABLEMOENY_PK",  
    allocationSize=1  
)

在主键生成后，这条纪录的 value 值，按 allocationSize 递增。
使用此策略需要数据库存在相应的表

-- 定义应用表 tb_generator
CREATE TABLE  tb_generator (  
  id NUMBER NOT NULL,  
  gen_name VARCHAR2(255) NOT NULL,  
  gen_value NUMBER NOT NULL,  
  PRIMARY KEY(id)  
)  
-- 插入纪录，供生成主键使用
INSERT INTO tb_generator(id, gen_name, gen_value) VALUES (1,PAYABLEMOENY_PK', 1);

@TableGenerator 的源码定义

@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标记中的用法类似；

hibernate 策略

hibernate 提供多种主键生成策略，有点是类似于 JPA，基于 Annotation 的方式通过 @GenericGenerator 注解实现。

@GenericGenerator 注解介绍

源码定义：

@Target({PACKAGE, TYPE, METHOD, FIELD})  
@Retention(RUNTIME)  
public @interface GenericGenerator {  
 String name();  
 String strategy();  
 Parameter[] parameters() default {};  
}

以上属性说明如下：

name 属性指定生成器名称；
strategy 属性指定具体生成器的类名；
parameters 得到strategy指定的具体生成器所用到的参数；

hibernate 特有策略

native：将主键的生成工作交由数据库完成，hibernate 不管（常用）

对于 oracle 采用 Sequence 方式，对于 MySQL 和 SQL Server 采用 identity（自增主键生成机制）

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

increment：插入数据的时候 hibernate 会给主键添加一个自增的主键，但是一个 hibernate 实例就维护一个计数器，所以在多个实例运行的时候不能使用这个方法

select：使用触发器生成主键（主要用于早期的数据库主键生成机制，少用）

sequence：调用底层数据库的序列来生成主键，要设定序列名，不然hibernate无法找到

seqhilo：通过 hilo 算法实现，但是主键历史保存在 Sequence 中

适用于支持 Sequence 的数据库，如 Oracle（比较少用）

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）版本

使用示例：

// uuid
@GeneratedValue(generator = "paymentableGenerator")    
@GenericGenerator(name = "paymentableGenerator", strategy = "uuid")
// 除以下所列特殊适配格式外，其他策略均采用上面第一种格式
// select
@GeneratedValue(generator = "paymentableGenerator")  
@GenericGenerator(name="select", strategy="select",  
                  parameters = { @Parameter(name = "key", value = "idstoerung") }) 
// sequence
@GeneratedValue(generator = "paymentableGenerator")  
@GenericGenerator(name = "paymentableGenerator", strategy = "sequence", 
                  parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })  
// seqhilo
@GeneratedValue(generator = "paymentableGenerator")  
@GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",  
                  parameters = { @Parameter(name = "max_lo", value = "5") })  
// foreign 
@GeneratedValue(generator = "idGenerator")  
@GenericGenerator(name = "idGenerator", strategy = "foreign", 
                  parameters = { @Parameter(name = "property", value = "employee") }) 
// sequence-identity
@GeneratedValue(generator = "paymentableGenerator")  
@GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",
                  parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

对于这些 hibernate 主键生成策略和各自的具体生成器之间的关系，在 org.hibernate.id.IdentifierGeneratorFactory 中指定了：

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一共默认支持十三种生成策略。

自定义策略

hibernate 每种主键生成策略提供接口 org.hibernate.id.IdentifierGenerator 的实现类，如果要实现自定义的主键生成策略也必须实现此接口。

IdentifierGenerator 提供一个 generate 方法，generate 方法返回产生的主键。

// 源码展示
public interface IdentifierGenerator {  
    public static final String ENTITY_NAME = "entity_name";  
  public Serializable generate(SessionImplementor session, Object object)   
    throws HibernateException;  
}

自定义主键生成策略

方式1：自定义类实现 IdentifierGenerator 接口
方式2：自定义类继承 hibernate 的主键生成器类（间接实现了 IdentifierGenerator 接口）
示例：

import org.hibernate.HibernateException;
import org.hibernate.MappingException;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.id.UUIDHexGenerator;
import org.hibernate.service.ServiceRegistry;
import org.hibernate.type.Type;
import java.io.Serializable;
import java.util.Properties;
/**
 * 自定义主键生成策略。实现自己设置ID，同时保留原来的主键生成策略（32位UUID）不变。
 * 调用的保存方法需为Repository.save()或EntityManager.merge()
 * 若调用的保存方法为EntityManager.persist()，且传入对象有id值时，仍会报错！
 */
public class CustomUUIDGenerator extends UUIDHexGenerator {
    private String entityName;
    @Override
    public void configure(Type type, Properties params, ServiceRegistry serviceRegistry) throws MappingException {
        entityName = params.getProperty(ENTITY_NAME);
        if (entityName == null) {
            throw new MappingException("no entity name");
        }
        super.configure(type, params, serviceRegistry);
    }
    @Override
    public Serializable generate(SharedSessionContractImplementor session, Object object) throws HibernateException {
        Serializable id = session.getEntityPersister(entityName, object).getIdentifier(object, session);
        if (id != null) {
            return id;
        }
        return super.generate(session, object);
    }
}

Entity 实体类中使用

@GeneratedValue(generator = "paymentableGenerator")  
@GenericGenerator(name = "paymentableGenerator", strategy = "{自定义主键生成策略的全限定类名}") 
private String id;

Repository 相关注解

Repository 相关注解主要在 SpringDataJpa 的 Repository 中使用。

@Query：自定义 JPQL 或原生 Sql 查询，摆脱命名查询的约束

@Query("select u from User u where u.firstname = :firstname")   // JPQL
User findByLastnameOrFirstname(@Param("lastname") String lastname);
@Query(value = "SELECT * FROM USERS WHERE X = ?1", nativeQuery = true)  // 原生sql
User findByEmailAddress(String X);

关于 @**Query **中参数的占位符：

方式1：标识符 :参数名

可以定义好参数名，赋值时采用 @Param(“参数名”)，而不用管顺序。

方式2：使用索引下标 ?索引值

索引值从 1 开始，查询中 ”?X” 个数需要与方法定义的参数个数相一致，并且顺序也要一致。

@Modifying：DELETE 和 UPDATE 操作必须加上 @modifying 注解，以通知 Spring Data 这是一个 DELETE 或 UPDATE 操作

@Transactional：UPDATE 或者 DELETE 操作需要使用事务

@Async：异步操作

@NoRepositoryBean：避免 Spring 容器为此接口创建实例。

不被Service层直接用到的Repository（如base repository）均应加此声明

可用于定义公共 Repository，并将业务中用到的公共方法抽离到公共Repository中

@NoRepositoryBean
public interface BaseRepository<T, ID> {
    @Modifying
    @Query("update #{#entityName} set isDelete='N' where id in ?1 ")
    Integer myUpdateAsNotDeleted(Collection<String> ids);
}

JPA 注解及主键生成策略使用指南2

@ManyToOne、@ManyToMany

@NamedStoredProcedureQuery

@JsonFormat、@DateTimeFormat

主键生成策略

通用策略

@GeneratedValue 注解介绍

AUTO、IDENTITY、SEQUENCE 策略

TABLE 策略

hibernate 策略

@GenericGenerator 注解介绍

hibernate 特有策略

自定义策略

Repository 相关注解

热门文章

最新文章

相关电子书