天天看点

【spring-data】spring-data学习

Spring data简述

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

•SpringData项目所支持 NoSQL 存储:

–MongoDB(文档数据库)

–Neo4j(图形数据库)

–Redis(键/值存储)

–Hbase(列族数据库)

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

–JDBC

–JPA

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

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

Spring Data Jpa HelloWorld

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

–配置Spring 整合JPA

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

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

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

环境搭建

•同时下载 Spring Data Commons 和 Spring Data JPA 两个发布包:

–Commons 是 Spring Data 的基础包

–并把相关的依赖 JAR 文件加入到 CLASSPATH 中

 •在 Spring 的配置文件中配置 Spring Data

【spring-data】spring-data学习

​​

代码演示:

【spring-data】spring-data学习

​​

Repository 接口

•Repository 接口是 Spring Data 的一个核心接口,它不提供任何方法,开发者需要在自己定义的接口中声明需要的方法 

 public interface RepositorySerializable> { } 

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

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

Repository 的子接口

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

–Repository: 仅仅是一个标识,表明任何继承它的均为仓库接口类

–CrudRepository: 继承 Repository,实现了一组 CRUD 相关的方法 

–PagingAndSortingRepository: 继承 CrudRepository,实现了一组分页排序相关的方法 

–JpaRepository: 继承 PagingAndSortingRepository,实现一组 JPA 规范相关的方法 

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

–JpaSpecificationExecutor: 不属于Repository体系,实现一组 JPACriteria 查询相关的方法 

SpringData 方法定义规范

•简单条件查询: 查询某一个实体类或者集合 

•按照 Spring Data 的规范,查询方法以 find | read | get 开头, 

涉及条件查询时,条件的属性用条件关键字连接,要注意的是:条件属性以首字母大写。 

•例如:定义一个 Entity 实体类 

class User{ 

  private String firstName; 

  private String lastName; 

} 

使用And条件连接时,应这样写: 

findByLastNameAndFirstName(String lastName,StringfirstName); 

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

支持的关键字

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

【spring-data】spring-data学习

​​

【spring-data】spring-data学习

​​

查询方法解析流程

•假如创建如下的查询:findByUserDepUuid(),框架在解析该方法时,首先剔除findBy,然后对剩下的属性进行解析,假设查询实体为Doc

–先判断 userDepUuid(根据 POJO 规范,首字母变为小写)是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,继续第二步;

–从右往左截取第一个大写字母开头的字符串(此处为Uuid),然后检查剩下的字符串是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,则重复第二步,继续从右往左截取;最后假设user 为查询实体的一个属性;

–接着处理剩下部分(DepUuid),先判断 user 所对应的类型是否有depUuid属性,如果有,则表示该方法最终是根据 “Doc.user.depUuid” 的取值进行查询;否则继续按照步骤 2 的规则从右往左截取,最终表示根据 “Doc.user.dep.uuid” 的值进行查询。

–可能会存在一种特殊情况,比如 Doc包含一个 user 的属性,也有一个userDep属性,此时会存在混淆。可以明确在属性之间加上 "_" 以显式表达意图,比如 "findByUser_DepUuid()" 或者"findByUserDep_uuid()"

•特殊的参数: 还可以直接在方法的参数上加入分页或排序的参数,比如:

–Page<</span>UserModel> findByName(String name, Pageablepageable);

–List<</span>UserModel> findByName(String name, Sort sort);

使用 @Query 注解

•这种查询可以声明在 Repository 方法中,摆脱像命名查询那样的约束,将查询直接在相应的接口方法中声明,结构更为清晰,这是 Spring data 的特有实现。

【spring-data】spring-data学习

​​

索引参数与命名参数

•索引参数如下所示,索引值从1开始,查询中 ”?X” 个数需要与方法定义的参数个数相一致,并且顺序也要一致 

•命名参数(推荐使用这种方式):可以定义好参数名,赋值时采用@Param("参数名"),而不用管顺序。

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

–@Query("select o from UserModelo where o.name like ?1%")

     public List<</span>UserModel> findByUuidOrAge(String name);

–@Query("select o from UserModel o where o.name like %?1")

    public List<</span>UserModel> findByUuidOrAge(String name);

–@Query("select o from UserModelo where o.name like %?1%")

    public List<</span>UserModel> findByUuidOrAge(String name);

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

–@Query(value="select * from tbl_userwhere name like %?1" ,nativeQuery=true)

    public List<</span>UserModel> findByUuidOrAge(String name);

@Modifying 注解和事务

•@Query 与 @Modifying 这两个 annotation一起声明,可定义个性化更新操作,例如只涉及某些字段更新时最为常用,示例如下:

• ​

【spring-data】spring-data学习

​​

•注意:

–方法的返回值应该是 int,表示更新语句所影响的行数

–在调用的地方必须加事务,没有事务不能正常执行

事务

•Spring Data 提供了默认的事务处理方式,即所有的查询均声明为只读事务。

•对于自定义的方法,如需改变 Spring Data 提供的事务默认方式,可以在方法上注解 @Transactional 声明

•进行多个 Repository 操作时,也应该使它们在同一个事务中处理,按照分层架构的思想,这部分属于业务逻辑层,因此,需要在 Service 层实现对多个Repository 的调用,并在相应的方法上声明事务。 

CrudRepository接口

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