Advice代码可以在同一个Java文件中声明OnMethodEnter
和OnMethodExit
。
Advice代码的静态方法也可以有参数。
例如,LogInterceptor.Java
的实现Advice方法中使用了几个参数
public class LogInterceptor{
public static Logger logger = Logger.getLogger(LogInterceptor.class.getName());
@OnMethodEnter
public static void methodStart(int param1,
String param2,
@Advice.Origin String mtd,
@Advice.Origin("#t") String mtdDeclrType,
@Advice.Origin("#m") String mtdName,
@Advice.Origin("#d") String mtdDescr,
@Advice.Origin("#s") String mtdParamType,
@Advice.Origin("#r") String mtdReturn,
@Advice.Argument(0) int id,
@Advice.Argument(1) String data,
@Advice.AllArguments Object[] params,
@Advice.This Object thiz,
@Advice.FieldValue("recordId") int data1,
@Advice.FieldValue("descr") String data2,
@Advice.Unused String unusedParam){
//codeisomitted
}
@OnMethodExit
public static void methodEnd(
@Advice.Return(typing=Assigner.Typing.DYNAMIC) Object returnObject){
//codeisomitted
}
}
观察到各种类型的注释已应用于methodStart
方法的参数。
第一个和第二个参数不使用任何注解。
当不使用注解时,这意味着参数被隐式映射到函数方法的参数。
在本例中,DataProducer.java
是函数代码,create
方法是函数方法。
public class DataProducer{
public int recordId = 1;
private String descr = "privateData";
public void create(int id, String data){
System.out.println("create data");
}
}
因此,methodStart
方法的param1
和param2
被映射到create
方法的所有参数。
开发人员必须确保它们具有相同
的数据类型。
param1
和param2
包含create方法的id
和data
参数的值。
例如,执行此Main1.java之后的检测过程。
Main1.java包含这行代码
public class Main1 {
public static void main(String[] args) {
new DataProducer().create(10000, "privateValue");
}
}
第一个和第二个参数的值分别为10000
和privateValue
。
这些值是LogInterceptor.java
的methodStart
方法的param1
和param2
参数的副本
。
methodStart
方法中从第三个参数开始的其余参数是Advice映射参数。
Advice映射参数必须使用Advice注解。
1、@Advice.Origin
注解提供函数代码的函数方法的方法签名。
参数:
@Advice.Origin String mtd
System.out.println(mtd)
输出:
public void com.wpixel.bytebuddy.chapter1.DataProducer.create(int, java.lang.String)
2、@Advice.Origin("#t")
注解提供了函数代码的类名,它声明了create方法。
参数:
@Advice.Origin("#t") String mtdDeclrType
System.out.println(mtdDeclrType);
输出:
com.wpixel.bytebuddy.chapter1.DataProducer
3、@Advice.Origin("#m")
注解提供函数方法的方法名称。
参数:
@Advice.Origin("#m") String mtdName
System.out.println(mtdName);
输出:
create
4、@Advice.Origin("#d")
注解提供创建方法的方法描述符。
参数:
@Advice.Origin("#d") String mtdDescr
System.out.println(mtdDescr);
输出:
(ILjava/lang/String;)V
5、@Advice.Origin("#s")
注释提供了一个字符串,该字符串列出了create方法的所有参数的数据类型。
参数:
@Advice.Origin("#s") String mtdParamType
System.out.println(mtdParamType);
输出:
(int, java.lang.String)
6、@Advice.Origin("#r")
注释提供函数方法返回的数据类型
参数:
@Advice.Origin("#r")String mtdReturn
System.out.println(mtdReturn);
输出:
void
7、@Advice.Argument
注解提供create方法的参数值。
此注解接收一个表示方法参数索引号的整数参数。
例如,Main1.java调用
new DataProducer().create(10000, "testValue");
参数:
@Advice.Argument(0) int id
@Advice.Argument(1) String value
System.out.println(id+" "+value);
输出:
10000 testValue
索引0表示第一参数,
索引1表示第二个参数,依此类推
8、@Advice.AllArguments
注解以对象数组格式提供create方法的所有参数的值。
例如:Main1.java调用
new DataProducer().create(10000, "testValue");
参数:
@Advice.AllArguments Object[] params
System.out.println(params[0] + " " + params[1]);
输出:
10000 testValue
9、@Advice.This
注释提供函数代码的Java对象
参数:
@Advice.This Object thiz
System.out.println(thiz.getClass().getName());
输出:
com.wpixel.bytebuddy.chapter1.DataProducer
10、@Advice.FieldValue
注释提供函数代码的实例变量的值。此注释接受一个表示实例变量名称的参数。
例如,DataProducer.java
声明了这两个实例变量:
public int recordId = 1;
private String descr = "privateData";
参数:
@Advice.FieldValue("recordId") int data1
@Advice.FieldValue("descr") String data2
System.out.println(data1 + " " + data2);
输出:
1 privateData
11、@Advice.Unused
注解表示该参数仅用于LogInterceptor.java
的methodStart
方法的内部使用。
参数没有映射功能代码,它只是一个标记注解,表示参数未映射到函数方法的任何参数。
参数:
@Advice.Unused String unusedParam
如果methodStart
方法的参数没有任何注释,并且参数索引与函数方法的参数索引不匹配,则在maven
构建过程中,检测过程将失败。
12、@Advice.Return
注解仅适用于用@OnMethodExit
注解的Advice方法。
@Advice.Return
提供create
方法的返回值
参数:
@Advice.Return(typing=Assigner.Typing.DYNAMIC) Object returnObject
System.out.println(returnObject);
输出:
null
观察到返回值为null
,这是因为create
方法返回void
。
当方法返回对象引用时,returnObject
应该具有值。
在后面的章节中,有一个示例代码展示了如何管理返回对象引用的方法。
现在,请注意,当方法返回void
时,returnObject
的参数值始终为空。
结论
本此介绍如何在Advice方法中创建参数。解释了各种类型的注解。
- @Advice.Origin
- @Advice.Origin("#t")
- @Advice.Origin("#m")
- @Advice.Origin("#d")
- @Advice.Origin("#s")
- @Advice.Origin("#r")
- @Advice.Argument
- @Advice.AllArgument
- @Advice.This
- @Advice.FieldValue
- @Advice.Unused
- @Advice.Return
bytebuddy书籍《Java Interceptor Development with ByteBuddy: Fundamental》
喜欢就点个👍吧