一种简单快捷的 java 热部署方式

作者 | 周忠太 阿里巴巴淘系技术部的一个搬砖工

【Arthas 官方社区正在举行征文活动，参加即有奖品拿~点击投稿】

Arthas Hot Swap 插件介绍

引言

热部署是帮助开发人员提高效率的利器，如果你的开发语言是 java，开发环境是远程服务器，远程服务器 debug 端口被限制，那么你可能无法通过 debug HotSwap 实现热部署，那么本文介绍的 IntelliJ IDEA 插件可以帮助你在远程服务器实现热部署，而且操作简单快捷。

本文热部署插件(Arthas Hot Swap)是基于 Arthas redefine 命令实现的，使用该插件进行远程热部署无需任何配置，无需使用 debug 端口，只需几个简单动作就能完成。gitHub 地址：https://github.com/xxxtai/arthas-hotswap

使用方法

1. IntelliJ IDEA 安装插件“Arthas Hot Swap”，从 gitHub Releases 下载安装包；
2. 热部署使用的是 class 文件，所以需要先使用“mvn compile”编译相关工程，后续可以使用 IDEA 的 Recompile 编译单个文件，节省编译时间；
3. 选择需要热部署的 java 源文件或者 class 文件，在类名或方法名上单击右键，选择“Arthas Hot Swap”的“Swap this class”，插件后台执行成功后会把热部署需要的命令复制到粘贴板；
4. 登录远程服务器，粘贴热部署命令并执行，热部署完成，该机器运行着最新的class。机器第一次执行热部署命令，可能失败，再执行一次试下。

第一步：选择 Arthas Hot Swap 插件选项

第二步：登录远程服务器粘贴命令并执行

第三步：执行完成，热部署成功

热部署的限制

由于是基于 Arthas 的 redefine 命令实现的热部署，redefine 又是基于 Instrumentation API 实现的热部署，所以和 IDEA 的 debug HotSwap 是有一样的限制。限制如下：无法修改类名、方法名，无法修改类属性名称，无法新增类属性，无法新增非静态方法。由于本插件暂时无法获取内部类的 class 文件，所以暂时不支持修改内部类。

Arthas Hot Swap 插件原理

Arthas 是阿里巴巴开源的 Java 代码诊断工具。Arthas 的 redefine 命令是基于 Instrumentation API 实现的热部署，因此和 HotSwap 热部署方式一样，有同样的限制。Arthas 的 redefine 命令其实是把 Instrumentation API 的redefineClasses 方法包装后提供给用户，那么我们就可以根据 redefine 命令发挥想象力，实现热部署。

Arthas 官方文档推荐使用 jad/mc/redefine 等一连串命令实现 class 远程热替换，流程大概是：jad 命令对老 class 进行反编译 ->vim 编辑源码 ->mc 命令编译源码 ->redefine 热替换 class。这种方式存在两个问题：一是太麻烦，二是 mc 编译大概率会失败。如果能这样就好，本地修改代码编译后上传 class 文件到远程服务器，再使用 redefine 命令热替换 class。因此官方文档又推荐，首先将 class 二进制文件转换成 base64 编码，然后再复制粘贴到远程服务器，再把 base64 编码转换成 class 文件，最后，使用 redefine 进行热替换。这么麻烦，还不如重新部署呢。所以 redefine 命令比较鸡肋。

Arthas 官方推荐的热替换方法最大的问题在于，上传 class 文件到远程服务器进行热替换的流程太麻烦，那么这些麻烦且固定的流程为何不交给机器来做呢。所以，本文推荐的“Arthas Hot Swap”插件就有必要了，该插件就是为了提升使用 Arthas 进行热替换的效率，几个简单的动作就能热替换一个 class 文件，可以解决开发过程中 80% 的热部署需求，剩下的 20% 用重新部署解决就好了。

Arthas Hot Swap 插件执行流程

1. 根据用户选择的源文件找到 class 文件，默认在 /target/classes 路径下面查找，用户也可以直接选择 class 文件；
2. 使用 AES-128 加密 class 文件，输出 base64 编码；
3. 加密的 class 文件上传至 oss，返回 oss 访问地址；
4. 渲染热部署需要执行的脚本，渲染后的脚本也上传至 oss，返回 oss 访问地址；
5. 组装热部署命令，并自动复制到粘贴板。

远程服务端热部署执行流程

1. 登录远程服务器，粘贴热部署命令并执行；
2. 下载热部署脚本，执行热部署脚本；
3. 创建工作空间；
4. 检查是否安装 openssl，没有安装则进行安装；
5. 下载 AES-128 加密的 class 文件；
6. 使用 openssl enc 解密得到 class 二进制文件；
7. 通过脚本方式安装 arthas；
8. 创建与 arthas 通信的管道并启动 arthas；
9. arthas 选择 java 进程，默认选择第一个；
10. arthas 执行 redefine 命令热替换 class 文件；
11. 打印热替换结果。

Arthas 征文活动火热进行中

Arthas 官方正在举行征文活动，如果你有：

• 使用 Arthas 排查过的问题
• 对 Arthas 进行源码解读
• 对 Arthas 提出建议
• 不限，其它与 Arthas 有关的内容

  欢迎参加征文活动，还有奖品拿哦~点击投稿

“阿里巴巴云原生关注微服务、Serverless、容器、Service Mesh 等技术领域、聚焦云原生流行技术趋势、云原生大规模的落地实践，做最懂云原生开发者的公众号。”