SpringData JPA

一、概述

1. SpringData 概述

• Spring Data : Spring 的一个子项目。用于简化数据库访问，支持NoSQL 和 关系数据存储。其主要目标是使数据库的访问变得方便快捷。

• SpringData 项目所支持 NoSQL 存储：

  • MongoDB （文档数据库）
  • Neo4j（图形数据库）
  • Redis（键/值存储）
  • Hbase（列族数据库）

• SpringData 项目所支持的关系数据存储技术：

  • JDBC
  • JPA

2. JPA SpringData 概述

• JPA Spring Data : 致力于减少数据访问层 (DAO) 的开发量. 开发者唯一要做的，就只是声明持久层的接口，其他都交给 Spring Data JPA 来帮你完成！

• 框架怎么可能代替开发者实现业务逻辑呢？比如：当有一个 UserDao.findUserById() 这样一个方法声明，大致应该能判断出这是根据给定条件的 ID 查询出满足条件的 User 对象。Spring Data JPA 做的便是规范方法的名字，根据符合规范的名字来确定方法需要实现什么样的逻辑。

二、环境搭建

1. 前提

• 同时下载 Spring Data Commons 和 Spring Data JPA 两个发布包：
  • Commons 是 Spring Data 的基础包
  • 并把相关的依赖 JAR 文件加入到 CLASSPATH 中
• 在 Spring 的配置文件中配置 Spring Data

2. 整合 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:context="http://www.springframework.org/schema/context"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:jpa="http://www.springframework.org/schema/data/jpa"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
        http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">

    <!-- 配置自动扫描的包 -->
    <context:component-scan base-package="com.atguigu.springdata" />

    <!-- 1. 配置数据源 -->
    <context:property-placeholder location="classpath:db.properties" />

    <bean id="dataSource"
        class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <property name="user" value="${jdbc.user}"></property>
        <property name="password" value="${jdbc.password}"></property>
        <property name="driverClass" value="${jdbc.driverClass}"></property>
        <property name="jdbcUrl" value="${jdbc.jdbcUrl}"></property>
    </bean>

    <!-- 2. 配置 JPA 的 EntityManagerFactory -->
    <bean id="entityManagerFactory"
        class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!-- jpa 实现产品的适配器 -->
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter" />
        </property>
        <!-- 扫描加 Entity 注解的那些包 -->
        <property name="packagesToScan" value="com.atguigu.springdata" />
        <!-- jpa 具体实现产品的属性  -->
        <property name="jpaProperties">
            <props>
                <!-- 二级缓存相关 -->
                <!-- <prop key="hibernate.cache.region.factory_class">org.hibernate.cache.ehcache.EhCacheRegionFactory</prop> 
                    <prop key="net.sf.ehcache.configurationResourceName">ehcache-hibernate.xml</prop> -->
                <!-- 生成的数据表的列的映射策略 -->
                <prop key="hibernate.ejb.naming_strategy">org.hibernate.cfg.ImprovedNamingStrategy</prop>
                <!-- hibernate 基本属性 -->
                <prop key="hibernate.dialect">org.hibernate.dialect.MySQL5InnoDBDialect</prop>
                <prop key="hibernate.show_sql">true</prop>
                <prop key="hibernate.format_sql">true</prop>
                <prop key="hibernate.hbm2ddl.auto">update</prop>
            </props>
        </property>
    </bean>

    <!-- 3. 配置事务管理器 -->
    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="entityManagerFactory" />
    </bean>

    <!-- 4. 配置支持注解的事务 -->
    <tx:annotation-driven transaction-manager="transactionManager"/>

    <!-- 5. 配置 SpringData -->
    <!-- 加入  jpa 的命名空间 -->
    <!-- base-package: 扫描 Repository Bean 所在的 package(extends Repository 接口的接口) -->
    <jpa:repositories base-package="com.atguigu.springdata" entity-manager-factory-ref="entityManagerFactory" />

</beans>

3. 编写实体类

4. 编写 PersonRepsotory 接口

5. 运行测试

package com.atguigu.springdata.test;

import java.sql.SQLException;

import javax.sql.DataSource;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.atguigu.springdata.Person;
import com.atguigu.springdata.PersonRepsotory;

class SpringDataTest {

    private ApplicationContext ctx = null;

    {
        ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
    }

    @Test
    public void testHelloWorldSpringData() {
        PersonRepsotory personRepsotory = ctx.getBean(PersonRepsotory.class);
        Person person = personRepsotory.getByLastName("AA");
        System.out.println(person);
    }

    @Test
    public void testJpa(){
        
    }
    
    @Test
    public void testDataSource() throws SQLException {
        DataSource dataSource = ctx.getBean(DataSource.class);
        System.out.println(dataSource.getConnection());
    }

}

三、Repository 接口概述

1. 概述

• Repository 接口是 Spring Data 的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法
  public interface Repository<T, ID extends Serializable> { }

• Spring Data可以让我们只定义接口，只要遵循 Spring Data的规范，就无需写实现类。

• 与继承 Repository 等价的一种方式，就是在持久层接口上使用 @RepositoryDefinition 注解，并为其指定 domainClass 和 idClass 属性。如下两种方式是完全等价的

2. Repository 的子接口

基础的 Repository 提供了最基本的数据访问功能，其几个子接口则扩展了一些功能。它们的继承关系如下：

• Repository： 仅仅是一个标识，表明任何继承它的均为仓库接口类

• CrudRepository： 继承 Repository，实现了一组 CRUD 相关的方法

• PagingAndSortingRepository： 继承 CrudRepository，实现了一组分页排序相关的方法

• JpaRepository： 继承 PagingAndSortingRepository，实现一组 JPA 规范相关的方法

• 自定义的 XxxxRepository 需要继承 JpaRepository，这样的 XxxxRepository 接口就具备了通用的数据访问控制层的能力。

• JpaSpecificationExecutor： 不属于Repository体系，实现一组 JPA Criteria 查询相关的方法

四、SpringData 方法定义规范

直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下：

1. 示例

package com.atguigu.springdata;

import java.util.Date;
import java.util.List;

import org.springframework.data.repository.Repository;

/**
 * 1. Repository 是一个空接口. 即是一个标记接口
 * 2. 若我们定义的接口继承了 Repository, 则该接口会被 IOC 容器识别为一个 Repository Bean.
 *  纳入到 IOC 容器中. 进而可以在该接口中定义满足一定规范的方法. 
 * 
 * 3. 实际上, 也可以通过 @RepositoryDefinition 注解来替代继承 Repository 接口
 */
/**
 * 在 Repository 子接口中声明方法
 * 1. 不是随便声明的. 而需要符合一定的规范
 * 2. 查询方法以 find | read | get 开头
 * 3. 涉及条件查询时，条件的属性用条件关键字连接
 * 4. 要注意的是：条件属性以首字母大写。
 * 5. 支持属性的级联查询. 若当前类有符合条件的属性, 则优先使用, 而不使用级联属性. 
 * 若需要使用级联属性, 则属性之间使用 _ 进行连接. 
 */
// 传入两个泛型：1-实际实体类的类型 2-主键类型
//@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)
public interface PersonRepsotory extends Repository<Person, Integer>{
    
    // 根据 lastName 来获取对应的 person
    Person getByLastName(String lastName);
    
    // WHERE lastName LIKE ?% AND id < ?
    List<Person> getByLastNameStartingWithAndIdLessThan(String lastName, Integer id);
    
    // WHERE lastName LIKE %? AND id < ?
    List<Person> getByLastNameEndingWithAndIdLessThan(String lastName, Integer id);
    
    // WHERE email IN (?, ?, ?) OR birth < ?
    List<Person> getByEmailInOrBirthLessThan(List<String> emails, Date birth);
    
    // WHERE a.id > ?
    List<Person> getByAddress_IdGreaterThan(Integer id);
}

    @Test
    public void testKeyWords2(){
        List<Person> persons = personRepsotory.getByAddress_IdGreaterThan(1);
        System.out.println(persons);
    }
    
    @Test
    public void testKeyWords(){
        List<Person> persons = personRepsotory.getByLastNameStartingWithAndIdLessThan("E", 10);
        System.out.println(persons);
        
        persons = personRepsotory.getByLastNameEndingWithAndIdLessThan("E", 10);
        System.out.println(persons);
        
        persons = personRepsotory.getByEmailInOrBirthLessThan(Arrays.asList("AA@atguigu.com", "FF@atguigu.com", 
                "SS@atguigu.com"), new Date());
        System.out.println(persons.size());
        
    }

注：若属性名与外键名重名时，查询时使用下划线区分（getByAddress_IdGreaterThan）

五、使用 @Query、@Modifying 注解

1. @Query

    // 查询 id 值最大的那个 Person
    // 使用 @Query 注解可以自定义 JPQL 语句以实现更灵活的查询
    @Query("SELECT p FROM Person p WHERE p.id = (SELECT max(p2.id) FROM Person p2)")
    Person getMaxIdPerson();

    // 为 @Query 注解传递参数的方式1: 使用占位符.
    @Query("SELECT p FROM Person p WHERE p.lastName = ?1 AND p.email = ?2")
    List<Person> testQueryAnnotationParams1(String lastName, String email);

    // 为 @Query 注解传递参数的方式1: 命名参数的方式.
    @Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")
    List<Person> testQueryAnnotationParams2(@Param("email") String email, @Param("lastName") String lastName);

    // SpringData 允许在占位符上添加 %%.
    @Query("SELECT p FROM Person p WHERE p.lastName LIKE %?1% OR p.email LIKE %?2%")
    List<Person> testQueryAnnotationLikeParam(String lastName, String email);

    // SpringData 允许在占位符上添加 %%.
    @Query("SELECT p FROM Person p WHERE p.lastName LIKE %:lastName% OR p.email LIKE %:email%")
    List<Person> testQueryAnnotationLikeParam2(@Param("email") String email, @Param("lastName") String lastName);

    // 设置 nativeQuery=true 即可以使用原生的 SQL 查询
    @Query(value = "SELECT count(id) FROM jpa_persons", nativeQuery = true)
    long getTotalCount();

    @Test
    public void testNativeQuery(){
        long count = personRepsotory.getTotalCount();
        System.out.println(count);
    }
    
    @Test
    public void testQueryAnnotationLikeParam(){
//      占位符未写%号时，需要构建%传递过去
//      List<Person> persons = personRepsotory.testQueryAnnotationLikeParam("%A%", "%bb%");
//      System.out.println(persons.size());
        
//      占位符书写%号时
//      List<Person> persons = personRepsotory.testQueryAnnotationLikeParam("A", "bb");
//      System.out.println(persons.size());
        
        List<Person> persons = personRepsotory.testQueryAnnotationLikeParam2("bb", "A");
        System.out.println(persons.size());
    }
    
    @Test
    public void testQueryAnnotationParams2(){
        List<Person> persons = personRepsotory.testQueryAnnotationParams2("AA@dsad.com", "AA");
        System.out.println(persons);
    }
    
    @Test
    public void testQueryAnnotationParams1(){
        List<Person> persons = personRepsotory.testQueryAnnotationParams1("AA", "AA@dsad.com");
        System.out.println(persons);
    }

    @Test
    public void testQueryAnnotation(){
        Person person = personRepsotory.getMaxIdPerson();
        System.out.println(person);
    }

2. @Modifying

    //可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作. 注意: JPQL 不支持使用 INSERT
    //在 @Query 注解中编写 JPQL 语句, 但必须使用 @Modifying 进行修饰. 以通知 SpringData, 这是一个 UPDATE 或 DELETE 操作
    //UPDATE 或 DELETE 操作需要使用事务, 此时需要定义 Service 层. 在 Service 层的方法上添加事务操作. 
    //默认情况下, SpringData 的每个方法上有事务, 但都是一个只读事务. 他们不能完成修改操作!
    @Modifying
    @Query("UPDATE Person p SET p.email = :email WHERE id = :id")
    void updatePersonEmail(@Param("id") Integer id, @Param("email") String email);

    @Test
    public void testModifying(){
//      personRepsotory.updatePersonEmail(1, "mmmm@atguigu.com");
        personService.updatePersonEmail("mmmm@atguigu.com", 1);
    }

@Service
public class PersonService {

    @Autowired
    private PersonRepsotory personRepsotory;
    
    @Transactional
    public void updatePersonEmail(String email, Integer id){
        personRepsotory.updatePersonEmail(id, email);
    }
}

六、Repsotory 子接口

1. CrudRepository

CrudRepository 接口提供了最基本的对实体类的添删改查操作

• T save(T entity);//保存单个实体
• Iterable<T> save(Iterable<? extends T> entities);//保存集合
• T findOne(ID id);//根据id查找实体
• boolean exists(ID id);//根据id判断实体是否存在
• Iterable<T> findAll();//查询所有实体,不用或慎用!
• long count();//查询实体数量
• void delete(ID id);//根据Id删除实体
• void delete(T entity);//删除一个实体
• void delete(Iterable<? extends T> entities);//删除一个实体的集合
• void deleteAll();//删除所有实体,不用或慎用!

public interface PersonRepsotory extends CrudRepository<Person, Integer> {
}

@Transactional
public void savePersons(List<Person> persons){
    personRepsotory.save(persons);
}

@Test
public void testCrudReposiory(){
    List<Person> persons = new ArrayList<>();
    
    for(int i = 'a'; i <= 'z'; i++){
        Person person = new Person();
        person.setAddressId(i + 1);
        person.setBirth(new Date());
        person.setEmail((char)i + "" + (char)i + "@atguigu.com");
        person.setLastName((char)i + "" + (char)i);
        
        persons.add(person);
    }
    
    personService.savePersons(persons);
}

2. PagingAndSortingRepository

该接口提供了分页与排序功能

• Iterable<T> findAll(Sort sort); //排序
• Page<T> findAll(Pageable pageable); //分页查询（含排序功能）

public interface PersonRepsotory extends PagingAndSortingRepository<Person, Integer> {
}

@Test
public void testPagingAndSortingRespository(){
    //pageNo 从 0 开始. 
    int pageNo = 6 - 1;
    int pageSize = 5;
    //Pageable 接口通常使用的其 PageRequest 实现类. 其中封装了需要分页的信息
    //排序相关的. Sort 封装了排序的信息
    //Order 是具体针对于某一个属性进行升序还是降序. 
    Order order1 = new Order(Direction.DESC, "id");
    Order order2 = new Order(Direction.ASC, "email");
    Sort sort = new Sort(order1, order2);
    
    PageRequest pageable = new PageRequest(pageNo, pageSize, sort);
    Page<Person> page = personRepsotory.findAll(pageable);
    
    System.out.println("总记录数: " + page.getTotalElements());
    System.out.println("当前第几页: " + (page.getNumber() + 1));
    System.out.println("总页数: " + page.getTotalPages());
    System.out.println("当前页面的 List: " + page.getContent());
    System.out.println("当前页面的记录数: " + page.getNumberOfElements());
}
    

3. JpaRepository

该接口提供了JPA的相关功能

• List<T> findAll(); //查找所有实体
• List<T> findAll(Sort sort); //排序、查找所有实体
• List<T> save(Iterable<? extends T> entities);//保存集合
• void flush();//执行缓存与数据库同步
• T saveAndFlush(T entity);//强制执行持久化
• void deleteInBatch(Iterable<T> entities);//删除一个实体集合

4. JpaSpecificationExecutor接口(可查询带条件的分页)

public interface PersonRepsotory extends JpaRepository<Person, Integer>,JpaSpecificationExecutor<Person> {
}

/**
     * 目标: 实现带查询条件的分页. id > 5 的条件
     * 
     * 调用 JpaSpecificationExecutor 的 Page<T> findAll(Specification<T> spec, Pageable pageable);
     * Specification: 封装了 JPA Criteria 查询的查询条件
     * Pageable: 封装了请求分页的信息: 例如 pageNo, pageSize, Sort
     */
    @Test
    public void testJpaSpecificationExecutor(){
        int pageNo = 3 - 1;
        int pageSize = 5;
        PageRequest pageable = new PageRequest(pageNo, pageSize);
        
        //通常使用 Specification 的匿名内部类
        Specification<Person> specification = new Specification<Person>() {
            /**
             * @param *root: 代表查询的实体类. 
             * @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以
             * 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象. 
             * @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象
             * @return: *Predicate 类型, 代表一个查询条件. 
             */
            @Override
            public Predicate toPredicate(Root<Person> root,
                    CriteriaQuery<?> query, CriteriaBuilder cb) {
                Path path = root.get("id");
                Predicate predicate = cb.gt(path, 5);
                return predicate;
            }
        };
        
        Page<Person> page = personRepsotory.findAll(specification, pageable);
        
        System.out.println("总记录数: " + page.getTotalElements());
        System.out.println("当前第几页: " + (page.getNumber() + 1));
        System.out.println("总页数: " + page.getTotalPages());
        System.out.println("当前页面的 List: " + page.getContent());
        System.out.println("当前页面的记录数: " + page.getNumberOfElements());
    }

5. 自定义 Repsotory 方法

(1) 创建 PersonDao 接口

public interface PersonDao {    
    void test();    
}

(2) 创建实现类PersonRepsotoryImpl（名称必须是需在要声明的 Repository + Impl）
注意: 默认情况下, Spring Data 会在 base-package 中查找 "接口名Impl" 作为实现类. 也可以通过　repository-impl-postfix　声明后缀.

public class PersonRepsotoryImpl implements PersonDao {
    
    @PersistenceContext
    private EntityManager entityManager;
    
    @Override
    public void test() {
        Person person = entityManager.find(Person.class, 11);
        System.out.println("-->" + person);
    }

}

(3) 需在要声明的 Repository 接口继承PersonDao

public interface PersonRepsotory extends JpaRepository<Person, Integer>,JpaSpecificationExecutor<Person>,PersonDao {
}

@Test
public void testCustomRepositoryMethod(){
    personRepsotory.test();
}