Spring之AOP

Pioneer..

已于 2022-04-14 11:40:00 修改

阅读量210

点赞数

文章标签： spring

于 2022-03-22 12:26:20 首次发布

本文链接：https://blog.csdn.net/Social_awesome/article/details/123657505

版权

AOP中关键性概念
连接点(Joinpoint)：程序执行过程中明确的点，如方法的调用，或者异常的抛出.

目标(Target)：被通知(被代理)的对象
注1：完成具体的业务逻辑

通知(Advice)：在某个特定的连接点上执行的动作，同时Advice也是程序代码的具体实现，例如一个实现日志记录的代码(通知有些书上也称为处理)
注2：完成切面编程

代理(Proxy)：将通知（公共部分的代码，日志记录）应用到目标（具体的业务逻辑方法）对象后创建的对象(代理=目标+通知),
例子：外科医生+护士
注3：只有代理对象才有AOP功能，而AOP的代码是写在通知的方法里面的

切入点(Pointcut)：多个连接点的集合，定义了通知应该应用到那些连接点。
(也将Pointcut理解成一个条件，此条件决定了容器在什么情况下将通知和目标组合成代理返回给外部程序)

适配器(Advisor)：适配器=通知(Advice)+切入点(Pointcut)

如何实现AOP
目标对象只负责业务逻辑代码
通知对象负责AOP代码，这二个对象都没有AOP的功能，只有代理对象才有

1. AOP
即面向切面编程

2. AOP带来的好处
让我们可以 “专心做事”
案例：

代理：
目标：具体执行的业务方法doSameBusiness

   <!--定义目标-->
    <bean id="bookBizTarget" class="com.zking.spring_02.biz.BookBizImpl"></bean>

通知：公共代码，日志记录

   <!--前置通知-->
    <bean id="beforeAdvice" class="com.zking.spring_02.advice.beforeAdvice"></bean>
    <!--后置通知-->
    <bean id="afterAdvice" class="com.zking.spring_02.advice.afterAdvice"></bean>
    <!--环绕通知-->
    <bean id="aroundAdvice" class="com.zking.spring_02.advice.aroundAdvice"></bean>
    <!--异常通知-->
    <bean id="exceptionAdvice" class="com.zking.spring_02.advice.ExceptionAdvice"></bean>
    <!--适配器-->
    <bean id="RegexpMethod" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">
        <!--通知-->
        <property name="advice">
            <ref bean="afterAdvice"></ref>
        </property>
        <!--切入点-->
        <property name="pattern">
            <value>.*buy</value>
        </property>
    </bean>

封装到AOP的通知中：
// 记录日志
log.info("调用 doSameBusiness方法，参数是："+lParam);

当doSameBusiness被调用时（连接点），将通知（日志记录）应用到doSameBusiness（目标）
通知+目标=代理对象，只有完整的代理对象才具备AOP的特性

如果只有目标，则只会去做核心业务逻辑处理，不会收集日志；
如果只有通知，则只会去做日志记录，不会执行核心业务逻辑；
通知应用到目标上才能得到代理对象（通知+目标=代理）
只有完整的代理对象才具备AOP的特性，而AOP的公共代码（日志收集）是写在通知中的！！

public void doSameBusiness (long lParam,String sParam){

<------------------- AOP 面向切面（通知）

// 输入合法性验证
if (lParam<=0){
throws new IllegalArgumentException("xx应该大于0");
}
if (sParam==null || sParam.trim().equals("")){
throws new IllegalArgumentException("xx不能为空");
}
// 异常处理
try{
... //核心业务逻辑
}catch(...){
}catch(...){
}
// 事务控制
tx.commit();
}

例子：病人做手术

外科医生+护士

主刀医生：理解为AOP中的目标，专注具体的业务逻辑操作
麻醉师和护士：理解为AOP中的通知，在某种特定的连接点上执行的动作
上述结合：AOP 代理对象：将通知应用到具体目标对象后创建对象
代理=目标+通知
只有代理对象才有AOP功能。

3 工具类org.springframework.aop.framework.ProxyFactoryBean用来创建一个代理对象,在一般情况下它需要注入以下三个属性：
proxyInterfaces：代理应该实现的接口列表(List)
interceptorNames：需要应用到目标对象上的通知Bean的名字。(List)
target：目标对象 (Object)

   <bean id="proxy" class="org.springframework.aop.framework.ProxyFactoryBean">
        <!--通知-->
        <property name="interceptorNames">
            <list>
                <!--前置通知-->
                <!--<value>beforeAdvice</value>-->
                <!--后置通知-->
                <!--<value>afterAdvice</value>-->
                <!--环绕通知-->
                <!--<value>aroundAdvice</value>-->
                <!--异常通知-->
               <!-- <value>exceptionAdvice</value>-->
                <!--适配器-->
                <value>RegexpMethod</value>
            </list>
        </property>
        <!--目标-->
        <property name="target">
           <ref bean="bookBizTarget" />
        </property>
        <!--定义代理对象实现接口-->
        <property name="proxyInterfaces">
            <list>
                <value>com.zking.spring_02.biz.IBookBiz</value>
            </list>
        </property>

    </bean>

4. 前置通知(org.springframework.aop.MethodBeforeAdvice)：在连接点之前执行的通知()
案例：在购书系统当中使用AOP方式实现日志系统

package com.zking.spring_02.advice;

import org.springframework.aop.MethodBeforeAdvice;

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

/**
 * 前置通知 用于方法被调用之前进行日志收集
 */
public class beforeAdvice implements MethodBeforeAdvice {
    /**
     *
     * @param method 目标方法
     * @param objects 目标方法所执行的参数
     * @param o 目标对象
     * @throws Throwable
     */
    @Override
    public void before(Method method, Object[] objects, Object o) throws Throwable {
        //获取被调用的方法名
        String methodName=method.getName();

        //获取方法对象的方法的类的全路径名
        String className=o.getClass().getName();

        System.out.println("【前置通知】"+className+"."+methodName+"执行参数"+ Arrays.toString(objects));
    }
}

5. 后置通知(org.springframework.aop.AfterReturningAdvice)：在连接点正常完成后执行的通知
案例：在线购书系统中，要求不修改BookBizImpl代码的情况下增加如下功能：对买书的用户进行返利：每买本书返利3元。(后置通知)
即：每调用一次buy方法打印：“[销售返利][时间]返利3元。”

package com.zking.spring_02.advice;

import org.springframework.aop.AfterReturningAdvice;

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

public class afterAdvice implements AfterReturningAdvice {
    /**
     *
     * @param returnValue 目标方法的返回值
     * @param method 目标方法
     * @param objects 目标方法的执行参数
     * @param target 目标对象
     * @throws Throwable
     */
    @Override
    public void afterReturning(Object returnValue, Method method, Object[] objects, Object target) throws Throwable {
        //获取目标对象的方法名
        String methodName=method.getName();
        //获取目标方法的类的全路劲名
        String className=target.getClass().getName();
        /*System.out.println("【后置通知】"+className+"."+methodName+"执行参数"+ Arrays.toString(objects)+"返回值"+returnValue);*/
        System.out.println("【买书返利2元！");
    }
}

6. 环绕通知(org.aopalliance.intercept.MethodInterceptor)：包围一个连接点的通知，最大特点是可以修改返回值，由于它在方法前后都加入了自己的逻辑代码，因此功能异常强大。
它通过MethodInvocation.proceed()来调用目标方法（甚至可以不调用，这样目标方法就不会执行）
案例：修改日志系统不光要输出参数，还要输出返回值(环绕通知)

package com.zking.spring_02.advice;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;

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

/**
 * 环绕通知
 */
public class aroundAdvice implements MethodInterceptor {
    @Override
    public Object invoke(MethodInvocation methodInvocation) throws Throwable {
        //获取目标对象
        Object target = methodInvocation.getThis();
        //获取目标方法
        Method method = methodInvocation.getMethod();
        //获取目标方法的执行参数

        Object[] arguments = methodInvocation.getArguments();
        System.out.println("【环绕通知】"+target.getClass().getName()+"."+method.getName()+"执行参数"+ Arrays.toString(arguments));
        //执行目标方法
        Object returnValue = methodInvocation.proceed();
        System.out.println("【环绕通知】"+target.getClass().getName()+"."+method.getName()+"执行参数"+ Arrays.toString(arguments)+"返回值"+returnValue);
        return returnValue;
    }
}

7. 异常通知(org.springframework.aop.ThrowsAdvice)：这个通知会在方法抛出异常退出时执行
案例：书本价格为负数时抛出一个异常，通过异常通知取消此订单

# 这个接口里面没有定义方法，我们要求我们的类必须实现afterThrows这个方法
# public void afterThrowing( [Method method,] [Object args,] [Object target,] Throwable throwable );
# 前面三个参数都是可选的，只有第三个参数是必须的,同时我们还可以在同一个类中定义这个方法的多个版本，如：
# public void afterThrowing( MyException1 ex ) {}
# public void afterThrowing( MyException2 ex ) {}
# 具体那个方法被调用则根据具体的Exception来判断，由AOP容器自动识别执行

7.1、定义异常继承RuntimeException

package com.zking.spring_02.advice;

public class priceException extends RuntimeException {
    public priceException() {
    }

    public priceException(String message) {
        super(message);
    }

    public priceException(String message, Throwable cause) {
        super(message, cause);
    }

    public priceException(Throwable cause) {
        super(cause);
    }

    public priceException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }
}

7.2、定义异常通知

package com.zking.spring_02.advice;

import org.springframework.aop.ThrowsAdvice;

/**
 * 异常通知
 */
public class ExceptionAdvice implements ThrowsAdvice {
    public void afterThrowing( priceException ex ) {
        System.out.println("【异常通知】 买书价格异常，购买失败");
    }
}

7.3、在目标方法中抛出异常

	public boolean buy(String userName, String bookName, Double price) {
		// 通过控制台的输出方式模拟购书
		if (null == price || price <= 0) {
			throw new priceException("book price exception");
		}
		System.out.println(userName + " buy " + bookName + ", spend " + price);
		return true;
	}

8. 适配器(org.springframework.aop.support.RegexpMethodPointcutAdvisor) 适配器=通知(Advice)+切入点(Pointcut)
案例：通过适配器解决发书评时也返利的问题
.*buy

   <!--适配器-->
    <bean id="RegexpMethod" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">
        <!--通知-->
        <property name="advice">
            <ref bean="afterAdvice"></ref>
        </property>
        <!--切入点-->
        <property name="pattern">
            <value>.*buy</value>
        </property>
    </bean>

9. 请使用接口接收返回的代理对象（注意！！！！）

   <!--代理=通知+目标，只有代理对象才具备完整的aop特性，而aop代码是写在通知中的-->
    <bean id="proxy" class="org.springframework.aop.framework.ProxyFactoryBean">
        <!--通知-->
        <property name="interceptorNames">
            <list>
                <!--前置通知-->
                <!--<value>beforeAdvice</value>-->
                <!--后置通知-->
                <!--<value>afterAdvice</value>-->
                <!--环绕通知-->
                <!--<value>aroundAdvice</value>-->
                <!--异常通知-->
               <!-- <value>exceptionAdvice</value>-->
                <!--适配器-->
                <value>RegexpMethod</value>
            </list>
        </property>
        <!--目标-->
        <property name="target">
           <ref bean="bookBizTarget" />
        </property>
        <!--定义代理对象实现接口-->
        <property name="proxyInterfaces">
            <list>
                <value>com.zking.spring_02.biz.IBookBiz</value>
            </list>
        </property>

    </bean>

//初始化Spring上下文容器（IOC）
        ApplicationContext ac=new ClassPathXmlApplicationContext("spring.xml");
//获取spring上下文的代理对象
        IBookBiz proxy = ac.getBean("proxy", IBookBiz.class);