zengdongwen

Spring4（二）AOP

需求：假如，一个业务类有四个方法（加减），我们要在每个方法都加上日志操作。

1、没有AOP，实现日志

1.1 定义接口

定义一个数字运算的接口，其中有两个方法：加法运算和减法运算：

package com.spring.aop;

public interface MathCalculator {
    public int add(int a,int b);
    public int sub(int a,int b);
}

1.2 定义实现类

定义实现类，除了进行运算，还要打印简单的日志功能：

package com.spring.aop;

public class NonAopMathCalculator implements MathCalculator {
    @Override
    public int add(int a, int b) {
        System.out.println("方法执行前参数是："+a+"，"+b);
        int result = a+b;
        System.out.println("方法执行后结果是："+result);
        return result;
    }

    @Override
    public int sub(int a, int b) {
        System.out.println("方法执行前参数是："+a+"，"+b);
        int result = a-b;
        System.out.println("方法执行后结果是："+result);
        return result;
    }
}

1.3 测试

package com.spring.aop;

public class MathCalculatorTest {
    public static void main(String[] args) {
        MathCalculator mathCalculator = new NonAopMathCalculator();
        int add = mathCalculator.add(9, 6);
        System.out.println("加法计算结果："+add);
        int sub = mathCalculator.sub(9, 6);
        System.out.println("减法计算结果："+sub);
    }
}

打印结果：

方法执行前参数是：9，6
方法执行后结果是：15
加法计算结果：15
方法执行前参数是：9，6
方法执行后结果是：3
减法计算结果：3

1.4 存在的问题

代码混乱：越来越多的非业务需求(日志和验证等)加入后，原有的业务方法急剧膨胀。每个方法在处理核心逻辑的同时还必须兼顾其他多个关注点。

代码分散：以日志需求为例，只是为了满足这个单一需求，就不得不在多个模块（方法）里多次重复相同的日志代码， 如果日志需求发生变化， 必须修改所有模块。

2、通过动态代理实现日志

代理设计模式的原理： 使用一个代理将对象包装起来，然后用该代理对象取代原始对象。任何对原始对象的调用都要通过代理，代理对象决定是否以及何时将方法调用转到原始对象上。这种方式可以解决上述存在的问题：

接口还是上面的，不用改变，现在我们使用动态代理的方式来实现，代码如下：

2.1 创建接口实现

创建接口的实现类，实现类中只做业务相关的事情，日志的事情不需要管：

package com.spring.aop;

public class MathCalculatorImpl implements MathCalculator {
    @Override
    public int add(int a, int b) {
        return a+b;
    }

    @Override
    public int sub(int a, int b) {
        return a-b;
    }
}

2.2 创建代理类

创代理类，代理类持有被代理对象的引用：

package com.spring.aop;

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

public class MathCalculatorProxyImpl {
    //持有被代理对象的引用
    private MathCalculatorImpl target;

    //通过构造方法传入被代理对象
    public MathCalculatorProxyImpl(MathCalculatorImpl target) {
        this.target = target;
    }

    //返回代理对象
    public MathCalculator getLoggingProxy(){
        MathCalculator proxy = null;
        ClassLoader classLoader = target.getClass().getClassLoader();//类加载器
        Class[] interfaces = new Class[]{MathCalculator.class};//被代理对象实现的接口的数组
        //处理器对象，进行日志操作，被代理对象的所有方法执行都要先经过该类的invoke方法
        InvocationHandler handler = new InvocationHandler() {
            /**
             * proxy: 代理对象。 一般不使用该对象
             * method: 正在被调用的方法
             * args: 调用方法传入的参数
             */
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                String methodName = method.getName();
                //打印日志
                System.out.println("[before] The method " + methodName + " begins with " + Arrays.asList(args));

                //调用目标方法
                Object result = null;//目录方法返回值
                try {
                    //前置通知
                    result = method.invoke(target, args);
                    //返回通知, 可以访问到方法的返回值
                } catch (NullPointerException e) {
                    e.printStackTrace();
                    //异常通知, 可以访问到方法出现的异常
                }
                //后置通知. 因为方法可以能会出异常, 所以访问不到方法的返回值
                //打印日志
                System.out.println("[after] The method ends with " + result);
                return result;
            }
        };
        /**
         * classLoader: 代理对象使用的类加载器。
         * interfaces: 指定代理对象的类型. 即代理代理对象中可以有哪些方法.
         * handler: 当具体调用代理对象的方法时, 应该如何进行响应, 实际上就是调用 InvocationHandler 的 invoke 方法
         */
        proxy = (MathCalculator) Proxy.newProxyInstance(classLoader,interfaces,handler);
        return proxy;
    }
}

2.3 测试

package com.spring.aop;

public class MathCalculatorProxyTest {
    public static void main(String[] args) {
        //创建被代理对象
        MathCalculatorImpl mathCalculatorImpl = new MathCalculatorImpl();
        //创建代理对象
        MathCalculatorProxyImpl mathCalculatorProxy = new MathCalculatorProxyImpl(mathCalculatorImpl);
        MathCalculator proxy = mathCalculatorProxy.getLoggingProxy();
        int add = proxy.add(9, 6);
        System.out.println("加法计算结果："+add);
        int sub = proxy.sub(9, 6);
        System.out.println("减法计算结果："+sub);
    }
}

打印结果：

[before] The method add begins with [9, 6]
[after] The method ends with 15
加法计算结果：15
[before] The method sub begins with [9, 6]
[after] The method ends with 3
减法计算结果：3

2.4 总结

动态代理的方式可以实现日志操作，这样实现起来很统一，就算目标类中加了其他方法，不需要任何操作，就能实现日志功能。但是如果每次这样手动实现，也会比较麻烦，所以Spring给我们提供了AOP模块。

3、AOP

3.1 AOP简介

• AOP(Aspect-Oriented Programming， 面向切面编程 ): 是一种新的方法论，是对传统 OOP(Object-Oriented Programming, 面向对象编程 ) 的补充。

• AOP 的主要编程对象是切面 (aspect)，而 切面模块化横切关注点 。

• 在应用 AOP 编程时，仍然需要定义 公共功能 ，但可以明确的定义这个功能在哪里，以什么方式应用， 并且不必修改受影响的类 。这样一来 横切关注点就被模块化到特殊的对象 ( 切面 ) 里。

• AOP 的好处：

– 每个事物逻辑位于一个位置，代码不分散，便于维护和升级。

–业务模块更简洁，只包含核心业务代码。

3.2 AOP术语

• 切面 (Aspect)： 横切关注点 ( 跨越应用程序多个模块的功能 ) 被模块化的特殊对象

• 通知(Advice)： 切面必须要完成的工作

• 目标(Target)： 被通知的对象

• 代理(Proxy)： 向目标对象应用通知之后创建的对象

• 连接点（ J oinpoint）：程序 执行的某个特定位置 ：如类某个方法调用前、调用后、方法抛出异常后等。 连接点 由两个信息确定：方法表示的程序执行点；相对点表示的方位 。例如 ArithmethicCalculator#add () 方法执行前的连接点，执行点为 ArithmethicCalculator#add () ；方位为该方法执行前的位置

• 切点（ pointcut ）：每个 类都拥有多个连接点 ：例如 ArithmethicCalculator 的所有方法实际上都是连接点，即 连接点是程序类中 客观存在 的事务 。 AOP 通过切点定位到特定的连接点 。类比 ：连接点相当于数据库中的记录，切点相当于查询条件 。切点和连接点不是一对一的关系，一个切点匹配多个连接点，切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。

3.3 AOP的实现AspectJ使用

• AspectJ ： Java 社区里最完整最流行的 AOP 框架 .

• 在 Spring2.0 以上版本中，可以使用基于 AspectJ 注解或基于 XML 配置的 AOP。

AspectJ需要的jar包： com.springsource.org.aopalliance-1.0.0.jar com.springsource.org.aspectj.weaver-1.6.8.RELEASE.jar spring-aop-4.0.0.RELEASE.jar spring-aspects-4.0.0.RELEASE.jar

3.3.1 注解配置使用AspectJ实现AOP

首先要把jar包导入到工程中

1、创建接口和实现类，并在实现类加上Spring注解

package com.spring.aspectjAop.annotation;

public interface MathCalculator {
    public int add(int a, int b);
    public int sub(int a, int b);
}

package com.spring.aspectjAop.annotation;

import org.springframework.stereotype.Component;

@Component("mathCalculator")
public class MathCalculatorImpl implements MathCalculator {
    @Override
    public int add(int a, int b) {
        return a+b;
    }

    @Override
    public int sub(int a, int b) {
        return a-b;
    }
}

2、创建AspectJ代理类

package com.spring.aspectjAop.annotation;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.List;

@Component//首先切面也是spring的一个Bean
@Aspect//表明这是一个AspectJ切面
public class LoggingAspectJAop {

    /**
     *     标识这个方法是个前置通知,  切点表达式表示执行任意类的任意方法. 第
     *     一个 * 代表匹配任意修饰符及任意返回值,  第二个 * 代表任意类的对象,
     *     第三个 * 代表任意方法, 参数列表中的 ..  匹配任意数量的参数
     */
    @Before("execution(* com.spring.aspectjAop.annotation.*.*(..))")
    public void beforeMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        List