美文网首页
1. Java探针技术:Instrumentation

1. Java探针技术:Instrumentation

作者: whslowly | 来源:发表于2021-04-23 10:48 被阅读0次

    背景:假如我们想打印出某些系统->某些类->某些方法的执行耗时,方式有很多,但是想要无侵入的做到这一点,只有Java探针一种方式。这也是很多调用链系统依赖的技术基础。

    什么是Java探针

    通俗来讲,就是Java提供的一种手段,使我们可以修改并重新加载Class字节码,做到在系统外部来改变类的行为。

    Java探针是如何做到的

    我们知道只要是java程序,运行的入口就一定是main方法。Java探针技术相当于变相的改变了这个约定,提供了一种外挂,只要用了这个外挂(即在程序的运行时参数中加了-javaagent),就可以先执行外挂jar包中的premain方法,然后再执行原程序中的main方法。这样就提供了一个在真正的程序执行前,可以修改并重新加载字节码的机会。

    具体怎么做

    我们写个demo。

    1. 假如原程序为:

      public class DemoMain {
      
          public static void main(String[] args) {
              System.out.println("\nDemoMain.main开始");
      
              HelloService helloService = new HelloService();
              helloService.sayHello("一拳超人");
      
              System.out.println("DemoMain.main结束");
          }
      
      }
      
      public class HelloService {
      
          public void sayHello(String name) {
              System.out.println("      HelloService.sayHello开始");
              System.out.println("         Hello " + name + "!");
              System.out.println("      HelloService.sayHello结束");
          }
      
      }
      
    2. 打jar包,新版的idea打包配置有点小问题,默认的MANIFEST的文件夹路径中,要删除/main/java,如图:


      idea打包配置.jpg
    3. 我们想打印HelloService.sayHello的执行耗时,使用Java探针来实现,先写外挂程序

    ```java
    public class PrintAgent {
    
        public static void premain(String agentArgs, Instrumentation instrumentation) {
            System.out.println("\nPrintAgent.premain开始");
            System.out.println("   PrintAgent.premain入参:" + agentArgs);
    
            instrumentation.addTransformer(new PrintTransformer());
    
            System.out.println("PrintAgent.premain结束");
        }
    
        public static void main(String[] args) {
            //main方法在idea打包时需要,实际上没什么作用,不会被执行。
        }
    
    }
    
    public class PrintTransformer implements ClassFileTransformer {
    
        final static String startTime = "\nlong startTime = System.nanoTime();\n";
        final static String endTime = "\nlong endTime = System.nanoTime();\n";
    
        final static Map<String, List<String>> methodMap = new HashMap<String, List<String>>();
    
        public PrintTransformer() {
            addMethod("com.wang.hello.HelloService", "sayHello");
        }
    
        private PrintTransformer addMethod(String className, String methodName) {
            List<String> list = methodMap.computeIfAbsent(className, cn -> new ArrayList<>());
            list.add(methodName);
            return this;
        }
    
        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            className = className.replace("/", ".");
            if (methodMap.containsKey(className)) {
                try {
                    CtClass ctClass = ClassPool.getDefault().get(className);
                    for (String methodName : methodMap.get(className)) {
                        String cost = "\nSystem.out.println(\"   Method:"
                                + methodName
                                + " Cost:\"+(endTime-startTime)+"
                                + "\"ns\");\n";
                        CtMethod ctMethod = ctClass.getDeclaredMethod(methodName);
                        String wrappedMethodName = methodName + "$wrapped";
                        ctMethod.setName(wrappedMethodName);
    
                        CtMethod newMethod = CtNewMethod.copy(ctMethod, methodName, ctClass, null);
    
                        StringBuilder newMethodBody = new StringBuilder();
                        newMethodBody.append("{");
                        newMethodBody.append(startTime);
                        newMethodBody.append(wrappedMethodName + "($$);\n");
                        newMethodBody.append(endTime);
                        newMethodBody.append(cost);
                        newMethodBody.append("}");
    
                        newMethod.setBody(newMethodBody.toString());
                        ctClass.addMethod(newMethod);
                    }
                    return ctClass.toBytecode();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
            return null;
        }
    }
    ```
    
    1. PrintAgent的打包配置如图:
    16191343861365.jpg
    1. 然后需要修改PrintAgent的META-INF/MANIFEST.MF文件,改为(注意结尾必须加一新行):

      Manifest-Version: 1.0
      Premain-Class: com.wang.agent.PrintAgent
      Can-Redefine-Classes: true
      **我是空白行占位符**
      
    2. 打完包后,我们就可以执行测试了,先看下原始程序打印的日志:

      //执行java -jar demo.jar
      DemoMain.main开始
            HelloService.sayHello开始
               Hello 一拳超人!
            HelloService.sayHello结束
      DemoMain.main结束
      
    3. 外挂探针后,再次执行打印的日志,注意其中"Method:sayHello Cost:128835ns"为我们增加的耗时日志:

      //执行java -javaagent:instrumentation.jar=wahaha -jar demo.jar
      PrintAgent.premain开始
         PrintAgent.premain入参:wahaha
      PrintAgent.premain结束
      
      DemoMain.main开始
            HelloService.sayHello开始
               Hello 一拳超人!
            HelloService.sayHello结束
         Method:sayHello Cost:128835ns
      DemoMain.main结束
      
    4. 关键的点解决后,再往深了做,就能慢慢的实现调用链的逻辑了。

    相关文章

      网友评论

          本文标题:1. Java探针技术:Instrumentation

          本文链接:https://www.haomeiwen.com/subject/gjhcrltx.html