Spring框架之AOP详解（带实战详细步骤）

Spring之AOP

AOP简介：

• 解决的问题：解决了需求的改变，造成了原有没必要改变的代码，需要去改变它；
  比如：书籍的增删改，本身只需要完成增删改的功能即可，这是如果需要添加日志功能，那么需要在原有的代码基础上，去修改添加日志功能，受牵连的方法就三个（add/edit/del）了;

AOP中关键性概念

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

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

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

• 代理(Proxy)：将通知应用到目标对象后创建的对象(代理=目标+通知),
  例子：外科医生+护士

• 注3：只有代理对象才有AOP功能，而AOP的代码是写在通知的方法里面的

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

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

实现功能代码步骤

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

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


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



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

#  这个接口里面没有定义方法，我们要求我们的类必须实现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. 异常通知(org.springframework.aop.ThrowsAdvice)：这个通知会在方法抛出异常退出时执行
   案例： 书本价格为负数时抛出一个异常，通过异常通知取消此订单


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



6. 请使用接口接收返回的代理对象
    A

  B   C

  A a1 = new B();
  A a2 = new C();
  B b = (B) a2;

核心点

通知
前置通知
实现org.springframework.aop.MethodBeforeAdvice接口
买书、评论前加系统日志

我的项目导包命名命名

导入IBookbiz

package lix.aop.biz;

public interface IBookBiz {
	// 购书
	public boolean buy(String userName, String bookName, Double price);

	// 发表书评
	public void comment(String userName, String comments);
}

导入实现类

package lix.aop.biz.imp;

import lix.aop.biz.IBookBiz;
import lix.aop.exception.PriceException;

public class BookBizImpl implements IBookBiz {

	public BookBizImpl() {
		super();
	}

	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;
	}

	public void comment(String userName, String comments) {
		// 通过控制台的输出方式模拟发表书评
		System.out.println(userName + " say:" + comments);
	}

}

导入RuntimeException

package lix.aop.exception;

public class PriceException extends RuntimeException {

	public PriceException() {
		super();
	}

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

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

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

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

package lix.aop.advice;

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

import org.springframework.aop.MethodBeforeAdvice;

/**
 * 买书，评论前添加系统日志
 * @author 20190816
 *
 */
public class MyMethodBeforeAdvice implements MethodBeforeAdvice {

	@Override
	public void before(Method arg0, Object[] arg1, Object arg2) throws Throwable {
		// 在这里  我可以获取导目标类的全路径及方法参数，然后就可以将他们写道日志表里面去
		String target=arg2.getClass().getName();
		String methodName=arg0.getName();
		String args=Arrays.toString(arg1);
		System.out.println("【前置通知：系统日志】"+target+"."+methodName+"("+args+")被调用了");
	}

}

去spring-context.xml配置

<!-- aop的讲解 -->
	<!-- 目标 -->
	<bean class="lix.aop.biz.imp.BookBizImpl" id="bookBiz"></bean>
	<!-- 前置通知 -->
	<bean class="lix.aop.advice.MyMethodBeforeAdvice" id="myMethodBeforeAdvice"></bean>

	<!-- 利用目标 +通知生成代理对象 -->
	<bean class="org.springframework.aop.framework.ProxyFactoryBean"
		id="pfb">
		<property name="target" ref="bookBiz"></property>
		<property name="proxyInterfaces">
			<list>
				<value>lix.aop.biz.IBookBiz</value>
			</list>
		</property>
		<property name="interceptorNames">
			<list>
				<value>myMethodBeforeAdvice</value>
			</list>
		</property>

	</bean>

测试方法

package lix.aop.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import lix.aop.biz.IBookBiz;

public class AopTest {
	public static void main(String[] args) {
		ApplicationContext applicationContext = new ClassPathXmlApplicationContext("/spring-context.xml");
//		IBookBiz bean=(IBookBiz) applicationContext.getBean("bookBiz");
		IBookBiz bean=(IBookBiz) applicationContext.getBean("pfb");
		bean.buy("小王爷", "羊皮卷", 99.9);
		bean.comment("小王爷", "太深奥了");
	}
}

测试结果

后置通知

package lix.aop.advice;

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

import org.springframework.aop.AfterReturningAdvice;
/**
 * 注意：后置比前置通知多一个参数
 * @author 20190816
 *
 */
public class MyAfterReturningAdvice implements AfterReturningAdvice {

	@Override
	public void afterReturning(Object arg0, Method arg1, Object[] arg2, Object arg3) throws Throwable {
		String target=arg3.getClass().getName();
		String methodName=arg1.getName();
		String args=Arrays.toString(arg2);
		System.out.println("【前置通知：系统日志】"+target+"."+methodName+"("+args+")被调用了"+"该方法被调用后的返回值为"+arg0);
	}
	}

spring-context.xml 配置后置通知

<!-- 后置通知 -->
	<bean class="lix.aop.advice.MyAfterReturningAdvice" id="myAfterReturningAdvice"></bean>
	<!-- 利用目标 +通知生成代理对象 -->
	<bean class="org.springframework.aop.framework.ProxyFactoryBean"
		id="pfb">
		<property name="target" ref="bookBiz"></property>
		<property name="proxyInterfaces">
			<list>
				<value>lix.aop.biz.IBookBiz</value>
			</list>
		</property>
		<property name="interceptorNames">
			<list>
				<value>myMethodBeforeAdvice</value>
				<value>myAfterReturningAdvice</value>
			</list>
		</property>

	</bean>

测试结果

环绕通知 MyMethodInterceptor

package lix.aop.advice;

import java.util.Arrays;

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

/**
 * 环绕通知
 * 包含了前置和后置通知
 * @author 20190816
 *
 */
public class MyMethodInterceptor implements MethodInterceptor{

	@Override
	public Object invoke(MethodInvocation arg0) throws Throwable {
		String target=arg0.getThis().getClass().getName();
		String methodName=arg0.getMethod().getName();
		String args=Arrays.toString(arg0.getArguments());
		System.out.println("【环绕通知调用前】"+target+"."+methodName+"("+args+")被调用了");
		//arg0.proceed();就是调用了目标对象的方法
		Object proceed= arg0.proceed();
		System.out.println("【环绕通知调用后】：该方法被调用之后的返回值为："+proceed);

		return proceed;
	}

}

spring-context.xml 配置环绕通知

<!-- 环绕通知 -->
	 <bean class="lix.aop.advice.MyMethodInterceptor" id="myMethodInterceptor"></bean>
	
	 <value>myMethodInterceptor</value>

执行结果

异常通知 MyThrowsAdvice

package lix.aop.advice;

import org.springframework.aop.ThrowsAdvice;

import lix.aop.exception.PriceException;

/**
 * 出现异常执行系统提示 ，然后进行处理，以价格异常为例
 * @author 20190816
 *
 */
public class MyThrowsAdvice implements ThrowsAdvice{
	//没有要实现接口的方法 但是要写一个固定的方法
	public void afterThrowing(PriceException ex) {
		System.out.println("【异常通知】：当价格发生异常，就执行此代码块");
	}
}

spring-context.xml 配置异常通知

<!-- 异常通知 --> <bean class="lix.aop.advice.MyThrowsAdvice" id="myThrowsAdvice"></bean> <value>myThrowsAdvice</value>
**执行结果 **

过滤通知（就是Plus版的后置通知）

spring-context.xml 配置过滤通知 直接配置就好了

<!-- 过滤通知 -->
	<bean class="org.springframework.aop.support.RegexpMethodPointcutAdvisor"
		id="myAfterReturningAdvicePlus">
		<property name="advice" ref="myAfterReturningAdvice"></property>
		<property name="pattern" value=".*buy"></property>
	</bean>

执行结果