ByteBuddy(四)—Advice参数

Advice代码可以在同一个Java文件中声明OnMethodEnterOnMethodExit
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方法的param1param2被映射到create方法的所有参数。
开发人员必须确保它们具有相同的数据类型。
param1param2包含create方法的iddata参数的值。
例如,执行此Main1.java之后的检测过程。
Main1.java包含这行代码

public class Main1 {
    public static void main(String[] args) {
        new DataProducer().create(10000, "privateValue");
    }
}

第一个和第二个参数的值分别为10000privateValue
这些值是LogInterceptor.javamethodStart方法的param1param2参数的副本

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.javamethodStart方法的内部使用。

参数没有映射功能代码,它只是一个标记注解,表示参数未映射到函数方法的任何参数。

参数:
@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》

----END----

喜欢就点个👍吧

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

推荐阅读更多精彩内容

  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong阅读 22,301评论 1 92
  • IoC 容器 Bean 的作用域 自定义作用域实现 org.springframework.beans.facto...
    Hsinwong阅读 2,451评论 0 7
  • 一、重点知识 ioc的实现原理1、创建一个工厂类2、用xml解析得到xml文件中的全路径名3、通过反射的方式创建对...
    一花一世界yu阅读 354评论 0 2
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,590评论 18 139
  • 一、 AOP 简介 1.1 什么是 AOP AOP (Aspect Orient Programming),直译过...
    GaaraZ阅读 246评论 0 0