『? 風(fēng)云說：能分享自己職位的知識(shí)的領(lǐng)導(dǎo)是個(gè)好領(lǐng)導(dǎo)蝇闭。 』
運(yùn)行環(huán)境：JDK 7 或 8舆驶，Maven 3.0+
技術(shù)棧：SpringBoot 1.5+吏口， Spring Data Elasticsearch 1.5+ 圈暗，ElasticSearch 2.3.2
本文提綱
一泽铛、spring-data-elasticsearch-crud 的工程介紹
二壮韭、運(yùn)行?spring-data-elasticsearch-crud 工程
三北发、spring-data-elasticsearch-crud 工程代碼詳解
一、spring-data-elasticsearch-crud 的工程介紹
spring-data-elasticsearch-crud 的工程喷屋，介紹 Spring Data Elasticsearch 簡(jiǎn)單的 ES 操作琳拨。Spring Data Elasticsearch 可以跟 JPA 進(jìn)行類比。其使用方法也很簡(jiǎn)單屯曹。
二狱庇、運(yùn)行?spring-data-elasticsearch-crud 工程
注意的是這里使用的是 ElasticSearch 2.3.2。是因?yàn)榘姹緦?duì)應(yīng)關(guān)系https://github.com/spring-projects/spring-data-elasticsearch/wiki/Spring-Data-Elasticsearch---Spring-Boot---version-matrix;
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**
* ?- 只需要你修改下對(duì)應(yīng)的 pom 文件版本號(hào)
** - 下一個(gè) ES 的版本會(huì)有重大的更新
1.?后臺(tái)起守護(hù)線程啟動(dòng)?Elasticsearch
cdelasticsearch-2.3.2/./bin/elasticsearch -d
git clone 下載工程?springboot-elasticsearch 恶耽，項(xiàng)目地址見 GitHub -https://github.com/JeffLi1993/ ... ample密任。
下面開始運(yùn)行工程步驟（Quick Start）：
2.?項(xiàng)目結(jié)構(gòu)介紹
org.spring.springboot.controller-Controller層org.spring.springboot.repository-ES數(shù)據(jù)操作層org.spring.springboot.domain-實(shí)體類org.spring.springboot.service-ES業(yè)務(wù)邏輯層Application-應(yīng)用啟動(dòng)類application.properties-應(yīng)用配置文件，應(yīng)用啟動(dòng)會(huì)自動(dòng)讀取配置
本地啟動(dòng)的 ES 驳棱，就不需要改配置文件了批什。如果連測(cè)試 ES 服務(wù)地址，需要修改相應(yīng)配置
3.編譯工程
在項(xiàng)目根目錄 spring-data-elasticsearch-crud社搅，運(yùn)行 maven 指令：
mvnclean install
4.運(yùn)行工程
右鍵運(yùn)行 Application 應(yīng)用啟動(dòng)類（位置：/springboot-learning-example/springboot-elasticsearch/src/main/java/org/spring/springboot/Application.java）的 main 函數(shù)驻债，這樣就成功啟動(dòng)了 springboot-elasticsearch 案例乳规。
用 Postman 工具新增兩個(gè)城市
a.?新增城市信息
POSThttp://127.0.0.1:8080/api/city{"id”:"1","score":"5","name":"上海","description":"上海是個(gè)熱城市"}
POSThttp://127.0.0.1:8080/api/city{"id":"2","score”:"4","name”:”溫嶺","description":”溫嶺是個(gè)沿海城市"}
可以打開 ES 可視化工具 head 插件：http://localhost:9200/_plugin/head/：
（如果不知道怎么安裝，請(qǐng)查閱?《Elasticsearch 和插件 elasticsearch-head 安裝詳解》http://www.bysocket.com/?p=1744合呐。）
在「數(shù)據(jù)瀏覽」tab暮的，可以查閱到 ES 中數(shù)據(jù)是否被插入，插入后的數(shù)據(jù)格式如下：
{"_index":"cityindex","_type":"city","_id":"1","_version":1,"_score":1,"_source": {"id":"2","score”:"4","name”:”溫嶺","description":”溫嶺是個(gè)沿海城市"}}
下面是基本查詢語句的接口：
a. 普通查詢淌实，查詢城市描述
GEThttp://localhost:8080/api/city ...on%3D溫嶺
返回 JSON 如下：
[{"id":2,"name":"溫嶺","description":"溫嶺是個(gè)沿海城市","score":4}]
b.?AND 語句查詢
GEThttp://localhost:8080/api/city ...on%3D溫嶺&score=4
返回 JSON 如下:
[{"id":2,"name":"溫嶺","description":"溫嶺是個(gè)沿海城市","score":4}]
如果換成 score=5 冻辩，就沒有結(jié)果了。
c. OR 語句查詢
GEThttp://localhost:8080/api/city ...on%3D上海&score=4
返回 JSON 如下：
[{"id":2,"name":"溫嶺","description":"溫嶺是個(gè)沿海城市","score":4},? ? {"id":1,"name":"上海","description":"上海是個(gè)好城市","score":3}]
d.?NOT 語句查詢
GEThttp://localhost:8080/api/city ...on%3D溫州
返回 JSON 如下：
[{"id":2,"name":"溫嶺","description":"溫嶺是個(gè)沿海城市","score":4},? ? {"id":1,"name":"上海","description":"上海是個(gè)好城市","score":3}]
e.?LIKE 語句查詢
GEThttp://localhost:8080/api/city ...on%3D城市
返回 JSON 如下：
[{"id":2,"name":"溫嶺","description":"溫嶺是個(gè)沿海城市","score":4},? ? {"id":1,"name":"上海","description":"上海是個(gè)好城市","score":3}]
三拆祈、spring-data-elasticsearch-crud 工程代碼詳解
具體代碼見 GitHub -https://github.com/JeffLi1993/springboot-learning-example
1.pom.xml 依賴
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.0http://maven.apache.org/xsd/ma ... gt%3B4.0.0springbootspring-data-elasticsearch-crud0.0.1-SNAPSHOTspring-data-elasticsearch-crud :: spring-data-elasticsearch - 基本案例 org.springframework.bootspring-boot-starter-parent1.5.1.RELEASEorg.springframework.bootspring-boot-starter-data-elasticsearchorg.springframework.bootspring-boot-starter-webjunitjunit4.12
這里依賴的?spring-boot-starter-data-elasticsearch 版本是?1.5.1.RELEASE恨闪，對(duì)應(yīng)的 spring-data-elasticsearch 版本是 2.1.0.RELEASE。對(duì)應(yīng)官方文檔：http://docs.spring.io/spring-d ... html/放坏。后面數(shù)據(jù)操作層都是通過該 spring-data-elasticsearch?提供的接口實(shí)現(xiàn)咙咽。
2. application.properties 配置 ES 地址
# ESspring.data.elasticsearch.repositories.enabled =truespring.data.elasticsearch.cluster-nodes =127.0.0.1:9300默認(rèn)9300是 Java 客戶端的端口。9200是支持 Restful HTTP 的接口淤年。
更多配置：
? spring.data.elasticsearch.cluster-name Elasticsearch ? ?集群名钧敞。(默認(rèn)值: elasticsearch)
? spring.data.elasticsearch.cluster-nodes ? ?集群節(jié)點(diǎn)地址列表，用逗號(hào)分隔麸粮。如果沒有指定溉苛，就啟動(dòng)一個(gè)客戶端節(jié)點(diǎn)。
? spring.data.elasticsearch.propertie ? ? 用來配置客戶端的額外屬性弄诲。
? spring.data.elasticsearch.repositories.enabled ? ? 開啟 Elasticsearch 倉(cāng)庫(kù)愚战。(默認(rèn)值:true。)
3.?ES 數(shù)據(jù)操作層
/*** ES 操作類*
* Created by bysocket on 17/05/2017.*/publicinterfaceCityRepositoryextendsElasticsearchRepository{/*** AND 語句查詢**@paramdescription*@paramscore*@return*/List findByDescriptionAndScore(String description, Integer score);/*** OR 語句查詢**@paramdescription*@paramscore*@return*/List findByDescriptionOrScore(String description, Integer score);/*** 查詢城市描述** 等同于下面代碼*@Query("{\"bool\" : {\"must\" : {\"term\" : {\"description\" : \"?0\"}}}}")* Page findByDescription(String description, Pageable pageable);**@paramdescription*@parampage*@return*/Page findByDescription(String description, Pageable page);/*** NOT 語句查詢**@paramdescription*@parampage*@return*/Page findByDescriptionNot(String description, Pageable page);/*** LIKE 語句查詢**@paramdescription*@parampage*@return*/Page findByDescriptionLike(String description, Pageable page);}
接口只要繼承?ElasticsearchRepository 類即可威根。默認(rèn)會(huì)提供很多實(shí)現(xiàn)凤巨，比如 CRUD 和搜索相關(guān)的實(shí)現(xiàn)视乐。類似于 JPA 讀取數(shù)據(jù)洛搀，是使用 CrudRepository 進(jìn)行操作 ES 數(shù)據(jù)。支持的默認(rèn)方法有： count(), findAll(), findOne(ID), delete(ID), deleteAll(), exists(ID), save(DomainObject), save(Iterable)佑淀。
另外可以看出留美，接口的命名是遵循規(guī)范的。常用命名規(guī)則如下：
關(guān)鍵字?????方法命名
And ? ? ? ? ?findByNameAndPwd
Or ? ? ? ? ? ? findByNameOrSex
Is ? ? ? ? ? ? ?findById
Between ? findByIdBetween
Like ? ? ? ? ? findByNameLike
NotLike ? ? findByNameNotLike
OrderBy? ? findByIdOrderByXDesc
Not ? ? ? ? ? findByNameNot
4.?實(shí)體類
/*** 城市實(shí)體類*
* Created by bysocket on 03/05/2017.*/@Document(indexName ="province", type ="city")publicclassCityimplementsSerializable{privatestaticfinallongserialVersionUID =-1L;/*** 城市編號(hào)*/privateLong id;/*** 城市名稱*/privateString name;/*** 描述*/privateString description;/*** 城市評(píng)分*/privateInteger score;publicLonggetId(){returnid;? ? }publicvoidsetId(Long id){this.id = id;? ? }publicStringgetName(){returnname;? ? }publicvoidsetName(String name){this.name = name;? ? }publicStringgetDescription(){returndescription;? ? }publicvoidsetDescription(String description){this.description = description;? ? }publicIntegergetScore(){returnscore;? ? }publicvoidsetScore(Integer score){this.score = score;? ? }}
注意
a. City 屬性名不支持駝峰式伸刃。
b. indexName 配置必須是全部小寫谎砾，不然會(huì)出異常。
org.elasticsearch.indices.InvalidIndexNameException: Invalid index name [provinceIndex], must be lowercase
四捧颅、小結(jié)
預(yù)告下
下一篇《深入淺出?spring-data-elasticsearch - 實(shí)戰(zhàn)案例詳解》景图，會(huì)帶來實(shí)戰(zhàn)項(xiàng)目中涉及到的權(quán)重分 & 短語精準(zhǔn)匹配的講解。
摘要: 原創(chuàng)出處 www.bysocket.com 「泥瓦匠BYSocket 」歡迎轉(zhuǎn)載碉哑，保留摘要挚币，謝謝亮蒋！
