Skip to content

Commit b81d57e

Browse files
committed
1. 支持JDK11
2. 完善README
1 parent c675974 commit b81d57e

File tree

2 files changed

+52
-47
lines changed

2 files changed

+52
-47
lines changed

README.md

+39-26
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,57 @@
99
> JVM沙箱容器,一种JVM的非侵入式运行期AOP解决方案<br/>
1010
> Real - time non-invasive AOP framework container based on JVM
1111
12+
## 目标群体
13+
14+
- BTRACE好强大,也曾技痒想做一个更便捷、更适合自己的问题定位工具,既可支持线上链路监控排查,也可支持单机版问题定位。
15+
- 有时候突然一个问题反馈上来,需要入参才能完成定位,但恰恰没有任何日志,甚至出现在别人的代码里,好想开发一个工具可以根据需要动态添加日志,最好还能按照业务ID进行过滤。
16+
- 系统间的异常模拟可以使用的工具很多,可是系统内的异常模拟怎么办,加开关或是用AOP在开发系统中实现,好想开发一个更优雅的异常模拟工具,既能模拟系统间的异常,又能模拟系统内的异常。
17+
- 好想获取行调用链路数据,可以用它识别场景、覆盖率统计等等,覆盖率统计工具不能原生支持,统计链路数据不准确。想自己开发一个工具获取行链路数据。
18+
- 我想开发录制回放、故障模拟、动态日志、行链路获取等等工具,就算我开发完成了,这些工具底层实现原理相同,同时使用,要怎么消除这些工具之间的影响,怎么保证这些工具动态加载,怎么保证动态加载/卸载之后不会影响其他工具,怎么保证在工具有问题的时候,快速消除影响,代码还原
19+
20+
如果你有以上研发诉求,那么你就是JVM-SANDBOX(以下简称沙箱容器)的潜在客户。沙箱容器提供
21+
22+
1. 动态增强类你所指定的类,获取你想要的参数和行信息甚至改变方法执行
23+
1. 动态可插拔容器框架
24+
1225
## 项目简介
1326

14-
**JVM-SANDBOX(JVM沙箱容器)实现了一种在不重启、不侵入目标JVM应用的AOP解决方案。**
27+
**JVM-SANDBOX(沙箱)实现了一种在不重启、不侵入目标JVM应用的AOP解决方案。**
1528

16-
- **JVM-SANDBOX的核心特性**
29+
### 沙箱的特性
1730

18-
1. `无侵入`:目标应用无需重启也无需感知沙箱的存在
19-
1. `类隔离`:沙箱以及沙箱的模块不会和目标应用的类相互干扰
20-
1. `可插拔`:沙箱以及沙箱的模块可以随时加载和卸载,不会在目标应用留下痕迹
21-
1. `多租户`:目标应用可以同时挂载不同租户下的沙箱并独立控制
22-
1. `高兼容`:支持JDK[6,11)
31+
1. `无侵入`:目标应用无需重启也无需感知沙箱的存在
32+
1. `类隔离`:沙箱以及沙箱的模块不会和目标应用的类相互干扰
33+
1. `可插拔`:沙箱以及沙箱的模块可以随时加载和卸载,不会在目标应用留下痕迹
34+
1. `多租户`:目标应用可以同时挂载不同租户下的沙箱并独立控制
35+
1. `高兼容`:支持JDK[6,11]
2336

24-
- **JVM-SANDBOX常见应用场景**
37+
### 沙箱常见应用场景
2538

26-
- 线上故障定位
27-
- 线上系统流控
28-
- 线上故障模拟
29-
- 方法请求录制和结果回放
30-
- 动态日志打印
31-
- 安全信息监测和脱敏
39+
- 线上故障定位
40+
- 线上系统流控
41+
- 线上故障模拟
42+
- 方法请求录制和结果回放
43+
- 动态日志打印
44+
- 安全信息监测和脱敏
3245

33-
*JVM沙箱还能帮助你做很多很多,取决于你的脑洞有多大了。*
46+
*JVM-SANDBOX还能帮助你做很多很多,取决于你的脑洞有多大了。*
3447

35-
- **实时无侵入AOP框架**
48+
### 实时无侵入AOP框架
3649

37-
在常见的AOP框架实现方案中,有静态编织和动态编织两种。
50+
在常见的AOP框架实现方案中,有静态编织和动态编织两种。
3851

39-
1. **静态编织**:静态编织发生在字节码生成时根据一定框架的规则提前将AOP字节码插入到目标类和方法中,实现AOP;
40-
1. **动态编织**:动态编织则允许在JVM运行过程中完成指定方法的AOP字节码增强.常见的动态编织方案大多采用重命名原有方法,再新建一个同签名的方法来做代理的工作模式来完成AOP的功能(常见的实现方案如CgLib),但这种方式存在一些应用边界:
41-
- **侵入性**:对被代理的目标类需要进行侵入式改造。比如:在Spring中必须是托管于Spring容器中的Bean
42-
- **固化性**:目标代理方法在启动之后即固化,无法重新对一个已有方法进行AOP增强
52+
1. **静态编织**:静态编织发生在字节码生成时根据一定框架的规则提前将AOP字节码插入到目标类和方法中,实现AOP;
53+
1. **动态编织**:动态编织则允许在JVM运行过程中完成指定方法的AOP字节码增强.常见的动态编织方案大多采用重命名原有方法,再新建一个同签名的方法来做代理的工作模式来完成AOP的功能(常见的实现方案如CgLib),但这种方式存在一些应用边界:
54+
- **侵入性**:对被代理的目标类需要进行侵入式改造。比如:在Spring中必须是托管于Spring容器中的Bean
55+
- **固化性**:目标代理方法在启动之后即固化,无法重新对一个已有方法进行AOP增强
4356

44-
要解决`无侵入`的特性需要AOP框架具备 **<span style="color:red;">在运行时完成目标方法的增强和替换</span>**。在JDK的规范中运行期重定义一个类必须准循以下原则
45-
1. 不允许新增、修改和删除成员变量
46-
1. 不允许新增和删除方法
47-
1. 不允许修改方法签名
57+
要解决`无侵入`的特性需要AOP框架具备 **在运行时完成目标方法的增强和替换**。在JDK的规范中运行期重定义一个类必须准循以下原则
58+
1. 不允许新增、修改和删除成员变量
59+
1. 不允许新增和删除方法
60+
1. 不允许修改方法签名
4861

49-
JVM-SANDBOX属于基于Instrumentation的动态编织类的AOP框架,**<span style="color:red;">通过精心构造了字节码增强逻辑,使得沙箱的模块能在不违反JDK约束情况下实现对目标应用方法的`无侵入`运行时AOP拦截</span>**
62+
JVM-SANDBOX属于基于Instrumentation的动态编织类的AOP框架,**通过精心构造了字节码增强逻辑,使得沙箱的模块能在不违反JDK约束情况下实现对目标应用方法的`无侵入`运行时AOP拦截**
5063

5164
## 核心原理
5265

bin/sandbox.sh

+13-21
Original file line numberDiff line numberDiff line change
@@ -151,20 +151,20 @@ usage: ${0} [h] [<p:> [vlRFfu:a:A:d:m:I:P:C:X]]
151151
${0} -p <PID> -P 3658 -v
152152
153153
154-
-C : Connect server only
154+
-C : connect server only
155155
No attach target JVM, just connect server with appoint IP:PORT only.
156156
157157
EXAMPLE:
158158
${0} -C -I 192.168.0.1 -P 3658 -m debug
159159
160-
-S : Shutdown server
160+
-S : shutdown server
161161
Shutdown jvm-sandbox\` server
162162
163-
-n : Namespace
163+
-n : namespace
164164
Appoint the jvm-sandbox\` namespace
165165
when default, use \"${DEFAULT_NAMESPACE}\"
166166
167-
-d : Data
167+
-d : data
168168
Send the command & data to module's command handle method.
169169
<MODULE-ID>/<COMMAND-NAME>[?<PARAM1=VALUE1>[&PARAM2=VALUE2]]
170170
@@ -186,30 +186,23 @@ check_permission()
186186

187187
# touch attach token file
188188
touch ${SANDBOX_TOKEN_FILE} \
189-
|| exit_on_err 1 "permission denied, ${SANDBOX_TOKEN_FILE} is not readable"
189+
|| exit_on_err 1 "permission denied, ${SANDBOX_TOKEN_FILE} is not readable."
190190
}
191191

192192
# reset sandbox work environment
193193
# reset some options for env
194194
reset_for_env()
195195
{
196196

197-
# if env define the JAVA_HOME, use it first
198-
# if is alibaba opts, use alibaba ops's default JAVA_HOME
199-
# [ -z ${JAVA_HOME} ] && JAVA_HOME=/opt/taobao/java
200-
if [[ -z "${JAVA_HOME}" ]]; then
201-
JAVA_HOME=$(ps aux|grep ${TARGET_JVM_PID}|grep java|awk '{print $11}'|xargs ls -l|awk '{if($1~/^l/){print $11}else{print $9}}'|sed 's/\/bin\/java//g')
202-
fi
197+
# use the target PID's java for SANDBOX_JAVA_BIN
198+
SANDBOX_JAVA_BIN="$(ps aux|grep ${TARGET_JVM_PID}|grep java|awk '{print $11}')"
199+
[[ ! -x "${SANDBOX_JAVA_BIN}" ]] \
200+
&& exit_on_err 1 "permission denied, ${SANDBOX_JAVA_BIN} is not executable."
203201

204-
205202
# check the jvm version, we need 1.6+
206-
local JAVA_VERSION=$("${JAVA_HOME}"/bin/java -version 2>&1|awk -F '"' '/version/&&$2>"1.5"{print $2}')
207-
[[ ! -x "${JAVA_HOME}" || -z ${JAVA_VERSION} ]] \
208-
&& exit_on_err 1 "illegal ENV, please set \$JAVA_HOME to JDK6+"
209-
210-
# reset BOOT_CLASSPATH
211-
[ -f "${JAVA_HOME}"/lib/tools.jar ] \
212-
&& BOOT_CLASSPATH=-Xbootclasspath/a:"${JAVA_HOME}"/lib/tools.jar
203+
local JAVA_VERSION=$("${SANDBOX_JAVA_BIN}" -version 2>&1|awk -F '"' '/version/&&$2>"1.5"{print $2}')
204+
[[ -z ${JAVA_VERSION} ]] \
205+
&& exit_on_err 1 "illegal java version: ${JAVA_VERSION}, please make sure target java process: ${TARGET_JVM_PID} run int JDK[6,11]"
213206

214207
}
215208

@@ -222,8 +215,7 @@ function attach_jvm() {
222215
local token=`date |head|cksum|sed 's/ //g'`
223216

224217
# attach target jvm
225-
"${JAVA_HOME}"/bin/java \
226-
"${BOOT_CLASSPATH}" \
218+
"${SANDBOX_JAVA_BIN}"\
227219
${SANDBOX_JVM_OPS} \
228220
-jar ${SANDBOX_LIB_DIR}/sandbox-core.jar \
229221
${TARGET_JVM_PID} \

0 commit comments

Comments
 (0)