SpringData JPA初入门及原理分析（上）

小二与小七 2020-03-08

318

今天小七为大家分享的是Spring家族里一位重要的成员SpringData JPA，下面我们先来看一下什么是SpringData JPA。

1.SpringData JPA简介

SpringData JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架，可使开发者用极简的代码即可实现对数据库的访问和操作。所以在学习Spring Data JPA之前我们需要先知道ORM和JPA是什么？

ORM（Object-Relational Mapping）：表示对象关系映射，在面向对象的程序开发过程中，通过ORM就可以把对象映射到关系型数据库中。简而言之，ORM就是建立实体类和数据库表之间的关系，从而达到操作实体类就相当于操作数据库表的目的。比如Mybatis、Hibernate、Jpa都是常见的ORM框架。

JPA（Java Persistence API）：Java 持久化API，是SUN公司推出的一套基于ORM的规范，内部是由一系列的接口和抽象类所构成的。它的本质就是一种ORM规范，注意不是ORM框架，因为JPA并未提供ORM的实现，它只是制订了一些规范，提供了一些编程的API接口，但具体实现则由服务厂商来提供。

SpringData JPA 让我们解脱了DAO层的操作，基本上所有的CRUD都可以依赖于它来实现，在实际的开发工程中，我们可以使用SpringData JPA + ORM框架来完成相关的数据操作，使数据库层操作更加简单，同时也方便解耦，我们使用JPA的API编程，意味着站在更高的角度上看待问题（面向接口编程）。

2.环境搭建与入门案例

2.1 环境搭建

开发工具：intellij IDEA 2019.3.3

jdk版本：java1.9

maven版本：3.5.2

数据库：oracle 10g

2.2入门案例

这个案例就是使用SpringData JPA完成基本的CRUD操作。

(1) 添加依赖坐标

使用SpringData JPA时需要整合Spring与SpringData JPA，并且需要提供JPA的服务提供者hibernate，因此需要导入spring，hibernate，数据库驱动坐标，数据库连接池等相关坐标。

<properties>
    <spring.version>5.2.1.RELEASE</spring.version> <!--spring版本-->
    <oracle.version>10.2.0.4.0</oracle.version> <!--oracle驱动版本-->
    <druid.version>1.1.20</druid.version> <!--druid数据库连接池-->
    <hibernate.version>5.4.9.Final</hibernate.version> <!--hibernate版本-->
    <slf4j.version>1.7.25</slf4j.version>
    <log4j.version>1.2.17</log4j.version>
</properties>
<dependencies>
    <!-- junit单元测试 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
    <!-- spring start -->
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.5</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context-support</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-beans</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <!-- spring end -->
    <!-- hibernate start -->
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-core</artifactId>
        <version>${hibernate.version}</version>
    </dependency>
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-entitymanager</artifactId>
        <version>${hibernate.version}</version>
    </dependency>
   <!-- <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>6.1.2.Final</version>
    </dependency>-->
    <!-- hibernate end -->
    <!-- druid start -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>${druid.version}</version>
    </dependency>
    <!-- druid end -->
    <!-- log end -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>${log4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>${slf4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>${slf4j.version}</version>
    </dependency>
    <!-- log end -->
    <dependency>
        <groupId>com.oracle</groupId>
        <artifactId>ojdbc14</artifactId>
        <version>${oracle.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-jpa</artifactId>
        <version>1.9.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>5.2.3.RELEASE</version>
    </dependency>
    <!-- el start 使用spring data jpa 必须引入 -->
    <dependency>
        <groupId>javax.el</groupId>
        <artifactId>javax.el-api</artifactId>
        <version>2.2.4</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.web</groupId>
        <artifactId>javax.el</artifactId>
        <version>2.2.4</version>
    </dependency>
    <!-- el end -->
</dependencies>

(2) 将SpringData JPA与Spring进行整合

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:jpa="http://www.springframework.org/schema/data/jpa" xmlns:task="http://www.springframework.org/schema/task"
       xsi:schemaLocation="
      http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
      http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
      http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd
      http://www.springframework.org/schema/data/jpa
      http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
    <!--配置dataSource-->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver"/>
        <property name="url" value="jdbc:oracle:thin:@localhost:1521:ORCL"/>
        <property name="username" value="franker"/>
        <property name="password" value="franker"/>
    </bean>
    <!--创建entityManagerFactory对象交给spring容器管理-->
    <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <!--配置需要扫描的包-->
        <property name="packagesToScan" value="com.xiaoqi.domain"/>
        <!--配置jpa的实现-->
        <property name="persistenceProvider" >
            <bean class="org.hibernate.jpa.HibernatePersistenceProvider"/>
        </property>
        <!--配置Hibernate适配器-->
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
                <!--配置是否创建数据库表-->
                <property name="generateDdl" value="false"/>
                <!--指定数据库-->
                <property name="database" value="ORACLE"/>
                <!--指定数据库语言：代表的数据库支持的特有语法-->
                <property name="databasePlatform" value="org.hibernate.dialect.Oracle10gDialect"/>
                <!--在控制台显示生成的sql语句-->
                <property name="showSql" value="true"/>
            </bean>
        </property>
        <!--配置JPA高级特性-->
        <property name="jpaDialect">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect"/>
        </property>
    </bean>
    <!--将SpringData JPA整合-->
    <jpa:repositories base-package="com.xiaoqi.mapper" transaction-manager-ref="transactionManager"
                      entity-manager-factory-ref="entityManagerFactory"></jpa:repositories>
    <!--配置事务管理器-->
    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="entityManagerFactory"/>
    </bean>
    <!--指定需要扫描的包，开启注解-->
    <context:component-scan base-package="com.xiaoqi"></context:component-scan>
</beans>

(3) 创建数据库表并编写实体类

建表的sql，这里用的时oracle数据库。

* CREATE TABLE product(
* id varchar2(32) default SYS_GUID() PRIMARY KEY,
* productNum VARCHAR2(32) NOT NULL UNIQUE,
* productName varchar(32),
* cityName varchar(32),
* departureTime date,
* productPrice number(12,2),
* productDesc VARCHAR2(500),
* productStatus INT
* );

编写实体类

import org.hibernate.annotations.GenericGenerator;
import javax.persistence.*;
import java.util.Date;
/**
 * 实体类
 */
@Entity
public class Product {
    
    @Id
    @GeneratedValue(generator = "paymentableGenerator")
    @GenericGenerator(name = "paymentableGenerator", strategy = "guid")
    private String id;
    private String productNum;
    private String productName;
    private String cityName;
    private Date departureTime;
    private double productPrice;
    private String productDesc;
    private int productStatus;
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getProductNum() {
        return productNum;
    }

    public void setProductNum(String productNum) {
        this.productNum = productNum;
    }

    public String getProductName() {
        return productName;
    }

    public void setProductName(String productName) {
        this.productName = productName;
    }

    public String getCityName() {
        return cityName;
    }

    public void setCityName(String cityName) {
        this.cityName = cityName;
    }

    public Date getDepartureTime() {
        return departureTime;
    }

    public void setDepartureTime(Date departureTime) {
        this.departureTime = departureTime;
    }

    public double getProductPrice() {
        return productPrice;
    }

    public void setProductPrice(double productPrice) {
        this.productPrice = productPrice;
    }

    public String getProductDesc() {
        return productDesc;
    }

    public void setProductDesc(String productDesc) {
        this.productDesc = productDesc;
    }

    public int getProductStatus() {
        return productStatus;
    }

    public void setProductStatus(int productStatus) {
        this.productStatus = productStatus;
    }

    @Override
    public String toString() {
        return "Product{" +
                "id='" + id + '\'' +
                ", productNum='" + productNum + '\'' +
                ", productName='" + productName + '\'' +
                ", cityName='" + cityName + '\'' +
                ", departureTime=" + departureTime +
                ", productPrice=" + productPrice +
                ", productDesc='" + productDesc + '\'' +
                ", productStatus=" + productStatus +
                '}';
    }
}

注解说明：

@Entity 声明实体类

@Table 指定实体类和表的映射关系

@Id 指定主键

@GenerateValue 指定主键的生成策略

@Colum 指定表中字段和实体类的属性之间的映射关系，这里如果属性名称和表中字段名称一致，可以省略。

(4) 编写持久层接口以及测试

使用Spring Data JPA，只需要按照框架的规范提供dao接口，不需要实现类就可以完成对数据库进行增删改查、分页查询等方法的定义，所以在写DAO接口时只需要实现JpaRepository和JpaSpecificationExecutor这两个接口并提供相应的泛型就可以了。

JpaRepository<T,D> 
 定义了对数据库的基本CRUD操作的所有方法
 泛型一：操作的实体类，泛型二：主键的数据类型
JpaSpecificationExecutor<T> 
 定义了对数据库的进行复杂操作的方法 泛型: 操作的实体类
import com.xiaoqi.domain.Product;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
/**
 *product的接口
 */
public interface ProductMapper extends JpaRepository<Product,String>, JpaSpecificationExecutor<Product> {
}
下面测试一下查询和保存操作

import com.xiaoqi.domain.Product;
import com.xiaoqi.mapper.ProductMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import java.util.List;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:applicationContext.xml") //指定spring配置文件的位置
public class ProductMapperTest {

    @Autowired
    private ProductMapper mapper;
    /**
     * 测试查询
          */
    @Test
    public void findAllTest(){
List<Product> products = mapper.findAll();
        products.forEach(a-> System.out.println(a));
    }

    /**
     * 测试保存数据到数据库
          */
    @Test
    public void saveOneTest(){
        Product product = new Product();
        product.setCityName("xian");
        product.setProductNum("xian-006");
        Product saveProduct = mapper.save(product);
        System.out.println(saveProduct);
    }
}

测试查询结果

测试插入结果

今天就到这里吧，下期小七再来介绍SpringData JPA的原理。

数据库

文章转载自小二与小七，如果涉嫌侵权，请发送邮件至：contact@modb.pro进行举报，并提供相关证据，一经查实，墨天轮将立刻删除相关内容。

SpringData JPA初入门及原理分析（上）

评论