07 jpa - 04 JPA中的API - 《Java框架(旧笔记,待整理)》

Persistence
EntityManagerFactory
EntityManager
EntityTransaction

Persistence

Persistence类是用于获取 EntityManagerFactory 实例。该类包含一个名createEntityManagerFactory 的静态方法。
createEntityManagerFactory 方法有如下两个重载版本。

带有一个参数的方法以 JPA 配置文件 persistence.xml 中的持久化单元名为参数
带有两个参数的方法：前一个参数含义相同，后一个参数 Map类型，用于设置 JPA 的相关属性，
这时将忽略其它地方设置的属性。Map 对象的属性名必须是 JPA 实现库提供商的名字空间约定的属性名。

EntityManagerFactory

EntityManagerFactory 接口主要用来创建 EntityManager 实例。该接口约定了如下4个方法：

createEntityManager()：用于创建实体管理器对象实例。
createEntityManager(Map map)：用于创建实体管理器对象实例的重载方法，Map 参数用于提供 EntityManager 的属性。
isOpen()：检查 EntityManagerFactory 是否处于打开状态。实体管理器工厂创建后一直处于打开状态，除非调用close()方法将其关闭。
close()：关闭 EntityManagerFactory 。 EntityManagerFactory 关闭后将释放所有资源，
isOpen()方法测试将返回 false，其它方法将不能调用，否则将导致IllegalStateException异常。

EntityManager

在 JPA 规范中, EntityManager 是完成持久化操作的核心对象。实体作为普通 Java 对象，
只有在调用 EntityManager 将其持久化后才会变成持久化对象。EntityManager 对象在一
组实体类与底层数据源之间进行 O/R 映射的管理。它可以用来管理和更新 Entity Bean,
根椐主键查找 Entity Bean, 还可以通过JPQL语句查询实体。
实体的状态:
新建状态: 新创建的对象，尚未拥有持久性主键。
持久化状态：已经拥有持久性主键并和持久化建立了上下文环境
游离状态：拥有持久化主键，但是没有与持久化建立上下文环境
删除状态: 拥有持久化主键，已经和持久化建立上下文环境，但是从数据库中删除。

EntityManager.find()方法

find (Class entityClass,Object primaryKey)：返回指定的 OID 对应的实体类对象
如果这个实体存在于当前的持久化环境，则返回一个被缓存的对象；
否则会创建一个新的 Entity, 并加载数据库中相关信息；
若 OID 不存在于数据库中，则返回一个 null。
Customer customer = entityManager.find(Customer.class, 1);

EntityManager.getReference()方法

只有在使用对象的时候才去数据库中查询。会出现懒加载异常
getReference (Class entityClass,Object primaryKey)：与find()方法类似，
不同的是：如果缓存中不存在指定的 Entity, EntityManager会创建一个 Entity 类的代理，
但是不会立即加载数据库中的信息，只有第一次真正使用此 Entity 的属性才加载，
所以如果此OID在数据库不存在，getReference()不会返回null值,而是抛出EntityNotFoundException
Customer customer = entityManager.getReference(Customer.class, 111);

EntityManager.persist()方法

使对象由临时状态变为持久化状态。
persist (Object entity)：用于将新创建的 Entity 纳入到 EntityManager 的管理。
该方法执行后，传入 persist() 方法的 Entity 对象转换成持久化状态。
如果传入 persist() 方法的 Entity 对象已经处于持久化状态，则 persist() 方法什么都不做。
如果对删除状态的 Entity 进行 persist() 操作，会转换为持久化状态。
如果对游离状态的实体执行 persist() 操作，可能会在 persist() 方法抛出 EntityExistException(也有可能是在flush或事务提交后抛出)。hibernate则可以对游离状态执行insert操作
Customer customer = new Customer();

    customer.setAge(99);
    customer.setEmail("123213@qq.com");
    customer.setLastName("ls");
    customer.setBirth(new Date());
    customer.setCreatedTime(new Date());
    // customer.setId(5);  游离状态，有id，会报错
    entityManager.persist(customer);
    System.out.println(customer.getId());

EntityManager.remove()方法

remove (Object entity)：删除数据库记录，只能删除持久化对象，游离对象不行。
hibernate的delete()实际上还可以移除游离对象
Customer customer = entityManager.find(Customer.class, 4);
entityManager.remove(customer);

EntityManager.merge()方法

merge (T entity)：merge() 用于处理 Entity 的同步。即数据库的插入和更新操作
04 JPA中的API - 图1

若传入的是一个临时对象，会创建一个新的对象，把临时对象的属性复制到新的对象中，然后对新的对象执行持久化操作，新的对象中会有id，之前的对象没有id了。

Customer customer = new Customer();

    customer.setAge(123);
    customer.setEmail("qweqwe123@qq.com");
    customer.setLastName("cc");
    customer.setBirth(new Date());
    customer.setCreatedTime(new Date());
    Customer customer2 = entityManager.merge(customer);
    System.out.println("customer#id: " + customer.getId());   // null
    System.out.println("customer2#id: " + customer2.getId()); // 有id

2.1 若传入的是一个游离对象，即传入的对象有OID。但EntityManager缓存中没有该对象,数据库中也没有对应的记录,则会创建一个新的对象,然后把当前游离对象的属性赋值到新的对象中,对新创建的对象进行inset操作
Customer customer = new Customer();

    customer.setAge(11);
    customer.setEmail("4645fsf@qq.com");
    customer.setLastName("zz");
    customer.setBirth(new Date());
    customer.setCreatedTime(new Date());
    customer.setId(100);
    Customer customer2 = entityManager.merge(customer);
    System.out.println("customer#id: " + customer.getId()); // 100 
    System.out.println("customer2#id: " + customer2.getId()); // 新id,对应数据库

2.2 若传入的是一个游离对象，即传入的对象有OID。在EntityManager缓存中没有该对象，数据库中有对应的记录，则会查询对应的记录，然后返回该记录对应的一个对象，再把游离对象的属性赋值到查询到的对象中，对查询到的对象进行update操作
Customer customer = new Customer();

    customer.setAge(55);
    customer.setEmail("hhh@qq.com");
    customer.setLastName("bb");
    customer.setBirth(new Date());
    customer.setCreatedTime(new Date());
    customer.setId(5);
    Customer customer2 = entityManager.merge(customer);
    System.out.println(customer == customer2); // false

2.3 若传入的是一个游离对象，即传入的对象有OID。在EntityManager缓存中有该对象，
则会把游离对象的属性赋值到缓存中的对象中，并对缓存中的对象进行update操作
Customer customer = new Customer();

    customer.setAge(87);
    customer.setEmail("zzz@qq.com");
    customer.setLastName("dd");
    customer.setBirth(new Date());
    customer.setCreatedTime(new Date());
    customer.setId(2);
    Customer customer2 = entityManager.find(Customer.class, 2);
    entityManager.merge(customer);
    System.out.println(customer == customer2); // false

EntityManager的其他方法

flush ()：同步持久上下文环境，即将持久上下文环境的所有未保存实体的状态信息保存到数据库中。
setFlushMode (FlushModeType flushMode)：设置持久上下文环境的Flush模式。参数可以取2个枚举

FlushModeType.AUTO 为自动更新数据库实体，
FlushModeType.COMMIT 为直到提交事务时才更新数据库记录。

getFlushMode ()：获取持久上下文环境的Flush模式。返回FlushModeType类的枚举值。
refresh (Object entity)：用数据库实体记录的值更新实体对象的状态，即更新实例的属性值。
clear ()：清除持久上下文环境，断开所有关联的实体。如果这时还有未提交的更新则会被撤消。
contains (Object entity)：判断一个实例是否属于当前持久上下文环境管理的实体。
isOpen ()：判断当前的实体管理器是否是打开状态。
getTransaction ()：返回资源层的事务对象。EntityTransaction实例可以用于开始和提交多个事务。
close ()：关闭实体管理器。之后若调用实体管理器实例的方法或其派生的查询对象的方法都将抛出 IllegalstateException 异常，除了getTransaction 和 isOpen方法(返回 false)。不过，当与实体管理器关联的事务处于活动状态时，调用 close 方法后持久上下文将仍处于被管理状态，直到事务完成。

EntityTransaction

EntityTransaction 接口用来管理资源层实体管理器的事务操作。通过调用实体管理器getTransaction方法获得其实例。
begin ()用于启动一个事务，此后的多个数据库操作将作为整体被提交或撤消。若这时事务已启动则会抛出 IllegalStateException 异常。
commit ()用于提交当前事务。即将事务启动以后的所有数据库更新操作持久化至数据库中。
rollback ()撤消(回滚)当前事务。即撤消事务启动后的所有数据库更新操作,从而不对数据库产生影响。
setRollbackOnly ()使当前事务只能被撤消。
getRollbackOnly ()查看当前事务是否设置了只能撤消标志。
isActive ()查看当前事务是否是活动的。如果返回true则不能调用begin方法，否则将抛出 IllegalStateException 异常；如果返回 false 则不能调用 commit、rollback、setRollbackOnly 及 getRollbackOnly 方法，否则将抛出 IllegalStateException 异常。