通过Java Agent的redefineClasses实现Mock功能

A)

最近组内项目有个模块进行了较大规模的重构, 需要跑一下压力测试, 看一下性能如何. 但是介于产品的模式, 在正常场景下需要向通道发送消息, 然而在压测中, 我们希望这段行为能被mock掉.
当时想到的方案可以采用Spring AOP, JMockit或者自己通过Javasisit/ASM这种字节码框架来实现功能.

由于项目中我自己很少使用Spring AOP来做一些功能, 便没让它当首选方案, 研究了一下JMockit实现, 发现是使用动态Agent实现的.ok, 那么便初步定了一下方案Agent+Javasisit来实现(ASM手写字节码实在太痛苦).

B)

这一段貌似是废话, 你们也看不见代码发生的真实地转变, 我只是记录一下心路历程.

利用了2个小时, 采用Agent+Javasisit实现了一个小的模块, 基本功能也都实现了, 但是使用起来实在是太麻烦了, 代码耦合性太高. 于是又换了个思路, 去掉了Javasisit框架, 也完美地实现了功能.

C)

整个mock框架分为俩部分.

  • agent-core, mock的核心代码
  • agent-client, 在这个工程中, 我们只需要在pom中引入需要替换的工程的依赖, 然后再agent-client中把要替换的类重写一遍就好了

核心部分

├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── co
    │   │       └── wangming
    │   │           └── agent
    │   │               ├── Agent.java
    │   │               └── ClassesLoadUtil.java
    │   └── resources
    │       └── META-INF
    │           └── MANIFEST.MF
    └── test
        └── java
            └── Test.java

核心就是俩个Java文件和一个MF文件

public class Agent {

    static ScheduledExecutorService scheduledExecutorService = new ScheduledThreadPoolExecutor(1);

    static List<String> hashCached = new ArrayList<>();

    public static void premain(String agentArgs, Instrumentation instrumentation) {

        System.out.println("Agnet 进入!!! " + agentArgs);
        scheduledExecutorService.scheduleAtFixedRate(() -> tryRedefine(instrumentation, agentArgs), 0, 10, TimeUnit.SECONDS);
    }

    private static void tryRedefine(Instrumentation instrumentation, String agentArgs) {

        Class[] allLoadedClasses = instrumentation.getAllLoadedClasses();
//      System.out.println("allLoadedClasses数量:" + allLoadedClasses.length);

        Map<String, Class> finupAllLoadedClasses = new HashMap<>();
        try {
            for (Class loadedClass : allLoadedClasses) {

                if (loadedClass == null) {
                    continue;
                }
                if (loadedClass.getCanonicalName() == null) {
                    continue;
                }
                if (!loadedClass.getCanonicalName().startsWith("com.finup")) {
                    continue;
                }
                if (hashCached.contains(loadedClass.getCanonicalName())) {
                    continue;
                }
                finupAllLoadedClasses.put(loadedClass.getCanonicalName(), loadedClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

        Map<String, byte[]> rewriteClasses = ClassesLoadUtil.getRewriteClasses(agentArgs);
        for (String className : hashCached) {
            rewriteClasses.remove(className);
        }

        if (finupAllLoadedClasses.size() == 0 || rewriteClasses.size() == 0) {
            return;
        }

        System.out.println("finupAllLoadedClasses数量:" + finupAllLoadedClasses.size());

        for (String className : rewriteClasses.keySet()) {
            byte[] classBytes = rewriteClasses.get(className);

            if (classBytes == null || classBytes.length == 0) {
                System.out.println("从 rewriteClasses 找不到class: " + className);
                continue;
            }

            Class redefineClass = finupAllLoadedClasses.get(className);
            if (redefineClass == null) {
                System.out.println("从 finupAllLoadedClasses 找不到class: " + className);
                continue;
            }

            System.out.println("开始redefineClasses: " + className);

            ClassDefinition classDefinition = new ClassDefinition(redefineClass, classBytes);

            try {
                instrumentation.redefineClasses(classDefinition);
                hashCached.add(className);

                System.out.println("结束redefineClasses: " + className);
            } catch (ClassNotFoundException e) {
                e.printStackTrace();
            } catch (UnmodifiableClassException e) {
                e.printStackTrace();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

    }
}
public class ClassesLoadUtil {

    private static final Map<String, byte[]> path2Classes = new ConcurrentHashMap<>();
    private static final Map<String, byte[]> className2Classes = new ConcurrentHashMap<>();

    private static boolean havaLoaded = false;

    private static void loadFromZipFile(String jarPath) {
        try {
            ZipFile zipFile = new ZipFile(jarPath);
            Enumeration<? extends ZipEntry> entrys = zipFile.entries();
            while (entrys.hasMoreElements()) {
                ZipEntry zipEntry = entrys.nextElement();
                entryRead(jarPath, zipEntry);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    private static boolean entryRead(String jarPath, ZipEntry ze) throws IOException {
        if (ze.getSize() > 0) {
            String fileName = ze.getName();
            if (!fileName.endsWith(".class")) {
                return true;
            }
            if (!fileName.contains("finup")) {
                return true;
            }

            try (ZipFile zf = new ZipFile(jarPath); InputStream input = zf.getInputStream(ze);
                 ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
                if (input == null) {
//                              logger.error("Code Reload cant find file : " + fileName);
                    return true;
                }
                int b = 0;
                while ((b = input.read()) != -1) {
                    byteArrayOutputStream.write(b);
                }
                byte[] bytes = byteArrayOutputStream.toByteArray();

                path2Classes.put(fileName, bytes);

                String name1 = fileName.replaceAll("\\.class", "");
                String name2 = name1.replaceAll("/", ".");

                className2Classes.put(name2, bytes);

                System.out.println("加载文件: fileName : " + fileName + ".  className:" + name2);
            }
        } else {
//          System.out.println(ze.getName() + " size is 0");
        }
        return false;
    }


    public static Map<String, byte[]> getRewriteClasses(String agentArgs) {
        synchronized (className2Classes) {
            if (!havaLoaded) {
                loadFromZipFile(agentArgs);
                havaLoaded = true;
            }
        }

        return className2Classes;
    }
}

MF

Manifest-Version: 1.0
Premain-Class: co.wangming.agent.Agent
Can-Redefine-Classes: true
Can-Retransform-Classes: true

基本上这三个文件就可以完成功能了.

agent-client

├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── co
    │   │       └── wangming
    │   │           └── agent_client
    │   │               └── service
    │   │                   └── TestService
    │   └── resources
    │       └── META-INF
    │           └── MANIFEST.MF
    └── test
        └── java
Manifest-Version: 1.0
Premain-Class: co.wangming.agent.Agent
Can-Redefine-Classes: true
Can-Retransform-Classes: true

我们只需要把需要覆盖的TestService类在这里重写一下就好了, 但是注意, 不能删除/增加 方法/字段, 不能修改继承结构. 总而言之就是不能修改类的结构, 但是只是修改方法实现应该也能满足大多数需求了.

以后有时间再想想怎么用Spring AOP来实现

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,376评论 6 491
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,126评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,966评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,432评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,519评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,792评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,933评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,701评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,143评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,488评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,626评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,292评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,896评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,742评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,977评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,324评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,494评论 2 348

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,629评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,761评论 25 707
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,699评论 2 59
  • 【1】 都说早起的鸟儿有虫吃,一天之计在于晨。 早上的时间何其宝贵,但是多少人都将其消磨在睡梦中。如今人们的生活状...
    半岛随说阅读 445评论 2 4
  • 就像每一次装傻的大笑,终是成就了现在我的乐观豁达。时间和习惯是都一剂良药,消亡你心心念念又不能不放下的过去,磨灭你...
    木木君的小日子阅读 423评论 3 2