1.Spring Data JPA:
-
它是JPA规范的再次封装抽象,底层还是使用了Hibernate的JPA技术实现,引用JPQL的查询语句
,是属于Spring的生成体系中的一部分。 -
.SpringDataJpa使用起来比较方便,加快了开发的效果,使开发人员不需要关心和配置更多的东西。
-
SpringDataJpa上手简单,开发效率高,对对象的支持非常好,还十分的灵活。
2.Spring Data 包含多个子项目:
Commons - 提供共享的基础框架,适合各个子项目使用,支持跨数据库持久化
JPA - 简化创建 JPA 数据访问层和跨存储的持久层功能
Hadoop - 基于 Spring 的 Hadoop 作业配置和一个 POJO 编程模型的 MapReduce 作业
Key-Value - 集成了 Redis 和 Riak ,提供多个常用场景下的简单封装
Document - 集成文档数据库:CouchDB 和 MongoDB 并提供基本的配置映射和资料库支持
Graph - 集成 Neo4j 提供强大的基于 POJO 的编程模型
Graph Roo AddOn - Roo support for Neo4j
JDBC Extensions - 支持 Oracle RAD、高级队列和高级数据类型
Mapping - 基于 Grails 的提供对象映射框架,支持不同的数据库
Examples - 示例程序、文档和图数据库
Guidance - 高级文档
#SpringData的结构
Spring Data JPA的七个Repository接口:
3. Repository接口
1.Respository接口是SpringData的一个核心接口,他不提供任何方法,开发者需要在自己定义的接口中声明需要的方法。
a.SpringData可以让我们只定义接口,只要遵循SpringData的规范,就无需写实现类。
b.与继承Repsitory等价的一种方式,就是在持久层上使用@RepositoryDefinition注解,并指定domain和IdClass属性。
2.Repository子接口
基础的Repository提供了最基本的数据访问功能,其几个子接口则扩展了一些功能。他们的继承关系如下:
Repository:仅仅是一个标识,表明继承他的均为仓库接口类
CrudRespository:继承Repository,实现一组CRUD相关的方法。
PagingAndSortingRepository:继承CrudRespository,实现一组分页和排序的相关方法。
JpaRespository:继承PagingAndSortingRepository,实现一组JPA规范的相关方法
自定义的XxxxRepository 需要继承JpaRepository,这样的XxxxRepository接口就具备了通用的数据访问控制层的能力。
JpaSpecificationExecutor:不属于Repository体系,实现一组JPACriteria 查询相关的方法
4.JpaRepository的基本功能
(1)普通的CRUD
//获取所有数据
@Test
public void testFindAll() throws Exception{
List<Employee> emps = employeeRepository.findAll();
for (Employee emp :emps){
System.out.println(emp);
}
}
//根据id到一条数据
@Test
public void testFindOne() throws Exception{
Employee employee = employeeRepository.findOne(1L);
System.out.println(employee);
}
添加与修改都使用save(主要看对象有没有id)
//添加与修改都使用save
@Test
public void testSave() throws Exception{
Employee employee = new Employee();
//employee.setId(103L);
employee.setUsername("张三");
employee.setPassword("1234");
employee.setEmail("zhangsha@163.com");
employeeRepository.save(employee);
}
//删除数据
@Test
public void testDelete() throws Exception{
employeeRepository.delete(103L);
}
//得到总条数
@Test
public void testCount(){
System.out.println(employeeRepository.count());
}
(2)分页排序功能
//进行分页功能
@Test
public void testPage() {
//1.需要先创建一个page对象(注意:页数是从0开始计算【0就是第1页】)
Pageable pageable = new PageRequest(0, 10);
//2.进行查询
Page<Employee> page = employeeRepository.findAll(pageable);
System.out.println(page.getTotalElements()); //总条数
System.out.println(page.getTotalPages()); //总页数
System.out.println(page.getContent()); //当前页数据
System.out.println(page.getNumber()); //第几页
System.out.println(page.getNumberOfElements()); //当前页有多少个数据
System.out.println(page.getSize()); //每页条数
}
//进行排序功能
@Test
public void testSort() {
//排序 :第一个参数是排序的规则(DESC/ASC) 后面参数是排序的字符
Sort sort = new Sort(Sort.Direction.DESC,"username");
List<Employee> emps = employeeRepository.findAll(sort);
for (Employee emp : emps) {
System.out.println(emp);
}
}
//分页与排序的集成
@Test
public void testPageAndSort() {
//排序 :第一个参数是排序的规则(DESC/ASC) 后面参数是排序的字符
Sort sort = new Sort(Sort.Direction.DESC,"username");
Pageable pageable = new PageRequest(0, 10,sort);
//2.进行查询
Page<Employee> page = employeeRepository.findAll(pageable);
for (Employee employee : page) {
System.out.println(employee);
}
}
(3)根据条件进行查询
public interface EmployeeRepository extends JpaRepository<Employee, Long> {
//根据名称模糊查询
List<Employee> findByUsernameLike(String username);
//根据名称进行查询
List<Employee> findByUsername(String username);
}
(4)规则如下:
5.@Query注解查询
在Respository方法中一定要按照查询方法的命名规则,其实是比较麻烦的如果我们想不遵循 查询方法的命名规则,还可以使用@Query的方法进行查询。
只需要将@Query定义在Respository的方法之上即可。
6.JpaSpecificationExecutor
(1)JpaSpecificationExecutor(JPA规则执行者)是JPA2.0提供的Criteria API的使用封装,可以用于动态生成Query来满足我们业务中的各种复杂场景。
(2)Spring Data JPA为我们提供了JpaSpecificationExecutor接口,只要简单实现toPredicate方法就可以实现复杂的查询。
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);
}
(3)单个条件的查询
@Test
public void testFind() {
List<Employee> emps = employeeRepository.findAll(
new Specification<Employee>() {
@Override
public Predicate toPredicate(Root<Employee> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
Path path = root.get("username");//拿到要做查询的字段
Predicate p = cb.like(path, "%1%");//like代表做模糊查询,后面就是它的条件值
return p;
}
}
);
for (Employee emp : emps) {
System.out.println(emp);
}
}
(4)多个条件查询
@Test
public void testFind02() {
Specification spec = new Specification<Employee>() {
@Override
public Predicate toPredicate(Root root, CriteriaQuery query, CriteriaBuilder cb) {
//加上第一个条件: username like '%1%'
Path path1 = root.get("username");
Predicate p1 = cb.like(path1, "%1%");
//加上第二个条件: email like '%2%'
Path path2 = root.get("email");
Predicate p2 = cb.like(path2,"%2%");
//加上第二个条件: age < 20
Path path3 = root.get("age");
Predicate p3 = cb.lt(path3, 20);
//下面是加上or的条件的方案
//Predicate p3 = cb.or(p1,p2);
//把两个查询条件放到query对象中去(条件使用where)
CriteriaQuery where = query.where(p1, p2, p3);
//返回查询条件
return where.getRestriction();
}
};
List<Employee> emps = employeeRepository.findAll(spec);
for (Employee emp : emps) {
System.out.println(emp);
}
}
(4)条件查询+分页排序
@Test
public void testFind03() {
Specification spec = new Specification<Employee>() {
@Override
public Predicate toPredicate(Root root, CriteriaQuery query, CriteriaBuilder cb) {
//加上条件: username like '%1%'
Path path1 = root.get("username");
Predicate p1 = cb.and(cb.like(path1, "%1%"));
//把两个查询条件放到query对象中去(条件使用where)
CriteriaQuery where = query.where(p1);
//返回查询条件
return where.getRestriction();
}
};
//排序 :第一个参数是排序的规则(DESC/ASC) 后面参数是排序的字符
Sort sort = new Sort(Sort.Direction.DESC,"username");
Pageable pageable = new PageRequest(0, 10,sort);
Page<Employee> page = employeeRepository.findAll(spec, pageable);
for (Employee emp : page) {
System.out.println(emp);
}
}
7.jpa-spec插件
这是一个对于咱们刚才的动态生成Query功能的一个封装版,如果我们使用这个插件,在完成查询与分页的时候功能会简单不少。
基于Spring Data Jpa的动态查询库 https://github.com/wenhao/jpa-spec
(1)功能介绍
1.兼容Spring Data Jpa 和JPA2.1接口。
2.Equal/NotEqual/Like/NotLike/In/NotIn支持可变参数, Equal/NotEqual 支持空(Null)值。
3.每个条件支持关联查询。
4.支持自定义条件查询。
5.条件构建器。
6.支持分页和排序。
(2)在Maven中引入相应的包
pom.xml(咱们项目中已经引入):
<!-- jpa的SpecificationSpecification功能封装 -->
<dependency>
<groupId>com.github.wenhao</groupId>
<artifactId>jpa-spec</artifactId>
<version>3.1.1</version>
<!-- 把所有依赖都过滤 -->
<exclusions>
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
(3)功能测试
//单个条件查询
@Test
public void testSpecFind01() {
Specification<Employee> spec = Specifications.<Employee>and().like("username", "%1%").build();
List<Employee> emps = employeeRepository.findAll(spec);
for (Employee emp : emps) {
System.out.println(emp);
}
}
//多个条件查询
@Test
public void testSpecFind02() {
Specification<Employee> spec = Specifications.<Employee>and().like("username", "%1%")
.like("email","%2%").lt("age", 20).build();
List<Employee> emps = employeeRepository.findAll(spec);
for (Employee emp : emps) {
System.out.println(emp);
}
}
//条件+排序分页功能
@Test
public void testSpecFind03() {
Specification<Employee> spec = Specifications.<Employee>and().like("username", "%1%").build();
//排序 :第一个参数是排序的规则(DESC/ASC) 后面参数是排序的字符
Sort sort = new Sort(Sort.Direction.DESC,"username");
Pageable pageable = new PageRequest(0, 10,sort);
Page<Employee> page = employeeRepository.findAll(spec, pageable);
for (Employee emp : page) {
System.out.println(emp);
}
}
8.Query查询条件
1 用户传的数据有0-n个(我们需要去判断)
2 需要准备一个对象接收用户传过来的数据(使用Query对象)
3 分页的条件对我们来说也是封装到Query对象中的
(1)BaseQuery
package cn.itsource.pss.query;
/**
* 公共的条件与规范
*/
public abstract class BaseQuery {
//当前页(从1开始)
private int currentPage = 1;
//每页条数
private int pageSize = 10;
//排序方式 ASC/DESC
private String orderByType ="ASC";
//排序字段
private String orderByName;
public int getCurrentPage() {
return currentPage;
}
/**
* 专门准备的方法,因为前台用户传的是从第1页开始,而我们后台分页又是从0开的
* @return
*/
public int getJpaPage() {
return currentPage - 1;
}
public void setCurrentPage(int currentPage) {
this.currentPage = currentPage;
}
public int getPageSize() {
return pageSize;
}
public void setPageSize(int pageSize) {
this.pageSize = pageSize;
}
public String getOrderByType() {
return orderByType;
}
public void setOrderByType(String orderByType) {
this.orderByType = orderByType;
}
public String getOrderByName() {
return orderByName;
}
public void setOrderByName(String orderByName) {
this.orderByName = orderByName;
}
}
(2)EmployeeQuery:Employee特有的一些条件
package cn.itsource.pss.query;
public class EmployeeQuery extends BaseQuery {
private String username;//姓名
private String email;//邮件
private Integer age;//年龄
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
(3)功能测试
//根据Query对象进行查询
@Test
public void testSpecFindByQuery() {
//创建模块一个Query对象
EmployeeQuery baseQuery = new EmployeeQuery();
//下面的都是测试的条件,可以任何放开进行测试
//baseQuery.setUsername("1");
//baseQuery.setAge(20);
//baseQuery.setEmail("2");
//baseQuery.setOrderByName("username");
//baseQuery.setOrderByType("DESC");
//baseQuery.setCurrentPage(2);
//baseQuery.setPageSize(5);
//like(条件boolean值,字段,值)
Specification<Employee> spec = Specifications.<Employee>and()
.like(StringUtils.isNotBlank(baseQuery.getUsername()), "username","%"+baseQuery.getUsername()+"%")
.like(StringUtils.isNotBlank(baseQuery.getEmail()), "email","%"+baseQuery.getEmail()+"%")
.lt(baseQuery.getAge()!=null, "age",baseQuery.getAge())
.build();
//这里确定是否需要排序
Sort sort = null;
if(baseQuery.getOrderByName()!=null){
Sort.Direction desc = "DESC".equals(baseQuery.getOrderByType())?Sort.Direction.DESC:Sort.Direction.ASC;
sort = new Sort(desc,baseQuery.getOrderByName());
}
Pageable pageable = new PageRequest(baseQuery.getJpaPage(), baseQuery.getPageSize(),sort);
Page<Employee> page = employeeRepository.findAll(spec, pageable);
for (Employee emp : page) {
System.out.println(emp);
}
}
通过上面的功能测试,我们已经知道如果前台传数据过来,后面的查询应该怎么处理了。但是大家也应该发现了,除了创建Specification对象这一,分页排序的部分每次查询的代码都应该是一样的,所以我们现在需要做的就是把代码开始进行功能抽取。
(4)创建Specification的流程放到Query里
BaseQuery中添加抽象方法
public abstract class BaseQuery {
...
//拿到查询的条件对象(由子类实现)
public abstract Specification createSpecification();
//拿到排序的数据
public Sort createSort() {
Sort sort = null;
if (StringUtils.isNotBlank(orderByName)) {
Sort.Direction type= "ASC".equals(orderByType.toUpperCase())? Sort.Direction.ASC:Sort.Direction.DESC;
sort = new Sort(type,orderByName);
}
return sort;
}
...
}
EmployeeQuery中实现相应方法
public class EmployeeQuery extends BaseQuery {
...
@Override
public Specification createSpecification() {
//根据条件把数据返回即可
return Specifications.<Employee>and()
.like(StringUtils.isNotBlank(username), "username","%"+username+"%")
.like(StringUtils.isNotBlank(email), "email","%"+email+"%")
.lt(age!=null, "age",age)
.build();
}
}
9.BaseRepository接口
package cn.itsource.pss.repository;
import cn.itsource.pss.query.BaseQuery;
import org.springframework.data.domain.Page;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.repository.NoRepositoryBean;
import java.io.Serializable;
import java.util.List;
/**
* 自定义一个Repository,它是JpaRepository的功能基础上继承增强
* 在上面添加@NoRepositoryBean标注,这样Spring Data Jpa在启动时就不会去实例化BaseRepository这个接口
* @param <T>
* @param <ID>
*/
@NoRepositoryBean
public interface BaseRepository<T,ID extends Serializable> extends JpaRepository<T,ID>,JpaSpecificationExecutor<T>{
//根据Query拿到分页对象(分页)
Page findPageByQuery(BaseQuery baseQuery);
//根据Query拿到对应的所有数据(不分页)
List<T> findByQuery(BaseQuery baseQuery);
//根据jpql与对应的参数拿到数据
List findByJpql(String jpql,Object... values);
}
9.1BaseRepositoryImpl功能实现
package cn.itsource.pss.repository;
import cn.itsource.pss.query.BaseQuery;
import org.springframework.data.domain.Page;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.repository.NoRepositoryBean;
import java.io.Serializable;
import java.util.List;
/**
* 自定义一个Repository,它是JpaRepository的功能基础上继承增强
* 在上面添加@NoRepositoryBean标注,这样Spring Data Jpa在启动时就不会去实例化BaseRepository这个接口
* @param <T>
* @param <ID>
*/
@NoRepositoryBean
public interface BaseRepository<T,ID extends Serializable> extends JpaRepository<T,ID>,JpaSpecificationExecutor<T>{
//根据Query拿到分页对象(分页)
Page findPageByQuery(BaseQuery baseQuery);
//根据Query拿到对应的所有数据(不分页)
List<T> findByQuery(BaseQuery baseQuery);
//根据jpql与对应的参数拿到数据
List findByJpql(String jpql,Object... values);
}
9.2 创建自定义创建自定义RepositoryFactoryBean
package cn.itsource.pss.repository;
import org.springframework.data.jpa.repository.support.JpaRepositoryFactory;
import org.springframework.data.jpa.repository.support.JpaRepositoryFactoryBean;
import org.springframework.data.jpa.repository.support.SimpleJpaRepository;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.core.RepositoryInformation;
import org.springframework.data.repository.core.RepositoryMetadata;
import org.springframework.data.repository.core.support.RepositoryFactorySupport;
import javax.persistence.EntityManager;
import java.io.Serializable;
public class BaseRepositoryFactoryBean<T extends Repository<S, ID>, S, ID extends Serializable> extends JpaRepositoryFactoryBean<T,S,ID> {
@Override
protected RepositoryFactorySupport createRepositoryFactory(EntityManager entityManager) {
return new MyRepositoryFactory<T,ID>(entityManager); //注:这里创建是我们的自定义类
}
//继承JpaRepositoryFactory后,把返回的对象修改成我们自己的实现
private static class MyRepositoryFactory<T,ID extends Serializable> extends JpaRepositoryFactory{
private final EntityManager entityManager;
/**
* Creates a new {@link JpaRepositoryFactory}.
*
* @param entityManager must not be {@literal null}
*/
public MyRepositoryFactory(EntityManager entityManager) {
super(entityManager);
this.entityManager = entityManager;
}
//这里返回最后的功能对象
@Override
protected Object getTargetRepository(RepositoryInformation information) {
return new BaseRepositoryImpl<T,ID>((Class<T>)information.getDomainType(),entityManager);
}
//确定功能对象的类型
@Override
protected Class<?> getRepositoryBaseClass(RepositoryMetadata metadata) {
return BaseRepositoryImpl.class;
}
}
}
9.3 功能完善
//applicationContext.xml 中修改配置
<!-- Spring Data Jpa配置 ********************************************-->
<!-- base-package:扫描的包 -->
<jpa:repositories base-package="cn.itsource.pss.repository" transaction-manager-ref="transactionManager"
entity-manager-factory-ref="entityManagerFactory"
factory-class="cn.itsource.aisell.repository.BaseRepositoryFactoryBean"
/>
9.4.继承BaseRepository测试扩展功能
//测试分页查询
@Test
public void testFindPageByQuery() {
EmployeeQuery baseQuery = new EmployeeQuery();
baseQuery.setUsername("1");
//baseQuery.setAge(20);
//baseQuery.setEmail("2");
baseQuery.setOrderByName("username");
baseQuery.setOrderByType("DESC");
//baseQuery.setCurrentPage(2);
baseQuery.setPageSize(5);
Page<Employee> page = employeeRepository.findPageByQuery(baseQuery);
for (Employee employee : page) {
System.out.println(employee);
}
}
//测试单独查询
@Test
public void findByQuery() {
EmployeeQuery baseQuery = new EmployeeQuery();
baseQuery.setUsername("1");
//baseQuery.setAge(20);
//baseQuery.setEmail("2");
baseQuery.setOrderByName("username");
baseQuery.setOrderByType("DESC");
List<Employee> emps = employeeRepository.findByQuery(baseQuery);
for (Employee employee : emps) {
System.out.println(employee);
}
}
//测试自定义JPQL
@Test
public void findByJpql() {
List<Employee> emps = employeeRepository.findByJpql("select o from Employee o where username = ? and password = ?","admin","admin");
for (Employee emp : emps) {
System.out.println(emp);
}
}