1. 支持JDK11

2. 完善README
alibaba · Feb 2, 2019 · b81d57e · b81d57e
1 parent c675974
commit b81d57e
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -9,44 +9,57 @@
 > JVM沙箱容器，一种JVM的非侵入式运行期AOP解决方案<br/>
 > Real - time non-invasive AOP framework container based on JVM
 
+## 目标群体
+
+- BTRACE好强大，也曾技痒想做一个更便捷、更适合自己的问题定位工具，既可支持线上链路监控排查，也可支持单机版问题定位。
+- 有时候突然一个问题反馈上来，需要入参才能完成定位，但恰恰没有任何日志，甚至出现在别人的代码里，好想开发一个工具可以根据需要动态添加日志，最好还能按照业务ID进行过滤。
+- 系统间的异常模拟可以使用的工具很多，可是系统内的异常模拟怎么办，加开关或是用AOP在开发系统中实现，好想开发一个更优雅的异常模拟工具，既能模拟系统间的异常，又能模拟系统内的异常。
+- 好想获取行调用链路数据，可以用它识别场景、覆盖率统计等等，覆盖率统计工具不能原生支持，统计链路数据不准确。想自己开发一个工具获取行链路数据。
+- 我想开发录制回放、故障模拟、动态日志、行链路获取等等工具，就算我开发完成了，这些工具底层实现原理相同，同时使用，要怎么消除这些工具之间的影响，怎么保证这些工具动态加载，怎么保证动态加载/卸载之后不会影响其他工具，怎么保证在工具有问题的时候，快速消除影响，代码还原
+
+如果你有以上研发诉求，那么你就是JVM-SANDBOX(以下简称沙箱容器)的潜在客户。沙箱容器提供
+
+1. 动态增强类你所指定的类，获取你想要的参数和行信息甚至改变方法执行
+1. 动态可插拔容器框架
+
 ## 项目简介
 
-**JVM-SANDBOX（JVM沙箱容器）实现了一种在不重启、不侵入目标JVM应用的AOP解决方案。**
+**JVM-SANDBOX（沙箱）实现了一种在不重启、不侵入目标JVM应用的AOP解决方案。**
 
-- **JVM-SANDBOX的核心特性**
+### 沙箱的特性
 
-  1. `无侵入`：目标应用无需重启也无需感知沙箱的存在
-  1. `类隔离`：沙箱以及沙箱的模块不会和目标应用的类相互干扰
-  1. `可插拔`：沙箱以及沙箱的模块可以随时加载和卸载，不会在目标应用留下痕迹
-  1. `多租户`：目标应用可以同时挂载不同租户下的沙箱并独立控制
-  1. `高兼容`：支持JDK[6,11)
+1. `无侵入`：目标应用无需重启也无需感知沙箱的存在
+1. `类隔离`：沙箱以及沙箱的模块不会和目标应用的类相互干扰
+1. `可插拔`：沙箱以及沙箱的模块可以随时加载和卸载，不会在目标应用留下痕迹
+1. `多租户`：目标应用可以同时挂载不同租户下的沙箱并独立控制
+1. `高兼容`：支持JDK[6,11]
 
-- **JVM-SANDBOX常见应用场景**
+### 沙箱常见应用场景
 
-  - 线上故障定位
-  - 线上系统流控
-  - 线上故障模拟
-  - 方法请求录制和结果回放
-  - 动态日志打印
-  - 安全信息监测和脱敏
+- 线上故障定位
+- 线上系统流控
+- 线上故障模拟
+- 方法请求录制和结果回放
+- 动态日志打印
+- 安全信息监测和脱敏
 
-  *JVM沙箱还能帮助你做很多很多，取决于你的脑洞有多大了。*
+*JVM-SANDBOX还能帮助你做很多很多，取决于你的脑洞有多大了。*
 
-- **实时无侵入AOP框架**
+### 实时无侵入AOP框架
 
-  在常见的AOP框架实现方案中，有静态编织和动态编织两种。
+在常见的AOP框架实现方案中，有静态编织和动态编织两种。
 
-  1. **静态编织**：静态编织发生在字节码生成时根据一定框架的规则提前将AOP字节码插入到目标类和方法中，实现AOP；
-  1. **动态编织**：动态编织则允许在JVM运行过程中完成指定方法的AOP字节码增强.常见的动态编织方案大多采用重命名原有方法，再新建一个同签名的方法来做代理的工作模式来完成AOP的功能(常见的实现方案如CgLib)，但这种方式存在一些应用边界：
-     - **侵入性**：对被代理的目标类需要进行侵入式改造。比如：在Spring中必须是托管于Spring容器中的Bean
-     - **固化性**：目标代理方法在启动之后即固化，无法重新对一个已有方法进行AOP增强
+1. **静态编织**：静态编织发生在字节码生成时根据一定框架的规则提前将AOP字节码插入到目标类和方法中，实现AOP；
+1. **动态编织**：动态编织则允许在JVM运行过程中完成指定方法的AOP字节码增强.常见的动态编织方案大多采用重命名原有方法，再新建一个同签名的方法来做代理的工作模式来完成AOP的功能(常见的实现方案如CgLib)，但这种方式存在一些应用边界：
+   - **侵入性**：对被代理的目标类需要进行侵入式改造。比如：在Spring中必须是托管于Spring容器中的Bean
+   - **固化性**：目标代理方法在启动之后即固化，无法重新对一个已有方法进行AOP增强
 
-   要解决`无侵入`的特性需要AOP框架具备 **<span style="color:red;">在运行时完成目标方法的增强和替换</span>**。在JDK的规范中运行期重定义一个类必须准循以下原则
-     1. 不允许新增、修改和删除成员变量
-     1. 不允许新增和删除方法
-     1. 不允许修改方法签名
+要解决`无侵入`的特性需要AOP框架具备 **在运行时完成目标方法的增强和替换**。在JDK的规范中运行期重定义一个类必须准循以下原则
+  1. 不允许新增、修改和删除成员变量
+  1. 不允许新增和删除方法
+  1. 不允许修改方法签名
 
-   JVM-SANDBOX属于基于Instrumentation的动态编织类的AOP框架，**<span style="color:red;">通过精心构造了字节码增强逻辑，使得沙箱的模块能在不违反JDK约束情况下实现对目标应用方法的`无侵入`运行时AOP拦截</span>**。
+JVM-SANDBOX属于基于Instrumentation的动态编织类的AOP框架，**通过精心构造了字节码增强逻辑，使得沙箱的模块能在不违反JDK约束情况下实现对目标应用方法的`无侵入`运行时AOP拦截**。
 
 ## 核心原理
 

diff --git a/bin/sandbox.sh b/bin/sandbox.sh
@@ -151,20 +151,20 @@ usage: ${0} [h] [<p:> [vlRFfu:a:A:d:m:I:P:C:X]]
             ${0} -p <PID> -P 3658 -v
 
 
-    -C : Connect server only
+    -C : connect server only
          No attach target JVM, just connect server with appoint IP:PORT only.
 
          EXAMPLE:
              ${0} -C -I 192.168.0.1 -P 3658 -m debug
 
-    -S : Shutdown server
+    -S : shutdown server
          Shutdown jvm-sandbox\` server
 
-    -n : Namespace
+    -n : namespace
          Appoint the jvm-sandbox\` namespace
          when default, use \"${DEFAULT_NAMESPACE}\"
 
-    -d : Data
+    -d : data
          Send the command & data to module's command handle method.
          <MODULE-ID>/<COMMAND-NAME>[?<PARAM1=VALUE1>[&PARAM2=VALUE2]]
 
@@ -186,30 +186,23 @@ check_permission()
 
     # touch attach token file
     touch ${SANDBOX_TOKEN_FILE} \
-        || exit_on_err 1 "permission denied, ${SANDBOX_TOKEN_FILE} is not readable"
+        || exit_on_err 1 "permission denied, ${SANDBOX_TOKEN_FILE} is not readable."
 }
 
 # reset sandbox work environment
 # reset some options for env
 reset_for_env()
 {
 
-    # if env define the JAVA_HOME, use it first
-    # if is alibaba opts, use alibaba ops's default JAVA_HOME
-    # [ -z ${JAVA_HOME} ] && JAVA_HOME=/opt/taobao/java
-    if [[ -z "${JAVA_HOME}" ]]; then
-        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')
-    fi
+    # use the target PID's java for SANDBOX_JAVA_BIN
+    SANDBOX_JAVA_BIN="$(ps aux|grep ${TARGET_JVM_PID}|grep java|awk '{print $11}')"
+    [[ ! -x "${SANDBOX_JAVA_BIN}" ]] \
+        && exit_on_err 1 "permission denied, ${SANDBOX_JAVA_BIN} is not executable."
 
-
     # check the jvm version, we need 1.6+
-    local JAVA_VERSION=$("${JAVA_HOME}"/bin/java -version 2>&1|awk -F '"' '/version/&&$2>"1.5"{print $2}')
-    [[ ! -x "${JAVA_HOME}" || -z ${JAVA_VERSION} ]] \
-        && exit_on_err 1 "illegal ENV, please set \$JAVA_HOME to JDK6+"
-
-    # reset BOOT_CLASSPATH
-    [ -f "${JAVA_HOME}"/lib/tools.jar ] \
-        && BOOT_CLASSPATH=-Xbootclasspath/a:"${JAVA_HOME}"/lib/tools.jar
+    local JAVA_VERSION=$("${SANDBOX_JAVA_BIN}" -version 2>&1|awk -F '"' '/version/&&$2>"1.5"{print $2}')
+    [[ -z ${JAVA_VERSION} ]] \
+        && exit_on_err 1 "illegal java version: ${JAVA_VERSION}, please make sure target java process: ${TARGET_JVM_PID} run int JDK[6,11]"
 
 }
 
@@ -222,8 +215,7 @@ function attach_jvm() {
     local token=`date |head|cksum|sed 's/ //g'`
 
     # attach target jvm
-    "${JAVA_HOME}"/bin/java \
-        "${BOOT_CLASSPATH}" \
+    "${SANDBOX_JAVA_BIN}"\
         ${SANDBOX_JVM_OPS} \
         -jar ${SANDBOX_LIB_DIR}/sandbox-core.jar \
         ${TARGET_JVM_PID} \