Spring AOP 笔记二(环绕通知,切面中获取参数)

此文是Sping in Action 第4版 英文原版切面部分的读书笔记,仅限交流使用,有不足之处,一定听取修改。

系列目录:
Spring AOP 笔记一(基础概念,一个简单切面)
Spring AOP 笔记二(环绕通知,切面中获取参数)
Spring AOP 笔记三(切面注解引入新的方法)

接上,上一篇的示例切面中我们重复写了三次代码。维护起来比较困难,可以在切面配置类中声明一个切点方法,相当于声明一个切面中的全局切点。

1. 切点方法 代码如下:

package concert;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
@Aspect
public class Audience {

    @Pointcut("execution(** concert.Performance.perform(..))")
    public void performance() {}
    
    @Before("performance()")
        public void silenceCellPhones() {
        System.out.println("Silencing cell phones");
    }
    @Before("performance()")
    public void takeSeats() {
        System.out.println("Taking seats");
    }
    @AfterReturning("performance()")
    public void applause() {
        System.out.println("CLAP CLAP CLAP!!!");
    }
    @AfterThrowing("performance()")
        public void demandRefund() {
        System.out.println("Demanding a refund");
    }
}
  • 切面方法即是使用 @Pointcut 注解的performance()方法。如何调用就在代码中。

1.1 使用java方式进行切面配置

上一篇文章已经代码贴出,这里就回忆一下注解的意思:

  • @Configration:声明当前类是一个配置类。
  • @EnableAspectJAutoProxy 激活Spring对AspectJ的自动代理功能的支持。
  • @ComponentScan() 自动扫描指定包名下所有使用@Service,@Component,@Repository,@Controller的类,如果没有指定包名,会默认扫描类所在的包。

2 创建环绕通知(around advice)

环绕通知相当于after和before的合体。

下面重写Audience切面:

package concert;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
@Aspect
public class Audience {

    @Pointcut("execution(* com.memgxiang.concert.Performance.perform(..))")
    public void performance() {}
    
    @Around("performance()")
    public void watchPerformance(ProceedingJoinPoint jp) {
        try {
            System.out.println("手机静音");
            System.out.println("得到座位");
            jp.proceed();
            System.out.println("鼓掌!!!");
        } catch (Throwable e) {
            System.out.println("这演的啥啊!退票");
        }
    }
}

这里的 @Around注解就声明了watchPerformance()方法成为了一个环绕通知切点。他的运行结果与上例使用@Before,@After等等的效果相同。可以发现watchPerformance()方法中给出了一个PreceedingJoinPoint类型的参数,这个是必须的,因为你需要告诉该切点中的任务相对与你的工作所处的位置。使用ProceedingJoinPoint’s proceed()方法将你的任务放在你想要的位置。

3. 在通知中获取参数。

在上面的@Around例子中,watchPerformance()只有一个用于说明被切面的方法如何切入的参数,而且这里的performance()方法中也没有任何参数,当被切入的方法没有参数的时候,可以使用上例中的那些简单方式。
不过当被切入(或者说被通知)的方法存在参数时,我们想要在通知中获取到该参数,就使用下面的方式。
我对原书中的示例做了简化。

首先定义一个类,有一个带int类型参数的方法 playTrack() ,该方法就是将要被切入的方法。


/**
 * 紧凑圆盘。
 * Created by Henvealf on 2016/8/28.
 */
public class CompactDisc {
    public void playTrack(int trackNumber){
        System.out.println("trackNumber =" + trackNumber);
    }
}

随后就是定义一个切面:

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;

/**
 *
 * Created by Henvealf on 2016/8/28.
 */
@Aspect
public class TrackCounter {

    @Pointcut("execution(* com.mengxiang.concert.CompactDisc.playTrack(int)) && args(trackNum)")
    public void trackPlayed(int trackNum) {}

    @Before("trackPlayed(trac)")
    public void countTrack(int trac) {
        System.out.println("我在切面中,我会在playTrack()运行前被调用" + trac);
    }

}
  • 测试类在这里就不列出了。

这里我们用 @PointCut 注解了一个带有int参数的方法 trackPlayed() ,将其定义为一个切点。在 @PointCut 中我们去匹配 CompactDisc 类中的 playTrack() 方法,并且定制了其参数类型为int,这里当这样限制了被切入方法的类型,就必须同时使用 args() 标识符来指明变量的名字,且名字要与定义切点的方法(trackPlayed)中的参数名字相比配。

之后在 countTrack()上使用@Before()来定义一个通知。里面直接使用了上面定义的切点方法,并且切点方法中加入了一个代表参数名的标识trackNumber,此标识与countTrack中的参数名必须相匹配。

从上面的例子可以发现,args()中的参数名标识不需要与被通知的方法的参数名一致,它只是为了在切点内部,互相区分参数列表中的各个参数。

为了说明我们将被切入的类CompactDisc中的 playTrack 方法修改成具有两个参数:

    public void playTrack(int trackNumber,int number){
        System.out.println("trackNumber =" + trackNumber);
        System.out.println("number =" + number);
    }

随之我们修改切点为:

@Pointcut("execution(* com.mengxiang.concert.CompactDisc.playTrack(int,int)) && args(trackNumb,numb))")
    public void trackPlayed(int trackNumb,int numb) {}
    
    
@Before("trackPlayed(trackNumber,number)")
public void countTrack(int trackNumber, int number) {
    System.out.println("我在切面中,我会在playTrack()运行前被调用" + trackNumber);
    System.out.println("我在切面中,我会在playTrack()运行前被调用" + number);
}

注意@Pointcut中的 playTrack(int,int)args(trackNumb,numb)

当我们调用playTrack(20,40)后,发现输出为:

我在切面中,我会在playTrack()运行前被调用20
我在切面中,我会在playTrack()运行前被调用40
trackNumber =22

现在我们将@Pointcut注解的trackPlayed()中的两个参数调换。即:

  • trackPlayed(int numb,int trackNumb){..}

会发现输出结果出现了变化:

我在切面中,我会在playTrack()运行前被调用40
我在切面中,我会在playTrack()运行前被调用20
trackNumber =22
number =40
  • 这样大概就明白了。

本篇就结束了,有问题的同学评论告诉我,这个结束好生硬。

你可能感兴趣的:(Spring AOP 笔记二(环绕通知,切面中获取参数))