SpringDataJPA之Specification复杂查询

最新推荐文章于 2024-04-06 14:34:23 发布
最新推荐文章于 2024-04-06 14:34:23 发布
阅读量5.4w 收藏 82
点赞数 17
分类专栏： Spring SpringBoot2启示录 文章标签： spring data jpa specificaion
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/moshowgame/article/details/80309642
版权

前言

继上次SpringData-JPA之ExampleMatcher实例查询使用一会之后发现ExampleMatcher对日期的查询特别糟糕，所以才有了Specification查询的研究。

  • 20200114:更新对JpaSpecificationExecutor的解析,Specification思路2,以及CriteriaBuilder +CriteriaQuery+Predicate+TypedQuery查询部分
  • 20180811:根据所学所用，重新更新了文章，并增加了Pageable分页排序功能。

实现

对应的Repository需要实现JpaSpecificationExecutor接口

public interface EventRepository extends JpaRepository<Event, Integer> , JpaSpecificationExecutor<Event>{

Specification与Controller业务逻辑

	@GetMapping("/event/list")
	public ApiReturnObject findAllEvent(String eventTitle,Timestamp registerTime,Integer pageNumber,Integer pageSize) {
		if(pageNumber==null) pageNumber=1;
        if(pageSize==null) pageNumber=10;
		//分页
        //Pageable是接口，PageRequest是接口实现，new PageRequest()是旧方法，PageRequest.of()是新方法
        //PageRequest.of的对象构造函数有多个，page是页数，初始值是0，size是查询结果的条数，后两个参数参考Sort对象的构造方法
        Pageable pageable = PageRequest.of(pageNumber,pageSize,Sort.Direction.DESC,"id");
        //Specification查询构造器
        Specification<Event> specification=new Specification<Event>() {
			private static final long serialVersionUID = 1L;

			@Override
			public Predicate toPredicate(Root<Event> root, CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder) {
                Predicate condition1 = null;
                if(StringUtils.isNotBlank(eventTitle)) {
                	condition1 = criteriaBuilder.like(root.get("eventTitle"),"%"+eventTitle+"%");
                }else {
                	condition1 = criteriaBuilder.like(root.get("eventTitle"),"%%");
                }
                Predicate condition2 = null;
                if(registerTime!=null) {
                	condition2 = criteriaBuilder.greaterThan(root.get("registerTime"), registerTime);
                }else {
                	condition2 = criteriaBuilder.greaterThan(root.get("registerTime"), new Timestamp(1514736000000L));
                }
                //Predicate conditionX=criteriaBuilder.and(condition1,condition2);
                //query.where(conditionX);
                query.where(condition1,condition2);
            	//query.where(getPredicates(condition1,condition2)); //这里可以设置任意条查询条件
                return null;  //这种方式使用JPA的API设置了查询条件，所以不需要再返回查询条件Predicate给Spring Data Jpa，故最后return null
			}
		};
		Page<Event> list=eventRepository.findAll(specification, pageable);
        
        return ApiReturnUtil.page(list);
	}

ApiReturnUtil.page封装

其实这个大家根据自己的项目自己封装,这部分不作为核心内容,知识之前有部分网友比较纠结这个工具,所以简单放出来参考一下.

	public static ApiReturnObject page(Page returnObject) {
		return new ApiReturnObject(returnObject.getNumber()+"",returnObject.getNumberOfElements()+"",returnObject.getTotalElements()+"",returnObject.getTotalPages()+"","00","success",returnObject.getContent());	
	}

ApiReturnObject的主要内容:

	String errorCode="00";
	Object errorMessage;
	Object returnObject;
	String pageNumber;
	String pageSize;
	String totalElements;
	String totalPages;
	
	public ApiReturnObject(String pageNumber,String pageSize,String totalElements,String totalPages,String errorCode, Object errorMessage, Object returnObject) {
		super();
		this.pageNumber = pageNumber;
		this.errorCode = errorCode;
		this.errorMessage = errorMessage;
		this.returnObject = returnObject;
		this.pageSize = pageSize;
		this.totalElements = totalElements;
		this.totalPages = totalPages;
	}

查询效果

返回对象有用的是pageNumber、pageSize、totalElements、totalPages等属性，可对其进行封装

{
    "errorCode": "00",
    "errorMessage": "success",
    "pageNumber": "1",
    "pageSize": "2",
    "returnObject": [
        {
            "eventTitle": "1111",
            "id": 3,
            "registerTime": 1528702813000,
            "status": "0"
        },
        {
            "eventTitle": "小明失踪",
            "id": 2,
            "registerTime": 1526268436000,
            "status": "0"
        }
    ],
    "totalElements": "5",
    "totalPages": "3"
}

可以查询了。网上关于这个的资料也很少。希望可以帮到大家。

可能遇到的错误

Unable to locate Attribute  with the the given name [event] on this ManagedType [org.microservice.tcbj.yytsg.checkcentersys.entity.Event]

出现这样的情况，一般是因为实体类中没有这个属性，例如我Event的是eventTitle，写成了event，就会报错。

JpaSpecificationExecutor接口

20200114补充
JPA 提供动态接口JpaSpecificationExecutor，利用类型检查的方式，利用Specification进行复杂的条件查询，比自己写 SQL 更加便捷和安全.

public interface JpaSpecificationExecutor<T> {

	/**
	 * Returns a single entity matching the given {@link Specification}.
	 * 
	 * @param spec
	 * @return
	 */
	T findOne(Specification<T> spec);

	/**
	 * Returns all entities matching the given {@link Specification}.
	 * 
	 * @param spec
	 * @return
	 */
	List<T> findAll(Specification<T> spec);

	/**
	 * Returns a {@link Page} of entities matching the given {@link Specification}.
	 * 
	 * @param spec
	 * @param pageable
	 * @return
	 */
	Page<T> findAll(Specification<T> spec, Pageable pageable);

	/**
	 * Returns all entities matching the given {@link Specification} and {@link Sort}.
	 * 
	 * @param spec
	 * @param sort
	 * @return
	 */
	List<T> findAll(Specification<T> spec, Sort sort);

	/**
	 * Returns the number of instances that the given {@link Specification} will return.
	 * 
	 * @param spec the {@link Specification} to count instances for
	 * @return the number of instances
	 */
	long count(Specification<T> spec);
}

Specification

Specification是我们传入进去的查询参数，是一个接口，并且只有一个方法

public interface Specification<T> {

    Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);
}

一个一目了然的方法

第二个实现思路,听说这个方法已经过时了,其实这个方法是最好理解的.这里附上作为思路参考.

public Page<Even> findAll(SearchEven even) {
     Specification<Even> specification = new Specifications<Even>()
         .eq(StringUtils.isNotBlank(even.getId()), "id", even.getId())
         .gt(Objects.nonNull(even.getStatus()), "status", 0)
         .between("registerTime", new Range<>(new Date()-1, new Date()))
         .like("eventTitle", "%"+even.getEventTitle+"%")
         .build();
     return personRepository.findAll(specification, new PageRequest(0, 15));
}

Criteria+TypedQuery

思路三,利用EntityManager相关的CriteriaBuilder +CriteriaQuery+Predicate+TypedQuery进行查询.

@PersistenceContext
private EntityManager em;

/**
 * CriteriaBuilder 安全查询创建工厂,创建CriteriaQuery,创建查询具体具体条件Predicate
 * @author zhengkai.blog.csdn.net
 */
@Override
public List<Even> list(Even even) {
    //查询工厂
	CriteriaBuilder cb = em.getCriteriaBuilder();
    //查询类
	CriteriaQuery<Even> query = cb.createQuery(Even.class);
	//查询条件
	List<Predicate> predicates = new LinkedList<>();
	//查询条件设置
    predicates.add(cb.equal("id", even.getId()));
	predicates.add(cb.like("eventTitle", even.getEventTitle()));
	//拼接where查询
    query.where(cb.or(predicates.toArray(new Predicate[predicates.size()])));
    //用JPA 2.0的TypedQuery进行查询
	TypedQuery<Even> typedQuery = em.createQuery(query);
    return typedQuery.getResultList();
}
Moshow郑锴
关注
  • 17
    点赞
  • 踩
  • 82
    收藏
    觉得还不错? 一键收藏
  • 7
    评论
专栏目录
JPA---Specifications
lanleihhh的博客
03-20 3314
/ 查询单个对象 Optional < T > findOne(@Nullable Specification < T > spec);// 查询列表 List < T > findAll(@Nullable Specification < T > spec);// 查询全部，分页；
JPA--SpringDataJpa之Specifications动态查询
吴声子夜歌的博客
12-17 1632
Specifications动态查询 JpaSpecificationExecutor 方法列表 T findOne(Specification spec)：查询单个对象 List findAll(Specification spec)：查询列表 Page findAll(Specification spec, Pageable pageable)：分页查询 pageable：分页参...
秒懂SpringBoot之如何使用Spring Data JPA中Specification进行动态查询
最新发布
ShuSheng007的程序人生
04-06 1079
操作数据库大概是一个web程序最重要的部分了，而Spring Data JPA 正是spring生态中用来解决此问题的利器。今天让我们简单聊聊这个话题。没接触Spring Data JPA 的时候觉得MyBatis和MyBatis plus真香，后来工作需要被迫使用了JPA，刚开始觉得变扭，但用熟悉了感觉也不错。人啊，走出自己的舒适区真的很难，所以那些能不断走出自己舒适区的同学真的很厉害，特别是在我们IT行业，这种能力更是弥足珍贵。虽然人善变，但男人有一样特别专一，就是至始至终都喜欢。
JPA之Specification复杂条件查询
热门推荐
qq_43110032的博客
11-14 1万+
在日常工作的过程中，难免会遇到条件查询，接下来就来了解一下Specification条件查询。 要使用Specification条件查询，我们需要继承JpaSpecificationExecutor这个接口。 public interface PetDao extends JpaRepository<Pet,Integer>, JpaSpecificationExecutor<Pet>{} 实体类我们依然使用Pet 测试: 查询所有名字为pp的Pet。由于Spec
Jpa进阶，使用 Specification 进行高级查询
没有伞的孩子必须努力奔跑！—小林
03-28 1770
了 Jpa 的简单使用，而在实际项目中并不能满足我们的需求。如对多张表的关联查询，以及查询时需要的各种条件，这个时候你可以使用自定义 SQL 语句，但是Jpa并不希望我们这么做，于是就有了一个扩展：使用 Specification 进行查询。
Java - JPA通过Query接口setMaxResults实现limit限制查询条数
Zebe
01-29 9505
实现JPA的限制查询功能 要实现JPA的limit限制查询功能，可以通过 JPA Query 接口中的 setMaxResults 方法来实现指定最大结果返回多少条。如果不通过 setMaxResults 设置最大返回条数，JPA默认最大返回 Integer 的上限，即 Integer.MAX_VALUE，这个数字是21亿左右。 可以参考这个官方文档地址：https://docs.oracle....
SpringDataJPA中使用Specification进行表多条件分页动态查询
qq_37579805的博客
05-08 1297
公司使用 SpringDataJPA进行项目开发，个人感觉jpa挺坑的，但是如果业务不是特别复杂的话使用起来确实很方便，话不多说，今天分享下SpringDataJPA中使用Specification如何实现多条件分页动态查询 ## 1 表结构，使用jpa对下列表进行条件查询，表中有以下图片中的字段 ![在这里插入图片描述](https://im...
Spring Data JPA分页复合查询原理解析
08-25
复合查询是Spring Data JPA中的一种复杂查询方式，通过使用JpaRepository<实体类，主键类型>和JpaSpecificationExecutor<实体类>，可以实现复杂的查询条件。例如，通过使用Specification来构建查询条件，例如，使用...
Spring Data JPA 复杂/多条件组合分页查询
08-30
在Spring Data JPA中，实现复杂或多条件组合的分页查询是一项常见的任务，这有助于高效地检索和展示大量数据。Spring Data JPA通过提供便捷的API使得开发者可以轻松地处理数据库查询，包括分页和排序。下面将详细...
Spring Data JPA中的动态查询实例
08-30
总的来说，Spring Data JPA 的动态查询通过 `Specification` 和 Criteria API 提供了一种灵活且类型安全的方式来构建动态 SQL。这种方式不仅提高了代码的可读性和可维护性，还避免了手动拼接 SQL 带来的潜在错误。在...
spring data jpa分页查询示例代码
08-31
Spring Data JPA 提供了多种方式来实现分页查询，包括使用 `Pageable`、`Specification` 和 `CriteriaQuery` 等。 使用 Pageable 实现分页查询 使用 `Pageable` 是 Spring Data JPA 中最简单的分页查询方式。可以...
Spring Data JPA例子代码[基于Spring Boot、Mysql]
08-27
Spring Data JPA 是 Spring 社区开发的一个重要组件，它构建在 Spring Framework 和 Java Persistence API (JPA) 之上，旨在简化数据库访问，特别是对于关系型数据库的处理。通过 Spring Data JPA，开发者可以避免...
JPA中Specification方法
qq_34157673的博客
10-30 3264
jpa自定义findAll 步骤一：继承JpaRepository @Repository public interface ProjectDao extends JpaRepository<Project, String> { int countByProjectNameAndIdNot(String projectName, String id); Page<Project> findAll(Specification<Project> speci
Spring Data JPA - Specifications
qingtianla的博客
08-31 458
JPA 2引入了一个标准API，您可以使用它以编程方式构建查询。通过编写条件，可以定义domain class查询的where子句。再后退一步，这些标准可以看作是JPA标准API约束所描述的实体的断言。 Spring Data JPA从Eric Evans的《领域驱动设计》一书中获得了规范的概念，遵循相同的语义，并提供了一个API来用JPA标准API定义这样的规范。为了支持规范，您可以使用JpaSpecificationExecutor接口扩展您的存储库接口，如下所示: public interfac
Spring-Data-JPA的Specification动态查询和多表联查
haha_ll的博客
08-11 7145
Specification动态查询 Spring Data JPA在实际业务中很多场景需要支持动态查询。比如前端查询功能提供了很多查询条件，用户可以根据一部分条件进行查询，那么后端就需要支持可配置的查询服务。 Spring Data JPA是支持动态查询，需要我们的repo继承JpaSpecificationExecutor接口，使用的时候传入相应参数即可。 查询方法 //查询单个 Optional<T> findOne(@Nullable Specification<T> var
hql中常用函數CAST 带来的日期转换问题[转]
New_Mao_Er的专栏
11-16 966
以前都是连接的ORACLE，MYSQL数据库，写程序一直也没出现过什么问题，就在近期用SQL SERVER出了点问题。 用hibernate操作sqlserver数据库，数据库表中有个日期字段是字符型，当查询一定时间范围内的数据时需要转换日期，这里需要注意了hibernate CAST函数支持转换类型在SQL SERVER中不一定行。 如：and cast(a.enterdate as d...
Spring Data JPA 从入门到精通~Specification工作中的一些扩展
小强快跑~~
01-09 409
Specification 工作中的一些扩展 我们在实际工作中会发现，如果上面的逻辑，简单重复写总感觉是不是可以抽出一些公用方法呢，此时引入一种工厂模式，帮我们做一些事情，可以让代码更加优雅。基于 JpaSpecificationExecutor 的思路，我们创建一个 SpecificationFactory.Java 内容如下： public final class SpecificationFactory { /** * 模糊查询，匹配对应字段 */ public st
Spring data jpa Specification 条件查询 时间段查询 -笔记
一起进步的博客
03-18 7421
jpa中最好用的时间段查询方法 @Override public Page<泛型> findRecordList(int couponDetailId, int pageNum, int pageSize, String startTime, String endTime) { try { 　　　　　　　　//排序规则和分页 Sort...
springdatajpa多条件组合条件查询
08-30
在使用Spring Data JPA进行多条件组合条件查询时，可以通过使用Specification来实现。Specification是一个接口，我们可以自定义一个实现该接口的类，然后在查询方法中传入该Specification对象来指定查询条件。 首先，我们需要在仓库接口中定义一个方法，该方法接收一个Specification参数，并返回查询结果。如下所示： ```java @Repository public interface UserRepository extends JpaRepository<User, Long> { List<User> findAll(Specification<User> spec); } ``` 接下来，我们在Specification实现类中重写toPredicate方法，在该方法中使用CriteriaBuilder构建查询条件，并返回一个Predicate对象表示查询条件。例如，我们可以按用户名和年龄进行查询，如下所示： ```java public class UserSpecification implements Specification<User> { private String username; private int age; public UserSpecification(String username, int age) { this.username = username; this.age = age; } @Override public Predicate toPredicate(Root<User> root, CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder) { List<Predicate> predicates = new ArrayList<>(); if (username != null) { predicates.add(criteriaBuilder.equal(root.get("username"), username)); } if (age != 0) { predicates.add(criteriaBuilder.equal(root.get("age"), age)); } return criteriaBuilder.and(predicates.toArray(new Predicate[0])); } } ``` 最后，我们可以在服务类中调用仓库方法并传入自定义的Specification对象来进行查询。例如： ```java @Service public class UserService { @Autowired private UserRepository userRepository; public List<User> getUsers(String username, int age) { UserSpecification spec = new UserSpecification(username, age); return userRepository.findAll(spec); } } ``` 这样，我们就可以根据传入的条件来进行组合条件查询了。当传入的条件为空时，不会加入到查询中。当传入的条件有值时，则会根据该条件进行查询。这样，就实现了多条件组合条件查询。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 7
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值