Elasticsearch Pinyin Analysis 插件安装与使用教程

1. 项目目录结构及介绍

elasticsearch-analysis-pinyin/
├── assets/
├── elasticsearch/
├── opensearch/
├── pinyin-core/
├── .gitignore
├── .travis.yml
├── CODE_OF_CONDUCT.md
├── LICENSE.txt
├── README.md
├── pom.xml

目录结构说明

• assets/: 存放项目相关的静态资源文件。
• elasticsearch/: 存放与 Elasticsearch 相关的代码和配置文件。
• opensearch/: 存放与 OpenSearch 相关的代码和配置文件。
• pinyin-core/: 核心的拼音转换逻辑代码。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CODE_OF_CONDUCT.md: 项目行为准则。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

启动文件

项目本身是一个 Elasticsearch 和 OpenSearch 的插件，因此没有传统的“启动文件”。插件的启动是通过 Elasticsearch 或 OpenSearch 的插件管理机制来实现的。

安装步骤

1. 下载插件:

   git clone https://github.com/medcl/elasticsearch-analysis-pinyin.git
   cd elasticsearch-analysis-pinyin
   

2. 安装插件:

   • 对于 Elasticsearch:

     bin/elasticsearch-plugin install file:///path/to/elasticsearch-analysis-pinyin.zip
     

   • 对于 OpenSearch:

     bin/opensearch-plugin install file:///path/to/elasticsearch-analysis-pinyin.zip
     

3. 重启 Elasticsearch 或 OpenSearch。

3. 项目的配置文件介绍

配置文件

插件的主要配置是通过 Elasticsearch 或 OpenSearch 的索引设置来完成的。以下是一个示例配置：

PUT /medcl
{
  "settings": {
    "analysis": {
      "analyzer": {
        "pinyin_analyzer": {
          "tokenizer": "my_pinyin"
        }
      },
      "tokenizer": {
        "my_pinyin": {
          "type": "pinyin",
          "keep_separate_first_letter": false,
          "keep_full_pinyin": true,
          "keep_original": true,
          "limit_first_letter_length": 16,
          "lowercase": true,
          "remove_duplicated_term": true
        }
      }
    }
  }
}

配置参数说明

• keep_first_letter: 是否保留每个汉字的首字母。
• keep_separate_first_letter: 是否单独保留每个汉字的首字母。
• keep_full_pinyin: 是否保留每个汉字的完整拼音。
• keep_original: 是否保留原始输入。
• limit_first_letter_length: 首字母结果的最大长度。
• lowercase: 是否将非汉字字母转换为小写。
• remove_duplicated_term: 是否移除重复的词项以节省索引空间。

通过以上配置，您可以自定义拼音分析器的行为，以满足不同的搜索需求。