阅读 162

【JPA专题】04.JPA的API和方法

JPA的架构

1.gif

Persistence

Persistence类是用于获取EntityManagerFactory实例,该类包含一个名为createEntityManagerFactory的静态方法

createEntityManagerFactory 方法有如下两个重载版本:

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

EntityManagerFactory

EntityManagerFactory用于创建一个EntityManager的实例。EntityManagerFactory是在应用程序启动时在PersistenceUnit的帮助(@PersistenceUnit标注注入或者通过JNDI查找获得EntityManagerFactory,其unitName属性(可选)用于指明使用哪个持久性单元)下创建的,作为EntityManager的一个工厂类,它创建并管理多个EntityManager实例,并且EntityManagerFactory的方法都是线程安全的

该接口约定了如下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语句查询实体。

实体对象的状态说明(跟Hibernate的三种对象状态类似):

  • 新建状态(瞬时状态): 新创建的对象,尚未拥有持久性主键
  • 持久化状态:已经拥有持久性主键并和持久化建立了上下文环境
  • 游离状态:拥有持久化主键,但是没有与持久化建立上下文环境
  • 删除状态: 拥有持久化主键,已经和持久化建立上下文环境,但是从数据库中删除

常用的操作方法(重要)

  • find (Class<T> entityClass,Object primaryKey):返回指定的 OID 对应的实体类对象,如果这个实体存在于当前的持久化环境,则返回一个被缓存的对象;否则会创建一个新的 Entity, 并加载数据库中相关信息;若 OID 不存在于数据库中,则返回一个 null。第一个参数为被查询的实体类类型,第二个参数为待查找实体的主键值。(类似于Hibernate中的get方法

  • getReference (Class<T> entityClass,Object primaryKey):与find()方法类似,不同的是:如果缓存中不存在指定的 Entity, EntityManager 会创建一个 Entity 类的代理,但是不会立即加载数据库中的信息,只有第一次真正使用此 Entity 的属性才加载,所以如果此 OID 在数据库不存在,getReference() 不会返回 null 值, 而是抛出EntityNotFoundException类似于Hibernate中的load方法

  • persist (Object entity):用于将新创建的Entity纳入到EntityManager的管理。该方法执行后,传入persist()方法的 Entity 对象转换成持久化状态。(类似于Hibernate中的save方法)

    • 如果传入 persist() 方法的 Entity 对象已经处于持久化状态,则 persist() 方法什么都不做。
    • 如果对删除状态的 Entity 进行 persist() 操作,会转换为持久化状态。
    • 如果对游离状态的实体执行 persist() 操作,可能会在 persist() 方法抛出 EntityExistException(也有可能是在flush或事务提交后抛出)。
  • remove (Object entity):删除实例。如果实例是被管理的,即与数据库实体记录关联,则同时会删除关联的数据库记录。(类似于Hibernate中的Delete方法)

  • merge (T entity):merge() 用于处理 Entity 的同步。即数据库的插入和更新操作,这个操作的情况有点多,我们通过代码进行说明

    状态转换的思维导图.png

  • 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 方法后持久上下文将仍处于被管理状态,直到事务完成。


跟查询相关的操作

  • createQuery (String qlString):创建一个查询对象
  • createNamedQuery (String name):根据命名的查询语句块创建查询对象。参数为命名的查询语句
  • createNativeQuery (String sqlString):使用标准 SQL语句创建查询对象。参数为标准SQL语句字符串
  • createNativeQuery (String sqls, String resultSetMapping):使用标准SQL语句创建查询对象,并指定返回结果集 Map的名称

EntityTransaction

EntityTransaction 接口用来管理资源层实体管理器的事务操作。通过调用实体管理器的getTransaction方法 获得其实例

  • begin ():用于启动一个事务,此后的多个数据库操作将作为整体被提交或撤消。若这时事务已启动则会抛出 IllegalStateException 异常

  • commit ():用于提交当前事务。即将事务启动以后的所有数据库更新操作持久化至数据库中

  • rollback ():撤消(回滚)当前事务。即撤消事务启动后的所有数据库更新操作,从而不对数据库产生影响

  • setRollbackOnly ():使当前事务只能被撤消

  • getRollbackOnly ():查看当前事务是否设置了只能撤消标志

  • isActive ():查看当前事务是否是活动的。如果返回true则不能调用begin方法,否则将抛出 IllegalStateException 异常;如果返回 false 则不能调用 commit、rollback、setRollbackOnly 及 getRollbackOnly 方法,否则将抛出 IllegalStateException 异常

Query

单独一个专题会讲查询的操作,日常开发我们经常使用的也是查询操作

Query接口封装了执行数据库查询的相关方法。调用 EntityManager 的 createQuery、create NamedQuery 及 createNativeQuery 方法可以获得查询对象,进而可调用 Query 接口的相关方法来执行查询操作。

Query接口的主要方法

  • int executeUpdate():用于执行update或delete语句

  • List getResultList():用于执行select语句并返回结果集实体列表

  • Object getSingleResult():用于执行只返回单个结果实体的select语句

  • Query setFirstResult(int startPosition):用于设置从哪个实体记录开始返回查询结果

  • Query setMaxResults(int maxResult):用于设置返回结果实体的最大数。与setFirstResult结合使用可实现分页查询

  • Query setFlushMode(FlushModeType flushMode):设置查询对象的Flush模式。参数可以取2个枚举值:

    • FlushModeType.AUTO 为自动更新数据库记录
    • FlushMode Type.COMMIT 为直到提交事务时才更新数据库记录
  • setHint(String hintName, Object value):设置与查询对象相关的特定供应商参数或提示信息。参数名及其取值需要参考特定 JPA 实现库提供商的文档。如果第二个参数无效将抛出IllegalArgumentException异常。

  • setParameter(int position, Object value): 为查询语句的指定位置参数赋值。Position 指定参数序号,value 为赋给参数的值。

  • setParameter(int position, Date d, TemporalType type):为查询语句的指定位置参数赋 Date 值。Position 指定参数序号,value 为赋给参数的值,temporalType 取 TemporalType 的枚举常量,包括 DATE、TIME 及 TIMESTAMP 三个,,用于将 Java 的 Date 型值临时转换为数据库支持的日期时间类型(java.sql.Date、java.sql.Time及java.sql.Timestamp)

  • setParameter(int position, Calendar c, TemporalType type):为查询语句的指定位置参数赋 Calenda r值。position 指定参数序号,value 为赋给参数的值,temporalType 的含义及取舍同前

  • setParameter(String name, Object value):为查询语句的指定名称参数赋值

  • setParameter(String name, Date d, TemporalType type):为查询语句的指定名称参数赋 Date 值。用法同前

  • setParameter(String name, Calendar c, TemporalType type):为查询语句的指定名称参数设置Calendar值name为参数名,其它同前。该方法调用时如果参数位置或参数名不正确,或者所赋的参数值类型不匹配,将抛出 IllegalArgumentException 异常

彼此之间的关系说明

EntityManagerFactory和EntityManager的关系是1对多。这是一个工厂类EntityManager实例。

EntityManager和EntityTransaction之间的关系是1对1。对于每个EntityManager操作,只有一个EntityTransaction实例。

EntityManager和Query之间的关系是1对多。查询数众多可以使用一个EntityManager实例执行。

EntityManager实体之间的关系是1对多。一个EntityManager实例可以管理多个实体