SpringBoot整合Elasticsearch詳細步驟以及代碼示例（附源碼）

SpringBoot整合Elasticsearch詳細步驟以及代碼示例（附源碼）

 

準備工做#

環境準備#

JAVA版本

Copy

java version "1.8.0_121" Java(TM) SE Runtime Environment (build 1.8.0_121-b13) Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)

ES版本

Copy

{
  "name": "pYaFJhZ", "cluster_name": "my-cluster", "cluster_uuid": "oC28y-cNQduGItC7qq5W8w", "version": { "number": "6.8.2", "build_flavor": "oss", "build_type": "tar", "build_hash": "b506955", "build_date": "2019-07-24T15:24:41.545295Z", "build_snapshot": false, "lucene_version": "7.7.0", "minimum_wire_compatibility_version": "5.6.0", "minimum_index_compatibility_version": "5.0.0" }, "tagline": "You Know, for Search" }

SpringBoot版本

Copy

2.1.7.RELEASE

開發工具使用的是IDEA

安裝ES#

Elasticsearch介紹以及安裝：ElasticSearch入門-基本概念介紹以及安裝

開始#

建立SpringBoot項目#

1. 打開IDEA，在菜單中點擊
   File > New > Project...
   在彈框中選擇Spring Initializr
   
   而後Next

2. 填寫項目名等，而後Next，
   

3. 選擇依賴的jar包（通常我只選Lombok，其餘的本身手動加），而後Next。
   

4. 最後選擇項目所在路徑，點擊Finish。
   

搞定收工。至此，一個新的SpringBoot項目就新鮮出爐了。

POM文件#

固然，具體依賴的jar包確定不止第2步選擇的那些，其中SpringBoot提供的操做ES的jar包spring-boot-starter-data-elasticsearch固然也是必不可少的。

這裏貼出最終的pom文件：

Copy

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.7.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.lifengdi</groupId> <artifactId>search</artifactId> <version>0.0.1-SNAPSHOT</version> <name>search</name> <description>elasticsearch</description> <properties> <java.version>1.8</java.version> <testng.version>6.14.2</testng.version> <spring-cloud-dependencies.version>Greenwich.RELEASE</spring-cloud-dependencies.version> <kibana-logging-spring-boot-starter.version>1.2.4</kibana-logging-spring-boot-starter.version> <fastjson.version>1.2.47</fastjson.version> <alarm-spring-boot-starter.version>1.0.15-SNAPSHOT</alarm-spring-boot-starter.version> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>${spring-cloud-dependencies.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--elasticsearch--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-elasticsearch</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <!--測試--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.testng</groupId> <artifactId>testng</artifactId> <version>${testng.version}</version> <scope>test</scope> </dependency> <!-- 日期處理 --> <dependency> <groupId>joda-time</groupId> <artifactId>joda-time</artifactId> </dependency> <!--FastJson--> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>${fastjson.version}</version> </dependency> <!--feign--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>

application.yml文件#

application.yml文件配置以下：

Copy

server:  port: 8080  servlet:  context-path: /search spring:  application:  name: search  data:  elasticsearch:  cluster-name: my-cluster  cluster-nodes: localhost:9300  jackson:  default-property-inclusion: non_null logging:  file: application.log  path: .  level:  root: info com.lifengdi.store.client: DEBUG index-entity:  configs:  - docCode: store  indexName: store  type: base  documentPath: com.lifengdi.document.StoreDocument

spring.data.elasticsearch.cluster-name：集羣名稱

spring.data.elasticsearch.cluster-nodes：集羣節點地址列表，多個節點用英文逗號（,）分隔

建立ES文檔和映射#

首先建立一個JAVA對象，而後經過註解來聲明字段的映射屬性。
spring提供的註解有@Document、@Id、@Field，其中@Document做用在類，@Id、@Field做用在成員變量，@Id標記一個字段做爲id主鍵。

Copy

package com.lifengdi.document; import com.lifengdi.document.store.*; import com.lifengdi.search.annotation.DefinitionQuery; import com.lifengdi.search.enums.QueryTypeEnum; import lombok.Data; import org.springframework.data.annotation.Id; import org.springframework.data.elasticsearch.annotations.Document; import org.springframework.data.elasticsearch.annotations.Field; import org.springframework.data.elasticsearch.annotations.FieldType; import java.util.List; /** * 門店Document * * @author 李鋒鏑 * @date Create at 19:31 2019/8/22 */ @Document(indexName = "store", type = "base") @Data @DefinitionQuery(key = "page", type = QueryTypeEnum.IGNORE) @DefinitionQuery(key = "size", type = QueryTypeEnum.IGNORE) @DefinitionQuery(key = "q", type = QueryTypeEnum.FULLTEXT) public class StoreDocument { @Id @DefinitionQuery(type = QueryTypeEnum.IN) @DefinitionQuery(key = "id", type = QueryTypeEnum.IN) @Field(type = FieldType.Keyword) private String id; /** * 基礎信息 */ @Field(type = FieldType.Object) private StoreBaseInfo baseInfo; /** * 標籤 */ @Field(type = FieldType.Nested) @DefinitionQuery(key = "tagCode", mapped = "tags.key", type = QueryTypeEnum.IN) @DefinitionQuery(key = "tagValue", mapped = "tags.value", type = QueryTypeEnum.AND) @DefinitionQuery(key = "_tagValue", mapped = "tags.value", type = QueryTypeEnum.IN) private List<StoreTags> tags; }

建立索引#

ElasticsearchTemplate提供了四個createIndex()方法來建立索引，能夠根據類的信息自動生成，也能夠手動指定indexName和Settings

Copy

@Override public <T> boolean createIndex(Class<T> clazz) { return createIndexIfNotCreated(clazz); } @Override public boolean createIndex(String indexName) { Assert.notNull(indexName, "No index defined for Query"); return client.admin().indices().create(Requests.createIndexRequest(indexName)).actionGet().isAcknowledged(); } @Override public boolean createIndex(String indexName, Object settings) { CreateIndexRequestBuilder createIndexRequestBuilder = client.admin().indices().prepareCreate(indexName); if (settings instanceof String) { createIndexRequestBuilder.setSettings(String.valueOf(settings), Requests.INDEX_CONTENT_TYPE); } else if (settings instanceof Map) { createIndexRequestBuilder.setSettings((Map) settings); } else if (settings instanceof XContentBuilder) { createIndexRequestBuilder.setSettings((XContentBuilder) settings); } return createIndexRequestBuilder.execute().actionGet().isAcknowledged(); } @Override public <T> boolean createIndex(Class<T> clazz, Object settings) { return createIndex(getPersistentEntityFor(clazz).getIndexName(), settings); }

建立映射#

ElasticsearchTemplate提供了三個putMapping()方法來建立映射

Copy

@Override public <T> boolean putMapping(Class<T> clazz) { if (clazz.isAnnotationPresent(Mapping.class)) { String mappingPath = clazz.getAnnotation(Mapping.class).mappingPath(); if (!StringUtils.isEmpty(mappingPath)) { String mappings = readFileFromClasspath(mappingPath); if (!StringUtils.isEmpty(mappings)) { return putMapping(clazz, mappings); } } else { LOGGER.info("mappingPath in @Mapping has to be defined. Building mappings using @Field"); } } ElasticsearchPersistentEntity<T> persistentEntity = getPersistentEntityFor(clazz); XContentBuilder xContentBuilder = null; try { ElasticsearchPersistentProperty property = persistentEntity.getRequiredIdProperty(); xContentBuilder = buildMapping(clazz, persistentEntity.getIndexType(), property.getFieldName(), persistentEntity.getParentType()); } catch (Exception e) { throw new ElasticsearchException("Failed to build mapping for " + clazz.getSimpleName(), e); } return putMapping(clazz, xContentBuilder); } @Override public <T> boolean putMapping(Class<T> clazz, Object mapping) { return putMapping(getPersistentEntityFor(clazz).getIndexName(), getPersistentEntityFor(clazz).getIndexType(), mapping); } @Override public boolean putMapping(String indexName, String type, Object mapping) { Assert.notNull(indexName, "No index defined for putMapping()"); Assert.notNull(type, "No type defined for putMapping()"); PutMappingRequestBuilder requestBuilder = client.admin().indices().preparePutMapping(indexName).setType(type); if (mapping instanceof String) { requestBuilder.setSource(String.valueOf(mapping), XContentType.JSON); } else if (mapping instanceof Map) { requestBuilder.setSource((Map) mapping); } else if (mapping instanceof XContentBuilder) { requestBuilder.setSource((XContentBuilder) mapping); } return requestBuilder.execute().actionGet().isAcknowledged(); }

測試代碼以下

Copy

@Test public void testCreate() { System.out.println(elasticsearchTemplate.createIndex(StoreDocument.class)); System.out.println(elasticsearchTemplate.putMapping(StoreDocument.class)); }

刪除索引#

ElasticsearchTemplate提供了2個deleteIndex()方法來刪除索引

Copy

@Override public <T> boolean deleteIndex(Class<T> clazz) { return deleteIndex(getPersistentEntityFor(clazz).getIndexName()); } @Override public boolean deleteIndex(String indexName) { Assert.notNull(indexName, "No index defined for delete operation"); if (indexExists(indexName)) { return client.admin().indices().delete(new DeleteIndexRequest(indexName)).actionGet().isAcknowledged(); } return false; }

新增&修改文檔#

在Elasticsearch中文檔是不可改變的，不能修改它們。相反，若是想要更新現有的文檔，須要重建索引或者進行替換。

因此能夠使用和新增一樣的接口來對文檔進行修改操做。區分的依據就是id。

下面提供新增&修改文檔的其中兩種方法，一種是經過ElasticsearchTemplate提供的index()方法：

Copy

@Override public String index(IndexQuery query) { String documentId = prepareIndex(query).execute().actionGet().getId(); // We should call this because we are not going through a mapper. if (query.getObject() != null) { setPersistentEntityId(query.getObject(), documentId); } return documentId; }

示例代碼以下：

Copy

/** * 更新索引 * @param indexName 索引名稱 * @param type 索引類型 * @param id ID * @param jsonDoc JSON格式的文檔 * @param refresh 是否刷新索引 * @return ID */ public String index(String indexName, String type, String id, JsonNode jsonDoc, boolean refresh) throws JsonProcessingException { log.info("AbstractDocumentIndexService更新索引.indexName:{},type:{},id:{},jsonDoc:{}", indexName, type, id, jsonDoc); IndexQuery indexQuery = new IndexQueryBuilder() .withIndexName(indexName) .withType(type) .withId(id) .withSource(objectMapper.writeValueAsString(jsonDoc)) .build(); try { if (elasticsearchTemplate.indexExists(indexName)) { String index = elasticsearchTemplate.index(indexQuery); if (refresh) { elasticsearchTemplate.refresh(indexName); } return index; } } catch (Exception e) { log.error("更新索引失敗,刷新ES重試", e); elasticsearchTemplate.refresh(indexName); return elasticsearchTemplate.index(indexQuery); } throw BaseException.INDEX_NOT_EXISTS_EXCEPTION.build(); }

另外一種則是經過Repository接口。Spring提供的ES的Repository接口爲ElasticsearchCrudRepository，因此咱們就能夠直接定義額新的接口，而後實現ElasticsearchCrudRepository便可：

Copy

package com.taoche.docindex.repo; import com.taoche.document.StoreDocument; import org.springframework.data.elasticsearch.repository.ElasticsearchRepository; /** * 門店Repository * @author 李鋒鏑 * @date Create at 09:30 2019/8/23 */ public interface StoreRepository extends ElasticsearchRepository<StoreDocument, String> { }

示例代碼以下：

Copy

@Test public void testSave() { StoreDocument storeDocument = new StoreDocument(); storeDocument.setId("1"); StoreBaseInfo baseInfo = new StoreBaseInfo(); baseInfo.setStoreId("1"); baseInfo.setCreatedTime(DateTime.now()); storeDocument.setBaseInfo(baseInfo); storeRepository.save(storeDocument); }

查詢#

ES的主要功能就是查詢，ElasticsearchRepository也提供了基本的查詢接口，好比findById()、findAll()、findAllById()、search()等方法；固然也能夠使用Spring Data提供的另一個功能：Spring Data JPA——經過方法名建立查詢，固然須要遵循必定的規則，好比你的方法名叫作findByTitle()，那麼它就知道你是根據title查詢，而後自動幫你完成，這裏就不仔細說了。

上邊說的基本能知足通常的查詢，複雜一點的查詢就無能爲力了，這就須要用到自定義查詢，這裏能夠查看個人另外一篇博客SpringBoot使用註解的方式構建Elasticsearch查詢語句，實現多條件的複雜查詢，這裏邊有詳細的說明。

另外還有一個比較厲害的功能，Elasticsearch的聚合；聚合主要實現的是對數據的統計、分析。這個暫時沒有用到的，因此要看聚合功能的小夥伴們可能要失望了~ 哈哈哈~~~

聚合功能之後有時間會再單獨說的~都會有的。

至此，SpringBoot整合Elasticsearch基本結束，有什麼不明白的地方請留言~

源碼#

Git項目地址：search

若是以爲有幫助的話，請幫忙點贊、點星小小的支持一下~

謝謝~~

原文連接：https://www.lifengdi.com/archives/article/945

做者： 李鋒鏑

出處：http://www.javashuo.com/article/p-trmkekeg-k.html

版權：本站使用「CC BY 4.0」創做共享協議，轉載請在文章明顯位置註明做者及出處。

 

分類: Java技術

標籤: Elasticsearch, Java, SpringBoot