跟我学Spring3(6.6): 通知参数

前边章节已经介绍了声明通知,但如果想获取被被通知方法参数并传递给通知方法,该如何实现呢?接下来我们将介绍两种获取通知参数的方式。

  • 使用JoinPoint获取:Spring AOP提供使用org.aspectj.lang.JoinPoint类型获取连接点数据,任何通知方法的第一个参数都可以是JoinPoint(环绕通知是ProceedingJoinPoint,JoinPoint子类),当然第一个参数位置也可以是JoinPoint.StaticPart类型,这个只返回连接点的静态部分。

1) JoinPoint:提供访问当前被通知方法的目标对象、代理对象、方法参数等数据:

java代码:

package org.aspectj.lang; 
import org.aspectj.lang.reflect.SourceLocation; 
public interface JoinPoint { 
 String toString(); //连接点所在位置的相关信息 
 String toShortString(); //连接点所在位置的简短相关信息 
 String toLongString(); //连接点所在位置的全部相关信息 
 Object getThis(); //返回AOP代理对象 
 Object getTarget(); //返回目标对象 
 Object[] getArgs(); //返回被通知方法参数列表 
 Signature getSignature(); //返回当前连接点签名 
 SourceLocation getSourceLocation();//返回连接点方法所在类文件中的位置 
 String getKind(); //连接点类型 
 StaticPart getStaticPart(); //返回连接点静态部分 
}

2)ProceedingJoinPoint:用于环绕通知,使用proceed()方法来执行目标方法:
java代码:

public interface ProceedingJoinPoint extends JoinPoint { 
 public Object proceed() throws Throwable; 
 public Object proceed(Object[] args) throws Throwable; 
}

3) JoinPoint.StaticPart:提供访问连接点的静态部分,如被通知方法签名、连接点类型等:

java代码:

public interface StaticPart { 
 Signature getSignature(); //返回当前连接点签名 
 String getKind(); //连接点类型 
 int getId(); //唯一标识 
 String toString(); //连接点所在位置的相关信息 
 String toShortString(); //连接点所在位置的简短相关信息 
 String toLongString(); //连接点所在位置的全部相关信息 
}

使用如下方式在通知方法上声明,必须是在第一个参数,然后使用jp.getArgs()就能获取到被通知方法参数:

java代码:

@Before(value="execution(* sayBefore(*))") 
public void before(JoinPoint jp) {} 

@Before(value="execution(* sayBefore(*))") 
public void before(JoinPoint.StaticPart jp) {}

自动获取:通过切入点表达式可以将相应的参数自动传递给通知方法,例如前边章节讲过的返回值和异常是如何传递给通知方法的。

在Spring AOP中,除了execution和bean指示符不能传递参数给通知方法,其他指示符都可以将匹配的相应参数或对象自动传递给通知方法。

java代码:

@Before(value="execution(* test(*)) && args(param)", argNames="param") 
public void before1(String param) { 
 System.out.println("===param:" + param); 
}

切入点表达式execution(* test(*)) && args(param) :
1)首先execution(* test(*))匹配任何方法名为test,且有一个任何类型的参数;
2)args(param)将首先查找通知方法上同名的参数,并在方法执行时(运行时)匹配传入的参数是使用该同名参数类型,即java.lang.String;如果匹配将把该被通知参数传递给通知方法上同名参数。
其他指示符(除了execution和bean指示符)都可以使用这种方式进行参数绑定。
在此有一个问题,即前边提到的类似于【3.1.2构造器注入】中的参数名注入限制:在class文件中没生成变量调试信息是获取不到方法参数名字的。
所以我们可以使用策略来确定参数名:

1、如果我们通过“argNames”属性指定了参数名,那么就是要我们指定的;
java代码:

@Before(value=" args(param)", argNames="param") //明确指定了 
public void before1(String param) { 
 System.out.println("===param:" + param); 
}

2、如果第一个参数类型是JoinPoint、ProceedingJoinPoint或JoinPoint.StaticPart类型,应该从“argNames”属性省略掉该参数名(可选,写上也对),这些类型对象会自动传入的,但必须作为第一个参数;
java代码:

@Before(value=" args(param)", argNames="param") //明确指定了 
public void before1(JoinPoint jp, String param) { 
 System.out.println("===param:" + param); 
}

3、如果“class文件中含有变量调试信息”将使用这些方法签名中的参数名来确定参数名;

java代码:

@Before(value=" args(param)") //不需要argNames了 
public void before1(JoinPoint jp, String param) { 
 System.out.println("===param:" + param); 
}

4、如果没有“class文件中含有变量调试信息”,将尝试自己的参数匹配算法,如果发现参数绑定有二义性将抛出AmbiguousBindingException异常;对于只有一个绑定变量的切入点表达式,而通知方法只接受一个参数,说明绑定参数是明确的,从而能配对成功。

java代码:

@Before(value=" args(param)") 
public void before1(JoinPoint jp, String param) { 
 System.out.println("===param:" + param); 
}

5、以上策略失败将抛出IllegalArgumentException。

接下来让我们示例一下组合情况吧:

java代码:

@Before(args(param) && target(bean) && @annotation(secure)", 
 argNames="jp,param,bean,secure") 
public void before5(JoinPoint jp, String param, 
 IPointcutService pointcutService, Secure secure) { 
…… 
}

该示例的执行步骤如图6-5所示。

图6-5 参数自动获取流程

除了上边介绍的普通方式,也可以对使用命名切入点自动获取参数:

java代码:

@Pointcut(value="args(param)", argNames="param") 
private void pointcut1(String param){} 
@Pointcut(value="@annotation(secure)", argNames="secure") 
private void pointcut2(Secure secure){} 

@Before(value = "pointcut1(param) && pointcut2(secure)", 
 argNames="param, secure") 
public void before6(JoinPoint jp, String param, Secure secure) { 
…… 
}

自此给通知传递参数已经介绍完了,示例代码在cn.javass.spring.chapter6.ParameterTest文件中。

本系列:



相关文章

发表评论

Comment form

(*) 表示必填项

2 条评论

  1. 小明 说道:

    关于通知参数传递部分讲的不是很透彻,我个人理解是:
    Spring AOP中,定义切入点的指示符除了execution和bean指示符不能传递参数给通知方法外,其他指示符都可以将匹配的相应参数或对象在运行时目标方法被调用的时候动态地进行捕获,自动传递给通知方法,如果有指定argNames, 则会根据指定的名称把捕获到的参数或对象传递给通知方法。

    argNames的名称用逗号分割开,它们的顺序对应于切入点表达式中声明的捕获约束的顺序,名称必须与通知方法的参数名称一样,否则Spring不知如何把已捕获的运行时参数或对象传给通知方法。

    Thumb up 0 Thumb down 0

    • 小明 说道:

      关键点是poincut表达式中的指示符是会动态地捕获符合条件的参数值或对象,然后根据映射规则argNames把它们映射进通知方法的参数列表中

      Thumb up 0 Thumb down 0

跳到底部
返回顶部