12、面向切面的Spring(2)(spring笔记)

3.2 创建环绕通知

环绕通知是最为强大的通知类型。它能够让你编写的逻辑将被通知的目标方法完全包装起来。实际上就像在一个通知方法中同时编写前置通知和后置通知。下面重写Audience切面:

package concert;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;

@Aspect
public class Audience {

    @Pointcut("execution(* concert.Performance.perform(..))")
    public void performance(){}

    @Around("performance()")
    public void watchPerformance(ProceedingJoinPoint jp){
        try {
            System.out.println("Silencing cell phones");
            System.out.println("Taking seats");
            jp.proceed();
            System.out.println("CLAP CLAP CLAP");
        } catch (Throwable e ){
            System.out.println("Demanding a refund");
        }
    }
}

说明:在这里@Around注解标明watchPerformance()方法会作为performance()切面的环绕通知。在这个通知中,观众在演出之前会将手机调至静音并就坐,演出结束后会鼓掌喝彩。这和前面一样。关于这个新的通知方法,首先注意到的可能是它接收ProceedingJoinPoint 作为参数。这个对象是必须要有的,因为要在通知中通过它来调用被通知的方法。通知方法中可以做任何事情,当要将控制权交给被通知的方法时,它需要调用proceed()方法

3.3 处理通知中的参数

以上的例子中都没有任何参数,唯一例外的是我们为环绕通知所编写的watchPerformance()示例方法中使用了ProceedingJoinPoint作为参数。这是因为我们所通知的perform()方法本身没有任何参数,如果有呢?这里通过例子说明,之前有过一个BlankDisc类:

package soundsystem;
import java.util.List;

public class BlankDisc implements CompactDisc {

  private String title;
  private String artist;
  private List<String> tracks;

  public BlankDisc(String title, String artist, List<String> tracks) {
    this.title = title;
    this.artist = artist;
    this.tracks = tracks;
  }

  public void play() {
    System.out.println("Playing " + title + " by " + artist);
    for (String track : tracks) {
      System.out.println("-Track: " + track);
    }
  }
}

说明:play()方法会循环所有的磁道并调用playTrack()方法。但是,我们也可以通过playTrack()方法直接播放某一个磁道中的歌曲。这里如果想记录每个磁道被播放的次数。一种方法就是修改playTrack()方法,直接在每次调用的时候记录这个数量,但是,记录磁道的播放次数与播放本身是不同的关注点,因此不应该属于playTrack()方法。这里为了记录每个磁道所播放的次数,我们创建TrackCounter类,它是通知playTrack()方法的一个切面:

package soundsystem;
import org.aspectj.lang.annotation.*;
import java.util.HashMap;
import java.util.Map;

@Aspect
public class TrackCounter {
    private Map<Integer, Integer> trackCounts = new HashMap<Integer, Integer>();

    @Pointcut("execution(* soundsystem.CompactDisc.playTrack(int)) && args(trackNumber)")
    public void trackPlayed(int trackNumber){}

    @Before("trackPlayed(trackNumber)")
    public void countTrack(int trackNumber){
        int currentCount = getPlayCount(trackNumber);
        trackCounts.put(trackNumber, currentCount + 1);
    }

    public int getPlayCount(int trackNumber){
        return trackCounts.containsKey(trackNumber) ? trackCounts.get(trackNumber) : 0;
    }
}

说明:这里使用args(trackNumber)限定符。表明传递给playTrack()方法的int类型参数也会传递到通知中去。参数的名称trackNumber也与切点方法签名中的参数相匹配(其实是当被通知方法被调用时,会有一个参数向其传递过来,这个参数会被切面接收到)。到目前为止,在使用的切面中,所包装的都是被通知对象的已有方法。但是,方法包装仅仅是切面所能实现的功能之一。下面看一下如何通过切面,为被通知的对象引入全新的功能。

3.4 通过注解引入新功能

Spring中,切面只是实现了它们所包装bean相同接口的代理。如果除了实现这些接口,代理也能暴露新接口的话,会怎样呢?那样的话,切面所通知的bean看起来像是实现了新的接口,即便底层实现类并没有实现这些接口也无所谓。如图所示。

1

为了验证该注意能行得通,我们要为所有的Performance实现引入下面的Encoreable接口:

package concert;

public interface Encoreable {
    void performance();
}

如果想让所有Performance实现都能引入Encoreable接口中的方法,那么所有实现都必须修改,让它们都实现此接口才行。但是这并不是一个好的设计。这里借助AOP的引入功能,首先创建一个新的切面:

package concert;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.DeclareParents;

@Aspect
public class EncoreableIntroducer {
    @DeclareParents(value="concert.Performance+", defaultImpl = DefaultEncoreable.class)
    public static Encoreable encoreable;
}

说明:这和前面的切面有所不同,这里通过@DeclareParents注解将Encoreable接口引入到Performance bean中。@DeclareParents注解由三部分组成:

  • value属性指定了哪种类型的bean要引入该接口。在本例中,也就是所有实现Performance的类型(标记符后买年的加号表示是Performance的所有子类型,而不是Performance本身)。
  • defaultImpl属性指定了为引入功能提供实现的类。在这里是DefaultEncoreable提供具体实现。
  • @DeclareParents注解所标注的静态属性指明了要引入的接口。在这里,我们所引入的是Encoreable接口。

同时,我们也要将EncoreableIntroducer 声明为一个bean。最后,在Spring中,注解和自动代理提供了一种很便利的方式来创建切面。但是,面向注解的切面声明有一个明显的劣势,就是必须能够为通知类添加注解,为了做到这一点,必须要有源码。如果没有的话,Spring提供了另一种方式,即XML配置方式。

四、在XML中声明切面

这里SpringAOP配置元素能够以非侵入的方式声明切面:

AOP配置元素 用途
<aop:advise> 定义AOP通知器
<aop:after> 定义AOP后置通知(不管被通知方法是否执行成功)
<aop:after-returning> 定义AOP返回通知
<aop:after-throwing> 定义AOP异常通知
<aop:around> 定义AOP环绕通知
<aop:aspect> 定义一个切面
<aop:aspectj-autoproxy> 启动@AspectJ注解驱动的切面
<aop:before> 定义一个AOP前置通知
<aop:config> 顶层的AOP配置元素。大多数的<aop:*>元素必须包含在<aop:config>元素内
<aop:declare-parents> 以透明的方式为被通知的对象引入额外的接口
<aop:printcut> 定义一个切点

4.1 声明前置和后置通知

通过XML将无注解的Audience声明为切面:

<aop:config>
    <aop:aspect ref="audience"><!--引用audience bean-->
    
      <aop:before pointcut="execution(* concert.Performance.perform(..))" method="silenceCellPhones" />
      <aop:before pointcut="execution(* concert.Performance.perform(..))" method="takeSeats" />
      <aop:after-returning pointcut="execution(* concert.Performance.perform(..))" method="applause" />
      <aop:after-throwing pointcut="execution(* concert.Performance.perform(..))" method="demandRefund" />
    
    </aop:aspect>
</aop:config>

说明:和之前一样,这里也可以定义一个切点,然后对上述配置进行简化:

<aop:config>
    <aop:aspect ref="audience"><!--引用audience bean-->
    
        <aop:pointcut id="performance" expression="execution(* concert.Performance.perform(..))" />

        <aop:before pointcut="performance" method="silenceCellPhones" />
        <aop:before pointcut="performance" method="takeSeats" />
        <aop:after-returning pointcut="performance" method="applause" />
        <aop:after-throwing pointcut="performance" method="demandRefund" />
    
    </aop:aspect>
</aop:config>

4.2 声明环绕通知

对于前置通知和后置通知,有时候如果想让两共享某些信息是较为困难的,有时候会出现线程安全问题,而如果使用环绕通知则不会出现这类问题了:

<aop:config>
    <aop:aspect ref="audience">
        <aop:pointcut id="performance" expression="execution(* concert.Performance.perform(..))" />
        
        <aop:around pointcut-ref="performance" method="watchPerformance" />
    
    </aop:aspect>
</aop:config>

4.3 为通知传递参数

<aop:config>
    <aop:aspect ref="trackCounter"><!--将TrackCounter声明为切面-->
        <aop:pointcut id="trackPlayed" expression="execution(* soundsystem.CompactDisc.playTrack(int)) and args(trackNumber)" />
        
        <aop:before pointcut-ref="trackPlayed" method="countTrack" />
    
    </aop:aspect>
</aop:config>

4.4 通过切面引入新的功能

<aop:aspect>
    <aop:declare-parents types-matching="concert.Performance+" 
                         implement-interface="concert.Encoreable"
                         default-impl="concert.DefaultEncoreable" />

</aop:aspect>

说明:这里类型匹配Performance接口(由type-matching属性指定)的那些bean在父类结构中会增加Encoreable接口(由implement-interface属性指定)。最后要解决的问题是Encoreable接口中的方法实现要来自何处。

这里有两种方式标识所引入接口的实现。在本例中使用default-impl属性用全限定类名来显示指定Encoreable的实现。还有另一种方式,就是使用delegate-ref属性来标识。

<aop:aspect>
    <aop:declare-parents types-matching="concert.Performance+" 
                         implement-interface="concert.Encoreable"
                         delegate-ref="encoreableDelegate" />

</aop:aspect>

说明:delegate-ref属性引用了一个Spring bean作为引入的委托,这需要再声明一个IDencoreableDelegatebean。两种方式的区别是后者是Spring bean,本身可以被注入、通知或使用其他的Spring配置。

五、注入AspectJ切面

虽然Spring AOP能够满足许多应用的切面需求,但是与AspectJ相比,却是一个功能较弱的AOP解决方案。AspectJ提供了Spring AOP所不能支持的许多类型的切点。如当我们需要在创建对象时应用通知,构造器切点就非常方便。由于Java构造器不同于其他的正常方法,这使得Spring基于代理的AOP无法把通知应用于对象的创建过程。

在应用AspectJ切面时几乎不会涉及到Spring,但是精心设计且有意义的切面很可能依赖其他类来完成它们的工作。如果在执行通知时,切面依赖于一个或多个类,我们可以在切面内部实例化这些协作的对象。但更好的方式是,我们可以借助Spring的依赖注入把bean装配进AspectJ切面中。

下面通过例子说明,这里为之前的演出创建一个新切面,具体来讲,以切面的方式创建一个评论员的角色,它会观看演出并且会在演出之后提供一些批评意见。

package concert;
public aspect CriticAspect {
    public CriticAspect(){}

    private CriticismEngine criticismEngine;

    pointcut performance() : execution(* perform(..));

    after() returning : performance(){
        System.out.println(criticismEngine.getCriticism());
    }

    public void setCriticismEngine(CriticismEngine criticismEngine){
        this.criticismEngine = criticismEngine;
    }
}

说明:

  • 首先IDE必须支持AspectJ,在IDEA中可以直接新建aspect文件。在编译此文件的时候需要使用ajc编译器(即AspectJ编译器,需要配置编译器)。此处书中使用的是afterReturning(),但是从文档中没有找到此种写法,于是进行了修改。

  • 这里,CriticAspect的主要职责是在表演结束后为表演发表评论。CriticAspect与一个CriticismEngine对象相互协作,在表演结束时,调用该对象getCriticism()方法来发表一个苛刻的评论。为了避免CriticAspectCriticismEngine之间产生不必要的耦合,我们通过Setter依赖注入为CriticAspect设置CriticismEngine。如图所示。

    2

  • 下面给出CriticismEngineImpl类的实现:

package concert;
public class CriticismEngineImpl implements CriticismEngine {

    public CriticismEngineImpl(){}
    private String[] criticismPool;

    public String getCriticism(){
        int i = (int)(Math.random() * criticismPool.length);
        return criticismPool[i];
    }

    //injected
    public void setCriticismPool(String[] criticismPool){
        this.criticismPool = criticismPool;
    }
}

说明:CriticismEngineImpl实现类CriticismEngine接口,通过从注入的评论中随机选择一个苛刻的评论。这个类可以使用如下的XML声明为一个Spring bean

<bean id="criticismEngine" class="com.springaction.springidol.CriticismEngineImpl">
    <property name="criticisms">
        <list>
            <value>Worst performance ever!</value>
            <value>I laughed, I cried, then I realized I was at the wrong show.</value>
            <value>A must see show!</value>
        </list>
    </property>
</bean>

以上给出了一个CriticismEngine的实现。剩下的就是为CriticAspect装配CriticismEngineImpl。首先必须清楚,AspectJ切面根本不需要Spring就可以织入到我们的应用中。如果想使用Spring的依赖注入为AspectJ切面注入协作者,那就需要在Spring配置中把切面声明为一个Spring配置中的bean。如下:

<bean class="com.springinaction.springidol.CriticAspect" factory-method="aspectOf">
    <property name="criticismEngine" ref="criticismEngine" />
</bean>

说明:

  • 这里和之前我们配置的bean的最大区别就是使用了factory-method属性。通常情况下,Spring beanSpring容器初始化,但是AspectJ切面是由AspectJ在运行期创建的。等到Spring有机会为CriticAspect注入CriticismEngine时,CriticAspect已经被实例化了。

  • 因为Spring不能负责创建CriticAspect,那就不能在Spring中简单地把CriticAspect声明为一个bean。相反,需要一种方式为Spring获得已经由AspectJ创建的CriticAspect实例句柄,从而可以注入CriticismEngine。幸好,所有的AspectJ切面都提供了一个静态的aspectOf()方法,该方法返回切面的一个实例。所以为了获得切面的实例,必须使用factory-method来调用aspectOf()方法,而不是调用CriticAspect的构造方法。

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

推荐阅读更多精彩内容

  • 本章内容: 面向切面编程的基本原理 通过POJO创建切面 使用@AspectJ注解 为AspectJ切面注入依赖 ...
    谢随安阅读 3,118评论 0 9
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • 在生活中,监控用电量是一个很重要的功能,但并不是大多数家庭重点关注的问题。软件系统的一些功能就像家里的电表一样,这...
    yjaal阅读 560评论 0 3
  • 首先我们来明确一下我们的任务,我们需要用HTML列表的知识做出一个如图1.1的列表。 这个列表我们分三个步骤完成。...
    陈锦楣阅读 276评论 4 3