Spring Boot 整合 Elasticsearch，實現 function score query 權重分查詢

運行環境：JDK 7 或 8，Maven 3.0+

技術棧：SpringBoot 1.5+，ElasticSearch 2.3.2

本文提綱

1、ES 的使用場景

2、運行 springboot-elasticsearch 工程

3、springboot-elasticsearch 工程代碼詳解

 

推薦 -

「springboot-learning-example」開源項目，Fork 一下，多多 Pull Request~

spring boot 實踐學習案例，是 spring boot 初學者及核心技術鞏固的最佳實踐。
https://git.oschina.net/jeff1993/springboot-learning-example

 

1、ES 的使用場景

簡單說，ElasticSearch（簡稱 ES）是搜索引擎，是結構化數據的分佈式搜索引擎。

在《Elasticsearch 和插件 elasticsearch-head 安裝詳解》 和 《Elasticsearch 默認配置 IK 及 Java AnalyzeRequestBuilder 使用》 我詳細的介紹瞭如何安裝，初步使用了 IK 分詞器。

這裏，我主要講下 SpringBoot工程中如何使用 ElasticSearch。

ES的使用場景大體分爲兩塊

1. 全文檢索。加上分詞（IK 是其中一個）、拼音插件等能夠成爲強大的全文搜索引擎。

2. 日誌統計分析。能夠實時動態分析海量日誌數據。

 

2、運行 springboot-elasticsearch 工程

注意的是這裏使用的是 ElasticSearch 2.3.2。是由於版本對應關係 ：

Spring Boot Version (x) Spring Data Elasticsearch Version (y) Elasticsearch Version (z)
x <= 1.3.5 y <= 1.3.4 z <= 1.7.2* x >= 1.4.x 2.0.0 <=y < 5.0.0** 2.0.0 <= z < 5.0.0**
* - 只須要你修改下對應的 pom 文件版本號
** - 下一個 ES 的版本會有重大的更新

git clone 下載工程 springboot-elasticsearch ，項目地址見 GitHub - https://github.com/JeffLi1993/springboot-learning-example。

 

1. 後臺起守護線程啓動 Elasticsearch

cd elasticsearch-2.3.2/
./bin/elasticsearch -d

下面開始運行工程步驟（Quick Start）：

2. 項目結構介紹

org.spring.springboot.controller - Controller 層
org.spring.springboot.repository - ES 數據操做層
org.spring.springboot.domain - 實體類
org.spring.springboot.service - ES 業務邏輯層
Application - 應用啓動類
application.properties - 應用配置文件，應用啓動會自動讀取配置

本地啓動的 ES ，就不須要改配置文件了。若是連測試 ES 服務地址，須要修改相應配置

 

3.編譯工程

在項目根目錄springboot-elasticsearch，運行 maven 指令：

mvn clean install

 

4.運行工程

右鍵運行 Application 應用啓動類（位置：/springboot-learning-example/springboot-elasticsearch/src/main/java/org/spring/springboot/Application.java）的 main 函數，這樣就成功啓動了 springboot-elasticsearch 案例。

用 Postman 工具 新增兩個城市

新增城市信息

POST http://127.0.0.1:8080/api/city
{
"id":"1",
"provinceid":"1",
"cityname":"溫嶺",
"description":"溫嶺是個好城市"
}

POST http://127.0.0.1:8080/api/city
{
"id":"2",
"provinceid":"2",
"cityname":"溫州",
"description":"溫州是個熱城市"
}

能夠打開 ES 可視化工具 head 插件：http://localhost:9200/_plugin/head/：（若是不知道怎麼安裝，請查閱 《Elasticsearch 和插件 elasticsearch-head 安裝詳解》 。）

 

在「數據瀏覽」tab，能夠查閱到ES 中數據是否被插入，插入後的數據格式以下：

{
"_index": "cityindex",
"_type": "city",
"_id": "1",
"_version": 1,
"_score": 1,
"_source": {
"id": 1,
"provinceid": 1,
"cityname": "溫嶺",
"description": "溫嶺是個好城市"
}
}

下面驗證下權重分查詢搜索接口的實現： GET http://localhost:8080/api/city/search?pageNumber=0&pageSize=10&searchContent=溫嶺

數據是會出現

[
{
"id": 1,
"provinceid": 1,
"cityname": "溫嶺",
"description": "溫嶺是個好城市"
},
{
"id": 2,
"provinceid": 2,
"cityname": "溫州",
"description": "溫州是個熱城市"
}
]

從啓動後臺 Console 能夠看出，打印出來對應的 DSL 語句：

{
"function_score" : {
"functions" : [ {
"filter" : {
"bool" : {
"should" : {
"match" : {
"cityname" : {
"query" : "溫嶺",
"type" : "boolean"
}
}
}
}
},
"weight" : 1000.0
}, {
"filter" : {
"bool" : {
"should" : {
"match" : {
"description" : {
"query" : "溫嶺",
"type" : "boolean"
}
}
}
}
},
"weight" : 100.0
} ]
}
}

爲何會出現 溫州 城市呢？由於 function score query 權重分查詢，無相關的數據默認分值爲 1。若是想除去，設置一個 setMinScore 分值便可。

 

3、springboot-elasticsearch工程代碼詳解

具體代碼見 GitHub - https://github.com/JeffLi1993/springboot-learning-example

1.pom.xml 依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>springboot</groupId>
    <artifactId>springboot-elasticsearch</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-elasticsearch :: 整合 Elasticsearch </name>

    <!-- Spring Boot 啓動父依賴 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.1.RELEASE</version>
    </parent>

    <dependencies>

        <!-- Spring Boot Elasticsearch 依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
        </dependency>

        <!-- Spring Boot Web 依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>
</project>

這裏依賴的 spring-boot-starter-data-elasticsearch 版本是 1.5.1.RELEASE，對應的 spring-data-elasticsearch 版本是 2.1.0.RELEASE。

後面數據操做層都是經過該 spring-data-elasticsearch 提供的接口實現。 操做對應官方文檔：http://docs.spring.io/spring-data/elasticsearch/docs/2.1.0.RELEASE/reference/html/。

 

2. application.properties 配置 ES 地址

# ES
spring.data.elasticsearch.repositories.enabled = true
spring.data.elasticsearch.cluster-nodes = 127.0.0.1:9300

默認 9300 是 Java 客戶端的端口。9200 是支持 Restful HTTP 的接口。

更多配置：

spring.data.elasticsearch.cluster-name Elasticsearch 集羣名。(默認值: elasticsearch)
spring.data.elasticsearch.cluster-nodes 集羣節點地址列表，用逗號分隔。若是沒有指定，就啓動一個客戶端節點。
spring.data.elasticsearch.propertie 用來配置客戶端的額外屬性。
spring.data.elasticsearch.repositories.enabled 開啓 Elasticsearch 倉庫。(默認值:true。)

 

3. ES 數據操做層

@Repository
public interface CityRepository extends ElasticsearchRepository<City,Long> {


}

接口只要繼承 ElasticsearchRepository 類便可。默認會提供不少實現，好比 CRUD 和搜索相關的實現。

4. 實體類

@Document(indexName = "cityindex", type = "city")
public class City implements Serializable{

    private static final long serialVersionUID = -1L;

    /**
     * 城市編號
     */
    private Long id;

    /**
     * 省份編號
     */
    private Long provinceid;

    /**
     * 城市名稱
     */
    private String cityname;

    /**
     * 描述
     */
    private String description;
}

注意 index 配置必須是所有小寫，否則會暴異常。 org.elasticsearch.indices.InvalidIndexNameException: Invalid index name [cityIndex], must be lowercase

 

5. ES 業務邏輯層

/**
 * 城市 ES 業務邏輯實現類
 *
 * Created by bysocket on 07/02/2017.
 */
@Service
public class CityESServiceImpl implements CityService {

    private static final Logger LOGGER = LoggerFactory.getLogger(CityESServiceImpl.class);

    @Autowired
    CityRepository cityRepository;

    @Override
    public Long saveCity(City city) {

        City cityResult = cityRepository.save(city);
        return cityResult.getId();
    }

    @Override
    public List<City> searchCity(Integer pageNumber,
                                 Integer pageSize,
                                 String searchContent) {
        // 分頁參數
        Pageable pageable = new PageRequest(pageNumber, pageSize);

        // Function Score Query
        FunctionScoreQueryBuilder functionScoreQueryBuilder = QueryBuilders.functionScoreQuery()
                .add(QueryBuilders.boolQuery().should(QueryBuilders.matchQuery("cityname", searchContent)),
                    ScoreFunctionBuilders.weightFactorFunction(1000))
                .add(QueryBuilders.boolQuery().should(QueryBuilders.matchQuery("description", searchContent)),
                        ScoreFunctionBuilders.weightFactorFunction(100));

        // 建立搜索 DSL 查詢
        SearchQuery searchQuery = new NativeSearchQueryBuilder()
                .withPageable(pageable)
                .withQuery(functionScoreQueryBuilder).build();

        LOGGER.info("\n searchCity(): searchContent [" + searchContent + "] \n DSL  = \n " + searchQuery.getQuery().toString());

        Page<City> searchPageResults = cityRepository.search(searchQuery);
        return searchPageResults.getContent();
    }

}

保存邏輯很簡單。 分頁 function score query 搜索邏輯以下： 先建立分頁參數，而後用 FunctionScoreQueryBuilder 定義 Function Score Query，並設置對應字段的權重分值。城市名稱 1000 分，description 100 分。 而後建立該搜索的 DSL 查詢，並打印出來。

4、小結

實際場景還會很複雜。這裏只是點睛之筆，後續你們優化或者更改下 DSL 語句就能夠完成本身想要的搜索規則。