Elasticsearch Mapper Attachments插件安装与使用指南

1. 项目目录结构及介绍

Elasticsearch的Mapper Attachments插件源代码托管在GitHub上，其目录结构如下：

elasticsearch-mapper-attachments/
├── dev-tools       # 开发工具相关文件夹
├── licenses        # 许可证文件
├── src             # 主要源代码存放目录
│   ├── main        # 包含主程序代码，如Java源码等
│   └── test        # 测试相关代码
├── .gitignore      # Git忽略文件配置
├── CONTRIBUTING.md # 贡献者指南
├── LICENSE.txt     # 许可证文件
├── README.md       # 项目说明文档
├── build.gradle    # Gradle构建脚本
└── ...             # 其它可能的辅助文件或配置文件

说明:

• src 目录包含了插件的主要实现代码。
• LICENSE.txt 记录了项目的授权协议（Apache-2.0）。
• README.md 提供了安装、使用的基本指导信息。
• build.gradle 是Gradle构建文件，用于编译和打包插件。

2. 项目的启动文件介绍

Mapper Attachments插件本身不直接提供一个独立的应用程序来“启动”，它是作为Elasticsearch的一个插件存在。因此，启动过程实际上是指集成到Elasticsearch中并使插件生效的过程。

Elasticsearch的启动通常通过执行其提供的脚本完成，例如，在Linux系统中，可能是通过运行bin/elasticsearch命令。为了使用此插件，你需要先确保Elasticsearch服务已启动，随后安装该插件。

插件安装命令示例:

bin/plugin install elasticsearch/elasticsearch-mapper-attachments/3.1.2

请注意，由于此项目已被归档，对于较新版本的Elasticsearch，应当改用Ingest Attachment Processor。

3. 项目的配置文件介绍

插件配置

Mapper Attachments插件的配置并不是直接在一个特定的文件中设置，而是通过Elasticsearch的全局配置或在索引的映射中指定。

全局配置示例

虽然该插件的主要配置是通过映射定义的，但可以调整某些全局设置。比如，如果要改变默认提取的字符数限制，可以在Elasticsearch的配置文件elasticsearch.yml中添加相应的配置（注意这可能依赖于具体版本的Elasticsearch是否支持这样的全局配置）。

# 示例配置，实际使用需确认是否适用
index.mapping.attachment.indexed_chars: 200000

映射配置

映射中的配置是在创建索引时定义的，以下展示了如何在映射中启用附件类型，并自定义属性：

PUT /my_index
{
  "mappings": {
    "properties": {
      "resume": {
        "type": "attachment",
        "fields": {
          "content": { "type": "text", "term_vector": "with_positions_offsets" }
        },
        "fielddata": true
      }
    }
  }
}

这里，“resume”字段被定义为附件类型，并进一步指定了内容如何被处理，包括启用词向量以支持高亮等功能。

请注意，随着Elasticsearch版本更新，如5.0以上版本推荐使用Ingest API的Attachment Processor替代Mapper Attachments插件进行文档内容的处理。务必参照当前使用的Elasticsearch版本的官方文档来选择正确的集成方式。