elasticsearch插件开发--环境搭建

从这篇开始，以nacos-elasticsearch为例，一步步介绍如何开发插件。

nacos-elasticsearch是一个自动将当前es节点注册到nacos注册中心的插件。

环境

基于maven，至少需要引用如下两个包

  org.elasticsearch
  elasticsearch
  ${elasticsearch.version}
  provided


  org.elasticsearch.test
  framework
  ${elasticsearch.version}
  test

开发es插件，肯定是要引用es的依赖，而且es还提供了测试框架，方便测试。这里要注意两点：

• elasticsearch.version需要根据你的目标es版本在指定
• 设置为provided避免打包时将es作为依赖打进来

打包插件推荐这么配置：

    maven-assembly-plugin
    3.1.1
    
      false
      
        src/assembly/release.xml
      
    
    
      
        make-assembly
        package
        
          single
        
      
    
  
  
    maven-resources-plugin
    3.1.0
    
      
        copy-resources
        
        validate
        
          copy-resources
        
        
          ${basedir}/target/extra-resources
          
            
              src/main/resources
              true
            
          
        
      
    
  

resources下增加文件：

src/main/resources/plugin-descriptor.properties
src/main/resources/plugin-security.policy

同时plugin-descriptor.properties内容如下，注意其中的变量：

java.version=1.8
name=${project.artifactId}
version=${version}
description=${project.description}.
elasticsearch.version=${elasticsearch.version}
classname=com.eoi.nacos.elasticsearch.NacosPlugin

maven-resources-plugin会将src/main/resources下的资源文件复制到target/extra-resources目录，并替换文件中的变量。

maven-assembly-plugin根据src/assembly/release.xml的配置进行打包。src/assembly/release.xml如下：

    
    ${build.timestamp}
    
        zip
    
    false
    
        
            
            ${project.basedir}/target/extra-resources
            .
            
                plugin-descriptor.properties
                plugin-security.policy
            
        
    
    
        
            
                
                org.joda:joda-convert
                joda-time:joda-time
                org.yaml:snakeyaml
                com.fasterxml.jackson.dataformat:jackson-dataformat-yaml
                jackson-core

                
                commons-collections:commons-collections
                commons-logging:commons-logging
            
            .
            true
            true
        
    

这里设置打包主要声明了生成zip包（es插件的标准发布方式），并把替换好的plugin-descriptor.properties和plugin-security.policy打到zip包中。同时设置排除一些包，这些包是与es有冲突的，在最终测试时，根据插件依赖的复杂度，这块很可能要调整。

基础类

创建一个继承自org.elasticsearch.plugins.Plugin的类NacosPlugin，这个类就是插件的入口：

public class NacosPlugin extends Plugin {
    protected final Settings settings;
    public NacosPlugin(final Settings settings) {
        this.settings = settings;
    }
    
    @Override
    public List> getSettings() {
        ...
    }
    
    @Override
    public Collection