@OnMethod注解用来匹配拦截的方法,Location用来指定在方法的某个位置或者某个动作时触发拦截代码。
常用的Location:
Kind.ENTRY(缺省的Location,当进入方法时,代码添加在方法第一行)
Kind.RETURN(当从方法返回时,如果方法有多个返回点,则每一个返回点前都会执行)
Kind.ERROR(当方法执行异常时,当方法执行过程中抛出异常,会触发)
实际生成的代码形如:try{...}catch(Throwable e){...}
方法匹配的原则:(方法名和type与被拦截方法的方法签名一致,如果type缺省,则匹配全部同名方法;当然,还必须符合方法参数的要求)
@OnMethod(clazz = "/my\\..*?Command/", method = "execute", type = "void(my.FooParam)")
方法参数要求:
除了注解参数以外,普通方法参数可以为空;但如果提供参数,就必须符合下面的要求:
Kind.ENTRY 方法参数必须和被拦截方法签名参数一致(参数个数和类型都一致)
Kind.RETURN方法参数必须和被拦截方法签名参数一致(参数个数和类型都一致)
Kind.ERROR 参数类型必须是Throwable(和被拦截方法签名无关)
其中,可以使用AnyType来匹配任何对象、或者数组参数
常用的Location:
Kind.ENTRY(缺省的Location,当进入方法时,代码添加在方法第一行)
Kind.RETURN(当从方法返回时,如果方法有多个返回点,则每一个返回点前都会执行)
Kind.ERROR(当方法执行异常时,当方法执行过程中抛出异常,会触发)
实际生成的代码形如:try{...}catch(Throwable e){...}
方法匹配的原则:(方法名和type与被拦截方法的方法签名一致,如果type缺省,则匹配全部同名方法;当然,还必须符合方法参数的要求)
@OnMethod(clazz = "/my\\..*?Command/", method = "execute", type = "void(my.FooParam)")
方法参数要求:
除了注解参数以外,普通方法参数可以为空;但如果提供参数,就必须符合下面的要求:
Kind.ENTRY 方法参数必须和被拦截方法签名参数一致(参数个数和类型都一致)
Kind.RETURN方法参数必须和被拦截方法签名参数一致(参数个数和类型都一致)
Kind.ERROR 参数类型必须是Throwable(和被拦截方法签名无关)
其中,可以使用AnyType来匹配任何对象、或者数组参数
@BTrace(unsafe = true)
public class SampleScript {
@TLS // 在转换后的Script脚本类中,@TLS变量会自动声明为ThreadLocal变量
static Object fooParam;
@OnMethod(clazz = "/my\\..*?Command/", method = "execute", type = "void(my.FooParam)")
public static void onExecute(@ProbeClassName String className, AnyType fooParam) {
SampleScript.fooParam = fooParam;
}
@OnMethod(clazz = "/my\\..*?Command/", method = "execute", location = @Location(Kind.RETURN), type = "void(my.FooParam)")
public static void onExecuteReturn(@ProbeClassName String className) {
BTraceUtils.println(Strings.concat("execute return : className = ", className));
BTraceUtils.println(Strings.concat("param : fooParam = ", Strings.str(fooParam)));
}
@OnMethod(clazz = "/my\\..*?Command/", method = "execute", location = @Location(Kind.ERROR), type = "void(my.FooParam)")
public static void onExecuteError(@ProbeClassName String className, Throwable e) {
BTraceUtils.println(Strings.concat("execute error : className = ", className));
BTraceUtils.println(Strings.concat("param : fooParam = ", Strings.str(fooParam)));
BTraceUtils.println(Strings.concat("throw : message = ", e.getMessage()));
}
}