天天看點

java怎麼加注解_JavaAgent技術之添加注解

什麼是JavaAgent(Java探針)?你可以了解為Java版AOP。隻不過這個AOP項目啟動時運作一次

JavaAgent 隻在項目啟動時運作一次并且是java檔案編譯成class檔案後才運作。是以不會影響到class檔案。

JavaAgent 是寄生項目。即需要依賴一個正常項目才能運作

我這裡示範使用 IDE 為 IDEA ,項目為maven普通項目結構,可以很友善的幫助我們建立一個 JavaAgent 項目。

按住CTRL+SHIFT+ALT+S 鍵,進入Project Structure界面

選擇添加JAR

java怎麼加注解_JavaAgent技術之添加注解

選擇項目,注意下面的連結要在SRC下。

java怎麼加注解_JavaAgent技術之添加注解

建立好的目錄結構,其中Premain-Class 是我後期添加上去的。這裡指定的為後面的 Agent 類中的 premain 方法。同時也是JavaAgent的啟動方法,Class-path中的值也是我們在maven中添加的包。你們應該沒有

java怎麼加注解_JavaAgent技術之添加注解

編寫一個JavaAgent方法

package com.annie;

import java.lang.instrument.Instrumentation;

public class Agent {

// JavaAgent啟動時調用的方法

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

System.out.println("傳入的參數為: " + args);

System.out.println("JavaAgent啟動了...");

}

}

到這裡一個JavaAgent項目就基本啟動完成了。我們在建立一個普通項目(項目類型無所謂)

這裡我建立的是一個SpringBoot的項目,因為比較好示範。

先将将JavaAgent編譯jar包,編譯好的jar包就在項目同級目錄下的out下面。

java怎麼加注解_JavaAgent技術之添加注解
java怎麼加注解_JavaAgent技術之添加注解

設定啟動配置,後面一個Hello是傳入的參數。可有可無。不要時不要忘記連 = 号也去掉。

-javaagent:C:\Users\13100\Documents\IdeaProjects\BaseJava\out\artifacts\JavaAgent_jar\JavaAgent.jar=Hello

儲存運作

java怎麼加注解_JavaAgent技術之添加注解

到這裡一個JavaAgent項目就基本搭建成功了。當然我們不能滿足于此。這裡我自示範基本的動态注解其實以下就沒有和JaveAgent相關内容了。

添加javassist包。

org.javassist

javassist

3.25.0-GA

編寫代碼(寫完不要忘記重新編譯)

package com.annie;

import javassist.ClassPool;

import javassist.CtClass;

import javassist.bytecode.AnnotationsAttribute;

import javassist.bytecode.AttributeInfo;

import javassist.bytecode.ClassFile;

import javassist.bytecode.ConstPool;

import javassist.bytecode.annotation.Annotation;

import java.io.ByteArrayInputStream;

import java.io.IOException;

import java.lang.instrument.ClassFileTransformer;

import java.lang.instrument.IllegalClassFormatException;

import java.lang.instrument.Instrumentation;

import java.security.ProtectionDomain;

import java.util.List;

public class Agent {

// JavaAgent啟動時調用的方法

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

System.out.println("傳入的參數為: " + args);

System.out.println("JavaAgent啟動了...");

// instrumentation 中包含了項目中的全部類。每加載一次.class檔案就運作一次

instrumentation.addTransformer(new ClassFileTransformer() {

@Override

public byte[] transform(ClassLoader loader, String className, Class> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {

// 這裡我隻捕捉自己寫 TestController 類

if(className.equals("com/annie/controller/TestController")){

// 接下來就是javassist的使用我會粗略的寫下備注。不會詳解。

// 擷取一個 class 池。

ClassPool classPool = ClassPool.getDefault();

try {

// 建立一個新的 class 類。classfileBuffer 就是目前class的位元組碼

CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));

ClassFile classFile = ctClass.getClassFile();

ConstPool constPool = classFile.getConstPool();

// 從這裡取出原本類中的注解 建議DEBUG看下attributes中的資料

List attributes = classFile.getAttributes();

AnnotationsAttribute attributeInfo = (AnnotationsAttribute) attributes.get(1);

// 導包是javassist的包

// 添加新的注解

Annotation annotation = new Annotation("org.springframework.web.bind.annotation.RequestMapping", constPool);

attributeInfo.addAnnotation(annotation);

// 傳回新的位元組碼

return ctClass.toBytecode();

} catch (Exception e) {

e.printStackTrace();

}

}

return new byte[0];

}

});

}

}

編寫一個 TestController,這裡我隻給了RestController的注解。并沒有給RequestMapping注解。RequestMapping由JavaAgent為我添加。

package com.annie.controller;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.lang.annotation.Annotation;

@RestController

public class TestController {

@RequestMapping("/test")

public String test() {

// 利用反射檢視Class注解。

Class extends TestController> aClass = this.getClass();

Annotation[] declaredAnnotations = aClass.getDeclaredAnnotations();

StringBuffer sb = new StringBuffer();

// 檢視類上全部注解

for (Annotation annotation : declaredAnnotations) {

sb.append(annotation.toString() + "\n");

}

return sb.toString();

}

}

浏覽器上輸入 127.0.0.1:8080/test 檢視TestController上的注解

java怎麼加注解_JavaAgent技術之添加注解

補充内容 linux 上釋出項目

将javaAgent.jar 和 javaassist.jar 放入到一個檔案夾中。

java怎麼加注解_JavaAgent技術之添加注解

運作指令

java -javaagent:JavaAgent.jar -jar web-test-0.0.1-SNAPSHOT.jar

項目就啟動成功。注意一點這個jar包就是你bulid出來的JAR

标簽:JavaAgent,java,jar,添加,import,注解,annotation,javassist

來源: https://blog.csdn.net/weixin_39933264/article/details/100181397