spring 入门篇之 aop
spring 入门篇之 aop
spring aop 简介
AOP 中的概念:
连接点(Joinpoint): 程序执行过程中明确的点,如方法的调用,或者异常的抛出。
目标(Target): 被通知(被代理)的对象。
注意: 完成具体的业务逻辑。
通知(Advice): 在某个特定的连接点上执行的动作,同时Advice也是程序代码的具体实现,例如一个实现日志记录的代码(通知有些书上也称为处理)。
注意: 完成切面编程。
代理(Proxy): 将通知应用到目标对象后创建的对象(代理=目标+通知)。
注意: 只有代理对象才有AOP功能,而AOP的代码是写在通知的方法里面的。
切入点(Pointcut): 多个连接点的集合,定义了通知应该应用到那些连接点。
(也将Pointcut理解成一个条件 ,此条件决定了容器在什么情况下将通知和目标组合成代理返回给外部程序)
适配器(Advisor): 适配器 = 通知(Advice) + 切入点(Pointcut)
如何实现AOP?
目标对象只负责业务逻辑代码
通知对象负责AOP代码,这二个对象都没有AOP的功能,只有代理对象才有。
AOP:即面向切面编程
AOP带来的好处:
让我们可以 “专心做事”
案例:
public void doSameBusiness (long lParam,String sParam){
// 记录日志
log.info("调用 doSameBusiness方法,参数是:"+lParam);
// 输入合法性验证
if (lParam<=0){
throws new IllegalArgumentException("xx应该大于0");
}
if (sParam==null || sParam.trim().equals("")){
throws new IllegalArgumentException("xx不能为空");
}
// 异常处理
try{ ...
}catch(...){
}catch(...){
}
// 事务控制
tx.commit();
}
工具类:org.springframework.aop.framework.ProxyFactoryBean 用来创建一个代理对象,在一般情况下它需要注入以下三个属性:
proxyInterfaces:代理应该实现的接口列表(List)
interceptorNames:需要应用到目标对象上的通知Bean的名字。(List)
target:目标对象 (Object)
AOP 中的通知:
-
前置通知(org.springframework.aop.MethodBeforeAdvice): 在连接点之前执行的通知()
在系统当中使用AOP方式实现日志系统 -
后置通知(org.springframework.aop.AfterReturningAdvice): 在连接点正常完成后执行的通知
案例:在线购书系统中,要求不修改BookBizImpl代码的情况下增加如下功能:对买书的用户进行返利:每买本书返利3元。(后置通知)
即:每调用一次buy方法打印:“[销售返利][时间]返利3元。” -
环绕通知(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容器自动识别 执行
-
异常通知(org.springframework.aop.ThrowsAdvice): 这个通知会在方法抛出异常退出时执行
案例: 书本价格为负数时抛出一个异常,通过异常通知取消此订单 -
适配器(org.springframework.aop.support.RegexpMethodPointcutAdvisor) 适配器=通知(Advice)+切入点(Pointcut)
案例:通过适配器解决发书评时也返利的问题
.*buy
使用接口接收返回的代理对象
A
B C
A a1 = new B();
A a2 = new C();
B b = (B) a2;
核心点
前置通知
实现org.springframework.aop.MethodBeforeAdvice接口
买书、评论前加系统日志
后置通知
实现org.springframework.aop.AfterReturningAdvice接口
买书返利(存在bug)
环绕通知
org.aopalliance.intercept.MethodInterceptor
类似拦截器,会包括切入点,目标类前后都会执行代码。
异常通知
org.springframework.aop.ThrowsAdvice
出现异常执行系统提示,然后进行处理。价格异常为例
过滤通知(适配器)
org.springframework.aop.support.RegexpMethodPointcutAdvisor
处理买书返利的bug
Demo
IBookBiz 接口
package com.dj.aop.biz;
public interface IBookBiz {
// 购书
public boolean buy(String userName, String bookName, Double price);
// 发表书评
public void comment(String userName, String comments);
}
BookBizImpl
package com.dj.aop.biz.impl;
import com.dj.aop.biz.IBookBiz;
import com.dj.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);
}
}
PriceException
package com.dj.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);
}
}
advice
MethodBeforeAdvice
package com.dj.aop.advice;
import java.lang.reflect.Method;
import java.util.Arrays;
/**
* 前置通知
* 买书、评论前加系统日志
* @author 86182
*
*/
public class MethodBeforeAdvice implements org.springframework.aop.MethodBeforeAdvice {
@Override
public void before(Method arg0, Object[] arg1, Object arg2) throws Throwable {
String clzName = arg2.getClass().getName();//被调的类
String methodName = arg0.getName();//被调的方法
String params = Arrays.toString(arg1);//传递参数
System.out.println("【系统日志】:"+clzName+"."+methodName+"("+params+")");
}
}
MyAfterReturningAdvice
package com.dj.aop.advice;
import java.lang.reflect.Method;
import java.util.Arrays;
import org.springframework.aop.AfterReturningAdvice;
/**
* 后置通知
* @author 86182
*
*/
public class MyAfterReturningAdvice implements AfterReturningAdvice {
@Override
public void afterReturning(Object arg0, Method arg1, Object[] arg2, Object arg3) throws Throwable {
String clzName = arg3.getClass().getName();//被调的类
String methodName = arg1.getName();//被调的方法
String params = Arrays.toString(arg2);//传递参数
System.out.println("【后置通知(买书返利)】:"+clzName+"."+methodName+"("+params+")");
}
}
MyMethodInterceptorAdvice
package com.dj.aop.advice;
import java.util.Arrays;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
/**
* 环绕通知
* @author 86182
*
*/
public class MyMethodInterceptorAdvice implements MethodInterceptor {
@Override
public Object invoke(MethodInvocation arg0) throws Throwable {
String clzName = arg0.getThis().getClass().getName();//被调的类
String methodName = arg0.getMethod().getName();//被调的方法
String params = Arrays.toString(arg0.getArguments());//传递参数
System.out.println("【环绕通知】:"+clzName+"."+methodName+"("+params+")");
//returnValue是代理对象调用目标对象方法的返回值
Object returnValue = arg0.proceed();
System.out.println("【环绕通知】:"+clzName+"."+methodName+"("+params+") 方法调用的返回值:"+returnValue);
return returnValue;
}
}
MyThrowsAdvice
package com.dj.aop.advice;
import org.springframework.aop.ThrowsAdvice;
import com.dj.aop.exception.PriceException;
/**
* 异常通知
* @author 86182
*
*/
public class MyThrowsAdvice implements ThrowsAdvice {
public void afterThrowing(PriceException e) {
System.out.println("价格输入有误,购买失败,请重新输入!");
}
}
xml 配置
spring-context.xml
重要代码:
<!-- aop 知识点 -->
<!-- 目标 -->
<bean id="bookBiz" class="com.dj.aop.biz.impl.BookBizImpl"></bean>
<!-- 通知 -->
<!-- 前置通知 -->
<bean id="myMethodBeforeAdvice" class="com.dj.aop.advice.MethodBeforeAdvice"></bean>
<!-- 后置通知:买书返利 -->
<bean id="myAfterReturningAdvice" class="com.dj.aop.advice.MyAfterReturningAdvice"></bean>
<!-- 环绕通知 -->
<bean id="myMethodInterceptorAdvice" class="com.dj.aop.advice.MyMethodInterceptorAdvice"></bean>
<!-- 异常通知 -->
<bean id="myThrowsAdvice" class="com.dj.aop.advice.MyThrowsAdvice"></bean>
<!-- 过滤通知(适配器) -->
<bean id="myAfterReturningAdvicePlus" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">
<property name="advice" ref="myAfterReturningAdvice"></property>
<property name="pattern" value=".*buy"></property>
</bean>
<!-- 代理对象=目标+通知 -->
<bean id="bookBizProxy" class="org.springframework.aop.framework.ProxyFactoryBean">
<!-- target: 目标对象 -->
<property name="target" ref="bookBiz"></property>
<!-- proxyInterfaces: 代理应该实现的接口列表 -->
<property name="proxyInterfaces">
<list>
<value>com.dj.aop.biz.IBookBiz</value>
</list>
</property>
<!-- interceptorNames: 需要应用到目标对象上的通知Bean的名字 -->
<property name="interceptorNames">
<list>
<!-- 前置通知 -->
<value>myMethodBeforeAdvice</value>
<!-- 后置通知:买书返利 -->
<!-- <value>myAfterReturningAdvice</value> -->
<!-- 环绕通知 -->
<value>myMethodInterceptorAdvice</value>
<!-- 异常通知 -->
<value>myThrowsAdvice</value>
<!-- 过滤通知(适配器) -->
<value>myAfterReturningAdvicePlus</value>
</list>
</property>
</bean>
test
package com.dj.aop.test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.dj.aop.biz.IBookBiz;
import com.dj.ioc.web.UserAction;
public class Demo1 {
public static void main(String[] args) {
//建模 拿到里面的所有对象
ApplicationContext context = new ClassPathXmlApplicationContext("/spring-context.xml");
//获取相应的对象
// IBookBiz bean = (IBookBiz)context.getBean("bookBiz");
// bean.buy("魏无羡", "魔道祖师", 99.99);
// System.out.println(bean.getClass());// 打印:魏无羡 buy 魔道祖师, spend 99.99
IBookBiz bean = (IBookBiz)context.getBean("bookBizProxy");
//System.out.println(bean.getClass());
bean.buy("魏无羡", "魔道祖师", 99.99);
bean.comment("魏无羡", "赠送陈情令一只");//后置通知
}
}
打印如下: