還是以官方的案例來串聯(lián)這個流程:
先編寫一個有問題的類,并啟動
通過agent暴露一個端口,通過IDEA來監(jiān)聽這個端口。
然后在啟動jvm-sandbox的插件,通過端口回調(diào)給IDEA監(jiān)聽
進行源碼調(diào)試
2.1 編寫dmeo
/**
* 報時的鐘
*/
public class Clock {
// 日期格式化
private final java.text.SimpleDateFormat clockDateFormat
= new java.text.SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
/**
* 狀態(tài)檢查 : 注意這里是否返回一個異常
*/
final void checkState() {
throw new IllegalStateException("STATE ERROR!");
}
/**
* 獲取當(dāng)前時間
*
* @return 當(dāng)前時間
*/
final java.util.Date now() {
return new java.util.Date();
}
/**
* 報告時間
*
* @return 報告時間
*/
final String report() {
checkState();
return clockDateFormat.format(now());
}
/**
* 循環(huán)播報時間
*/
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

然后到輸出的目錄下執(zhí)行java -jar xxx.jar是否能成功。
如果你用的Spring-Boot項目的話,可以忽略。。
2.2 編寫修復(fù)插件
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()}方法,當(dāng)這個方法拋出異常時將會被
* AdviceListener#afterThrowing()所攔截
*/
@Override
protected void afterThrowing(Advice advice) throws Throwable {
// 在此,你可以通過ProcessController來改變原有方法的執(zhí)行流程
// 這里的代碼意義是:改變原方法拋出異常的行為,變更為立即返回;void返回值用null表示
ProcessController.returnImmediately(null);
}
});
}
}
目前的話,我是寫到了sandbox-debug-module模塊中,他的插件編號是broken-clock-tinker他的執(zhí)行命令是repairCheckState。
后續(xù)你要編寫自己的業(yè)務(wù)模塊,也可以參考sandbox-debug-module的pom.xml文件。
這個插件的作用是當(dāng)Clock.checkState方法拋出異常的時候,直接返回null,而不是異常。
2.3 上傳插件
將你寫好的sandbox-debug-module模塊打包之后,上傳到~/.sandbox-module/目錄下.
2.4 啟動demo應(yīng)用,并加入agent
- 啟動demo
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5050 -jar sandbox-my-demo.jar
\2. 開啟沙箱植入環(huán)境
# 查找demo的pid
jps
# 2710 jar
# 啟動sandbox到對應(yīng)的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 通過端口接收監(jiān)聽回調(diào)

這個時候服務(wù)那邊的觸發(fā)事件會通過端口傳給你本地,你可以去調(diào)試了。
2.6 sandbox-debug-module源碼調(diào)試
上面我們已經(jīng)知道如何暴露一個端口給本地的IDEA去做一些監(jiān)聽方面的工作,這次我們希望去查看一下debug模塊中的一些常用插件比如wathc、trace等源碼實現(xiàn)如何去做?
首先下載源碼之后,本地maven編譯打包成功之后。
將sandbox-debug-module模塊下的sandbox-debug-module-1.3.3-jar-with-dependencies.jar包上傳到服務(wù)器的sandbox-module模塊下,這是sandbox自定義的模塊加載目錄。
放好了之后:
# 1 . 通過attach方式,找到對應(yīng)的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*'
# 這個時候關(guān)注IDEA是否進入到com.alibaba.jvm.sandbox.module.debug.DebugWatchModule#watch類中的斷點?