Elasticsearch经典插件描述文件详解

夏磊讳

于 2025-05-30 09:03:05 发布

阅读量318

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00584/article/details/148323692

Elasticsearch经典插件描述文件详解

elasticsearch elastic/elasticsearch: 是一个用于全文搜索和分析的分布式搜索引擎。适合用于需要实现复杂搜索功能的应用程序。特点是可以提供高扩展性和高可用性的搜索解决方案，支持多种数据格式和查询语言。项目地址: https://gitcode.com/gh_mirrors/ela/elasticsearch

什么是插件描述文件

在Elasticsearch生态系统中，插件描述文件(plugin descriptor file)是一个关键配置文件，它定义了插件的基本属性和运行要求。对于经典插件(classic plugins)，这个文件被命名为plugin-descriptor.properties，采用Java属性文件格式编写。

文件结构与位置

插件描述文件必须位于插件包的根目录下，与插件的JAR文件并列。一个典型的插件包结构如下：

my-plugin.zip
├── my-plugin-core.jar
├── dependency-library.jar
└── plugin-descriptor.properties

核心属性解析

必需属性

description
插件的简短描述，用一句话概括插件的功能。
version
插件自身的版本号，遵循语义化版本控制规范。
name
插件的名称，在Elasticsearch中必须是唯一的。
java.version
插件编译所依赖的Java版本，格式如"1.8"或"11"。
elasticsearch.version
插件兼容的Elasticsearch版本。对于实现plugin-api.jar的插件，只需匹配主版本号；其他插件必须精确匹配。

可选属性

classname
插件主类的全限定名，仅适用于"isolated"隔离模式的插件。
modulename
模块名称，指定后插件将作为模块加载。
extended.plugins
该插件通过SPI扩展的其他插件列表。
has.native.controller
布尔值，指示插件是否包含原生控制器。
licensed
布尔值，表示插件是否需要接受许可协议才能安装。

属性详解表格

| 属性名称 | 类型 | 描述 | 是否必需 | |---------|------|------|---------| | description | String | 插件功能简述 | 是 | | version | String | 插件版本号 | 是 | | name | String | 插件唯一名称 | 是 | | java.version | String | 编译Java版本 | 是 | | elasticsearch.version | String | 兼容的ES版本 | 是 | | classname | String | 主类全限定名 | 否 | | modulename | String | 模块名称 | 否 | | extended.plugins | String | 扩展的插件列表 | 否 | | has.native.controller | Boolean | 是否有原生控制器 | 否 | | licensed | Boolean | 是否需要许可 | 否 |