【Elasticsearch 7.x升级8.x】代码兼容多版本ES过渡方案

一、需求

由于某些要求，一部分业务地区需要将es从7.9.2升级到8.9.2，其他业务地区不升级。

二、ES升级和数据迁移

1.安装新版本

(1)从官网发布版本下载8.9.2的es和kibana，解压。

(2)安装新的分词器安装中文分词器，在es主目录内plugins目录内建立ik目录，解压分词插件压缩包到ik目录。

(3)其他配置迁移，将旧版本的config/elasticsearch.yml文件中自行添加的配置例如集群、节点、内存、网络、安全等配置迁移过来。

(4)设置用户名密码与旧版本保持一致。

2.创建快照

(1)服务运行时建立速度可能很慢，并且升级完成后还需要同步中途的数据，所以建议停止访问es。

(2)编辑旧版本es配置文件config/elasticsearch.yml，设置快照仓库路径path.repo: ['xxx/es_snapshot_repository']。

(3)注册快照仓库。注册后会在(2)中仓库路径中建立相应的文件夹。

PUT /_snapshot/snapshot_repository
{
  "type": "fs",
  "settings": {
    "location": "snapshot_repository"
  }
}

(4)建立索引数据快照。

#第二个路径是注册的快照仓库名称，第三个是快照名称，命名上可以加上日期，没有请求体就是全部索引都建立快照
PUT /_snapshot/snapshot_repository/snapshot_20231024

(5)在kibana中Stack Management->Snapshot and Restore中查看快照是否建立完毕。
(6)完成创建快照以后，记录当前数据总量以及分词搜索结果用于验证。之后停止旧版本的es和kibana。

GET my_index/_search
{
  "query": {
    "match": {
      "keyword": "李佳琪哪李贵了"
    }
  },
  "track_total_hits": true,
  "_source": ["keyword"]
}

3.恢复快照

(1)编辑新版本es配置文件config/elasticsearch.yml，与2中(2)的快照仓库路径保持一致。

(2)启动新版本es和kibana。

(3)注册快照仓库。与2中(3)保持一致。

(4)进入kibana中Stack Management->Snapshot and Restore，选择快照点击Restore进行恢复。

(5)取消全部勾选，只勾选业务索引数据，es、kibana自身的索引数据视情况恢复。

后续一直点击next，恢复数据即可，恢复完成后验证数量和分词搜索结果。

三、服务修改

我们有使用一个项目es-search访问es，其他服务引入它的jar包来调用编写好的接口访问es。

1.现有代码兼容es8.x

目前我们使用rest-high-level-client相关api访问es。ES官方文档显示8.x版本不再提供这个包，而是使用elasticsearch-java访问，其中的api全部变了。同时，官方给出了一种过度方案，使用7.17.x版本的rest-high-level-client可以以兼容模式访问8.x 原文地址 。

所以如果在不修改业务代码的情况下，要访问es8.x需要使用7.17.14的es相关包。

<properties>
    <!--spring-boot-parent-starter有es的依赖，所以只需要变更es版本即可变更依赖-->
    <elasticsearch.version>7.17.14</elasticsearch.version>
</properties>

2.兼容两个版本es

经过实测发现，使用7.17.14版本的包无法访问当前版本为7.9.2的es 无法访问的原因是es的完全开源版本是7.10.2，所以后面的客户端都会校验es的build_flavor，如果是oss版本就不让你用，官网下载的default版本能用，而我们有es是购买的云服务商的搜索服务，它们都是oss版本，所以不能使用。

所以考虑需要搞两套代码，分别使用7.6.2的包和7.17.14的包。将es-search拆分为4个子模块，

• es-search，依赖其余三个模块，最终作为构建jar包的模块。
• es-search-common，提供不受es版本影响并且被共同依赖的代码，例如实体类、工具类、service接口。
• es-search-es7和gpmall-search-es8，分别使用7.6.2和7.17.14的es相关包编写实现service接口，通过配置选择性将实现类加载到spring容器。

存在的问题

由于java不支持同时引入多版本的包，所以在最终使用是只有一种版本的包。例如project-A引入es-search后，pom文件只能指定一个es的版本。那给不同地区部署的时候就需要不同的es包的版本，并修改配置文件以加载不同版本的实现类。这样导致不好管理，测试也比较麻烦。

---

2.1 修改es包

使用maven-shade-plugin插件对7.17.14的包进行修改。它可以对package名进行一部分的替换，这样就相当于把es的代码copy了一份，就可以跟7.6.2的包同时使用。

(1)使用maven-shade-plugin修改包

创建一个空的maven项目，引入7.17.14的es依赖。因为es底层是lucene，所以我们除了修改org.elasticsearch也需要修改org.apache.lucene。

最后还需要注意修改META-INF中service的全限定类名，有的项目是通过类加载器去找的，所以也要改。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://maven.apache.org/POM/4.0.0"
         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.yourcompany.yourporject</groupId>
    <artifactId>shade-es</artifactId>
    <version>7.17.14-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.elasticsearch</groupId>
            <artifactId>elasticsearch</artifactId>
            <version>7.17.14</version>
            <exclusions>
                <exclusion>
                    <groupId>commons-logging</groupId>
                    <artifactId>commons-logging</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-core</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-api</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-high-level-client</artifactId>
            <version>7.17.14</version>
            <exclusions>
                <exclusion>
                    <groupId>commons-logging</groupId>
                    <artifactId>commons-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>


    <build>
        <finalName>maven-shade</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.4</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <artifactSet>
                                <excludes>
                                    <exclude>classworlds:classworlds</exclude>
                                    <exclude>junit:junit</exclude>
                                    <exclude>jmock:*</exclude>
                                    <exclude>*:xml-apis</exclude>
                                    <exclude>org.apache.maven:lib:tests</exclude>
                                    <exclude>log4j:log4j:jar:</exclude>
                                </excludes>
                            </artifactSet>
                            <filters>
                                <filter>
                                    <artifact>*:*</artifact>
                                    <excludes>
                                        <exclude>META-INF/*.SF</exclude>
                                        <exclude>META-INF/*.DSA</exclude>
                                        <exclude>META-INF/*.RSA</exclude>
                                    </excludes>
                                </filter>
                            </filters>
                            <createDependencyReducedPom>true</createDependencyReducedPom>
                            <relocations>
                                <relocation>
                                    <!-- 改名前 -->
                                    <pattern>org.elasticsearch</pattern>
                                    <!-- 改名后 -->
                                    <shadedPattern>shade.org.elasticsearch</shadedPattern>
                                </relocation>
                                <relocation>
                                    <!-- 改名前 -->
                                    <pattern>org.apache.lucene</pattern>
                                    <!-- 改名后 -->
                                    <shadedPattern>shade.org.apache.lucene</shadedPattern>
                                </relocation>
                            </relocations>

                            <!--修改META-INF中定义的需要加载的全限定类名-->
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

(2)引入shade-es包

3.增加代理层

包的问题解决了，但是因为es-search中有两套实现代码，我们原来spring注入的service不可能注入两个。所以我们将es-search-common中对外提供的service接口作为代理层（有点像反向代理），在es-search中实现这些代理接口，实现方法中通过获取配置判断去调用es7还是es8中的实现类。

代理类实现

当然，以上修改办法只是过渡方案，当es全面升级以后，应该使用新api去重构旧方法。