Jpa使用詳解

說故事的五公子發表於2020-06-02

目錄

ORM思想

1.ORM概述

ORM（Object-Relational Mapping） 表示物件關係對映。在物件導向的軟體開發中，通過ORM，就可以把物件對映到關係型資料庫中。只要有一套程式能夠做到建立物件與資料庫的關聯，操作物件就可以直接運算元據庫資料，就可以說這套程式實現了ORM物件關係對映

簡單的說：ORM就是建立實體類和資料庫表之間的關係，從而達到操作實體類就相當於運算元據庫表的目的。

2.為什麼要使用ORM

當實現一個應用程式時（不使用O/R Mapping），我們可能會寫特別多資料訪問層的程式碼，從資料庫儲存資料、修改資料、刪除資料，而這些程式碼都是重複的。而使用ORM則會大大減少重複性程式碼。物件關係對映（Object Relational Mapping，簡稱ORM），主要實現程式物件到關聯式資料庫資料的對映。

3.常見的ORM框架

當實現一個應用程式時（不使用O/R Mapping），我們可能會寫特別多資料訪問層的程式碼，從資料庫儲存資料、修改資料、刪除資料，而這些程式碼都是重複的。而使用ORM則會大大減少重複性程式碼。物件關係對映（Object Relational Mapping，簡稱ORM），主要實現程式物件到關聯式資料庫資料的對映。

JPA簡介

1.JPA概述

JPA的全稱是Java Persistence API， 即Java 持久化API，是SUN公司推出的一套基於ORM的規範，內部是由一系列的介面和抽象類構成。JPA通過JDK 5.0註解描述物件－關係表的對映關係，並將執行期的實體物件持久化到資料庫中。

2.JPA的優勢

1. 標準化

JPA 是 JCP 組織釋出的 Java EE 標準之一，因此任何聲稱符合 JPA 標準的框架都遵循同樣的架構，提供相同的訪問API，這保證了基於JPA開發的企業應用能夠經過少量的修改就能夠在不同的JPA框架下執行。

2. 容器級特性的支援

JPA框架中支援大資料集、事務、併發等容器級事務，這使得 JPA 超越了簡單持久化框架的侷限，在企業應用發揮更大的作用。

3. 簡單方便

JPA的主要目標之一就是提供更加簡單的程式設計模型：在JPA框架下建立實體和建立Java 類一樣簡單，沒有任何的約束和限制，只需要使用 javax.persistence.Entity進行註釋，JPA的框架和介面也都非常簡單，沒有太多特別的規則和設計模式的要求，開發者可以很容易的掌握。JPA基於非侵入式原則設計，因此可以很容易的和其它框架或者容器整合

4. 查詢能力

JPA的查詢語言是物件導向而非面向資料庫的，它以物件導向的自然語法構造查詢語句，可以看成是Hibernate HQL的等價物。JPA定義了獨特的JPQL（Java Persistence Query Language），JPQL是EJB QL的一種擴充套件，它是針對實體的一種查詢語言，操作物件是實體，而不是關聯式資料庫的表，而且能夠支援批量更新和修改、JOIN、GROUP BY、HAVING 等通常只有 SQL 才能夠提供的高階查詢特性，甚至還能夠支援子查詢。

5. 高階特性

JPA 中能夠支援物件導向的高階特性，如類之間的繼承、多型和類之間的複雜關係，這樣的支援能夠讓開發者最大限度的使用物件導向的模型設計企業應用，而不需要自行處理這些特性在關聯式資料庫的持久化。

3.JPA與hibernate的關係

JPA規範本質上就是一種ORM規範，注意不是ORM框架——因為JPA並未提供ORM實現，它只是制訂了一些規範，提供了一些程式設計的API介面，但具體實現則由服務廠商來提供實現。

JPA和Hibernate的關係就像JDBC和JDBC驅動的關係，JPA是規範，Hibernate除了作為ORM框架之外，它也是一種JPA實現。JPA怎麼取代Hibernate呢？JDBC規範可以驅動底層資料庫嗎？答案是否定的，也就是說，如果使用JPA規範進行資料庫操作，底層需要hibernate作為其實現類完成資料持久化工作。

JPA入門案例

1.搭建開發環境

第一步：建立一個maven工程

第二步：引入jar包

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.hibernate.version>5.0.7.Final</project.hibernate.version>
    </properties>

<dependencies>
    <!-- junit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>

    <!-- hibernate對jpa的支援包 -->
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-entitymanager</artifactId>
        <version>${project.hibernate.version}</version>
    </dependency>

    <!-- c3p0 -->
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-c3p0</artifactId>
        <version>${project.hibernate.version}</version>
    </dependency>

    <!-- log日誌 -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>

    <!-- Mysql and MariaDB -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.6</version>
    </dependency>
</dependencies>

第三步：建立資料庫表

 /*建立客戶表*/
    CREATE TABLE cst_customer (
      cust_id bigint(32) NOT NULL AUTO_INCREMENT COMMENT '客戶編號(主鍵)',
      cust_name varchar(32) NOT NULL COMMENT '客戶名稱(公司名稱)',
      cust_source varchar(32) DEFAULT NULL COMMENT '客戶資訊來源',
      cust_industry varchar(32) DEFAULT NULL COMMENT '客戶所屬行業',
      cust_level varchar(32) DEFAULT NULL COMMENT '客戶級別',
      cust_address varchar(128) DEFAULT NULL COMMENT '客戶聯絡地址',
      cust_phone varchar(64) DEFAULT NULL COMMENT '客戶聯絡電話',
      PRIMARY KEY (`cust_id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

第四步：建立客戶實體類

public class Customer {

    private Long custId;
    private String custName;
    private String custSource;
    private String custIndustry;
    private String custLevel;
    private String custAddress;
    private String custPhone;

    public Long getCustId() {
        return custId;
    }
    public void setCustId(Long custId) {
        this.custId = custId;
    }
    public String getCustName() {
        return custName;
    }
    public void setCustName(String custName) {
        this.custName = custName;
    }
    public String getCustSource() {
        return custSource;
    }
    public void setCustSource(String custSource) {
        this.custSource = custSource;
    }
    public String getCustIndustry() {
        return custIndustry;
    }
    public void setCustIndustry(String custIndustry) {
        this.custIndustry = custIndustry;
    }
    public String getCustLevel() {
        return custLevel;
    }
    public void setCustLevel(String custLevel) {
        this.custLevel = custLevel;
    }
    public String getCustAddress() {
        return custAddress;
    }
    public void setCustAddress(String custAddress) {
        this.custAddress = custAddress;
    }
    public String getCustPhone() {
        return custPhone;
    }
    public void setCustPhone(String custPhone) {
        this.custPhone = custPhone;
    }

    @Override
    public String toString() {
        return "Customer{" +
                "custId=" + custId +
                ", custName='" + custName + '\'' +
                ", custSource='" + custSource + '\'' +
                ", custIndustry='" + custIndustry + '\'' +
                ", custLevel='" + custLevel + '\'' +
                ", custAddress='" + custAddress + '\'' +
                ", custPhone='" + custPhone + '\'' +
                '}';
    }
}

第五步：編寫實體類和資料庫表的對映配置[重點]

import javax.persistence.*;

@Entity //宣告實體類
@Table(name="cst_customer") //建立實體類和表的對映關係
public class Customer {

    @Id//宣告當前私有屬性為主鍵
    @GeneratedValue(strategy= GenerationType.IDENTITY) //配置主鍵的生成策略
    @Column(name="cust_id") //指定和表中cust_id欄位的對映關係
    private Long custId;

    @Column(name="cust_name") //指定和表中cust_name欄位的對映關係
    private String custName;

    @Column(name="cust_source")//指定和表中cust_source欄位的對映關係
    private String custSource;

    @Column(name="cust_industry")//指定和表中cust_industry欄位的對映關係
    private String custIndustry;

    @Column(name="cust_level")//指定和表中cust_level欄位的對映關係
    private String custLevel;

    @Column(name="cust_address")//指定和表中cust_address欄位的對映關係
    private String custAddress;

    @Column(name="cust_phone")//指定和表中cust_phone欄位的對映關係
    private String custPhone;

    public Long getCustId() {
        return custId;
    }
    public void setCustId(Long custId) {
        this.custId = custId;
    }
    public String getCustName() {
        return custName;
    }
    public void setCustName(String custName) {
        this.custName = custName;
    }
    public String getCustSource() {
        return custSource;
    }
    public void setCustSource(String custSource) {
        this.custSource = custSource;
    }
    public String getCustIndustry() {
        return custIndustry;
    }
    public void setCustIndustry(String custIndustry) {
        this.custIndustry = custIndustry;
    }
    public String getCustLevel() {
        return custLevel;
    }
    public void setCustLevel(String custLevel) {
        this.custLevel = custLevel;
    }
    public String getCustAddress() {
        return custAddress;
    }
    public void setCustAddress(String custAddress) {
        this.custAddress = custAddress;
    }
    public String getCustPhone() {
        return custPhone;
    }
    public void setCustPhone(String custPhone) {
        this.custPhone = custPhone;
    }

    @Override
    public String toString() {
        return "Customer{" +
                "custId=" + custId +
                ", custName='" + custName + '\'' +
                ", custSource='" + custSource + '\'' +
                ", custIndustry='" + custIndustry + '\'' +
                ", custLevel='" + custLevel + '\'' +
                ", custAddress='" + custAddress + '\'' +
                ", custPhone='" + custPhone + '\'' +
                '}';
    }
}

常用註解說明

       @Entity
        	作用：指定當前類是實體類。
        @Table
        	作用：指定實體類和表之間的對應關係。
        	屬性：
        		name：指定資料庫表的名稱
        @Id
        	作用：指定當前欄位是主鍵。
        @GeneratedValue
        	作用：指定主鍵的生成方式。。
        	屬性：
        		strategy ：指定主鍵生成策略。
        @Column
        	作用：指定實體類屬性和資料庫表之間的對應關係
        	屬性：
        		name：指定資料庫表的列名稱。
        		unique：是否唯一  
        		nullable：是否可以為空  
        		inserttable：是否可以插入  
        		updateable：是否可以更新  
        		columnDefinition: 定義建表時建立此列的DDL  
        		secondaryTable: 從表名。如果此列不建在主表上（預設建在主表），該屬性定義該列所在從表的名字搭建開發環境[重點]

第六步：配置JPA的核心配置檔案

在java工程的resources路徑下建立一個名為META-INF的資料夾，在此資料夾下建立一個名為persistence.xml的配置檔案

<?xml version="1.0" encoding="UTF-8"?>
<persistence 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"
             version="2.0">

    <!--配置持久化單元
		name：持久化單元名稱
		transaction-type：事務型別
		 	RESOURCE_LOCAL：本地事務管理
		 	JTA：分散式事務管理 -->
    <persistence-unit name="myJpa" transaction-type="RESOURCE_LOCAL">

        <!--配置JPA規範的服務提供商 也就是JPA的具體實現 -->
        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>
        <properties>
            <!-- 資料庫驅動 -->
            <property name="javax.persistence.jdbc.driver" value="com.mysql.jdbc.Driver" />
            <!-- 資料庫地址 -->
            <property name="javax.persistence.jdbc.url" value="jdbc:mysql://localhost:3306/jpa" />
            <!-- 資料庫使用者名稱 使用你自己的使用者名稱 -->
            <property name="javax.persistence.jdbc.user" value="root" />
            <!-- 資料庫密碼 用你自己的密碼 -->
            <property name="javax.persistence.jdbc.password" value="123456" />

            <!--jpa提供者的可選配置：我們的JPA規範的提供者為hibernate，所以jpa的核心配置中相容hibernate的配 -->
            <property name="hibernate.show_sql" value="true" />
            <property name="hibernate.format_sql" value="true" />
            <property name="hibernate.hbm2ddl.auto" value="create" />

        </properties>

    </persistence-unit>

</persistence>

第七步：編寫單元測試

在test目錄下面建立JpaTest測試類

import cn.wgzblog.entity.Customer;
import org.junit.Test;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.Persistence;

public class JpaTest {

    @Test
    public void test() {
        /**
         * 建立實體管理類工廠，藉助Persistence的靜態方法獲取
         * 		其中傳遞的引數為持久化單元名稱，需要jpa配置檔案中指定
         */
        EntityManagerFactory factory = Persistence.createEntityManagerFactory("myJpa");
        //建立實體管理類
        EntityManager entityManager = factory.createEntityManager();
        //獲取事務物件
        EntityTransaction transaction = entityManager.getTransaction();
        //開啟事務
        transaction.begin();
        //設定實體類
        Customer customer=new Customer();
        customer.setCustAddress("上海陸家嘴");
        customer.setCustName("五公子");
        customer.setCustPhone("18898886666");
        //儲存操作
        entityManager.persist(customer);
        //提交事務
        transaction.commit();
        // 釋放資源
        entityManager.close();
        factory.close();
    }
}

輸出結果：

Hibernate: 
    drop table if exists cst_customer
Hibernate: 
    create table cst_customer (
        cust_id bigint not null auto_increment,
        cust_address varchar(255),
        cust_industry varchar(255),
        cust_level varchar(255),
        cust_name varchar(255),
        cust_phone varchar(255),
        cust_source varchar(255),
        primary key (cust_id)
    )
Hibernate: 
    insert 
    into
        cst_customer
        (cust_address, cust_industry, cust_level, cust_name, cust_phone, cust_source) 
    values
        (?, ?, ?, ?, ?, ?)

JPA主鍵生成策略

通過annotation（註解）來對映hibernate實體的,基於annotation的hibernate主鍵標識為@Id, 其生成規則由@GeneratedValue設定的.這裡的@id和@GeneratedValue都是JPA的標準用法。

JPA提供的四種標準用法為TABLE,SEQUENCE,IDENTITY,AUTO。

具體說明如下：

IDENTITY：主鍵由資料庫自動生成（主要是自動增長型）

用法：

@Id  
@GeneratedValue(strategy = GenerationType.IDENTITY) 
private Long custId;

SEQUENCE：根據底層資料庫的序列來生成主鍵，條件是資料庫支援序列。

用法：

@Id  
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")  
@SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")  
private Long custId;


//@SequenceGenerator原始碼中的定義
@Target({TYPE, METHOD, FIELD})   
@Retention(RUNTIME)  
public @interface SequenceGenerator {  
    //表示該表主鍵生成策略的名稱，它被引用在@GeneratedValue中設定的“generator”值中
    String name();  
    //屬性表示生成策略用到的資料庫序列名稱。
    String sequenceName() default "";  
    //表示主鍵初識值，預設為0
    int initialValue() default 0;  
    //表示每次主鍵值增加的大小，例如設定1，則表示每次插入新記錄後自動加1，預設為50
    int allocationSize() default 50;  
}

AUTO*：主鍵由程式控制

用法：

@Id  
@GeneratedValue(strategy = GenerationType.AUTO)  
private Long custId;

TABLE：使用一個特定的資料庫表格來儲存主鍵

@Id  
@GeneratedValue(strategy = GenerationType.TABLE, generator="payablemoney_gen")  
@TableGenerator(name = "pk_gen",  
                table="tb_generator",  
                pkColumnName="gen_name",  
                valueColumnName="gen_value",  
                pkColumnValue="PAYABLEMOENY_PK",  
                allocationSize=1  
               ) 
private Long custId;


//@TableGenerator的定義：
@Target({TYPE, METHOD, FIELD})   
@Retention(RUNTIME)  
public @interface TableGenerator {  
    //表示該表主鍵生成策略的名稱，它被引用在@GeneratedValue中設定的“generator”值中
    String name();  
    //表示表生成策略所持久化的表名，例如，這裡表使用的是資料庫中的“tb_generator”。
    String table() default "";  
    //catalog和schema具體指定表所在的目錄名或是資料庫名
    String catalog() default "";  
    String schema() default "";  
    //屬性的值表示在持久化表中，該主鍵生成策略所對應鍵值的名稱。例如在“tb_generator”中將“gen_name”作為主鍵的鍵值
    String pkColumnName() default "";  
    //屬性的值表示在持久化表中，該主鍵當前所生成的值，它的值將會隨著每次建立累加。例如，在“tb_generator”中將“gen_value”作為主鍵的值 
    String valueColumnName() default "";  
    //屬性的值表示在持久化表中，該生成策略所對應的主鍵。例如在“tb_generator”表中，將“gen_name”的值為“CUSTOMER_PK”。 
    String pkColumnValue() default "";  
    //表示主鍵初識值，預設為0。 
    int initialValue() default 0;  
    //表示每次主鍵值增加的大小，例如設定成1，則表示每次建立新記錄後自動加1，預設為50。
    int allocationSize() default 50;  
    UniqueConstraint[] uniqueConstraints() default {};  
} 

//這裡應用表tb_generator，定義為 ：
CREATE TABLE  tb_generator (  
    id NUMBER NOT NULL,  
    gen_name VARCHAR2(255) NOT NULL,  
    gen_value NUMBER NOT NULL,  
    PRIMARY KEY(id)  
)

JPA的API介紹

1.Persistence物件

Persistence物件主要作用是用於獲取EntityManagerFactory物件的 。通過呼叫該類的createEntityManagerFactory靜態方法，根據配置檔案中持久化單元名稱建立EntityManagerFactory。

//1. 建立 EntitymanagerFactory
String unitName = "myJpa";
EntityManagerFactory factory= Persistence.createEntityManagerFactory(unitName);

2.EntityManagerFactory

EntityManagerFactory 介面主要用來建立 EntityManager 例項

//建立實體管理類
EntityManager em = factory.createEntityManager();

由於EntityManagerFactory 是一個執行緒安全的物件（即多個執行緒訪問同一個EntityManagerFactory 物件不會有執行緒安全問題），並且EntityManagerFactory 的建立極其浪費資源，所以在使用JPA程式設計時，我們可以對EntityManagerFactory 的建立進行優化，只需要做到一個工程只存在一個EntityManagerFactory 即可

3.EntityManager

在 JPA 規範中, EntityManager是完成持久化操作的核心物件。實體類作為普通 java物件，只有在呼叫 EntityManager將其持久化後才會變成持久化物件。EntityManager物件在一組實體類與底層資料來源之間進行 O/R 對映的管理。它可以用來管理和更新 Entity Bean, 根椐主鍵查詢 Entity Bean, 還可以通過JPQL語句查詢實體。

我們可以通過呼叫EntityManager的方法完成獲取事務，以及持久化資料庫的操作

方法說明：

getTransaction : 獲取事務物件
persist ： 儲存操作
merge ： 更新操作
remove ： 刪除操作
find/getReference ： 根據id查詢

4.EntityTransaction

在 JPA 規範中, EntityTransaction是完成事務操作的核心物件，對於EntityTransaction在我們的java程式碼中承接的功能比較簡單

begin：開啟事務
commit：提交事務
rollback：回滾事務

相關文章