JPA - 标准 API

标准 API 是一个预定义的 API,用于定义实体查询。 它是定义 JPQL 查询的替代方法。 这些查询是类型安全的、可移植的并且易于通过更改语法来修改。 与 JPQL 类似,它遵循抽象模式(易于编辑模式)和嵌入对象。 元数据 API 与标准 API 混合在一起,为标准查询建模持久实体。

标准 API 的主要优点是可以在编译时更早地检测到错误。 基于字符串的 JPQL 查询和基于 JPA 标准的查询在性能和效率上是相同的。

标准 API 的历史记录

标准 API 包含在 JPA 的所有版本中,因此标准 API 的每个步骤都会在 JPA 规范中通知。

  • 在 JPA 2.0 中,开发了条件查询 API、查询标准化。
  • JPA 2.1 中包含 Criteria 更新和删除(批量更新和删除)。

条件查询结构

Criteria API 和 JPQL 密切相关,并且允许在其查询中使用类似的运算符进行设计。 它遵循 javax.persistence.criteria 包来设计查询。 查询结构是指语法条件查询。

以下简单条件查询将返回数据源中实体类的所有实例。

EntityManager em = ...;
CriteriaBuilder cb = em.getCriteriaBuilder();

CriteriaQuery<Entity class> cq = cb.createQuery(Entity.class);
Root<Entity> from = cq.from(Entity.class);

cq.select(Entity);
TypedQuery<Entity> q = em.createQuery(cq);
List<Entity> allitems = q.getResultList();

该查询演示了创建条件的基本步骤。

  • EntityManager 实例用于创建 CriteriaBuilder 对象。
  • CriteriaQuery 实例用于创建查询对象。 该查询对象的属性将根据查询的详细信息进行修改。
  • CriteriaQuery.from 方法被调用来设置查询根。
  • CriteriaQuery.select 被调用来设置结果列表类型。
  • TypedQuery 实例用于准备要执行的查询并指定查询结果的类型。
  • TypedQuery 对象上的 getResultList 方法来执行查询。 该查询返回实体的集合,结果存储在列表中。

标准 API 示例

让我们考虑一下员工数据库的例子。 让我们假设 jpadb.employee 表包含以下记录:

Eid	Ename           Salary	Deg
401	Gopal	        40000	Technical Manager
402	Manisha	        40000	Proof reader
403	Masthanvali     35000	Technical Writer
404     Satish	        30000	Technical writer
405	Krishna	        30000	Technical Writer
406	Kiran	        35000	Proof reader

在 eclipse IDE 中创建一个名为 JPA_Eclipselink_Criteria 的 JPA 项目。 本项目各模块如下所示:

创建实体

'src'包下创建一个名为com.tutorialspoint.eclipselink.entity的包。

在给定包下创建一个名为Employee.java的类。 Employee类实体如下所示:

package com.tutorialspoint.eclipselink.entity;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Employee {
   @Id
   @GeneratedValue(strategy= GenerationType.AUTO) 	
   
   private int eid;
   private String ename;
   private double salary;
   private String deg;
   
   public Employee(int eid, String ename, double salary, String deg) {
      super( );
      this.eid = eid;
      this.ename = ename;
      this.salary = salary;
      this.deg = deg;
   }

   public Employee( ) {
      super();
   }

   public int getEid( ) {
      return eid;
   }
   
   public void setEid(int eid) {
      this.eid = eid;
   }

   public String getEname( ) {
      return ename;
   }
   
   public void setEname(String ename) {
      this.ename = ename;
   }

   public double getSalary( ) {
      return salary;
   }
   
   public void setSalary(double salary) {
      this.salary = salary;
   }

   public String getDeg( ) {
      return deg;
   }
   
   public void setDeg(String deg) {
      this.deg = deg;
   }
   
   @Override
   public String toString() {
   return "Employee [eid = " + eid + ", ename = " + ename + ", salary = " + salary + ", deg = " + deg + "]";
   }
}

Persistence.xml

配置数据库和注册实体类需要Persistence.xml文件。

Persistence.xml 将在创建 JPA 项目时由 eclipse IDE 创建。 配置详细信息是用户指定的。 persistence.xml文件如下所示:

<?xml version = "1.0" encoding = "UTF-8"?>
<persistence version="2.0" xmlns = "http://java.sun.com/xml/ns/persistence" 
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation = "http://java.sun.com/xml/ns/persistence 
   http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
   
   <persistence-unit name = "Eclipselink_JPA" transaction-type = "RESOURCE_LOCAL">
      <class>com.tutorialspoint.eclipselink.entity.Employee</class>
      
      <properties>
         <property name = "javax.persistence.jdbc.url" value = "jdbc:mysql://localhost:3306/jpadb"/>
         <property name = "javax.persistence.jdbc.user" value = "root"/>
         <property name = "javax.persistence.jdbc.password" value = "root"/>
         <property name = "javax.persistence.jdbc.driver" 
         value="com.mysql.jdbc.Driver"/>
         <property name = "eclipselink.logging.level" value = "FINE"/>
         <property name = "eclipselink.ddl-generation" 
         value="create-tables"/>
      </properties>
      
   </persistence-unit>
</persistence>

service 类

该模块包含服务类,它使用 MetaData API 初始化实现 Criteria 查询部分。 创建一个名为'com.tutorialspoint.eclipselink.service'的包。 名为 CriteriaAPI.java 的类在给定包下创建。 DAO类如下所示:

package com.tutorialspoint.eclipselink.service;

import java.util.List;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Root;

import com.tutorialspoint.eclipselink.entity.Employee;

public class CriteriaApi {
   public static void main(String[] args) {
   
   EntityManagerFactory emfactory = Persistence.createEntityManagerFactory( "Eclipselink_JPA" );
   EntityManager entitymanager = emfactory.createEntityManager( );
   CriteriaBuilder criteriaBuilder = entitymanager.getCriteriaBuilder();
   CriteriaQuery<Object> criteriaQuery = criteriaBuilder.createQuery();
   Root<Employee> from = criteriaQuery.from(Employee.class);

   //select all records
   System.out.println("Select all records");
   CriteriaQuery<Object> select = c riteriaQuery.select(from);
   TypedQuery<Object> typedQuery = entitymanager.createQuery(select);
   List<Object> resultlist = typedQuery.getResultList();

   for(Object o:resultlist) {
      Employee e = (Employee)o;
      System.out.println("EID : " + e.getEid() + " Ename : " + e.getEname());
   }

   //Ordering the records 
   System.out.println("Select all records by follow ordering");
   CriteriaQuery<Object> select1 = criteriaQuery.select(from);
   select1.orderBy(criteriaBuilder.asc(from.get("ename")));
   TypedQuery<Object> typedQuery1 = entitymanager.createQuery(select);
   List<Object> resultlist1 = typedQuery1.getResultList();

   for(Object o:resultlist1){
      Employee e=(Employee)o;
      System.out.println("EID : " + e.getEid() + " Ename : " + e.getEname());
   }

   entitymanager.close( );
   emfactory.close( );
   }
}

编译并执行上述程序后,您将在 Eclipse IDE 的控制台面板中得到如下输出:

Select All records
EID : 401 Ename : Gopal
EID : 402 Ename : Manisha
EID : 403 Ename : Masthanvali
EID : 404 Ename : Satish
EID : 405 Ename : Krishna
EID : 406 Ename : Kiran
Select All records by follow Ordering
EID : 401 Ename : Gopal
EID : 406 Ename : Kiran
EID : 405 Ename : Krishna
EID : 402 Ename : Manisha
EID : 403 Ename : Masthanvali
EID : 404 Ename : Satish