SpringBoot 集成Elasticsearch 實現增刪改查

Elasticsearch簡介

Elasticsearch是一個基於Lucene的搜索服務器。
它提供了一個分佈式多用戶能力的全文搜索引擎，基於RESTful web接口。Elasticsearch是用Java開發的，並作爲Apache許可條款下的開放源碼發佈，是當前流行的企業級搜索引擎。設計用於雲計算中，能夠達到實時搜索，穩定，可靠，快速，安裝使用方便。

ES安裝x-pack後，默認的賬戶有三個，如下：

賬戶名	默認密碼	權限
elastic	changeme
kibana	changeme
logstash_system	changeme

注意登錄Kibana時，最好使用 Elastic 的賬號。
您需要使用Elastic用戶/密碼登錄才能創建新用戶。Kibana用戶僅用於連接和與ES通信。

需要知道的：
9300端口： ES節點之間通訊使用
9200端口： ES節點 和 外部 通訊使用

另外elasticsearch.yml的配置需要添加

network.host: 0.0.0.0

讓其可以外網訪問。

另外，注意JAVA SpringBoot集成Elaskicsearch時，需要注意版本相對應，

spring data elasticsearch	elasticsearch
3.1.x	6.2.2
3.0.x	5.5.0
2.1.x	2.4.0
2.0.x	2.2.0
1.3.x	1.5.2

與SpringBoot集成

添加JAR包依賴：

compile group: 'org.springframework.boot', name: 'spring-boot-starter-data-elasticsearch', version: '2.0.6.RELEASE'
compile 'org.elasticsearch.client:x-pack-transport:5.5.0'

配置連接elasticsearch

由於使用了X-PACK插件，需要做密碼驗證。

所以需要引入x-pack-transport包。

需要密碼驗證，所以yml配置不了，需要配置Bean注入，如下：

 @Bean
    public TransportClient transportClient() throws UnknownHostException {
        TransportClient client = new PreBuiltXPackTransportClient(Settings.builder()
                .put("cluster.name", "docker-cluster")
                .put("xpack.security.user", "elastic:changeme")
                .build())
                .addTransportAddress(new InetSocketTransportAddress(InetAddress.getByName("localhost"), 9300));
        return client;
    }

使用上面的Bean注入，便可通過驗證，連接到elasticsearch。
若無配置X-PACK,可直接配置yml或properties：

# ES
spring:
  data:
    elasticsearch:
      repositories:
        enabled: true
      cluster-name: elasticsearch
      cluster-nodes: 120.132.29.37: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。)

部分註解介紹：

@Document

@Document註解裏面的幾個屬性，類似Mysql的:

index –> DB   
type –> Table   
Document –> row

加上@Id註解後，在Elasticsearch裏對應的該列就是主鍵了，在查詢時就可以直接用主鍵查詢。其實和mysql非常類似，基本就是一個數據庫。

@Persistent
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface Document {
    String indexName();//索引庫的名稱，個人建議以項目的名稱命名
    String type() default "";//類型，個人建議以實體的名稱命名
    short shards() default 5;//默認分區數
    short replicas() default 1;//每個分區默認的備份數
    String refreshInterval() default "1s";//刷新間隔
    String indexStoreType() default "fs";//索引文件存儲類型
}

@Field

加上了@Document註解之後，默認情況下這個實體中所有的屬性都會被建立索引、並且分詞。

通過@Field註解來進行詳細的指定，如果沒有特殊需求，那麼只需要添加@Document即可。

@Field註解的定義如下：  

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Inherited
public @interface Field {

    FieldType type() default FieldType.Auto;#自動檢測屬性的類型
    FieldIndex index() default FieldIndex.analyzed;#默認情況下分詞
    DateFormat format() default DateFormat.none;
    String pattern() default "";
    boolean store() default false;#默認情況下不存儲原文
    String searchAnalyzer() default "";#指定字段搜索時使用的分詞器
    String indexAnalyzer() default "";#指定字段建立索引時指定的分詞器
    String[] ignoreFields() default {};#如果某個字段需要被忽略
    boolean includeInParent() default false;
}

CURD 操作

同樣，類似於jpa，Spring提供了ElasticsearchRepository<T, ID>類，基本的curd都幫我們提供了，我們如果有特別需要只需根據規範命名即可自行擴展，感嘆Spring的強大。
定義自己的Dao

public interface UserSearchRepository extends ElasticsearchRepository<User, Integer> {

    /**
     * Find by name list.
     *
     * @param name the name
     * @return the list
     */
    List<User> findByName(String name);

    /**
     * 使用 Page<User> users = userSearchRepository.findByName("測試",  PageRequest.of(0, 10)); //分頁是從0開始的
     *
     * @param name     the name
     * @param pageable the pageable
     * @return the page
     */
    Page<User> findByName(String name, Pageable pageable);

    /**
     * Find product by id user.
     *
     * @param name the name
     * @return the user
     */
    User findProductById(String name);
}

model 類定義

@Document(indexName = "springboot-curd", type = "user")
public class User {
    @Id
    private Integer id;

    @Field(searchAnalyzer = "ik_max_word", analyzer = "ik_smart", type = FieldType.Keyword)
    private String name;

    @Field(type = FieldType.Date, format = DateFormat.custom, pattern = "date_optional_time")
    private Date date;
    
    /* get set */

這裏的註解概念可基本對應關係型數據庫

indexNmae –> DB   
type –> Table   
@Field –> row

Service 實現

@Service
public class UserSearchServiceImpl implements UserSearchService {
    /**
     * The User search repository.
     */
    @Autowired
    UserSearchRepository userSearchRepository;

    private final Logger logger = LoggerFactory.getLogger(UserSearchServiceImpl.class);

    @Override
    public List<User> getUserAll() {
        List<User> userList = new ArrayList<>();
        Iterable<User> userIterable = userSearchRepository.findAll();
        userIterable.forEach(userList::add);
        return userList;
    }

    @Override
    public List<User> getUserLimit(int pageNum, int size) {
        Page<User> userPage = userSearchRepository.findAll(PageRequest.of(pageNum, size));
        return userPage.getContent();
    }

    @Override
    public List<User> getUserByName(String name, int pageNum, int size) {
        Page<User> userPage = userSearchRepository.findByName(name, PageRequest.of(pageNum, size));
        return userPage.getContent();
    }

    @Override
    public List<User> getUserByName(String name) {
        return userSearchRepository.findByName(name);
    }

    @Override
    public Boolean insertUser(User user) {
        try {
            userSearchRepository.save(user);
        } catch (Exception e) {
            logger.warn("添加失敗!param:{}", JSONParseUtils.object2JsonString(user), e);
            return false;
        }
        return true;
    }

    @Override
    public Boolean updateUser(User user) {
        try {
            userSearchRepository.save(user);
        } catch (Exception e) {
            logger.warn("修改失敗!param:{}", JSONParseUtils.object2JsonString(user), e);
            return false;
        }
        return true;
    }

    @Override
    public Boolean dropUser(Integer id) {
        try {
            userSearchRepository.deleteById(id);
        } catch (Exception e) {
            logger.warn("刪除失敗!param:{}", id, e);
            return false;
        }
        return true;
    }
}

提供API訪問

@RestController
@Api(value = "SpringBoot集成ElasticSearch測試接口", tags = "UserOperationApi")
public class UserOperationApi {

    @Autowired
    private UserSearchService userSearchService;

    @GetMapping("/getAll")
    @ApiOperation(value = "查詢全部User信息", notes = "獲取全部User信息", response = ApiResult.class)
    public ApiResult getAll() {
        return ApiResult.prepare().success(userSearchService.getUserAll());
    }

    @GetMapping("/getUserByName")
    @ApiOperation(value = "根據用戶名查詢User信息", notes = "根據用戶名查詢User信息", response = ApiResult.class)
    @ApiImplicitParam(name = "name", value = "用戶名", required = true, dataType = "String", paramType = "query")
    public ApiResult getUserByName(String name) {
        return ApiResult.prepare().success(userSearchService.getUserByName(name));
    }

    @GetMapping("/getLimitUser")
    @ApiOperation(value = "根據用戶名查詢User信息", notes = "根據用戶名查詢User信息", response = ApiResult.class)
    @ApiImplicitParams({
            @ApiImplicitParam(name = "page", value = "頁數", dataType = "String"),
            @ApiImplicitParam(name = "size", value = "條數", dataType = "String")
    })
    public ApiResult getLimitUser(@RequestParam(defaultValue = "0", required = false) String page,
                                  @RequestParam(defaultValue = "5", required = false) String size) {
        return ApiResult.prepare().success(userSearchService.getUserLimit(
                Integer.parseInt(page), Integer.parseInt(size)));
    }

    @PostMapping("/saveUser")
    @ApiOperation(value = "添加User信息", response = ApiResult.class)
    @ApiImplicitParam(name = "user", value = "用戶信息", required = true, dataType = "User")
    public ApiResult saveUser(@RequestBody User user) {
        Boolean isSuccess = userSearchService.insertUser(user);
        if (isSuccess) {
            return ApiResult.prepare().success("添加成功!");
        }
        return ApiResult.prepare().error(JSONParseUtils.object2JsonString(user), 500, "添加失敗!");
    }

    @PostMapping("/updateUser")
    @ApiOperation(value = "修改User信息", response = ApiResult.class)
    @ApiImplicitParam(name = "user", value = "用戶信息", required = true, dataType = "User")
    public ApiResult updateUser(@RequestBody User user) {
        Boolean isSuccess = userSearchService.updateUser(user);
        if (isSuccess) {
            return ApiResult.prepare().success("修改成功!");
        }
        return ApiResult.prepare().error(JSONParseUtils.object2JsonString(user), 500, "添加失敗!");
    }

    @GetMapping("/deleteUser")
    @ApiOperation(value = "刪除User信息", response = ApiResult.class)
    @ApiImplicitParam(name = "id", value = "用戶Id", required = true, dataType = "Integer")
    public ApiResult updateUser(Integer id) {
        Boolean isSuccess = userSearchService.dropUser(id);
        if (isSuccess) {
            return ApiResult.prepare().success("刪除成功!");
        }
        return ApiResult.prepare().error(null, 500, "刪除失敗!");
    }
}

集成Demo可查看源碼，地址：
https://github.com/liaozihong/SpringBoot-Learning/tree/master/SpringBoot-Elasticsearch

參考鏈接：
https://github.com/spring-projects/spring-data-elasticsearch
https://segmentfault.com/a/1190000015568618#911