Spring实战 | 第一部分 Spring的核心（第四章 面向切面的Spring）

第四章 面向切面编程

面向切面编程的基本原理

通过POJO创建切面

使用@AspectJ注解

为AspectJ切面注入依赖

AspectJ是一个面向切面的框架，它扩展了java语言。AspectJ定义了AOP语法，它有一个专门的编译器用来生成遵循java字节编码规范的Class文件。

在第2章，我们介绍了如何使用依赖注入（DI）管理和配置我们的应用对象。DI有助于应用对象之间的解耦，而AOP可以实现横切关注点与它们所影响的对象之间的解耦。

日志是应用切面的常见范例，但它并不是切面适用的唯一场景。通过本书，我们还会看到切面锁适用的多个场景，包括声明式事务、安全和缓存。

本章展示了Spring对切面的支持，包括如何把普通类声明为一个切面和如何使用注解创建切面。除此之外，我们还会看到AspectJ，另一种流行的AOP实现，如何补充spring AOP框架的功能。但是，我们先不管事务、安全和缓存，先看一下spring是如何实现切面的，就从AOP的基础知识开始说起。

一、什么是面向切面编程

如前所述，切面能帮助我们模块化横切关注点。简而言之，横切关注点可以被，描述为影响应用多处的功能。例如，安全就是一个横切关注点，应用中的许多方法都会涉及到安全规则，如下图直观呈现了横切关注点的概念。

图中展示了一个被划分为模块的典型应用。每个模块的核心功能都是为特定业务领域提供服务，如果在整个应用中都使用相同的基类，继承往往导致一个脆弱的对象提醒；而使用委托可能需要对委托对象进行复杂的调用。

切面提供了取代继承和委托的另一种可选方案，而且在很多场景下更清晰简洁。在使用面向切面编程时，我们仍然在一个地方定义通用功能。横切关注点可以被模块化为特殊的类，这些类被称为切面（aspect）。这样做有两个好处：首先，现在每个关注点都集中在一个地方，而不是分散到多处代码中；其次，服务模块功能简洁，因为它们只包含主要关注点（或核心功能）的代码，而次要关注点的代码被移到切面中。

1、定义AOP术语

AOP已经形成了自己的术语，描述切面的常用术语有通知（advice）、切点（pointcut）和连接点（join point）。下图展示了这些概念是如何关联在一起的。

通知（advice）

在AOP术语中，切面的工作被称为通知，①描述切面要完成工作，②何时执行这个工资。

Spring切面可以应用5种类型的通知：

• 前置通知（Before）：在目标方法被调用之前调用通知功能；
• 后置通知（After）：在目标方法完成之后调用通知，此时不会关心方法的输出是什么；
• 返回通知（After-returning）：在目标方法成功执行之后调用通知；
• 异常通知（After-throwing）：在目标方法抛出异常后调用通知；
• 环绕通知（Around）：通知包裹了被通知的方法，在被通知的方法调用之前和调用之后执行自定义的行为。

连接点（join point）

应用中可能有数以千计的时机应用通知，这些时机被称为连接点。连接点是在应用执行过程中能够插入切面的一个点。这个点可以是在调用方法时、抛出异常时、甚至修改一个字段时。切面代码可以利用这些点插入到应用的正常流程之中，并添加新的行为。

切点（pointcut）

切点有助于缩小切面所通知的连接点的范围。

切点的定义会匹配通知所要织入的一个或多个连接点，我们通常使用明确的类和方法名称，或是利用正则表达式定义所匹配的类和方法名称来指定这些切点。有些AOP框架允许我们创建动态的切点，可以根据运行时的决策来决定是否应用通知。

切面（Aspect）

切面是通知和切点的集合。通知和切点共同定义了切面的全部内容，它是什么，在何时何处完成其功能。

引入（Introduction）

引入允许我们向现有的类添加新方法或属性。

织入（Weaving）

织入是吧切面应用到目标对象并创建新的代理对象的过程。切面在指定的连接点被织入到目标对象中，在目标对象的生命周期里有多个点可以进行织入：

• 编译器：切面在目标类编译时被织入。这种方式需要特殊的编译器，AspectJ的织入编译器就是这种方式织入切面的。
• 类加载期：切面在目标类加载到JVM时被织入。这种方式需要特殊的类加载器（ClassLoader），它可以在目标类被引入应用之前增强该目标类的字节码。AspectJ5的加载时织入（load-time weaving,LTW）就支持以这种方式织入切面。
• 运行期：切面在应用运行的某个时刻被织入。一般情况下，在织入切面时，AOP容器会为目标对象动态的加载创建一个代理对象。spring AOP就是以这种方式织入切面的。

2、spring对AOP的支持

Spring提供了4种类型的AOP支持：

• 基于代理的经典spring AOP；
• 纯POJO切面；
• @AspectJ注解驱动的切面；
• 注入式AspectJ切面（适用于spring各版本）。

spring通知是java写的，定义通知所应用的切点通常会使用注解或在spring配置文件里采用XML来编写。

AspectJ与之相反。虽然AspectJ现在支持基于注解的切面，但AspectJ最初是以JAVA语言扩展的方式实现的。通过特有的AOP语言，我们可以获得更强大的细粒度的控制以及更丰富的AOP工具类，但是我们需要额外学习新的工具和语法。

spring在运行时通知对象

通过在代理类中包裹切面，spring在运行期把切面织入到spring管理的bean中。如下图所示，代理类封装了目标类，并拦截通知方法的调用，再把调用转发给真正的目标bean。当大力拦截到方法调用时，在调用目标bean方法之前，会执行切面逻辑。

直到应用需要被代理的bean时，spring才创建对象。如果使用的是ApplicationContext的话，在ApplicationContext从beanFactory中加载所有bean的时候，spring才会创建被代理的对象。因为spring运行时才创建代理对象，所以我们需要特殊的编译器来织入spring AOP的切面。

spring只支持方法级别的连接点

二、通过切点来选择连接点

在spring AOP中，要使用AspectJ的切点表达式语言来定义切点。如果你已经很熟悉AspectJ，那么在spring中定义切点就感觉非常自然。但是如果你一点都不了解AspectJ的话，本小节我们将快速介绍一下如何编写AspectJ风格的切点。

关于spring AOP的AspectJ切点，最重要的一点就是spring仅支持AspectJ切点指示器（pointcut designator）的一个子集。

下表列出了spring AOP所支持的AspectJ切点指示器。

在spring中尝试使用AspectJ其他指示器时，将会抛出IllegalArgument-Exception异常。

当我们查看如上所展示的这些spring支持的指示器时，注意只有execution指示器时实际执行匹配的，而其它的指示器都是用来限制匹配的。这说明execution指示器时我们在编写切面定义时最主要使用的指示器。在此基础上，我们使用其它指示器来限制所匹配的切点。

1、编写切点

为了阐述spring中的切面，我们需要有个主题来定义切面的切点。为此，我们定义一个Performance接口：

package oschina;
public interface Performance{
    public void perform();
}

Performance可以代表任何类型的现场表演，如舞台剧、电影或音乐会。假设我们想编写Performance的perform()方法触发的通知。如下图展示了一个切点表达式，这个表达式能够设置当perform()方法执行时触发通知的调用。

我们使用execution()指示器选择Performance的perform()方法。方法表达式以“*”号开始，表明了我们不关心方法返回值的类型。然后，我们指定了全限定类名和方法名。对于方法参数列表，我们使用两个点号（..）表明切点要选择任意的perform()方法，无论该方法的入参是什么。

现在假设我们需要配置的切点仅匹配concert包。在此场景下，可以使用within()指示器来限制匹配，如下图所示：

请注意我们使用了“&&”操作符把execution()和within()指示器连接在一起形成与（and）关系（切点必须匹配所有的指示器）。类似地，我们可以使用“||”操作符来标识或（or）关系，而使用“！”操作符来标识非（not）操作。

因为“&”在XML中有特殊含义，所以在Spring的XML配置里面描述切点时，我们使用and来代替“&&”。同样，not和or分别带图“！”和“||”。

2、在切点中选择bean

除了上述介绍的指示器外，spring还引入了一个新的bean()指示器，它允许我们在切点表达式中使用bean的ID来标识bean。bean()使用bean ID或bean名称作为参数来限制切点只匹配特定的bean。

例如，考虑如下的切点：

execution(* concert.Performance.perform()) and bean('woodstock')

在此场景下，切面的通知会被编织到所有ID不为Woodstock的bean中。

三、使用注解创建切面

使用注解来创建切面是AspectJ5引入的关键特性。AspectJ5之前，编写AspectJ切面需要学习一种java语言的扩展，但是AspectJ面向注解的模型可以非常简便的通过少量注解把任意类转变为切面。

我们已经定义了Performance()接口，它是切面中切点的目标对象。现在，让我们使用AspectJ注解来定义切面。

1、定义切面

package oschina;
@Aspect
public class Audience{
    //表演之前
    @Before("execution(** concert.Performance.perform(..))")
    public void silenceCellPhones(){
        System.out.println("silencing cell phones");
    }
    //表演之前
    @Before("execution(** concert.Performance.perform(..))")
    public void takeSeats(){
        System.out.println("taking seats");
    }
    //表演之后
    @AfterReturning("execution(** concert.Performance.perform(..))")
    public void applause(){
        System.out.println("CLAP CLAP CLAP!!!");
    }
    //表演失败之后
    @AfterThrowing("execution(** concert.Performance.perform(..))")
    public void demandRefund(){
        System.out.println("Demanding a refund");
    }
}

Audience类使用@AspectJ注解进行了标注。该注解声明Audience不仅仅是一个POJO，还是一个切面。Audience类中的方法都使用注解来定义切面的具体行为。

Audience有四个方法，定义了一个观众在观看演出时可能会做的事情。在演出之前，观众要就坐（takeSeats()）并将手机调至静音状态silenceCellPhones()。如果演出很精彩的话，观众应该会鼓掌喝彩applause()。不过演出没有达到预期的话，观众会要求退票demandRefund()。

可以看到，这些方法都使用了通知注解来表明他们应该在什么时候调用。AspectJ提供了五个注解来定义通知，如下图所示：

spring使用AspectJ注解来声明通知方法

Audience使用到了前面五个注解中的三个。

相同的切点表达式我们重复写了四遍，这可不是什么光彩的事情。

通过@Pointcut注解声明频繁使用的切点表达式

package oschina;
@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");
    }
}

在Audience中，performance()方法使用了@Pointcut注解。为@Pointcut注解设置的值是一个切点表达式，就像之前在通知注解上所设置的那样。通过在performance()方法上添加@Pointcut注解，我们实际上扩展了切点表达式语言，这样就可以在任何的切点表达式中使用performance()了。

需要注意的是，除了注解和没有实际操作的performance()方法，Audience类依然是一个POJO。我们能够像其他的Java类那样调用它的方法，它的方法能够进行独立的单元测试。

2、创建环绕通知

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

为了阐述环绕通知，我们重写Autience切面。

@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(Exception e){
            System.out.println("Demanding a refund");
        }
    }
}

在这里，@Around注解声明watchPerformance()方法会作为Performance()切点的环绕通知。这个通知所达到的效果和前置通知和后置通知是一样的。

3、处理通知中的参数

4、通过注解引入新功能

当引入接口的方法被调用时，代理会把此调用委托给实现了新接口的某个其它对象，实际上，一个bean的实现被拆分到多个类中。

借助于AOP的引入功能，为了实现该功能，我们要创建一个新的切面：

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

可以看到EncoreableIntroducer是一个切面，通过@DeclareParents注解，将Encoreable接口引入到Performance bean中。

@DeclareParents注解由三部分组成：

• value属性指定了哪种类型的bean要引入该接口。在本例中，就是所有Performance类型。（标记符后面的+表示Performance的所有子类型，而不是Performance本身）
• defaultImpl属性指定了为引入功能提供实现的类。
• @DeclareParents注解所标注的静态属性指明了要引入的接口。

和其它切面一样，我们需要在spring应用中将EncoreableIntroducer声明为一个bean：

<bean class="concert.EncoreableIntroducer" />

spring的自动代理机制将会获得它的声明，当spring发现一个bean使用了@Aspect注解时，spring就会创建一个代理，然后将调用委托给被代理的bean或被引入的实现，这取决于调用的方法属于被代理的bean还是属于被引入的接口。

四、在XML中声明切面

基于注解的配置优于基于java的配置，基于java的配置优于基于XML的配置。

在spring的AOP命名空间中，提供了多个元素用来在XML中声明切面，如图所示：

spring的AOP配置元素能够以非侵入性的方式声明切面

我们已经看到了<aop:aspectj-autoproxy>元素，它能够自动代理AspectJ注解的通知类。aop命名空间的其它元素能够让我们直接在spring配置中声明切面，而不需要使用注解。

1、声明前置和后置通知

<aop:config>
    <aop:aspect ref="audience"> --引用audience bean
        <aop:before pointcut="execution(** concert.Performance.perform(..))" method="silencePhones" />
        <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>

关于Spring AOP配置元素，第一个需要注意的事项是大多数的AOP配置元素必须在<aop:config>元素的上下文内使用。

在所有的通知元素中，pointcut属性定义了通知所应用的切点，它的值是使用AspectJ切点表达式语法锁定义的切点。

2、声明环绕通知

使用环绕通知可以完成前置通知和后置通知所实现的相同功能，而且只需要在一个方法中。

watchPerformance()方法提供了AOP环绕通知：

package oschina;
public class Audience{
    public void watchPerformance(ProceedingJoinPoint jp){
        try{
            System.out.println("Silencing cell phone");
            System.out.println("Taking seats");
            jp.proceed();
        }catch(Exception e){
            System.out.println("Demanding a refund");
        }
    }
}

watchPerformance()方法中包含了四个通知方法的所有功能。

在XML中使用<aop:around>元素声明环绕通知：

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

像其他通知的XML元素一样，<aop:around>指定了一个切点和一个通知方法的名字。在这里，我们使用跟之前一样的切点，但是为该切点所设置的method属性值为watchPerformance()。

3、为通知传递参数

4、通过切面引入新的功能

5、注入AspectJ切面

public aspect CriticAspect{
    public CriticAspect(){}
    pointcut perfoemance():execution(* perfoem(...));
    afterReturning():performance(){
        System.out.println(criticismEngine.getCriticism);
    }
    private CriticismEngine(CriticismEngine criticismEngine){
         this.criticismEngine = criticismEngine;
    }
}

CriticAspect的主要职责是在表演结束后为表演发表评论。performance()切点匹配perform()方法。当它与afterReturning()通知一起配合使用时，我们可以让该切面在表演结束时起作用。

6、小结

AOP是面向对象编程的一个强大扩充，通过AspectJ，我们现在可以把之前分散在应用各处的行为放入可重用的模板中，我们显示的声明在何处如何应用该行为，这有效的减少了代码冗余，并让我们额类关注自身的主要功能。

spring提供了一个AOP框架，让我们把切面插入到方法执行的周围，我们现在已经学会如何把通知织入前置、后置和环绕方法的调用中，以及处理异常增加自定义的行为。

关于spring应用中如何使用切面，我们可以有多种选择。通过使用@AspectJ注解和简化的配置命名空间，在spring中装配通知和切点变得非常简单。

我们了解了如何使用spring为AspectJ切面注入依赖。

Spring实战@目录