零侵入mock探索

前言

回看上一篇文章的发表时间，竟发现自己快2个月没有写文章了，实在有些慌张，对于自身的懈怠，自责不已。一直都想把《Java Agent+Javassist实现零侵入mock》文章提到的技术应用到测试工作中，但却迟迟未能落地，究其原因在于投入专研的时间不够，未能输出成熟的技术方案。
虽说最终方案未定，但前期的专研也扫清了不少障碍，现总结如下。

Tomcat启动javaAgent的配置方法

修改bin\catalina.bat文件，增加以下参数，其中javassist.jar的作用是修改待加载的类文件。

set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:D:\IntelliJ_IDEA_workspace\AlphaX1Autotest-2\javassist\out\artifacts\javassist_jar\javassist.jar

常见问题

• 在ctalina.bat配置javaagent（premain）命令的话，第一次启动tomcat并没有加载修改后的class文件，第二次启动才加载。
  解决方案1：如果使用premain的方式，则需修改conf配置文件夹下context.xml文件，添加reloadable="true"，修改class等文件后tomcat会自动加载。

<Context reloadable="true">

    <!-- Default set of monitored resources -->
    <WatchedResource>WEB-INF/web.xml</WatchedResource>

    <!-- Uncomment this to disable session persistence across Tomcat restarts -->
    <!--
    <Manager pathname="" />
    -->

    <!-- Uncomment this to enable Comet connection tacking (provides events
         on session expiration as well as webapp lifecycle) -->
    <!--
    <Valve className="org.apache.catalina.valves.CometConnectionManagerValve" />
    -->
</Context>

解决方案2：还是使用premain方式，找到jvm类的路径，然后修改字节码。此方案无需理会是修改jar包还是class文件，因为是直接改jvm里的class文件。

import javassist.*;

import java.io.IOException;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;

public class ClassFileTransformerImp implements ClassFileTransformer {


    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        if (className.equals("com/test/hello/controller/HelloController")) {
            try {
                System.out.println("类名：" + className);
                ClassPool cPool = ClassPool.getDefault();
                cPool.insertClassPath(new ByteArrayClassPath(className.replace("/","."),classfileBuffer));
                System.out.println("url:"+cPool.find(className));
                 /*
                    Class<?> rClazz = Class.forName(className.replace("/","."));
                    System.out.println("类："+rClazz);
                    cPool.insertClassPath(new ClassClassPath(rClazz));
                    */

                System.out.println("111111111111111");
                //获取该class对象
                CtClass cClass = cPool.get(className.replace("/","."));
                System.out.println("2222222222222221111" + cClass.getName());
                //获取到对应的方法

                CtMethod cMethod = cClass.getDeclaredMethod("index");
                System.out.println("333333333333333" + cMethod.getName());

                cMethod.insertAt(17, "{System.out.println(\"tomandy77777\");}");
                cMethod.insertAfter("{System.out.println(\"tomandy666666666\");}");
                System.out.println("444444444444444");
                /*
                cMethod.instrument(
                        new ExprEditor() {
                            public void edit(MethodCall m) throws CannotCompileException {
                                if (m.getClassName().equals("Test")
                                        && m.getMethodName().equals("minusNuber"))  //查找addNumber方法中调用的minusNuber，然后minusNuber第一个入参写死为0；
                                    m.replace("{ int tom = 123;$1 = 0; $_ = $proceed($$); }");
                            }
                        });
                 */

                System.out.println("=======修改方法完=========");
                return cClass.toBytecode();

            } catch (NotFoundException e) {
                e.printStackTrace();
            } catch (CannotCompileException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}

解决方案3：还是用premain方式，通过toClass来加载；

import javassist.*;

import java.io.IOException;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;

public class ClassFileTransformerImp1 implements ClassFileTransformer {


    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        if (className.equals("com/test/hello/controller/HelloController")) {
            try {
                System.out.println("类名：" + className);
                ClassPool cPool = ClassPool.getDefault();//new ClassPool(true);

                String filePath = loader.getResource("").getPath();
                cPool.insertClassPath(filePath);

                //获取该class对象
                CtClass cClass = cPool.get(className.replace("/", "."));
                System.out.println("类名：" + cClass.getName());
                //获取到对应的方法

                CtMethod cMethod = cClass.getDeclaredMethod("index");
                System.out.println("方法名：" + cMethod.getName());

                cMethod.insertAt(17, "{System.out.println(\"tomandy77777\");}");
                System.out.println("123456789000000");

                cMethod.insertAfter("{System.out.println(\"tomandy666666666\");}");
                /*
                cMethod.instrument(
                        new ExprEditor() {
                            public void edit(MethodCall m) throws CannotCompileException {
                                if (m.getClassName().equals("Test")
                                        && m.getMethodName().equals("minusNuber"))  //查找addNumber方法中调用的minusNuber，然后minusNuber第一个入参写死为0；
                                    m.replace("{ int tom = 123;$1 = 0; $_ = $proceed($$); }");
                            }
                        });
                 */

                cClass.toClass(); //加载
                System.out.println("=======修改方法完并加载=========");

                //return cClass.toBytecode();

            } catch (NotFoundException e) {
                e.printStackTrace();
            } catch (CannotCompileException e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}

解决方案4：使用agentMain的方式，直接修改已加载到jvm运行的类。
《探秘 Java 热部署三（Java agent agentmain）》
《JAVA AgentMain开发示例》

• tomcat启动报错：StandardServer.await: create[localhost:8005]: java.net.BindException: Address already in use: JVM_Bind
  解决方案：修改conf/server.xml的端口号。

展望

技术已经有了一定的积累，下一阶段主要探索以下几方面。

• 前端系统开发，主要用于测试人员编写mock脚本、触发mock生效等。
• 后端环境部署。