Arthas mc-redefine命令

软件技术 2024-12-23 05:49 79 0

Arthas

Arthas 是Alibaba开源的Java诊断工具，深受开发者喜爱。在线排查问题，无需重启；动态跟踪Java代码；实时监控JVM状态。

Arthas 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 Tab 自动补全功能，进一步方便进行问题的定位和诊断。

当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：

这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
是否有一个全局视角来查看系统的运行状况？
有什么办法可以监控到JVM的实时运行状态？
怎么快速定位应用的热点，生成火焰图？

本教程会以一个普通的Spring Boot应用为例，演示mc-redefine命令。

Github: https://github.com/alibaba/arthas
文档: https://arthas.aliyun.com/doc/

启动demo

下载demo-arthas-spring-boot.jar，再用java -jar命令启动：

bash
wget https://code.aliyun.com/middleware-container/handsonLabExternedFiles/raw/master/demo-arthas-spring-boot.jar;java -jar demo-arthas-spring-boot.jar

demo-arthas-spring-boot是一个很简单的spring boot应用，源代码：查看

启动之后，可以访问61000端口：点击查看

启动arthas-boot

在新的Terminal 2里，下载arthas-boot.jar，再用java -jar命令启动：

bash
wget https://arthas.aliyun.com/arthas-boot.jar;java -jar arthas-boot.jar

arthas-boot是Arthas的启动程序，它启动后，会列出所有的Java进程，用户可以选择需要诊断的目标进程。

选择第一个进程，输入 1 ，再Enter/回车：

bash
1

Attach成功之后，会打印Arthas LOGO。输入 help 可以获取到更多的帮助信息。

bash
help

mc命令

Memory Compiler/内存编译器，编译.java文件生成.class。可以通过-c/--classLoaderClass参数指定classloader，-d参数指定输出目录

编译生成.class文件之后，可以结合redefine命令实现热更新代码。

redefine命令

加载外部的.class文件，redefine jvm已加载的类。

参考：Instrumentation#redefineClasses

常见问题

redefine的class不能修改、添加、删除类的field和method，包括方法参数、方法名称及返回值
如果mc失败，可以在本地开发环境编译好class文件，上传到目标系统，使用redefine热加载class
目前redefine 和watch/trace/jad/tt等命令冲突，以后重新实现redefine功能会解决此问题

注意， redefine后的原来的类不能恢复，redefine有可能失败（比如增加了新的field），参考jdk本身的文档。
reset命令对redefine的类无效。如果想重置，需要redefine原始的字节码。
redefine命令和jad/watch/trace/monitor/tt等命令会冲突。执行完redefine之后，如果再执行上面提到的命令，则会把redefine的字节码重置。原因是jdk本身redefine和Retransform是不同的机制，同时使用两种机制来更新字节码，只有最后修改的会生效。

参数说明

| 参数名称 | 参数说明 | | --------------------- | ------------------------------------------ | | [c:] | ClassLoader的hashcode | | [classLoaderClass:] | 指定执行表达式的 ClassLoader 的 class name | | [p:] | 外部的.class文件的完整路径，支持多个 |

redefine的限制

不允许新增加field/method
正在跑的函数，没有退出不能生效。

热更新代码

下面介绍通过jad/mc/redefine 命令实现动态更新代码的功能。

目前，访问 http://localhost:61000/user/0 ，会返回500异常：

bash
curl http://localhost:61000/user/0
plaintext
{"timestamp":1550223186170,"status":500,"error":"Internal Server Error","exception":"java.lang.IllegalArgumentException","message":"id < 1","path":"/user/0"}

下面通过热更新代码，修改这个逻辑。

jad反编译UserController

bash
jad --source-only com.example.demo.arthas.user.UserController > /tmp/UserController.java

jad反编译的结果保存在 /tmp/UserController.java文件里了。

再打开一个Terminal 3，然后用vim来编辑/tmp/UserController.java：

bash
vim /tmp/UserController.java

比如当 user id 小于1时，也正常返回，不抛出异常：

java
@GetMapping(value={"/user/{id}"})
public User findUserById(@PathVariable Integer id) {
    logger.info("id: {}", (Object)id);
    if (id != null && id < 1) {
        return new User(id, "name" + id);
        // throw new IllegalArgumentException("id < 1");
    }
    return new User(id.intValue(), "name" + id);
}

sc查找加载UserController的ClassLoader

bash
sc -d *UserController | grep classLoaderHash
console
$ sc -d *UserController | grep classLoaderHash
 classLoaderHash   1be6f5c3

可以发现是 spring boot LaunchedURLClassLoader@1be6f5c3 加载的。

注意hashcode是变化的，需要先查看当前的ClassLoader信息，提取对应ClassLoader的hashcode。

如果你使用-c，你需要手动输入hashcode：-c <hashcode>

对于只有唯一实例的ClassLoader可以通过--classLoaderClass指定class name，使用起来更加方便.

--classLoaderClass 的值是ClassLoader的类名，只有匹配到唯一的ClassLoader实例时才能工作，目的是方便输入通用命令，而-c <hashcode>是动态变化的。

mc

保存好/tmp/UserController.java之后，使用mc(Memory Compiler)命令来编译，并且通过--classLoaderClass参数指定ClassLoader：

bash
mc --classLoaderClass org.springframework.boot.loader.LaunchedURLClassLoader /tmp/UserController.java -d /tmp
console
$ mc --classLoaderClass org.springframework.boot.loader.LaunchedURLClassLoader /tmp/UserController.java -d /tmp
Memory compiler output:
/tmp/com/example/demo/arthas/user/UserController.class
Affect(row-cnt:1) cost in 346 ms

也可以通过mc -c <classLoaderHash> /tmp/UserController.java -d /tmp，使用-c参数指定ClassLoaderHash:

console
$ mc -c 1be6f5c3 /tmp/UserController.java -d /tmp

redefine

再使用redefine命令重新加载新编译好的UserController.class：

bash
redefine /tmp/com/example/demo/arthas/user/UserController.class
plaintext
$ redefine /tmp/com/example/demo/arthas/user/UserController.class
redefine success, size: 1

热修改代码结果

redefine成功之后，再次访问 user/0 ，结果是：

plaintext
{
  "id": 0,
  "name": "name0"
}