概述
ES插件官方介绍文档：https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-authors.html
1、插件分类
ES提供了插件功能，可以自由扩展ES的功能，开发者可以根据自己的业务需求实现自定义的功能。插件分类有以下类别：
AnalysisPlugin
分析插件，扩展索引分析功能，用于增强ES自身分析功能的不足，例如大家熟知的IK分词插件。
ActionPlugin
Rest api接口请求插件。开发者可以开发自身需要的rest命令，也可以对rest请求进行增加处理。
ScriptPlugin
脚本插件。主要用于扩展ES的脚本功能，比如自定义方法打分，让ES支持其他脚本语言。
SearchPlugin
查询插件。扩展ES的查询功能。
IngestPlugin
预处理插件。在数据索引之前进行预处理，例如根据ip来增加地理信息的geoip processor plugin。
Ingest geoip processor plugin
NetworkPlugin
网络传输插件。
MapperPlugin
映射插件。增强ES的数据类型。
2、插件部署
ES插件部署在ES安装目录的plugins目录下。两种方式部署插件：1）通过ES自带的elasticsearch-plugin命令安装打包好的插件zip包 2）直接将插件zip包解压复制到plugins目录下
ES插件能被正确加载要满足以下几个条件：
1）在plugins目录下有对应插件的目录
2）插件目录下包含打包好的jar包以及其依赖包
3）目录下包含plugin-descriptor.properties插件描述文件
4）目录下包含plugin-security.policy插件安全配置文件
3、插件开发
1）工程结构
2）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>com.yyx.plugin</groupId>
<artifactId>es-plugin-demo</artifactId>
<version>${elasticsearch.version}</version>
<packaging>jar</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<elasticsearch.version>7.3.1</elasticsearch.version>
<maven.compiler.target>1.8</maven.compiler.target>
<elasticsearch.description>test plugin</elasticsearch.description>
<elasticsearch.plugin.name>es-plugin-demo</elasticsearch.plugin.name>
<elasticsearch.plugin.classname>com.yyx.plugin.RequestPlugin</elasticsearch.plugin.classname>
</properties>
<dependencies>
<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch</artifactId>
<version>${elasticsearch.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.2</version>
<configuration>
<appendAssemblyId>false</appendAssemblyId>
<outputDirectory>${project.build.directory}</outputDirectory>
<descriptors>
<descriptor>src/main/assembly/assembly.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
<!--maven编译插件-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.7.0</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
<configuration>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<archive>
<manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
</archive>
</configuration>
</plugin>
</plugins>
</build>
</project>
3）plugin-descriptor.properties
description={elasticsearch.description}
version=${project.version}
name=${elasticsearch.plugin.name}
classname=${elasticsearch.plugin.classname}
java.version=${maven.compiler.target}
elasticsearch.version=${elasticsearch.version}
description：插件描述
version：插件版本
name：插件名称
classname：插件入口类名
java.version：依赖java版本
elasticsearch.version：插件兼容的ES版本（注意必须和运行ES版本强匹配）
3）plugin-security.policy
grant {
permission java.security.AllPermission;
};
plugin-security.policy是插件对敏感资源(比如本地文件)或者应用代码(类的方法)的访问声明。es要求插件开发者在plugin-security.policy中声明对敏感资源的需求，并在代码中使用AccessController.doPrivileged包裹包含敏感操作的代码。
4）assembly.xml
zip打包描述文件
<?xml version="1.0" encoding="UTF-8"?>
<assembly>
<id>plugin</id>
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>target</directory>
<outputDirectory>.</outputDirectory>
<includes>
<include>*.jar</include>
</includes>
<fileMode>0600</fileMode>
<directoryMode>0700</directoryMode>
</fileSet>
</fileSets>
<files>
<file>
<source>${project.basedir}/src/main/resources/plugin-descriptor.properties</source>
<filtered>true</filtered>
</file>
<file>
<source>${project.basedir}/src/main/resources/plugin-security.policy</source>
<filtered>true</filtered>
</file>
</files>
</assembly>
5）插件业务实现
public class RequestPlugin extends Plugin implements ActionPlugin {
@Override
public UnaryOperator<RestHandler> getRestHandlerWrapper(ThreadContext threadContext) {
return (RestHandler r) -> new RequestPluginHandler(r);
}
}
public class RequestPluginHandler implements RestHandler {
private RestHandler restHandler;
public RequestPluginHandler(RestHandler restHandler) {
super();
this.restHandler = restHandler;
}
/**
* 处理业务逻辑
*/
@Override
public void handleRequest(RestRequest request, RestChannel channel, NodeClient client) throws Exception {
String remoteHostName = request.getHttpChannel().getRemoteAddress().getAddress().getHostName();
System.out.println("remote host name : " + remoteHostName);
restHandler.handleRequest(request, channel, client);
}
}
如上代码handleRequest打印每个rest请求远端IP地址（无实际意义，仅用于测试）。
6）部署并执行
插件部署后目录如下：
发送任意rest请求，ES输出如下打印记录：
