# AOP

AOP 为 Aspect Oriented Programming 的缩写,意思为面向切面编程,是通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。

AOP 是 OOP 的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。注意AOP是在程序运行期间,在不修改源码的情况下对方法进行功能增强。

# 底层实现

AOP 的底层是通过 Spring 提供的的动态代理技术实现的。在运行期间,Spring通过动态代理技术动态的生成代理对象,代理对象方法执行时进行增强功能的介入,在去调用目标对象的方法,从而完成功能的增强。

常用的动态代理技术有:

  • JDK代理:基于接口的动态代理技术
  • cglib代理:基于父类的动态代理技术

dynamicAgent

# JDK代理样例

下面是一个JDK代理的样例:

要被增强的目标类Target.java:

package com.muyun.proxy.jdk;

public class Target implements TargetInterface{

    public void save() {
        System.out.println("this is target method need to be enchanced!");
    }
}
1
2
3
4
5
6
7
8

目标接口TargetInterface.java:

package com.muyun.proxy.jdk;

public interface TargetInterface {
    public void save();
}
1
2
3
4
5

增强类EnchanceClass.java:

package com.muyun.proxy.jdk;

public class EnchanceClass {
    public void before(){
        System.out.println("前置增强!");
    }
    public void after(){
        System.out.println("后置增强!");
    }
}
1
2
3
4
5
6
7
8
9
10

测试Main文件ProxyMainTest.java:

package com.muyun.proxy.jdk;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

public class ProxyMainTest {
    public static void main(String[] args){
        //创建目标对象
        final Target target = new Target();
        //创建增强对象
        EnchanceClass enchanceClass = new EnchanceClass();
        //返回值是动态生成的代理对象
        TargetInterface proxy = (TargetInterface) Proxy.newProxyInstance(
                target.getClass().getClassLoader(), //目标对象类加载器
                target.getClass().getInterfaces(),//目标对象相同的接口字节码对象数组
                new InvocationHandler() {
                    //调用代理对象的任何方法,实质执行的都是invoke方法
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        enchanceClass.before();
                        //执行目标方法
                        method.invoke(target,args);
                        enchanceClass.after();
                        return null;
                    }
                }
        );
        //调用代理对象的方法
        proxy.save();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# cglib代理样例

目标类Target.java和增强类EnchanceClass.java同上,下面是测试主类ProxyMainTest.java:

package com.muyun.proxy.cglib;

import org.springframework.cglib.proxy.Enhancer;
import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

public class ProxyMainTest {
    public static void main(final String[] args){
        //创建目标对象
        final Target target = new Target();
        final EnchanceClass enchanceClass = new EnchanceClass();
        //返回值是动态生成的代理对象,基于cglib
        //1.创建增强器
        Enhancer enhancer = new Enhancer();
        //2.设置父类
        enhancer.setSuperclass(Target.class);
        //3.设置回调
        enhancer.setCallback(new MethodInterceptor() {
            public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
                //执行前置
                enchanceClass.before();
                Object invoke = method.invoke(target,args);
                enchanceClass.after();
                //执行后置
                return invoke;
            }
        });
        //4.创建代理类对象
        Target proxyClass = (Target) enhancer.create();
        proxyClass.save();

    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# AOP相关概念

Spring 的 AOP 实现底层就是对上面的动态代理的代码进行了封装,封装后我们只需要对需要关注的部分进行代码编写,并通过配置的方式完成指定目标的方法增强。

在正式讲解 AOP 的操作之前,我们必须理解 AOP 的相关术语,常用的术语如下:

  • Target(目标对象):代理的目标对象
  • Proxy (代理):一个类被 AOP 织入增强后,就产生一个结果代理类
  • Joinpoint(连接点):所谓连接点是指那些被拦截到的点。在spring中,这些点指的是方法,因为spring只支持方法类型的连接点
  • Pointcut(切入点):所谓切入点是指我们要对哪些 Joinpoint 进行拦截的定义
  • Advice(通知/ 增强):所谓通知是指拦截到 Joinpoint 之后所要做的事情就是通知
  • Aspect(切面):是切入点和通知(引介)的结合
  • Weaving(织入):是指把增强应用到目标对象来创建新的代理对象的过程。spring采用动态代理织入,而AspectJ采用编译期织入和类装载期织入

# AOP开发注意事项

# 需要编写的内容

  • 编写核心业务代码(目标类的目标方法)
  • 编写切面类,切面类中有通知(增强功能方法)
  • 在配置文件中,配置织入关系,即将哪些通知与哪些连接点进行结合

# AOP 技术实现的内容

Spring框架监控切入点方法的执行。一旦监控到切入点方法被运行,使用代理机制,动态创建目标对象的代理对象,根据通知类别,在代理对象的对应位置,将通知对应的功能织入,完成完整的代码逻辑运行。

# AOP 底层使用哪种代理方式

在spring中,框架会根据目标类是否实现了接口来决定采用哪种动态代理的方式。

# 总结

  • aop:面向切面编程
  • aop底层实现:基于JDK的动态代理 和 基于Cglib的动态代理
  • aop的重点概念:
    • Pointcut(切入点):被增强的方法
    • Advice(通知/ 增强):封装增强业务逻辑的方法
    • Aspect(切面):切点+通知
    • Weaving(织入):将切点与通知结合的过程
  • 开发明确事项:
    • 谁是切点(切点表达式配置)
    • 谁是通知(切面类中的增强方法)
    • 将切点和通知进行织入配置

# 基于XML的AOP

# 开发步骤

  1. 导入AOP相关坐标

    <dependency>
     <groupId>org.aspectj</groupId>
     <artifactId>aspectjweaver</artifactId>
     <version>1.9.6</version>
    </dependency>
    
    1
    2
    3
    4
    5
  2. 创建目标接口TargetInterface.java和目标类Target.java(内部有切点)

  3. 创建切面类AspectClass.java(内部有增强方法)

  4. 将目标类和切面类的对象创建权交给spring,在applicationContext.xml中配置织入关系:

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns:aop="http://www.springframework.org/schema/aop"
          xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
          http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
    
       <!--目标对象-->
       <bean id="target" class="com.muyun.aop.Target"></bean>
       <!--切面对象-->
       <bean id="AspectClass" class="com.muyun.aop.AspectClass"></bean>
       <!--配置织入,告诉Spring框架,哪些方法需要进行哪些增强-->
       <aop:config>
           <!--声明切面-->
           <aop:aspect ref="AspectClass">
               <!--切面=切点+通知-->
               <aop:before method="before" pointcut="execution(public void com.muyun.aop.Target.save())"></aop:before>
           </aop:aspect>
       </aop:config>
    </beans
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
  5. 测试代码

    package com.muyun;
    
    import com.muyun.aop.TargetInterface;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.test.context.ContextConfiguration;
    import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
    
    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration("classpath:applicationContext.xml")
    public class AopTest {
        @Autowired
        private TargetInterface target;
    
        @Test
        public void test1(){
            target.save();
        }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20

# 切点表达式配置

切点表达式的写法:

execution([修饰符] 返回值类型 包名.类名.方法名(参数))

  • 访问修饰符可以省略
  • 返回值类型、包名、类名、方法名可以使用星号* 代表任意
  • 包名与类名之间一个点 . 代表当前包下的类,两个点 .. 表示当前包及其子包下的类
  • 参数列表可以使用两个点 .. 表示任意个数,任意类型的参数列表

切点表达式的样例如下:

execution(public void com.itheima.aop.Target.method())
execution(void com.itheima.aop.Target.*(..))
execution(* com.itheima.aop.*.*(..))
execution(* com.itheima.aop..*.*(..))
execution(* *..*.*(..))
1
2
3
4
5

# 通知配置

通知的配置语法:

<aop:通知类型 method="切面类中方法名" pointcut="切点表达式"></aop:通知类型>

名称 标签 说明
前置通知 aop:before 用于配置前置通知。指定增强的方法在切入点方法之前执行
后置通知 aop:after-returning 用于配置后置通知。指定增强的方法在切入点方法之后执行
环绕通知 aop:around 用于配置环绕通知。指定增强的方法在切入点方法之前和之后都执行
异常抛出通知 aop:throwing 用于配置异常抛出通知。指定增强的方法在出现异常时执行
最终通知 aop:after 用于配置最终通知。无论增强方式执行是否有异常都会执行

下面是一个样例,增强类AspectClass.java文件:

package com.muyun.aop;

import org.aspectj.lang.ProceedingJoinPoint;

public class AspectClass {
    public void before(){
        System.out.println("前置增强!");
    }
    public void afterReturning(){
        System.out.println("后置增强!");
    }

    //Proceeding JointPoint:正在执行的连接点==切点
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("环绕前增强。。。");
        Object returnObj = pjp.proceed();
        System.out.println("环绕后增强。。。");
        return returnObj;
    }

    public void afterThrowing(){
        System.out.println("异常抛出增强。。。");
    }

    public void after(){
        System.out.println("最终增强。。。");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

配置文件:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--目标对象-->
    <bean id="target" class="com.muyun.aop.Target"></bean>
    <!--切面对象-->
    <bean id="AspectClass" class="com.muyun.aop.AspectClass"></bean>
    <!--配置织入,告诉Spring框架,哪些方法需要进行哪些增强-->
    <aop:config>
        <!--声明切面-->
        <aop:aspect ref="AspectClass">
            <!--切面=切点+通知-->
            <aop:before method="before" pointcut="execution(public void com.muyun.aop.Target.save())"></aop:before>
            <aop:after-returning method="afterReturning" pointcut="execution(* com.muyun.aop.*.*(..))"/>
            <aop:around method="around" pointcut="execution(* com.muyun.aop.*.*(..))"></aop:around>
            <aop:after-throwing method="afterThrowing" pointcut="execution(* com.muyun.aop.*.*(..))"/>
            <aop:after method="after" pointcut="execution(* com.muyun.aop.*.*(..))"/>
        </aop:aspect>
    </aop:config>
</beans>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

上面的配置文件可以抽取切点表达式:

<aop:config>
    <!--声明切面-->
    <aop:aspect ref="AspectClass">
        <!--切面=切点+通知-->
        <aop:before method="before" pointcut="execution(public void com.muyun.aop.Target.save())"></aop:before>
        <aop:pointcut id="myPointcut" expression="execution(* com.muyun.aop.*.*(..))"/>
        <aop:after-returning method="afterReturning" pointcut-ref="myPointcut"/>
        <aop:around method="around" pointcut-ref="myPointcut"></aop:around>
        <aop:after-throwing method="afterThrowing" pointcut-ref="myPointcut"/>
        <aop:after method="after" pointcut-ref="myPointcut"/>
    </aop:aspect>
</aop:config>
1
2
3
4
5
6
7
8
9
10
11
12

# 基于注解的AOP

开发步骤如下:

  1. 创建目标接口和目标类(内部有切点)

  2. 创建切面类(内部有增强方法)

  3. 将目标类和切面类的对象创建权交给 spring

    @Component("myAspect")
    public class AspectClass {
    }
    
    @Component("target")
    public class Target implements TargetInterface {
    }
    
    1
    2
    3
    4
    5
    6
    7
  4. 在切面类AspectClass.java中使用注解配置织入关系

    package com.muyun.annotation;
    
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.springframework.stereotype.Component;
    
    @Component("myAspect")
    @Aspect //标注当前类是一个切面类
    public class AspectClass {
        @Before(value="AspectClass.pointcut()")
        public void before(){
            System.out.println("前置增强!");
        }
        public void afterReturning(){
            System.out.println("后置增强!");
        }
    
        //Proceeding JointPoint:正在执行的连接点==切点
        @Around("pointcut()")
        public Object around(ProceedingJoinPoint pjp) throws Throwable {
            System.out.println("环绕前增强。。。");
            Object returnObj = pjp.proceed();
            System.out.println("环绕后增强。。。");
            return returnObj;
        }
    
        @AfterThrowing("pointcut()")
        public void afterThrowing(){
            System.out.println("注解异常抛出增强。。。");
        }
    
        @After("pointcut()")
        public void after(){
            System.out.println("最终增强。。。");
        }
    
        @Pointcut("execution(* com.muyun.annotation.*.*(..))")
        public void pointcut(){
    
        }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
  5. 在配置文件中开启组件扫描和 AOP 的自动代理,配置文件applicationContext-anno.xml内容:

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
           xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
                                http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd">
    
        <!--开启组件扫描-->
        <context:component-scan base-package="com.muyun.annotation"></context:component-scan>
        <aop:aspectj-autoproxy/>
    </beans>
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
  6. 测试:AnnotationTest.java内容:

    package com.muyun;
    
    import com.muyun.annotation.TargetInterface;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.test.context.ContextConfiguration;
    import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
    
    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration("classpath:applicationContext-anno.xml")
    public class AnnotationTest {
        @Autowired
        private TargetInterface target;
    
        @Test
        public void test1(){
            target.save();
        }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20