SpringData JPA (三) SpringData JPA

最新推荐文章于 2024-03-19 11:05:47 发布

转载最新推荐文章于 2024-03-19 11:05:47 发布 · 392 阅读

Spring Data JPA 专栏收录该内容

3 篇文章

订阅专栏

本文深入讲解SpringDataJPA的特性和使用方法，包括快速入门、内部原理、查询方式等，助您高效掌握数据库操作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1 Spring Data JPA的概述

1.1 Spring Data JPA概述

在这里插入图片描述
Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架，可使开发者用极简的代码即可实现对数据库的访问和操作。它提供了包括增删改查等在内的常用功能，且易于扩展！学习并使用 Spring Data JPA 可以极大提高开发效率！

Spring Data JPA 让我们解脱了DAO层的操作，基本上所有CRUD都可以依赖于它来实现,在实际的工作工程中，推荐使用Spring Data JPA + ORM（如：hibernate）完成操作，这样在切换不同的ORM框架时提供了极大的方便，同时也使数据库层操作更加简单，方便解耦

1.2 Spring Data JPA的特性

在这里插入图片描述
SpringData Jpa 极大简化了数据库访问层代码。如何简化的呢？使用了SpringDataJpa，我们的dao层中只需要写接口，就自动具有了增删改查、分页查询等方法。

1.3 Spring Data JPA 与 JPA和hibernate之间的关系

JPA是一套规范，内部是有接口和抽象类组成的。hibernate是一套成熟的ORM框架，而且Hibernate实现了JPA规范，所以也可以称hibernate为JPA的一种实现方式，我们使用JPA的API编程，意味着站在更高的角度上看待问题（面向接口编程）

Spring Data JPA是Spring提供的一套对JPA操作更加高级的封装，是在JPA规范下的专门用来进行数据持久化的解决方案。

2 Spring Data JPA的快速入门

2.1 需求说明

Spring Data JPA完成客户的基本CRUD操作

2.2 搭建Spring Data JPA的开发环境

2.2.1 引入Spring Data JPA的坐标

使用Spring Data JPA，需要整合Spring与Spring Data JPA，并且需要提供JPA的服务提供者hibernate，所以需要导入spring相关坐标，hibernate坐标，数据库驱动坐标等。

<dependencies> 
    <dependency> 
        <groupId>mysql</groupId> 
        <artifactId>mysql-connector-java</artifactId> 
        <version>5.1.6</version> 
    </dependency> 
    <dependency> 
         <groupId>org.springframework</groupId> 
         <artifactId>spring-context</artifactId> 
         <version>5.0.2.RELEASE</version> 
     </dependency> 
    <dependency> 
        <groupId>org.springframework.data</groupId> 
        <artifactId>spring-data-jpa</artifactId> 
        <version>2.0.5.RELEASE</version> 
    </dependency> 
    <dependency>
        <groupId>c3p0</groupId> 
        <artifactId>c3p0</artifactId> 
        <version>0.9.1.2</version> 
    </dependency> 
    <dependency> 
        <groupId>org.hibernate</groupId> 
        <artifactId>hibernate-entitymanager</artifactId> 
        <version>5.0.7.Final</version> 
    </dependency> 
    <dependency> 
        <groupId>org.hibernate</groupId> 
        <artifactId>hibernate-c3p0</artifactId> 
        <version>5.0.7.Final</version> 
    </dependency> 
    <dependency> 
        <groupId>log4j</groupId> 
        <artifactId>log4j</artifactId> 
        <version>1.2.12</version> 
    </dependency> 
    <dependency> 
        <groupId>junit</groupId> 
        <artifactId>junit</artifactId> 
        <version>4.12</version> 
    </dependency> 
    <dependency> 
        <groupId>org.springframework</groupId> 
        <artifactId>spring-tx</artifactId> 
        <version>5.0.2.RELEASE</version> 
    </dependency> 
    <dependency> 
        <groupId>org.springframework</groupId> 
        <artifactId>spring-orm</artifactId> 
        <version>5.0.2.RELEASE</version> 
    </dependency> 
    <dependency> 
        <groupId>org.aspectj</groupId> 
        <artifactId>aspectjweaver</artifactId> 
        <version>1.8.7</version> 
    </dependency> 
    <dependency> 
        <groupId>org.springframework</groupId> 
        <artifactId>spring-test</artifactId> 
        <version>5.0.2.RELEASE</version> 
    </dependency>
</dependencies>

2.2.2 整合Spring Data JPA与Spring

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 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:jpa="http://www.springframework.org/schema/data/jpa" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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">
 <!-- 配置要扫描的包 -->
 <context:component-scan base-package="com.xxx"/>
 <!-- 1.dataSource -->
 <bean class="com.mchange.v2.c3p0.ComboPooledDataSource" id="dataSource">
  <property name="driverClass" value="com.mysql.jdbc.Driver"/>
  <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/ee314"/>
  <property name="user" value="root"/>
  <property name="password" value="1234"/>
 </bean>
 <!-- 2.EntityManagerFactory -->
 <bean class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean" id="entityManagerFactory">
  <property name="dataSource" ref="dataSource"/>
  <property name="packagesToScan" value="com.xxx.domain"/>
  <property name="persistenceProvider">
   <bean class="org.hibernate.jpa.HibernatePersistenceProvider"/>
  </property>
  <!--JPA供应商适配器-->
  <property name="jpaVendorAdapter">
   <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
    <property name="generateDdl" value="false"/>
    <property name="database" value="MYSQL"/>
    <property name="databasePlatform" value="org.hibernate.dialect.MySQLDialect"/>
    <property name="showSql" value="true"/>
   </bean>
  </property>
  <!--JPA方言-->
  <property name="jpaDialect">
   <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect"/>
  </property>
 </bean>
 <!-- 3.事务管理器-->
 <!-- JPA事务管理器 -->
 <bean class="org.springframework.orm.jpa.JpaTransactionManager" id="transactionManager">
  <property name="entityManagerFactory" ref="entityManagerFactory"/>
 </bean>
 <!-- 整合spring data jpa-->
 <jpa:repositories base-package="com.xxx.dao" entity-manager-factory-ref="entityManagerFactory" transaction-manager-ref="transactionManager"/>
 <!-- 4.txAdvice-->
 <tx:advice id="txAdvice" transaction-manager="transactionManager">
  <tx:attributes>
   <tx:method name="get*" propagation="SUPPORTS" read-only="true"/>
   <tx:method name="find*" propagation="SUPPORTS" read-only="true"/>
   <tx:method name="*" propagation="REQUIRED" read-only="false"/>
  </tx:attributes>
 </tx:advice>
 <!-- 5.aop-->
 <aop:config>
  <aop:pointcut expression="execution(* com.xxx.service.*.*(..))" id="pointcut"/>
  <aop:advisor advice-ref="txAdvice" pointcut-ref="pointcut"/>
 </aop:config>
</beans>

2.2.3 使用JPA注解配置映射关系

我们使用昨天案例中的Customer实体类对象，已经配置好了映射关系

/** 
 * 所有的注解都是使用JPA的规范提供的注解， 
 * 所以在导入注解包的时候，一定要导入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; } }

2.3 使用Spring Data JPA完成需求

2.3.1 编写符合Spring Data JPA规范的Dao层接口

Spring Data JPA是spring提供的一款对于数据访问层（Dao层）的框架，使用Spring Data JPA，只需要按照框架的规范提供dao接口，不需要实现类就可以完成数据库的增删改查、分页查询等方法的定义，极大的简化了我们的开发过程。

在Spring Data JPA中，对于定义符合规范的Dao层接口，我们只需要遵循以下几点就可以了：

创建一个Dao层接口，并实现JpaRepository和JpaSpecificationExecutor
提供相应的泛型

import java.util.List; 
import org.springframework.data.jpa.repository.JpaRepository; 
import org.springframework.data.jpa.repository.JpaSpecificationExecutor; 
import cn.itcast.entity.Customer; 
/** 
 * JpaRepository<实体类类型，主键类型>：用来完成基本CRUD操作 
 * JpaSpecificationExecutor<实体类类型>：用于复杂查询（分页等查询操作） 
 * */
public interface CustomerDao extends JpaRepository<Customer, Long>, JpaSpecificationExecutor<Customer> { }

这样我们就定义好了一个符合Spring Data JPA规范的Dao层接口.

2.3.2 编写业务层代码

public interface ICustomerService { 
    /** 
     * @param customer
     * */ 
    void saveCustomer(Customer customer); 
    /** 
     * @param customer 
     * */ 
    void updateCustomer(Customer customer); 
    /** 
     * @param customer 
     * */ 
    void deleteCustomer(Customer customer); 
    /** 
     * @param custId 
     * @return 
     * */ 
    Optional<Customer> findById(Integer custId);
}

@Service("customerService") 
public class CustomerServiceImpl implements ICustomerService { 
    @Autowired 
    private ICustomerDao customerDao; 
    @Override public void saveCustomer(Customer customer) { 
        customerDao.save(customer); 
    } 
    @Override public void updateCustomer(Customer customer) {
        customerDao.save(customer); 
    } 
    @Override public void deleteCustomer(Customer customer) { 
        customerDao.delete(customer); 
    } 
    @Override public Optional<Customer> findById(Integer custId) { 
        return customerDao.findById(custId); 
    } 
}

2.3.3 完成基本CRUD操作

@RunWith(SpringJUnit4ClassRunner.class) 
@ContextConfiguration(locations="classpath:applicationContext.xml") 
public class SpringDataJPATest { 
    @Autowired 
    private ICustomerService cs; 
    @Test 
    public void testSave() { 
        Customer c = new Customer(); 
        c.setCustName("spring data jpa"); 
        cs.saveCustomer(c); 
    } 
    @Test 
    public void testUpdate() { 
        Optional<Customer> optional = cs.findById(94); 
        Customer c = optional.get(); 
        c.setCustAddress("北京"); 
        cs.updateCustomer(c); 
    }
    @Test 
    public void testDelete() { 
        Optional<Customer> optional = cs.findById(94); 
        Customer c = optional.get(); 
        cs.deleteCustomer(c); 
    } 
    @Test 
    public void testFindOne() { 
        Optional<Customer> optional = cs.findById(94); 
        System.out.println(optional.get()); 
    } 
}

3 Spring Data JPA的内部原理剖析

3.1 Spring Data JPA的常用接口分析

在客户的案例中，我们发现在自定义的CustomerDao中，并没有提供任何方法就可以使用其中的很多方法，那么这些方法究竟是怎么来的呢？答案很简单，对于我们自定义的Dao接口，由于继承了JpaRepository和JpaSpecificationExecutor，所以我们可以使用这两个接口的所有方法。
在这里插入图片描述
在使用Spring Data JPA时，一般实现JpaRepository和JpaSpecificationExecutor接口，这样就可以使用这些接口中定义的方法，但是这些方法都只是一些声明，没有具体的实现方式，那么在 Spring Data JPA中它又是怎么实现的呢？

3.2 Spring Data JPA的实现过程

通过对客户案例，以debug断点调试的方式，通过分析Spring Data JPA的原来来分析程序的执行过程，我们以findOne方法为例进行分析：

代理子类的实现过程
在这里插入图片描述
断点执行到方法上时，我们可以发现注入的customerDao对象，本质上是通过JdkDynamicAopProxy生成的一个代理对象

代理对象中方法调用的分析

当程序执行的时候，会通过JdkDynamicAopProxy的invoke方法，对customerDao对象生成动态代理对象。根据对Spring Data JPA介绍而知，要想进行findOne查询方法，最终还是会出现JPA规范的API完成操作，那么这些底层代码存在于何处呢？答案很简单，都隐藏在通过JdkDynamicAopProxy生成的动态代理对象当中，而这个动态代理对象就是SimpleJpaRepository

在这里插入图片描述
通过SimpleJpaRepository的源码分析，定位到了findOne方法，在此方法中，返回em.find()的返回结果，那么em又是什么呢？

在这里插入图片描述
带着问题继续查找em对象，我们发现em就是EntityManager对象，而他是JPA原生的实现方式，所以我们得到结论：

$SpringDataJPA只是对标准JPA操作进行了进一步封装，简化了Dao层代码的开发。\color{red}{Spring Data JPA只是对标准JPA操作进行了进一步封装，简化了Dao层代码的开发。}$

3.3 Spring Data JPA完整的调用过程分析

在这里插入图片描述

4 Spring Data JPA的查询方式

4.1 使用Spring Data JPA中接口定义的方法进行查询

在继承JpaRepository，和JpaSpecificationExecutor接口后,我们就可以使用接口中定义的方法进行查询

4.1.1 继承JpaRepository后的方法列表

在这里插入图片描述

4.1.2 继承JpaSpecificationExecutor的方法列表

在这里插入图片描述

4.2 使用JPQL的方式查询

使用Spring Data JPA提供的查询方法已经可以解决大部分的应用场景，但是对于某些业务来说，我们还需要灵活的构造查询条件，这时就可以使用@Query注解，结合JPQL的语句方式完成查询

@Query 注解的使用非常简单，只需在方法上面标注该注解，同时提供一个JPQL查询语句即可

public interface CustomerDao extends JpaRepository<Customer, Long>,JpaSpecificationExecutor<Customer> { 
    //@Query 使用jpql的方式查询。 
    @Query(value="from Customer") 
    public List<Customer> findAllCustomer(); 
    //@Query 使用jpql的方式查询。?1代表参数的占位符，其中1对应方法中的参数索引
    @Query(value="from Customer where custName = ?1") 
    public Customer findCustomer(String custName); 
}

此外，也可以通过使用 @Query 来执行一个更新操作，为此，我们需要在使用 @Query 的同时，用 @Modifying 来将该操作标识为修改查询，这样框架最终会生成一个更新的操作，而非查询

@Query(value="update Customer set custName = ?1 where custId = ?2") 
@Modifying 
public void updateCustomer(String custName,Long custId);

4.3 使用SQL语句查询

Spring Data JPA同样也支持sql语句的查询，如下：

/** 
 * nativeQuery : 使用本地sql的方式查询 
 * */ 
@Query(value="select * from cst_customer",nativeQuery=true) 
public void findSql();

4.4 方法命名规则查询

顾名思义，方法命名规则查询就是根据方法的名字，就能创建查询。只需要按照Spring Data JPA提供的方法命名规则定义方法的名称，就可以完成查询工作。Spring Data JPA在程序执行的时候会根据方法名称进行解析，并自动生成查询语句进行查询

按照Spring Data JPA 定义的规则，查询方法以findBy开头，涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性首字母需大写。框架在进行方法名解析时，会先把方法名多余的前缀截取掉，然后对剩下部分进行解析。

//方法命名方式查询（根据客户名称查询客户） 
public Customer findByCustName(String custName);

具体的关键字，使用方法和生产成SQL如下表所示:
在这里插入图片描述

在这里插入图片描述

5 Specifications动态查询

有时我们在查询某个实体的时候，给定的条件是不固定的，这时就需要动态构建相应的查询语句，在Spring Data JPA中可以通过JpaSpecificationExecutor接口查询。相比JPQL,其优势是类型安全,更加的面向对象。

import java.util.List; 
import org.springframework.data.domain.Page; 
import org.springframework.data.domain.Pageable; 
import org.springframework.data.domain.Sort; 
import org.springframework.data.jpa.domain.Specification; 
/** 
 * JpaSpecificationExecutor中定义的方法 
 * */ 
public interface JpaSpecificationExecutor<T> { 
    //根据条件查询一个对象 T 
    findOne(Specification<T> spec); 
    //根据条件查询集合 
    List<T> findAll(Specification<T> spec); 
    //根据条件分页查询 
    Page<T> findAll(Specification<T> spec, Pageable pageable); 
    //排序查询查询 
    List<T> findAll(Specification<T> spec, Sort sort); 
    //统计查询 
    long count(Specification<T> spec); 
}

对于JpaSpecificationExecutor，这个接口基本是围绕着Specification接口来定义的。我们可以简单的理解为，Specification构造的就是查询条件。

Specification接口中只定义了如下一个方法：

//构造查询条件 
/** 
 * root ：Root接口，代表查询的根对象，可以通过root获取实体中的属性 
 * query ：代表一个顶层查询对象，用来自定义查询 
 * cb ：用来构建查询，此对象里有很多条件方法 
 * */ 
public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);

5.1 使用Specifications完成条件查询

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:applicationContext.xml")
public class SepcificationTest {
    @Autowired
    private ICustomerService cs;

    /**
     * 查询所有带条件
     */
    @Test
    public void testFindAll() {
        Specification<Customer> spec = new Specification<Customer>() {
            /** * root表示实体类对象 * query是查询的顶层对象 * CriteriaBuilder用于添加查询条件 */
            @Override
            public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
                return cb.and(cb.equal(root.get("custName").as(String.class), "xxx"), cb.like(root.get("custAddress"), "%北%"));
            }
        };
        List list = cs.findAll(spec);
        System.out.println(list);
    }
}

5.2 基于Specifications的分页查询

/**
 * 查询带分页
 */
@Test
public void testFindAllPage() {
    Specification<Customer> spec = new Specification<Customer>() {
        /** 
         * root表示实体类对象 
         * query是查询的顶层对象 
         * CriteriaBuilder用于添加查询条件 
         * */
        @Override
        public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
            return cb.like(root.get("custAddress"), "%北%");
        }
    };
    Pageable pageable = PageRequest.of(0, 2);
    Page<Customer> page = cs.findAll(spec, pageable);
    for (Object obj : page.getContent()) System.out.println(obj);
}

/**
 * 构造分页参数 
 * Pageable : 接口 
 * PageRequest实现了Pageable接口，调用构造方法的形式构造 
 * 第一个参数：页码（从0开始） 
 * 第二个参数：每页查询条数
 */
Pageable pageable = new PageRequest(0, 5);
/**
 * 分页查询，封装为Spring Data Jpa 内部的page bean 
 * 此重载的findAll方法为分页方法需要两个参数 
 * 第一个参数：查询条件Specification 
 * 第二个参数：分页参数
 */
Page<Customer> page = customerDao.findAll(spec, pageable);

对于Spring Data JPA中的分页查询，是其内部自动实现的封装过程，返回的是一个Spring Data JPA提供的pageBean对象。其中的方法说明如下：

//获取总页数 
int getTotalPages(); 
//获取总记录数 
long getTotalElements();
//获取列表数据 
List<T> getContent();

5.3 Specification多表查询

/** 
 * 连接查询 
 * */ 
@Test 
public void testFindLeftJoin() { 
    Specification<Customer> spec = new Specification<Customer>() { 
        /** 
         * root表示实体类对象 
         * query是查询的顶层对象 
         * CriteriaBuilder用于添加查询条件 
         * */ 
        @Override 
        public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query, CriteriaBuilder cb) { 
            //Join代表链接查询，通过root对象获取 
            //创建的过程中，第一个参数为关联对象的属性名称，第二个参数为连接查询的方式（left，inner，right） 
            //JoinType.LEFT : 左外连接,JoinType.INNER：内连接,JoinType.RIGHT：右外连接 
            Join<Customer,LinkMan> join = root.join("linkmans",JoinType.LEFT); 
            return cb.like(root.get("custAddress"), "%北%"); 
        } 
    }; 
    Pageable pageable = PageRequest.of(0,2); 
    Page<Customer> page = cs.findAll(spec,pageable); 
    List<Customer> list = page.getContent(); 
    for(Customer cust : list) { 
        System.out.println(cust); 
        System.out.println(cust.getLinkmans()); 
    } 
}