带你一同认识和使用JPA框架进行开发你的应用服务
- 什么是JPA框架
- JPA持久层框架
- 使用JPA实现持久化
- JPA注解介绍
- 按类别划分的 JPA注解
- 实体注解@Entity
- 模型注解@Table
- 示例-显示了如何使用此批注指定主表名。
- 注解@TableGenerator
- @TableGenerator主要属性
- strategy
- strategy属性可以是下列枚举值:
- 注解@GeneratedValue
- 示例@TableGenerator
- @id
- 使用案例
- 结论
什么是JPA框架
JPA(Java Persistence API)是一种Java ORM(Object-Relational Mapping)规范,它提供了一种简单的方式来映射 Java 对象到关系型数据库中的表。JPA 是一个标准,而不是一个具体的实现,因此需要使用一个具体的 JPA 实现来实现 JPA 规范。在本文中,我们将介绍 JPA 的持久层框架以及如何使用 JPA 实现持久化。
JPA持久层框架
JPA 持久层框架是一个实现 JPA 规范的框架,它提供了一种简单的方式来实现持久化。以下是一些常用的 JPA 持久层框架:
-
Hibernate:Hibernate 是一个流行的 Java ORM 框架,它提供了一种简单的方式来映射 Java 对象到关系型数据库中的表。Hibernate 是 JPA 规范的一个实现,因此它支持 JPA 的所有特性。
-
EclipseLink:EclipseLink 是一个开源的 Java ORM 框架,它提供了一种简单的方式来映射 Java 对象到关系型数据库中的表。EclipseLink 也是 JPA 规范的一个实现,因此它支持 JPA 的所有特性。
-
OpenJPA:OpenJPA 是一个 Apache 项目,它提供了一种简单的方式来映射 Java 对象到关系型数据库中的表。OpenJPA 也是 JPA 规范的一个实现,因此它支持 JPA 的所有特性。
使用JPA实现持久化
使用 JPA 实现持久化需要进行以下步骤:
-
定义实体类:定义一个 Java 类来表示数据库中的表。该类必须使用 @Entity 注解进行注释,并且必须具有一个唯一的标识符属性,该属性必须使用 @Id 注解进行注释。
-
配置持久化单元:在 persistence.xml 文件中配置持久化单元。持久化单元是一个逻辑单元,它包含了与数据库交互所需的所有信息,例如数据库连接信息、实体类信息等。
-
创建 EntityManager:使用 EntityManagerFactory 创建 EntityManager。EntityManager 是 JPA 中最重要的接口之一,它提供了一种简单的方式来管理实体类的生命周期。
-
操作实体类:使用 EntityManager 对实体类进行 CRUD(Create、Read、Update、Delete)操作。例如,使用 EntityManager 的 persist() 方法将一个新的实体类对象保存到数据库中。
JPA注解介绍
我们可以将任何普通的旧式Java 对象 (POJO) 类指定为 JPA 实体:使用JPA持久化提供程序的服务将其非临时字段持久保存到关系数据库的Java对象。
我们可以使用注解配置实体的JPA行为,注解是一种使用元数据修饰 Java 源代码的简单表达方法,它编译为相应的 Java 类文件,以便在运行时由 JPA 持续性提供程序解释以管理 JPA 行为。
我们可以将Java 类指定为JPA 实体,请使用 @Entity 批注,如下所示:
@Entity
public class Object2 implements Serializable {...
}
JPA主要广泛引用了JSR-220 Enterprise JavaBean版本3.0,Java持续性API规范。
按类别划分的 JPA注解
默认情况下,JPA持续性提供程序假设Java类是非持续类,并且仅当使用此批注对其进行修饰的情况下才可用于 JPA 服务。
实体注解@Entity
使用此注解将普通的Java 对象 (POJO) 类指定为实体,以便可以将它用于 JPA 服务。要将类用于JPA服务,必须将该类指定为 JPA 实体。
@Entity(name="EntityName")
该注解必须要进行添加到对应的POJO类模型上面的,其中,属性name为可选填写,代表着对应数据库中一的个表的名称。
模型注解@Table
默认情况下,JPA 持续性提供程序假设实体的所有持久字段均存储到一个名称为实体名称的数据库表中。
在以下条件下,使用 @Table 批注指定与实体关联的主表:
实体名称难于处理、是一个保留字、与预先存在的数据模型不兼容或作为数据库中的表名无效需要控制表所属的目录或模式
@Table(name="",catalog="",schema="")
注解本身可选进行配置,通常和@Entity结合使用,只能配置在实体的class定义处,表示实体对应的数据库表的信息。
- name : 可选 , 表示表的名称,默认与表名和实体名称一致,只有在不一致的情况下才需要指定表名。
- 默认值:JPA 持续性提供程序假设实体的数据库表与实体类同名。如果实体类名难以处理、是一个保留字或与预先存在的数据模型不兼容,请将 name 设置为相应的数据表名称。
- catalog : 可选 , 表示Catalog名称,默认为Catalog(“”).
- 默认值:JPA 持续性提供程序使用任何适用于数据库的默认目录。 如果默认目录不适合于应用程序,请将 catalog 设置为要使用的 String 目录名。
- schema : 可选 , 表示Schema名称,默认为Schema(“”).
- 默认值:JPA 持续性提供程序使用任何适用于数据库的默认模式。 如果默认模式不适合于应用程序,请将 schema 设置为要使用的 String 模式名。
- uniqueConstraints:默认值:JPA 持续性提供程序假设实体的数据库表中的任何列均没有唯一约束。
- 如果唯一约束应用于该表中的一列或多列,请将 uniqueContraints 设置为一个或多个 UniqueConstraint 实例的数组。
示例-显示了如何使用此批注指定主表名。
@Entity
@Table(name="EMP")
public class Employee implements Serializable { ...
}
注解@TableGenerator
如果使用@GeneratedValue注解指定一个TABLE类型的主键生成器,可以使用@TableGenerator注解微调该主键生成器。
- 由于名称难于处理、是一个保留字、与预先存在的数据模型不兼容或作为数据库中的表名无效而更改主键生成器的表名称
- 更改分配大小以匹配应用程序要求或数据库性能参数
- 更改初始值以匹配现有的数据模型(例如,如果基于已经为其分配或保留了一组主键值的现有数据集构建)
- 使用特定目录或模式配置主键生成器的表
- 在主键生成器表的一列或多列商配置一个唯一的约束
@TableGenerator主要属性
-
name:SequenceGenerator的名称必须匹配其stategy设置为stategy的GeneratedValue的名称。
-
allocationSize:默认情况下,JPA 持续性提供程序使用的分配大小为 50。如果此分配大小与应用程序要求或数据库性能参数匹配。
-
catalog:默认值:JPA 持续性提供程序使用任何适用于数据库的默认目录。
如果默认目录不适合于应用程序,请将 catalog 设置为要使用的 String 目录名。 -
GeneratedValue:可以支持两个属性 strategy和 generator。
-
initialValue:默认情况下,JPA 持续性提供程序将所有主键值的起始值设置为 0。请将它设置与现有数据模型匹配的值。
-
pkColumnName:默认值:JPA 持续性提供程序为生成器表中的主键列提供名称。如果该名称不适合于应用程序,请将 pkColumnName 设置为所需的 String 名称。
-
pkColumnValue:默认值:JPA持续性提供程序为生成器表中的主键列提供一个合适的主键值。如果该值不适合于应用程序,请将pkColumnValue设置为所需的 String 值。
strategy
strategy表示主键生成策略,strategy是GenerationType类型的枚举值有AUTO、INDENTITY、SEQUENCE和TABLE4种,分别表示让ORM框架自动选择。
strategy属性可以是下列枚举值:
- GeneratorType.AUTO:表示实体标识由 OpenJPA 容器自动生成,这也是 Strategy 属性的默认值。
- GenerationType.IDENTITY:OpenJPA 容器将使用数据库的自增长字段为新增加的实体对象赋唯一值,作为实体的标识。这种情况下需要数据库提供对自增长字段的支持,常用的数据库中,HSQL、SQL Server、MySQL、DB2、Derby 等数据库都能够提供这种支持。
- GenerationType.SEQUENCE:表示使用数据库的序列号为新增加的实体对象赋唯一值,作为实体的标识。这种情况下需要数据库提供对序列号的支持,常用的数据库中,Oracle、PostgreSQL 等数据库都能够提供这种支持。
- GenerationType.TABLE:表示使用数据库中指定表的某个字段记录实体对象的标识,通过该字段的增长为新增加的实体对象赋唯一值,作为实体的标识。
注解@GeneratedValue
默认情况下,JPA 持续性提供程序管理为实体主键提供的唯一标识符。如果要微调此机制以实现以下目的,请使用 @GeneratedValue 批注。
-
strategy:默认值:GenerationType.AUTO表示主键生成策略,根据数据库的Identity字段生成,根据数据库表的Sequence字段生成,以有根据一个额外的表生成主键。默认情况下,JPA 持续性提供程序选择最适合于基础数据库的主键生成器类型。如果您感觉另一个生成器类型更适合于数据库或应用程序,请将 strategy 设置为所需的 GeneratorType:
- IDENTITY — 指定持续性提供程序使用数据库身份列
- AUTO — 指定持续性提供程序应选择一个最适合于基础数据库的主键生成器。
- SEQUENCE — 指定持续性提供程序使用数据库序列
- TABLE — 指定持续性提供程序为使用基础数据库表的实体分配主键以确保唯一性
-
generator:表示主键生成器的名称,这个属性通常和ORM框架相关,例如,Hibernate可以指定uuid等主键生成方式。
- 默认值:JPA 持续性提供程序为它选择的主键生成器分配一个名称。如果该名称难于处理、是一个保留字、与事先存在的数据模型不兼容或作为数据库中的主键生成器名称无效,则将 generator 设置为要使用的 String 生成器名称
@GeneratedValue(strategy=GenerationType,generator="")
示例@TableGenerator
@Entity
public class Employee implements Serializable {@TableGenerator( name="empGen",allocationSize=1)@GeneratedValue(strategy=TABLE, generator="empGen")@Column(name="CUST_ID")public Long getId() { return id; }
}
显示了如何使用此批注指示持续性提供程序使用名为CUST_SEQ、类型为 GeneratorType.SEQUENCE 的主键生成器。
@Entity
public class Employee implements Serializable {...
@Id
@GeneratedValue(strategy=SEQUENCE, generator="CUST_SEQ")
@Column(name="CUST_ID")
public Long getId() {
return id; }...
}
@id
@id定义了映射到数据库表的主键的属性,置于getXxxx()上面。使用@Id批注将一个或多个持久字段或属性指定为实体的主键。
对于每个实体,必须至少指定以下项之一:
- 一个 @Id
- 多个@Id 和一个@IdClass(对于复合主键)
- 一个 @EmbeddedId
默认情况下,JPA持久化提供程序选择最合适的主键生成器并负责管理主键值:您不必采取任何进一步的操作。如果要使用 JPA 持续性提供程序的默认键生成机制,则不必采取任何进一步的操作。
使用案例
显示了如何使用此批注将持久字段 empID 指定为 Employee 表的主键。
@Entity
public class Employee implements Serializable {
@Id
private int empID;...
}
整体结合GeneratedValues注解进行设置对应的主键。
@Id
@GeneratedValues(strategy=StrategyType.SEQUENCE)
public int getPk() { return pk;
}
结论
JPA 是一个非常强大的 Java ORM 规范,它提供了一种简单的方式来映射 Java 对象到关系型数据库中的表。JPA 持久层框架是实现 JPA 规范的框架,它提供了一种简单的方式来实现持久化。在使用 JPA 实现持久化时,我们需要定义实体类、配置持久化单元、创建 EntityManager,并使用 EntityManager 对实体类进行 CRUD 操作。