Spring AOP 的实现方式(以日志管理为例)
1.为什么需要AOP
假如我们应用中有n个业务逻辑组件,每个业务逻辑组件又有m个方法,那现在我们的应用就一共包含了n*m个方法,我会抱怨方法太多。。。现在,我有这样一个需求,每个方法都增加一个通用的功能,常见的如:事务处理,日志,权限控制。。。最容易想到的方法,先定义一个额外的方法,实现该功能,然后再每个需要实现这个功能的地方去调用这个额外的方法。这种做法的好处和坏处分别是。
好处:可以动态地添加和删除在切面上的逻辑而不影响原来的执行代码。
坏处:一旦要修改,就要打开所有调用到的地方去修改。
好,现在我们用AOP的方式可以实现在不修改源方法代码的前提下,可以统一为原多个方法增加横切性质的“通用处理”。
2.什么是AOP
AOP(Aspect-OrientedProgramming,面向方面编程),可以说是OOP(Object-Oriented Programing,面向对象编程)的补充和完善。本文提供Spring官方文档出处:https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#aop-api
从官方文档上摘抄的解释就是:面向方面编程(AOP)是面向对象编程(OOP)补充的另一种提供思考程序结构补充。在OOP中模块化的关键单元是类,而在AOP模块的单位是一个方面。面对关注点,如事务管理跨越多个类型和对象切模块化。(这些关注经常被称为在AOP文学横切关注点。)
相关概念(只需做个大概的了解就好)
Aspect:这横切多个对象关心的模块化。事务管理是企业Java应用程序的横切关注点的一个很好的例子。在SpringAOP中,切面可以使用类(基于模式)或@Aspect注解(@AspectJ风格)注解普通班实施。
Join point:程序在执行过程中的一个点,如方法的执行或异常的处理。在SpringAOP中,一个连接点总是代表一个方法的执行。
Advice:在切面的某个特定的动作连接点。不同类型的意见,包括 "around," "before" and "after"的advice。(通知的类型将在下面讨论)。许多AOP框架,包括Spring都是以拦截器作为通知模型,去维护一条围绕着一个连接点的拦截器链。
Pointcut:匹配连接点的断言。通知是跟一个切入点表达式,并在运行在切入点匹配的连接点相关联(例如,一个方法的执行要有一个确定的名字)。切入点表达式作为匹配的连接点的概念是重要的对AOP和Spring缺省使用AspectJ切入点表达式语言。
Introduction:声明代表的类型的额外的方法或字段。 Spring允许引入新的接口(以及一个对应的实现)到任何被代理的对象。例如,你可以使用引入来使一个bean实现IsModified接口,以便简化缓存。 (介绍被誉为AspectJ的社会类型间的声明。)
Target object:对象由一个或多个方面被建议。也被称作被通知对象。既然Spring AOP是通过运行时代理实现的,这个对象永远是一个被代理对象。
AOP proxy:AOP框架,以实现切面契约(例如通知方法执行等等)创建的对象。在Spring中,AOP代理可以是JDK动态代理或者CGLIB代理。
Weaving:与连接其他应用程序类型或对象方面来创建一个被通知的对象。这是可以做到在编译时(使用AspectJ编译器,例如),加载时间,或在运行时。 Spring AOP中,像其他纯Java AOP框架,在运行时进行编织。
那问题来了,AOP是在什么时候去改我们的代码的?即给我们加上额外的横切性质的"通用处理"的?
两个时机:
- 在编译java源代码的时候 ----编译时增强
- 在运行时动态地修改类 ----运行时增强(动态代理)
我们的Spring的AOP的实现原理就是基于动态代理。
3.Spring AOP的3种实现方式
对于框架的学习,我觉得得先会用,然后再深入原理。关于SpringAOP的实现我在这里划分成3个方式(以日志管理为例)废话不多说,直接上代码了。
配置之前注意配置文件要加上命名空间:xmlns:aop="http://www.springframework.org/schema/aop"
1.基于xml配置的实现
spring-mvc.xml
<!-- 使用xml配置aop -->
<!-- 强制使用cglib代理,如果不设置,将默认使用jdk的代理,但是jdk的代理是基于接口的 -->
<aop:config proxy-target-class="true" />
<aop:config>
<!--定义切面-->
<aop:aspect id="logAspect" ref="logInterceptor">
<!-- 定义切入点 (配置在com.gray.user.controller下所有的类在调用之前都会被拦截)-->
<aop:pointcut expression="execution(* com.gray.user.controller.*.*(..))" id="logPointCut"/>
<!--方法执行之前被调用执行的-->
<aop:before method="before" pointcut-ref="logPointCut"/><!--一个切入点的引用-->
<aop:after method="after" pointcut-ref="logPointCut"/><!--一个切入点的引用-->
</aop:aspect>
</aop:config>
LogInterceptor.java
package com.gray.interceptor;
import org.springframework.stereotype.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Component
public class LogInterceptor {
private final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);
public void before(){
logger.info("login start!");
}
public void after(){
logger.info("login end!");
}
}
在这里我没有配bean是因为我在之前的配置文件里面写了自动扫描组件的配置了
要加入日志管理逻辑的地方
@RequestMapping("/dologin.do") //url
public String dologin(User user, Model model){
logger.info("login ....");
String info = loginUser(user);
if (!"SUCC".equals(info)) {
model.addAttribute("failMsg", "用户不存在或密码错误!");
return "/jsp/fail";
}else{
model.addAttribute("successMsg", "登陆成功!");//返回到页面说夹带的参数
model.addAttribute("name", user.getUsername());
return "/jsp/success";//返回的页面
}
}
2.基于注解的实现
spring-mvc.xml
<aop:aspectj-autoproxy proxy-target-class="true">
</aop:aspectj-autoproxy>
LogInterceptor.java
@Aspect
@Component
public class LogInterceptor {
private final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);
@Before(value = "execution(* com.gray.user.controller.*.*(..))")
public void before(){
logger.info("login start!");
}
@After(value = "execution(* com.gray.user.controller.*.*(..))")
public void after(){
logger.info("login end!");
}
要加入逻辑的地方同上。
3.基于自定义注解的实现
基于注解,所以spring-mvc.xml也是和上面的一样的。
LogInterceptor.java(这里我只加入前置日志)
package com.gray.interceptor;
import java.lang.reflect.Method;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import com.gray.annotation.Log;
@Aspect
@Component
public class LogInterceptor {
private final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);
@Pointcut("@annotation(com.gray.annotation.Log)")
public void controllerAspect() {
}
@Before("controllerAspect()")
public void before(JoinPoint joinPoint){
logger.info(getOper(joinPoint));
}
private String getOper(JoinPoint joinPoint) {
MethodSignature methodName = (MethodSignature)joinPoint.getSignature();
Method method = methodName.getMethod();
return method.getAnnotation(Log.class).oper();
}
}
同时,加入逻辑的地方需要加入Log注解
@RequestMapping("/dologin.do") //url
@Log(oper="user login")
public String dologin(User user, Model model){
logger.info("login ....");
String info = loginUser(user);
if (!"SUCC".equals(info)) {
model.addAttribute("failMsg", "用户不存在或密码错误!");
return "/jsp/fail";
}else{
model.addAttribute("successMsg", "登陆成功!");//返回到页面说夹带的参数
model.addAttribute("name", user.getUsername());
return "/jsp/success";//返回的页面
}
}
常见的基于注解的方式除了before和after,还有around和AfterThrowing等,在做第三种方式实验的时候还遇到这种错误:error at ::0 can't find referenced pointcut。我的解决办法是:因为我的jdk是1.7,与原来在pom.xml中配的那个aspectjweaver的jar包版本不匹配,所以我需要升级,由1.5.4改成1.7.4。
上一篇: 日志管理