摘要：根據(jù)區(qū)域部門學(xué)科類別查詢出符合條件的考評(píng)人員。繼承接口我們的考評(píng)員倉庫原繼承，為了實(shí)現(xiàn)可以復(fù)雜查詢，繼承接口。實(shí)現(xiàn)規(guī)格接口為了規(guī)范，我們建了一個(gè)的查詢規(guī)格的包，將所有生成查詢規(guī)格的類放入該包中。

Spring項(xiàng)目中，我們使用JPA進(jìn)行查詢，只需簡(jiǎn)單地繼承SpringData提供的接口即可實(shí)現(xiàn)強(qiáng)大的數(shù)據(jù)查詢功能。

之前的強(qiáng)檢器具統(tǒng)計(jì)管理用的僅僅是單表查詢，理解不深，這次開發(fā)的考評(píng)員綜合查詢涉及到了多個(gè)實(shí)體間的查詢，值得學(xué)習(xí)，特此記錄。

以下是ER圖。

管理部門選擇本部門或其管轄的部門中的某人員作為該部門的考評(píng)人員。根據(jù)區(qū)域、部門、學(xué)科類別查詢出符合條件的考評(píng)人員。

復(fù)雜查詢，我們就需要SpringData提供的JpaSpecificationExecutor接口，這是該接口的源代碼。

public interface JpaSpecificationExecutor {

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

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

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

    /**
     * Returns all entities matching the given {@link Specification} and {@link Sort}.
     * 
     * @param spec
     * @param sort
     * @return
     */
    List findAll(Specification 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 spec);
}

該接口中聲明的方法都有一個(gè)共同的參數(shù)：Specification，翻譯過來就是規(guī)范的意思。

這是Specification接口源代碼。

public interface Specification {

    /**
     * Creates a WHERE clause for a query of the referenced entity in form of a {@link Predicate} for the given
     * {@link Root} and {@link CriteriaQuery}.
     * 
     * @param root
     * @param query
     * @return a {@link Predicate}, must not be {@literal null}.
     */
    Predicate toPredicate(Root root, CriteriaQuery query, CriteriaBuilder cb);
}

Specification接口中有一個(gè)toPredicate方法，看不懂代碼我們可以看注釋。

Creates a WHERE clause for a query of the referenced entity in form of a {Predicate}

用謂詞的形式為引用的實(shí)體創(chuàng)建一個(gè)WHERE語句。

到這里，我們應(yīng)該明白了這個(gè)查詢的原理：我們先生成我們需要的謂語，然后用toPredicate將謂語生成為where語句，最后再使用我們Specification類型的where語句作為參數(shù)用JpaSpecificationExecutor接口中定義的方法進(jìn)行查詢。

public interface ExaminerRepository extends CrudRepository, JpaSpecificationExecutor {
}

我們的考評(píng)員倉庫原繼承CrudRepository，為了實(shí)現(xiàn)可以復(fù)雜查詢，繼承JpaSpecificationExecutor接口。

為了規(guī)范，我們建了一個(gè)spec的查詢規(guī)格的包，將所有生成查詢規(guī)格的類放入該包中。

/**
 * @author zhangxishuo on 2018/5/26
 * 考評(píng)人員查詢規(guī)格
 */

public class ExaminerSpecs {

    // 日志
    private static final Logger logger = Logger.getLogger(ExaminerSpecs.class);

    public static Specification base(Department userDepartment, final Map map) {
        return new Specification() {

            @Override
            public Predicate toPredicate(Root root, CriteriaQuery criteriaQuery, CriteriaBuilder criteriaBuilder) {
                return null;
            }
        };
    }
}

我們?cè)谶@個(gè)類中寫了一個(gè)base方法，用于根據(jù)傳入的參數(shù)生成一個(gè)查詢規(guī)格。

return語句中，我們new了一個(gè)接口，然后在new這個(gè)接口的同時(shí)對(duì)這個(gè)接口進(jìn)行實(shí)現(xiàn)，實(shí)現(xiàn)接口中的toPredicate方法。

toPredicate中的三個(gè)參數(shù)意義。Root：查詢的模型；CriteriaQuery：標(biāo)準(zhǔn)查詢，用于查詢的；CriteriaBuilder：標(biāo)準(zhǔn)構(gòu)建，用戶構(gòu)建查詢語句的。

大家不要去糾結(jié)是直接new接口然后在花括號(hào)中實(shí)現(xiàn)還是寫一個(gè)類實(shí)現(xiàn)接口然后再去new？

這里說一下我自己的理解。其實(shí)這主要是看實(shí)際需要，如果這個(gè)接口的實(shí)現(xiàn)類需要被好多個(gè)其他類調(diào)用，為了代碼的復(fù)用，我們就會(huì)寫一個(gè)類去實(shí)現(xiàn)接口，就像我們后臺(tái)MVC架構(gòu)的業(yè)務(wù)邏輯層，因?yàn)橥粋€(gè)方法可能會(huì)被好多個(gè)控制器進(jìn)行調(diào)用，所以我們建一個(gè)Service接口，再建立一個(gè)Service接口實(shí)現(xiàn)類，然后其他類需要時(shí)進(jìn)行Autowire。

如果我們的方法不需要復(fù)用，那Android代碼就是我們最好的例子（Android中大量使用了new接口然后在new時(shí)去實(shí)現(xiàn)的寫法）。

public class MyActivity extends Activity {
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.content_layout_id);

        final Button button = findViewById(R.id.button_id);
        button.setOnClickListener(new View.OnClickListener() {
            public void onClick(View v) {
                // Code here executes on main thread after user presses button
            }
        });
    }
}

這是Android官方文檔中對(duì)按鈕添加點(diǎn)擊事件的示例代碼，我們看到這里的View.OnClickListener()就是在new的時(shí)候再去實(shí)現(xiàn)的。其實(shí)這也不難理解，打開我們每天用的APP，幾乎每個(gè)按鈕，每個(gè)視圖的功能都是不一樣的，所以不需要進(jìn)行代碼復(fù)用。

謂語是什么呢？按我的理解，一個(gè)謂語就是一個(gè)條件。

logger.debug("構(gòu)建謂語，人員的部門的區(qū)域的id等于map中區(qū)域的id");
Predicate districtPredicate = criteriaBuilder
        .equal(root.join("qualifier")
                    .join("department")
                    .join("district")
                    .get("id")
                    .as(Long.class),
                ((District) map.get("district"))
                    .getId());

我們使用criteriaBuilder的equal方法構(gòu)建了一個(gè)等于的條件(或謂語)，該條件要求考評(píng)員(root)的人員的部門的區(qū)域的id轉(zhuǎn)化為Long類型的結(jié)果與傳入的區(qū)域的id相等。

類似的寫法，我們可以構(gòu)建出部門和學(xué)科的謂語。

謂語創(chuàng)建完了，我們還需要將這些謂語進(jìn)行連接。

這里我們需要用到and條件，即區(qū)域符合且部門符合且學(xué)科類別符合。

為了方便構(gòu)建，這里參考之前的項(xiàng)目代碼構(gòu)建了一個(gè)用and拼接謂語的方法。

private Predicate predicate = null;
private CriteriaBuilder criteriaBuilder;

// 設(shè)置and謂語.注意，這里只能設(shè)置and關(guān)系的謂語，如果謂語為OR，則需要手動(dòng)設(shè)置
private void andPredicate(Predicate predicate) {
    // 如果傳入的謂語不為空
    if (null != predicate) {
        if (null == this.predicate) {
            // 如果該方法之前沒有謂語，則直接賦值
            this.predicate = predicate;
        } else {
            // 如果之前有謂語。則使用criteriaBuilder的與將已有謂語和新謂語用and連接
            this.predicate = this.criteriaBuilder.and(this.predicate, predicate);
        }
    }
}

這幾行代碼就體現(xiàn)了一名優(yōu)秀軟件工程師的素養(yǎng)，優(yōu)秀的人在寫代碼之前就能遇見哪些功能是重復(fù)的，不需實(shí)現(xiàn)之后再將相同代碼分離重構(gòu)。

logger.debug("用and連接該謂語");
this.andPredicate(districtPredicate);

如果我們只是單純的查詢的話，沒有什么特殊要求的話，那我們直接就可以把我們的謂語返回。

return this.predicate;

沒錯(cuò)，直接將謂語返回，debug的時(shí)候發(fā)現(xiàn)實(shí)際查詢時(shí)會(huì)獲取我們的謂語，并執(zhí)行query.where語句。

如果需要復(fù)雜功能的話，可以使用CriteriaQuery。

// 把Predicate應(yīng)用到CriteriaQuery中去，可以實(shí)現(xiàn)更豐富的查詢功能，可以分組，排序等
criteriaQuery.where(this.predicate);

return criteriaQuery.getRestriction();

基礎(chǔ)工作完成了，我們終于可以使用我們的謂語進(jìn)行查詢啦。

/**
 * 查詢符合條件的考評(píng)員信息
 * @param district   區(qū)域
 * @param department 部門
 * @param discipline 學(xué)科類別
 * @return 符合條件的考評(píng)員信息
 */
@Override
public List getAllExaminerInfo(District district, Department department, Discipline discipline) {
    logger.debug("新建Map并設(shè)置屬性");
    Map map = new HashMap<>();
    map.put("department", department);
    map.put("district", district);
    map.put("discipline", discipline);

    logger.debug("調(diào)用根據(jù)Map的查詢方法");
    return this.getExaminerInfoByMap(map);
}

/**
 * 根據(jù)Map查詢考評(píng)員的信息
 * @param map 考評(píng)員查詢Map
 * @return 考評(píng)員列表
 */
private List getExaminerInfoByMap(Map map) {
    logger.debug("獲取當(dāng)前登錄用戶");
    User currentLoginUser = userService.getCurrentLoginUser();

    logger.debug("獲取查詢謂語");
    Specification specification = ExaminerSpecs.base(currentLoginUser.getDepartment(), map);

    logger.debug("查詢并返回");
    return (List) examinerRepository.findAll(specification);
}

怎么樣，謂語拼接完之后是不是很簡(jiǎn)單呢？