SpringData

JPA Spring Data

概述：

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

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

JAR

需要JPA的包，和 Spring Data Commons 、Spring Data JP、slf4j

创建步骤

使用 Spring Data JPA 进行持久层开发需要的四个步骤：

• 配置 Spring 整合 JPA

• 在 Spring 配置文件中配置 Spring Data，让 Spring 为声明的接口创建代理对象。配置了 jpa:repositories 后，Spring 初始化容器时将会扫描 base-package 指定的包目录及其子目录，为继承 Repository 或其子接口的接口创建代理对象，并将代理对象注册为 Spring Bean，业务层便可以通过 Spring 自动封装的特性来直接使用该对象。

• 声明持久层的接口，该接口继承 Repository，Repository 是一个标记型接口，它不包含任何方法，如必要，Spring Data 可实现 Repository 其他子接口，其中定义了一些常用的增删改查，以及分页相关的方法。

• 在接口中声明需要的方法。Spring Data 将根据给定的策略（具体策略稍后讲解）来为其生成实现代码。

Repository 的子接口

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

• Repository： 仅仅是一个标识，表明任何继承它的均为仓库接口类
• CrudRepository： 继承 Repository，实现了一组 CRUD 相关的方法
• PagingAndSortingRepository： 继承 CrudRepository，实现了一组分页排序相关的方法
• JpaRepository： 继承 PagingAndSortingRepository，实现一组 JPA 规范相关的方法
• 自定义的 XxxxRepository 需要继承 JpaRepository，这样的 XxxxRepository 接口就具备了通用的数据访问控制层的能力。
• JpaSpecificationExecutor： 不属于Repository体系，实现一组 JPA Criteria 查询相关的方法

接口关系图

在 Repository 子接口中声明方法

• 不是随便声明的. 而需要符合一定的规范
• 查询方法以 find | read | get 开头
• 涉及条件查询时，条件的属性用条件关键字连接
• 要注意的是：条件属性以首字母大写。
• 支持属性的级联查询. 若当前类有符合条件的属性, 则优先使用, 而不使用级联属性.

若需要使用级联属性, 则属性之间使用 _ 进行连接.

简单条件查询

• 简单条件查询: 查询某一个实体类或者集合
• 按照 Spring Data 的规范，查询方法以 find | read | get 开头， 涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写。
• 例如：定义一个 Entity 实体类

class User｛ 
    private String firstName; 
    private String lastName;｝ 

使用And条件连接时，方法名应这样写：

条件的属性名称与个数要与参数的位置与个数一一对应

interface UserRepsotory extends JpaRepository<User, Integer>{
	User findByLastNameAndFirstName(String lastName,String firstName); 
}

@Query自定义查询

这种查询可以声明在 Repository 方法中，摆脱像命名查询那样的约束，将查询直接在相应的接口方法中声明，

结构更为清晰，这是 Spring data 的特有实现。

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

• 索引参数如下所示，索引值从1开始，查询中 ”?X” 个数需要与方法定义的参数个数相一致，并且顺序也要一致
• 命名参数（推荐使用这种方式）：可以定义好参数名，赋值时采用@Param(“参数名”)，而不用管顺序。

//为 @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);

• 如果是 @Query 中有 LIKE 关键字，后面的参数需要前面或者后面加 %，这样在传递参数值的时候就可以不加 %：

//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("

• 还可以使用@Query来指定本地查询，只要设置nativeQuery为true，比如：

表名为数据库的表的名称，不是类名

@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)
    public List<UserModel> findByUuidOrAge(String name);

@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);

需要在service上调用，需要加入事务

子接口 CrudRepository 接口

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

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

子接口 PagingAndSortingRepository接口

该接口提供了分页与排序功能 ，实现不了带查询条件进行分页

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

@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);  不排序
    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());
}

子接口 JpaRepository接口

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

• List findAll(); //查找所有实体
• List findAll(Sort sort); //排序、查找所有实体
• List save(Iterable<? extends T> entities);//保存集合
• void flush();//执行缓存与数据库同步
• T saveAndFlush(T entity);//强制执行持久化 (对象主键值为空时进行添加，有值时进行修改)
• void deleteInBatch(Iterable entities);//删除一个实体集合

子接口 JpaSpecificationExecutor接口

不属于Repository体系，实现一组 JPA Criteria 查询相关的方法 ，Specification封装了查询条件

JpaSpecificationExecutor接口 继承了PagingAndSortingRepository接口

• T findOne(Specification spec);

• List findAll(Specification spec);

• Page findAll(Specification spec,Pageable pageable)); 根据条件对查询结果进行排序或者分页

  • Pageable: 封装了请求分页的信息: 例如 pageNo, pageSize, Sort

• List findAll(Specification spec,Sort sort);

• int count(Specification spec);

@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());
}
	

自定义 Repository 方法

步骤：

• 1.定义一个接口: 声明要添加的, 并自实现的方法
• 2.提供该接口的实现类: 类名需在要声明的 Repository 后添加 Impl, 并实现方法
• 3.声明 Repository 接口, 并继承 步骤1声明的接口
  使用.
  "当前页面的 List: " + page.getContent());
  System.out.println("当前页面的记录数: " + page.getNumberOfElements());
  }

#### 自定义 Repository 方法

步骤：

- 1.定义一个接口: 声明要添加的, 并自实现的方法
- 2.提供该接口的实现类: 类名需在要声明的 Repository 后添加 Impl, 并实现方法
- 3.声明 Repository 接口, 并继承  步骤1声明的接口
  使用. 
- 注意: 默认情况下, Spring Data 会在 base-package 中查找 "接口名Impl" 作为实现类. 也可以通过　repository-impl-postfix　声明后缀. [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GFinD4r3-1594206945799)(C:\Users\potato\Desktop\笔记总结\img\20200708082401.png)]