JavaEE高级-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 进行持久层开发需要的四个步骤:
1、 配置 spring 整合 jpa
2、 在 spring 配置文件中配置 spring data,让 spring 为声明的接口创建代理对象。配置了 <jpa:repositories> 后,spring 初始化容器时将会扫描 base-package 指定的包目录及其子目录,
为继承 repository 或其子接口的接口创建代理对象,并将代理对象注册为 spring bean,业务层便可以通过 spring 自动封装的特性来直接使用该对象。
3、声明持久层的接口,该接口继承 repository,repository 是一个标记型接口,它不包含任何方法,如必要,spring data 可实现 repository 其他子接口,其中定义了一些常用的增删改查,以及分页相关的方法。
4、在接口中声明需要的方法。spring data 将根据给定的策略(具体策略稍后讲解)来为其生成实现代码。
- 搭建环境:
1、同时下载 spring data commons 和 spring data jpa 两个发布包:
> commons 是 spring data 的基础包
> 并把相关的依赖 jar 文件加入到 classpath 中
2、在 spring 的配置文件中配置 spring data:
- 示例代码:
repository 接口概述
- repository 接口是 spring data 的一个核心接口,它不提供任何方法,开发者需要在自己定义的接口中声明需要的方法 ,public interface repository<t, id extends serializable> { }
- spring data可以让我们只定义接口,只要遵循 spring data的规范,就无需写实现类。
- 与继承 repository 等价的一种方式,就是在持久层接口上使用 @repositorydefinition 注解,并为其指定 domainclass 和 idclass 属性。两种方式是完全等价的
- repository 的子接口:
> 基础的 repository 提供了最基本的数据访问功能,其几个子接口则扩展了一些功能。它们的继承关系如下:
>> repository: 仅仅是一个标识,表明任何继承它的均为仓库接口类
>> crudrepository: 继承 repository,实现了一组 crud 相关的方法
>> pagingandsortingrepository: 继承 crudrepository,实现了一组分页排序相关的方法
>> jparepository: 继承 pagingandsortingrepository,实现一组 jpa 规范相关的方法
>> 自定义的 xxxxrepository 需要继承 jparepository,这样的 xxxxrepository 接口就具备了通用的数据访问控制层的能力。
>> jpaspecificationexecutor: 不属于repository体系,实现一组 jpa criteria 查询相关的方法
springdata 方法定义规范
- 简单条件查询:
> 简单条件查询: 查询某一个实体类或者集合
> 按照 spring data 的规范,查询方法以 find | read | get 开头, 涉及条件查询时,条件的属性用条件关键字连接,要注意的是:条件属性以首字母大写。
> 例如:定义一个 entity 实体类
class user{
private string firstname;
private string lastname;
}
>> 使用and条件连接时,应这样写: findbylastnameandfirstname(string lastname,string firstname);
>> 条件的属性名称与个数要与参数的位置与个数一一对应
- 支持的关键字
> 直接在接口中定义查询方法,如果是符合规范的,可以不用写实现,目前支持的关键字写法如下:
- 查询方法解析流程
> 假如创建如下的查询: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<usermodel> findbyname(string name, pageable pageable);
>> list<usermodel> findbyname(string name, sort sort);
使用 @query 注解
- 使用@query自定义查询
> 这种查询可以声明在 repository 方法中,摆脱像命名查询那样的约束,将查询直接在相应的接口方法中声明,结构更为清晰,这是 spring data 的特有实现。
- 索引参数与命名参数
> 索引参数如下所示,索引值从1开始,查询中 ”?x” 个数需要与方法定义的参数个数相一致,并且顺序也要一致
> 命名参数(推荐使用这种方式):可以定义好参数名,赋值时采用@param("参数名"),而不用管顺序。
> 如果是 @query 中有 like 关键字,后面的参数需要前面或者后面加 %,这样在传递参数值的时候就可以不加 %:
>> @query("select o from usermodel o where o.name like ?1%")
public list<usermodel> findbyuuidorage(string name);
>> @query("select o from usermodel o where o.name like %?1")
public list<usermodel> findbyuuidorage(string name);
>> @query("select o from usermodel o where o.name like %?1%")
public list<usermodel> findbyuuidorage(string name);
- 用@query来指定本地查询
> 还可以使用@query来指定本地查询,只要设置nativequery为true,比如:
>> @query(value="select * from tbl_user where name like %?1" ,nativequery=true)
public list<usermodel> findbyuuidorage(string name);
@modifying 注解和事务
- @query 与 @modifying 执行更新操作
> @query 与 @modifying 这两个 annotation一起声明,可定义个性化更新操作,例如只涉及某些字段更新时最为常用,示例如下:
> 注意:
>> 方法的返回值应该是 int,表示更新语句所影响的行数
>> 在调用的地方必须加事务,没有事务不能正常执行
事务
- spring data 提供了默认的事务处理方式,即所有的查询均声明为只读事务。
- 对于自定义的方法,如需改变 spring data 提供的事务默认方式,可以在方法上注解 @transactional 声明
- 进行多个 repository 操作时,也应该使它们在同一个事务中处理,按照分层架构的思想,这部分属于业务逻辑层,因此,需要在 service 层实现对多个 repository 的调用,并在相应的方法上声明事务。
crudrepository 接口
- 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();//删除所有实体,不用或慎用!
pagingandsortingrepository接口
- pagingandsortingrepository
> 该接口提供了分页与排序功能 :
>> iterable<t> findall(sort sort); //排序
>> page<t> findall(pageable pageable); //分页查询(含排序功能)
jparepository接口
- 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);//删除一个实体集合
jpaspecificationexecutor接口
- jpaspecificationexecutor
> 不属于repository体系,实现一组 jpa criteria 查询相关的方法
> specification:封装 jpa criteria 查询条件。通常使用匿名内部类的方式来创建该接口的对象
自定义 repository 方法
- 为某一个 repository 上添加自定义方法
> 步骤:
1、 定义一个接口: 声明要添加的, 并自实现的方法
2、 提供该接口的实现类: 类名需在要声明的 repository 后添加 impl, 并实现方法
3、 声明 repository 接口, 并继承 1) 声明的接口
4、 使用.
>> 注意: 默认情况下, spring data 会在 base-package 中查找 "接口名impl" 作为实现类. 也可以通过 repository-impl-postfix 声明后缀.
- 为所有的 repository 都添加自实现的方法
> 步骤:
1、声明一个接口, 在该接口中声明需要自定义的方法, 且该接口需要继承 spring data 的 repository.
2、提供 1) 所声明的接口的实现类. 且继承 simplejparepository, 并提供方法的实现
3、定义 jparepositoryfactorybean 的实现类, 使其生成 1) 定义的接口实现类的对象
4、修改 <jpa:repositories /> 节点的 factory-class 属性指向 3) 的全类名
>> 注意: 全局的扩展实现类不要用 imp 作为后缀名, 或为全局扩展接口添加 @norepositorybean 注解告知 spring data: spring data 不把其作为 repository