使用spring data jpa实现统一的多条件查询

由于篇幅限制，本文中，我们只给出了部分示例代码。
如果你需要完整的代码，请点击： https://github.com/mengyunzhi/springBootSampleCode/tree/master/multiQuery

本文开发环境：java:1.8 + maven:3.3

WHY TO DO

在系统开发中，我们避免不了要使用多条件查询，比如我们按学生的性氏来查找学生，按学生所在的班级查找学生，按学生入学的时间来查找学生等。在以往的开发中，进行综合查询时，我们需要为每个实体单独写综合查询的代码。具体思路为：先将查询条件加入map，然后在综合查询时，取出map中的值，并加入查询条件中，最后实现综合查询。

时间一长，我们发现在查询的过程中，大多有以下规律：

• 传入的值类型为number（short int long ...)时，大多进行的为精确查询。
• 传入的值的类型为String时，大多进行的为模糊查询。
• 传入的值为Collection，大多进行为in查询。
• 传入的值为Date时，大多进行的为范围查询。

鉴于大多数符合以上规律，本文将阐述了一种简单的方法，能够使得我们像使用findById(Long id)一样，来使用pageByEntity(Object entity)进行综合条件查询。

本文需求

有3个实体类：教师，班级，地址。一个实体基类,YunZhiAbstractEntity
三者的关系如下：

功能需求如下：
以klass对象做为查询参数，按klass对象中的属性值来进行综合查询：
比如：

1. 设置klass对象的name值为zhangsan，则模糊查出所有name为zhangsan班级信息。
2. 设置klass对象的totalStudentCount值为3，则查出所有totalStudentCount为3班级信息。
3. 设置klass对象中的teacher。则查询时加入klass->teacher的信息。如果teacher设置了ID，则加入teacher对应ID的精确查询，如果未设置ID，则查询teacher的其它属性，其属性不为null，加入查询条件。
4. 设置klass对象中的teacher中的address，则按第3点的标准进行klass->teacher->address的关联查询。
5. 可以在查询中实现排除某些字段（不为null，也不进行关联查询)。
6. 可以实现对某些字段的范围查询。

知识准备

本文大体将使用到以下知识点：

• spring-data-jpa的5.5章节对综合查询进行了说明，并且给出了示例代码。
• java的反射机制。
• java的注解。

基本思路：

1. 根据传入的查询实体，反射出其字段、字段中的注解、字段的值。然后在依次判断其类型，按类型的不同，加入查询条件。
2. 如果字段类型为实体，则说明进行关联查询(join),此时，进行递归调用，来获取关联查询实体的字段，并按字段类型，字段值进行综合查询
3. 特殊的查询（排除字段，范围查询的开始，结束字段，in查询），使用注解来协助完成。

代码实现

本文github中给出的示例代码，除in查询外，已经实现了其它几点在本文中所需要的功能。本节中，只直接给出关键代码，其它的关联代码，还需要到github中进行查看。

文件列表

├── java
│   └── com
│       └── mengyunzhi
│           └── springbootsamplecode
│               └── multiquery
│                   ├── MultiQueryApplication.java
│                   ├── annotation
│                   │   ├── BeginQueryParam.java
│                   │   ├── EndQueryParam.java
│                   │   └── IgnoreQueryParam.java
│                   ├── entity
│                   │   ├── Address.java
│                   │   ├── Klass.java
│                   │   ├── Teacher.java
│                   │   └── YunZhiAbstractEntity.java
│                   ├── repository
│                   │   ├── AddressRepository.java
│                   │   ├── KlassRepository.java
│                   │   └── TeacherRepository.java
│                   └── service
│                       ├── AddressService.java
│                       ├── AddressServiceImpl.java
│                       ├── CommonService.java
│                       ├── KlassService.java
│                       ├── KlassServiceImpl.java
│                       ├── TeacherService.java
│                       ├── TeacherServiceImpl.java
│                       ├── YunzhiService.java
│                       └── YunzhiServiceImpl.java
└── resources
    └── application.yml

实体类的继承我们在需求中已经给出。annotation注解，repository仓库（dao)层，service服务层中都很普通，它们是本文完成综合查询的基础。最下方的 YunzhiServiceImpl.java，便是我们今天的主角。

YunzhiService

package com.mengyunzhi.springbootsamplecode.multiquery.service;


import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;

import java.util.List;

/**
 * @author panjie
 */
public interface YunzhiService {
    /**
     * 通过传入的实体进行多条件查询
     * @param entity
     * @param pageable
     * @return 分页数据
     * panjie
     */
    Page page(JpaSpecificationExecutor jpaSpecificationExecutor, Object entity, Pageable pageable);

    /**
     * 通过传入的实体查询所有数据
     * @param entity
     * @return
     * panjie
     */
    List findAll(JpaSpecificationExecutor jpaSpecificationExecutor, Object entity);
}

YunzhiServiceImpl

代码中，已经给出详细的注释。请参阅。

package com.mengyunzhi.springbootsamplecode.multiquery.service;

import com.mengyunzhi.springbootsamplecode.multiquery.annotation.BeginQueryParam;
import com.mengyunzhi.springbootsamplecode.multiquery.annotation.EndQueryParam;
import com.mengyunzhi.springbootsamplecode.multiquery.annotation.IgnoreQueryParam;
import com.mengyunzhi.springbootsamplecode.multiquery.entity.YunZhiAbstractEntity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.stereotype.Service;

import javax.persistence.criteria.*;
import java.lang.reflect.Field;
import java.sql.Date;
import java.util.Calendar;
import java.util.Collection;
import java.util.List;

/**
 * 多条件综合查询
 *
 * @author panjie
 */
@Service
public class YunzhiServiceImpl implements YunzhiService {
    private static final Logger logger = LoggerFactory.getLogger(YunzhiServiceImpl.class);

    @Override
    public Page