本篇介绍与演示JPA的基本API的使用,包括实体的插入、查找、更新和删除。
本篇演示环境- JPA 2.2
- Hibernate 5.6.9.Final
- MySQL 8
- JUnit 5.8.2
- 开发IDE:Eclipse 2021-06 (4.20.0)
本篇使用JUnit 5 演示API的使用, 这里仅列出表和数据以及实体类的定义, 完整的环境搭建部分可以参考 : 在Eclipse下搭建JPA项目(HIbernate + MySQL)
表和数据的准备在MySQL 下执行如下语句:
-- 创建数据库 create database jpaency; -- 使用数据库 use jpaency; -- 创建表 CREATE TABLE USR ( id INT NOT NULL COMMENT '主键', name varchar(30) NOT NULL COMMENT '姓名', PRIMARY KEY (id) )ENGINE=InnoDB DEFAULT CHARSET=utf8; -- 插入数据 INSERT INTO USR(ID,NAME) VALUES(1,'刘备') ; INSERT INTO USR(ID,NAME) VALUES(2,'关羽') ; INSERT INTO USR(ID,NAME) VALUES(3,'张飞') ;
数据库准备完成后的数据如下:
@Entity
public class Usr {
@Id
private Integer id;
private String name;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
JUnit 5 单元测试类准备
将EntityManager的初始化和资源释放放在整个测试类中
package com.osxm.jpa.api;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import com.osxm.jpa.entity.Usr;
public class APITests {
private static EntityManagerFactory entityManagerFactory;
private static EntityManager entityManager;
@BeforeAll
public static void setup() {
String persistenceUnitName = "jpaency_mysql";
entityManagerFactory = Persistence.createEntityManagerFactory(persistenceUnitName);
entityManager = entityManagerFactory.createEntityManager();
}
@AfterAll
public static void destroy() {
entityManager.close();
if (entityManagerFactory != null) {
entityManagerFactory.close();
}
}
}
API演示
1. EntityManager find() 方法
根据主键,查找对象。
先查找缓存, 找不到再发送SQL语句查询数据库, 如果数据库也不存在, 则返回null 的对象。
Usr usr = entityManager.find(Usr.class, 1L);
完整的测试代码如下:
@Test
public void find() {
Usr usr = entityManager.find(Usr.class, 1);
usr.setName("刘备");
Assertions.assertEquals("刘备",usr.getName());
}
2. EntityManager refresh() 方法
将数据库中的数据刷新到Managed的实体中。
使用JUnit 的调试方式运行以下代码, 在下面标注的地方加上断点, 并且在进入断点时更新数据库,
update Usr set name='刘玄德' where id=1; 。 随后使用refresh方法将数据库的改动更新到实体上。
@Test
public void refresh() {
Usr usr = entityManager.find(Usr.class, 1);
usr.setName("刘备");
Assertions.assertEquals("刘备",usr.getName());
//下面一行代码添加断点, 手动修改Db, 刘备-> 刘玄德,或者执行 update Usr set name='刘玄德' where id=1;
//如果不Refresh ,则取不到最新值
entityManager.refresh(usr);
Assertions.assertEquals("刘玄德",usr.getName());
}
3. EntityManager persist() 方法
保存到数据库并且保持对象的Managed状态。
JPA发送insert 语句的时机与主键策略有关:
- 主键自动生成, 则该方法后立即发送insert到数据库
- 如果主键手动设置, 则commit 时发送insert 语句
示例代码:
@Test
public void persist() {
Usr usr = new Usr();
usr.setId(4);
usr.setName("赵云");
entityManager.getTransaction().begin();
entityManager.persist(usr);
entityManager.getTransaction().commit();//主键手动设置,事务提交时发送SQL
System.out.println("Done");
}
4. EntityManager merge() 方法
merge() 方法 用来更新或是插入。
- merge() 不会改变传入实体的状态
- merge() 返回一个Managed状态的实体
- 如果插入无id 的实体, 如果id 不是自动生成, 则会抛出异常
- 插入有id 实体,如果数据库没有,则创建;已经已经存在,则更新。
示例:
@Test
public void merge() {
Usr usr = new Usr();
usr.setId(4);
usr.setName("赵云");
entityManager.getTransaction().begin();
entityManager.merge(usr);
entityManager.getTransaction().commit();
}
5. EntityManager flush() 方法
将Managed状态的实体的数据更新到数据库(不需要等到commit)。
执行的示例代码如下:
@Test
public void flush() {
Usr usr = entityManager.find(Usr.class,4);
usr.setName("赵云3");
entityManager.getTransaction().begin();
entityManager.flush(); //如果对象有改动,此句会发出更新语句
entityManager.getTransaction().commit();
}
注意: flush() 方法的执行需要在事务中,如果对象有改动,此句会发出更新语句。 执行的效果如下图:
@Test
public void detachAfterCommit() {
Usr usr = new Usr();
usr.setId(4);
usr.setName("赵云");
entityManager.getTransaction().begin();
entityManager.merge(usr);
entityManager.getTransaction().commit();
Assertions.assertTrue(!entityManager.contains(usr));
}
方法汇总说明
- flush(), 同步持久上下文环境,将所有未保存实体的状态信息保存到数据库
- refresh(entity) 用数据库实体记录更新实体对象
- clear() 清除持久上下文环境, 断开所有关联实体, 未提交的更新会被撤销
- contains(entity) 判断实例是否属于持久上下文环境管理的实体
- isOpen() 判断实体管理器是否是打开状态
- getTransaction() 返回资源层的事务对象
- close() 关闭实体管理器。
persist() 保存, merge() 如果不存在就创建, 存在就更新。
如果persist() 一个已经存在的, 则会报错,类似:
Caused by: java.sql.SQLIntegrityConstraintViolationException: Duplicate entry '1' for key 'PRIMARY'
两种方式会将实体添加到 PersistenceContext
- Persist 获取一个实体实例,将其添加到上下文并管理该实例(跟踪对实体的未来更新)。
- merge创建实体的新实例,从提供的实体复制状态,并使新副本受到管理。 传入的实例将不会被管理(所做的任何更改都不会成为事务的一部分 - 除非再次调用merge)。
一般大部分persist() 用来保存, merge()用来更新



