基于jvm-sandbox IDEA Debug 调试 (二)
2021-11-08 本文已影响0人
凯凯雄雄
还是以官方的案例来串联这个流程：
-
先编写一个有问题的类，并启动
-
通过agent暴露一个端口，通过IDEA来监听这个端口。
-
然后在启动jvm-sandbox的插件，通过端口回调给IDEA监听
-
进行源码调试
2.1 编写dmeo
/**
* 报时的钟
*/
public class Clock {
// 日期格式化
private final java.text.SimpleDateFormat clockDateFormat
= new java.text.SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
/**
* 状态检查 : 注意这里是否返回一个异常
*/
final void checkState() {
throw new IllegalStateException("STATE ERROR!");
}
/**
* 获取当前时间
*
* @return 当前时间
*/
final java.util.Date now() {
return new java.util.Date();
}
/**
* 报告时间
*
* @return 报告时间
*/
final String report() {
checkState();
return clockDateFormat.format(now());
}
/**
* 循环播报时间
*/
final void loopReport() throws InterruptedException {
while (true) {
try {
System.out.println(report());
} catch (Throwable cause) {
cause.printStackTrace();
}
Thread.sleep(1000);
}
}
public static void main(String... args) throws InterruptedException {
new Clock().loopReport();
}
}
正常情况下，只要启动就会报异常:
java.lang.IllegalStateException: STATE ERROR!
at com.sandbox.demo.Clock.checkState(Clock.java:16)
at com.sandbox.demo.Clock.report(Clock.java:34)
at com.sandbox.demo.Clock.loopReport(Clock.java:44)
at com.sandbox.demo.Clock.main(Clock.java:53)
java.lang.IllegalStateException: STATE ERROR!
at com.sandbox.demo.Clock.checkState(Clock.java:16)
at com.sandbox.demo.Clock.report(Clock.java:34)
at com.sandbox.demo.Clock.loopReport(Clock.java:44)
at com.sandbox.demo.Clock.main(Clock.java:53)
这个类需要被打包成一个可运行文件，如何将一个mian方法打包成可运行的jar
IDEA - file - project structure
img
然后到输出的目录下执行java -jar xxx.jar是否能成功。
如果你用的Spring-Boot项目的话，可以忽略。。
2.2 编写修复插件
import com.alibaba.jvm.sandbox.api.Information;
import com.alibaba.jvm.sandbox.api.Module;
import com.alibaba.jvm.sandbox.api.ProcessController;
import com.alibaba.jvm.sandbox.api.annotation.Command;
import com.alibaba.jvm.sandbox.api.listener.ext.Advice;
import com.alibaba.jvm.sandbox.api.listener.ext.AdviceListener;
import com.alibaba.jvm.sandbox.api.listener.ext.EventWatchBuilder;
import com.alibaba.jvm.sandbox.api.resource.ModuleEventWatcher;
import org.kohsuke.MetaInfServices;
import javax.annotation.Resource;
@MetaInfServices(Module.class)
@Information(id = "broken-clock-tinker")
public class BrokenClockTinkerModule implements Module {
@Resource
private ModuleEventWatcher moduleEventWatcher;
@Command("repairCheckState")
public void repairCheckState() {
new EventWatchBuilder(moduleEventWatcher)
.onClass("com.sandbox.demo.Clock")
.onBehavior("checkState")
.onWatch(new AdviceListener() {
/**
* 拦截{@code com.taobao.demo.Clock#checkState()}方法，当这个方法抛出异常时将会被
* AdviceListener#afterThrowing()所拦截
*/
@Override
protected void afterThrowing(Advice advice) throws Throwable {
// 在此，你可以通过ProcessController来改变原有方法的执行流程
// 这里的代码意义是：改变原方法抛出异常的行为，变更为立即返回；void返回值用null表示
ProcessController.returnImmediately(null);
}
});
}
}
目前的话,我是写到了sandbox-debug-module模块中，他的插件编号是broken-clock-tinker他的执行命令是repairCheckState。
后续你要编写自己的业务模块，也可以参考sandbox-debug-module的pom.xml文件。
这个插件的作用是当Clock.checkState方法抛出异常的时候，直接返回null，而不是异常。
2.3 上传插件
将你写好的sandbox-debug-module模块打包之后，上传到~/.sandbox-module/目录下.
2.4 启动demo应用,并加入agent
- 启动demo
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5050 -jar sandbox-my-demo.jar
\2. 开启沙箱植入环境
# 查找demo的pid
jps
# 2710 jar
# 启动sandbox到对应的pid
./sandbox.sh -p 2710
NAMESPACE : default
VERSION : 1.3.3
MODE : ATTACH
SERVER_ADDR : 0.0.0.0
SERVER_PORT : 41011
UNSAFE_SUPPORT : ENABLE
SANDBOX_HOME : /elab/tools/sandbox/bin/..
SYSTEM_MODULE_LIB : /elab/tools/sandbox/bin/../module
USER_MODULE_LIB : /elab/tools/sandbox/sandbox-module;~/.sandbox-module;
SYSTEM_PROVIDER_LIB : /elab/tools/sandbox/bin/../provider
EVENT_POOL_SUPPORT : DISABLE
# 查看运行中的插件
./sandbox.sh -p 2710 -l
debug-ralph ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
sandbox-info ACTIVE LOADED 0 0 0.0.4 luanjia@taobao.com
broken-clock-tinker ACTIVE LOADED 0 0 UNKNOW_VERSION UNKNOW_AUTHOR
sandbox-module-mgr ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
debug-trace ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
sandbox-control ACTIVE LOADED 0 0 0.0.3 luanjia@taobao.com
debug-watch ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
# 运行插件
./sandbox.sh -p 2710 -d 'broken-clock-tinker/repairCheckState'
2.5 IDEA 通过端口接收监听回调
img
这个时候服务那边的触发事件会通过端口传给你本地，你可以去调试了。
2.6 sandbox-debug-module源码调试
上面我们已经知道如何暴露一个端口给本地的IDEA去做一些监听方面的工作，这次我们希望去查看一下debug模块中的一些常用插件比如wathc、trace等源码实现如何去做？
首先下载源码之后，本地maven编译打包成功之后。
将sandbox-debug-module模块下的sandbox-debug-module-1.3.3-jar-with-dependencies.jar包上传到服务器的sandbox-module模块下，这是sandbox自定义的模块加载目录。
放好了之后:
# 1 . 通过attach方式，找到对应的jar的pid进入
# 1.1 查看debug模块是否加载完毕
./sandbox.sh -p 20787 -l
debug-ralph ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
debug-exception-logger ACTIVE LOADED 1 5 0.0.2 luanjia@taobao.com
sandbox-info ACTIVE LOADED 0 0 0.0.4 luanjia@taobao.com
sandbox-module-mgr ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
debug-trace ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
debug-lifecycle ACTIVE LOADED 0 0 0.0.1 luanjia@taobao.com
sandbox-control ACTIVE LOADED 0 0 0.0.3 luanjia@taobao.com
debug-watch ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
debug-servlet-access ACTIVE LOADED 0 0 0.0.2 luanjia@taobao.com
total=9
./sandbox.sh -p 20787 -d 'debug-watch/watch?class=*com.sandbox.demo.Clock&method=*report*'
# 这个时候关注IDEA是否进入到com.alibaba.jvm.sandbox.module.debug.DebugWatchModule#watch类中的断点?
