零侵入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生效等。
• 後端環境部署。