Spring Data Solr 教程: 排序

2024年5月10日 302次阅读来源: JeOam

当实现一个字符查询功能时，一般都会以搜索结果的质量高低来降序显示 relevancy of each search result。这也正是Solr的做法。
然而，有时也需要采用手工干预的方式来调整展示顺序。其中一个场景就是在之前文中 previous part of my Spring Data Solr tutorial。提到的”常规”检索的实现
该文说明了如何使用 Spring Data Solr 来分类查询结果。具体就是说明如何通过修改示例应用的查询功能以使用id字段的值来降序展示查询结果。
文章可以分为三大块：

第一部分讲解了如何在查询语句中设置排序条件
第二部分说的是使用查询方法时如何排序查询结果
第三部分告诉我们如何进行动态查询结果的排序

咱们继续往下看

定义排序条件

查询语句中的排序是通过 Sort 类来实现的。常见的排序方式如下：

按单个字段结果排序
当按多个不同字段的排序结果相同时按多个字段组合排序
当按多个不同字段的排序结果不同时按多个字段组合排序

下来看看如何创建实现上述条件的Sort对象
首先，创建一个按单字段排序的Sort对象。假设我们想按照Id字段的值来升序排列，实现代码如下:

new Sort(Sort.Direction.ASC, "id")

其次，创建满足场景二中的Sort对象。这里假设我们使用id 和description 为查询字段并将结果以降序排列。实现代码如下：

new Sort(Sort.Direction.DESC, "id", "description")

最后，创建满足场景三的Sort对象。这里假设降序排列description升序排列id 字段的查询结果。实现代码如下：

new Sort(Sort.Direction.DESC, "description").and(new Sort(Sort.Direction.ASC, "id"))

现在知道了如何创建相应的Sort对象，再来看看如何在具体情况中的使用。

查询方法结果排序

当使用查询方法时，可以按以下步骤来排序查询结果:

在方法体中加入Sort参数。用来传递排序设置
在服务层创建一个Sort对象，当调用查询方法时将其作为变量传递过去

下面具体看一下是如何实现的.

修改Repository接口

我们可以通过在查询方法体中添加一个变量来控制将来查询结果的排序情况。下面来看看查询方法的定义:

从方法名派生查询语句

如果使用了从方法名生成查询语句的策略，那需要在TodoDocumentRepositoryinterface的
findByTitleContainsOrDescriptionContains() 方法中添加Sort参数。源码如下：

import org.springframework.data.domain.Sort;
import org.springframework.data.solr.repository.Query;
import org.springframework.data.solr.repository.SolrCrudRepository;

import java.util.List;

public interface TodoDocumentRepository extends PartialUpdateRepository, SolrCrudRepository<TodoDocument, String> {

    public List<TodoDocument> findByTitleContainsOrDescriptionContains(String title, String description, Sort sort);
}

命名查询语句

如果使用命名查询语句的策略，那需要在odoDocumentRepository 的thefindByNamedQuery() 方法中添加Sort参数。源码如下：

import org.springframework.data.domain.Sort;
import org.springframework.data.solr.repository.Query;
import org.springframework.data.solr.repository.SolrCrudRepository;

import java.util.List;

public interface TodoDocumentRepository extends PartialUpdateRepository, SolrCrudRepository<TodoDocument, String> {

    @Query(name = "TodoDocument.findByNamedQuery")
    public List<TodoDocument> findByNamedQuery(String searchTerm, Sort sort);
}

注意: 如果使用的是Spring Data Solr RC1该功能不能正常工作源于 known bug.
如此，要么使用snapshot依赖或是使用RC2版本。

@Query 注解

如果使用@Query注解模式，我们要在theTodoDocumentRepository 接口中的 findByQueryAnnotation() 方法中添加Sort 参数。源码如下：

import org.springframework.data.domain.Sort;
import org.springframework.data.solr.repository.Query;
import org.springframework.data.solr.repository.SolrCrudRepository;

import java.util.List;

public interface TodoDocumentRepository extends PartialUpdateRepository, SolrCrudRepository<TodoDocument, String> {

    @Query("title:*?0* OR description:*?0*")
    public List<TodoDocument> findByQueryAnnotation(String searchTerm, Sort sort);
}

注意: 如果使用的是Spring Data Solr RC1该功能不能正常工作源于 known bug。如此，要么使用snapshot依赖或是使用RC2版本。

查询方法

通过修改RepositoryIndexService 类中的thesearch() 方法实现修改查询方法体

创建sortByIdDesc()方法实现以文档的id为关键字降序排列结果
通过调用 TodoDocumentRepository接口中定义的查询方法获取查询结果
返回查询结果集

再来看看search()方法的不同实现方式。

从方法名称生成查询

当我们按照方法名称策略通过查询生成来构造我们的查询时，可以使用TodoDocumentRepository接口的findByTitleContainsOrDescriptionContains() 方法获得查询结果。
RepositoryTodoIndexService 类的相关部分源代码大致如下:

import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
import java.util.List;

@Service
public class RepositoryTodoIndexService implements TodoIndexService {

    @Resource
    private TodoDocumentRepository repository;

    @Override
    public List<TodoDocument> search(String searchTerm) {
        return repository.findByTitleContainsOrDescriptionContains(searchTerm, searchTerm, sortByIdDesc());
    }

    private Sort sortByIdDesc() {
        return new Sort(Sort.Direction.DESC, "id");
    }

    //Other methods are omitted
}

命名查询
当我们用命名查询构建我们的查询时，我们可以利用TodoDocumentRepository接口的findByNamedQuery()方法得到查询结果。
RepositoryTodoIndexService 相关部分的代码如下：

import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
import java.util.List;

@Service
public class RepositoryTodoIndexService implements TodoIndexService {

    @Resource
    private TodoDocumentRepository repository;

    @Override
    public List<TodoDocument> search(String searchTerm) {
        return repository.findByNamedQuery(searchTerm, sortByIdDesc());
    }

    private Sort sortByIdDesc() {
        return new Sort(Sort.Direction.DESC, "id");
    }

    //Other methods are omitted
}

@Query 注解
当我们使用@Query注解来构建我们的查询时，我们可以使用TodoDocumentRepository接口的findByQueryAnnotation()方法来获取查询结果。
RepositoryTodoIndexService 类的相关部分如下：

import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
import java.util.List;

@Service
public class RepositoryTodoIndexService implements TodoIndexService {

    @Resource
    private TodoDocumentRepository repository;

    @Override
    public List<TodoDocument> search(String searchTerm) {
        return repository.findByQueryAnnotation(searchTerm, sortByIdDesc());
    }

    private Sort sortByIdDesc() {
        return new Sort(Sort.Direction.DESC, "id");
    }

    //Other methods are omitted
}

排序动态查询的查询结果

因为动态查询是通过在仓储接口中添加自定义方法实现的, 所以对动态查询的结果进行排序的步骤不会影响到我们的实例应用中的Service层。
我们可以通过对我们自定义仓储接口的实现进行如下修改来排序动态查询的结果集。

在TodoDocumentRepositoryImpl类中添加一个 private sortByIdDesc() 方法。这个方法返回一个Sort对象，这个对象指定查询结果集以id降序排列。
修改TodoDocumentRepositoryImpl 的search()方法.使用Query 接口的addSort()方法来设置执行查询的排序选项，并且将创建的Sort对象作为参数传递给addSort()。

TodoDocumentRepositoryImpl 类的相关方法如下：

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Sort;
import org.springframework.data.solr.core.SolrTemplate;
import org.springframework.data.solr.core.query.Criteria;
import org.springframework.data.solr.core.query.SimpleQuery;
import org.springframework.stereotype.Repository;

import javax.annotation.Resource;
import java.util.List;

@Repository
public class TodoDocumentRepositoryImpl implements CustomTodoDocumentRepository {

    @Resource
    private SolrTemplate solrTemplate;

    @Override
    public List<TodoDocument> search(String searchTerm) {
        String[] words = searchTerm.split(" ");

        Criteria conditions = createSearchConditions(words);
        SimpleQuery search = new SimpleQuery(conditions);

        //SET SORT OPTIONS
        search.addSort(sortByIdDesc());

        Page results = solrTemplate.queryForPage(search, TodoDocument.class);
        return results.getContent();
    }

    private Criteria createSearchConditions(String[] words) {
        Criteria conditions = null;

        for (String word: words) {
            if (conditions == null) {
                conditions = new Criteria("id").contains(word)
                        .or(new Criteria("description").contains(word));
            }
            else {
                conditions = conditions.or(new Criteria("id").contains(word))
                        .or(new Criteria("description").contains(word));
            }
        }

        return conditions;
    }

    private Sort sortByIdDesc() {
        return new Sort(Sort.Direction.DESC, "id");
    }

    //Other methods are omitted
}

总结

现在我们已经了解了使用Spring Data Solr时，如何对查询结果进行排序。本教程教会我们三件事:

我们知道可以使用Sort 类来指定排序选项。
我们学习到可以对query方法增加一个新的参数的查询，来对结果进行排序。
我们学习到可以给一个动态查询设置排序选项，方法是使用Query接口的addSort()方法。

下一次，我的Spring Data Solr教程会描述如何对我们的查询结果进行分页。
P.S. 本博客文章中的样例程序已经发布到Github (query方法和动态查询)。

原文: Spring Data Solr Tutorial: Sorting
转载自：开源中国 – petert, lwei, 赵亮-碧海情天, GoodLoser, HTCKF

    原文作者：JeOam
    原文地址: https://segmentfault.com/a/1190000000412105
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。