SpringAOP基础入门与日志实践详解
Spring中使用AspectJ实现AOP的五种通知
SpringAOP中Aspect优先级与切面表达式详解
Spring AOP使用(踩坑)实践总结
Spring AOP中如何为Bean创建代理
【1】AOP是什么
SpringBoot下我们可以添加如下依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
① 基本概念
(Aspect-Oriented Programming
, 面向切面编程),是一种新的方法论, 是对传统 OOP(Object-Oriented Programming, 面向对象编程) 的补充。作为面向对象的一种补充,用于处理系统中分布于各个模块的横切关注点,比如事务管理、日志、缓存等等。
Aspect是一种新的模块化机制,用来描述分散在对象、类或函数中的横切关注点(crosscutting concern)。从关注点中分离出横切关注点是面向切面的程序设计的核心概念。
AOP实现的关键在于AOP框架自动创建的AOP代理
AOP代理主要分为静态代理和动态代理,静态代理的代表为AspectJ
。而动态代理则以Spring AOP
为代表。静态代理是编译期实现(编译期间生成代理类),动态代理是运行期实现,可想而知前者拥有更好的性能。
AOP 的主要编程对象是切面(aspect), 而切面模块化横切关注点.
在应用 AOP 编程时, 仍然需要定义公共功能, 但可以明确的定义这个功能在哪里, 以什么方式应用, 并且不必修改受影响的类. 这样一来横切关注点就被模块化到特殊的对象(切面)里.
静态代理 是编译阶段生成AOP代理类,也就是说生成的字节码就织入了增强后的AOP对象。
动态代理 则不会修改字节码,而是在内存中临时生成一个AOP对象,这个AOP对象包含了目标对象的全部方法,并且在特定的切点做了增强处理,并回调原对象的方法。
Spring AOP中的动态代理主要有两种方式,JDK动态代理和CGLIB动态代理
JDK动态代理通过反射来接收被代理的类,并且要求被代理的类必须实现一个接口。JDK动态代理的核心是InvocationHandler
接口和Proxy
类。
如果目标类没有实现接口,那么Spring AOP会选择使用CGLIB
来动态代理目标类。CGLIB(Code Generation Library
),是一个代码生成的类库,可以在运行时动态的生成某个类的子类。注意,CGLIB是通过继承的方式做的动态代理
,因此如果某个类被标记为final
,那么它是无法使用CGLIB做动态代理的,诸如private的方法也是不可以作为切面的。
这里要说明下,由于Spring AOP是使用JDK动态代理和CGLIB代理实现的(缺省使用jdk动态代理),因此Spring AOP只可以对方法的执行进行拦截
,如果需要拦截字段的访问或更新,则需要像AspectJ这样的AOP语言。
另外Spring可以无缝的集成IOC,Spring AOP 以及AspectJ AOP。
AspectJ
Java 社区里最完整最流行的 AOP 框架。在 Spring2.0 以上版本中, 可以使用基于 AspectJ 注解或基于 XML 配置的 AOP。
AspectJ的底层技术是静态代理,即用一种AspectJ支持的特定语言编写切面,通过一个命令来 编译,生成一个新的代理类,该代理类增强了业务类,这是在编译时增强,相对于运行时增强,编译时增强的性能更好。
此外还有以下AOP技术:
- AspectWerkz:AOP框架,使用字节码动态编织器和xml配置;
- JBoss-AOP:基于拦截器和元数据的AOP框架,运行在JBoss应用服务器上。以及在AOP中用到的一些相关的技术实现
- BCEL(Byte-Code Engineering Library):Java字节码操作类库
- Javassist:Java字节码操作类库,JBoss的一个子项目
② Spring AOP与AspectJ
与 AspectJ 相同的是,Spring AOP 同样需要对目标类进行增强,也就是生成新的 AOP 代理类。与AspectJ 不同的是,Spring AOP 无需使用任何特殊命令对 Java 源代码进行编译,它采用运行时动态地、在内存中临时生成”代理类”的方式来生成 AOP 代理。
Spring 允许使用 AspectJ Annotation 用于定义切面(Aspect)、切入点(Pointcut)和增强处理(Advice)。Spring 框架则可识别并根据这些 Annotation 来生成 AOP 代理。
Spring 只是使用了和AspectJ 5 一样的注解,但并没有使用 AspectJ 的编译器或者织入器( Weaver ),底层依然使用的是Spring AOP,依然是在运行时动态生成 AOP 代理,并不依赖于 AspectJ 的编译器或者织入器。
简单地说,Spring 依然采用运行时生成动态代理的方式来增强目标对象,所以它不需要增加额外的编译,也不需要 AspectJ 的织入器支持。而 AspectJ 在采用编译时增强,所以 AspectJ 需要使用自己的编译器来编译 Java 文件,还需要织入器。
为了启用 Spring 对 @AspectJ 方面配置的支持,并保证 Spring 容器中的目标 Bean 被一个或多个方面自动增强,必须在 Spring 配置文件中配置如下片段:
<!-- 启动 @AspectJ 支持 -->
<aop:aspectj-autoproxy/>
如果不打算使用 Spring 的 XML Schema 配置方式,则应该在 Spring 配置文件中增加如下片段来启用@AspectJ 支持。
<!-- 启动 @AspectJ 支持 -->
<bean class="org.springframework.aop.aspectj.annotation.
AnnotationAwareAspectJAutoProxyCreator"/>
上面配置文件中的 AnnotationAwareAspectJAutoProxyCreator
是一个 Bean 后处理器
(BeanPostProcessor),该 Bean 后处理器将会为容器中 Bean 生成 AOP 代理。
SpringBoot环境下需要加上如下配置:
<!-- springboot下加上如下配置 -->
@EnableAspectJAutoProxy(proxyTargetClass = true)
③ 通知类型
主要有前置通知、后置通知、返回通知、异常通知以及环绕通知。
@Before:
前置通知, 在方法执行之前执行,这个通知不能阻止连接点前的执行(除非它抛出一个异常)。
@After:
后置通知, 在方法执行之后执行(不论是正常返回还是异常退出)。
@AfterRunning:
返回通知, 在方法正常返回结果之后执行 。
@AfterThrowing:
异常通知, 在方法抛出异常之后。
@Around:
包围一个连接点(join point)的通知,如方法调用。这是最强大的一种通知类型。 环绕通知可以在方法调用前后完成自定义的行为。它也会选择是否继续执行连接点或直接返回它们自己的返回值或抛出异常来结束执行。
AOP 主要应用场景有:
- Authentication 权限
- Caching 缓存
- Context passing 内容传递
- Error handling 错误处理
- Lazy loading 懒加载
- Debugging 调试
- logging, tracing, profiling and monitoring 记录跟踪 优化 校准
- Performance optimization 性能优化
- Persistence 持久化
- Resource pooling 资源池
- Synchronization
【2】AOP术语
- 切面(Aspect): 横切关注点(跨越应用程序多个模块的功能)被模块化的特殊对象
- 通知(Advice): 切面必须要完成的工作,是拥有某个功能的方法。所谓通知指的就是指拦截到连接点之后要执行的代码,通知分为前置、后置、异常、最终、环绕通知五类。
- 目标(Target): 被通知的对象
- 代理(Proxy): 向目标对象应用通知之后创建的对象
- 连接点(Joinpoint):程序执行的某个特定位置:如类某个方法调用前、调用后、方法抛出异常后等。
- 切入点(pointcut):对连接点进行拦截的定义。
每个类都拥有多个连接点:例如 类的所有方法实际上都是连接点,即连接点是程序类中客观存在的事务。AOP 通过切点定位到特定的连接点。切点和连接点不是一对一的关系,一个切点匹配多个连接点,切点通过
org.springframework.aop.Pointcut
接口进行描述,它使用类和方法作为连接点的查询条件。 - 横切关注点:对哪些方法进行拦截,拦截后怎么处理,这些关注点称之为横切关注点。
- 织入(weave):将切面应用到目标对象并导致代理对象创建的过程。
- 引入(introduction):在不修改代码的前提下,引入可以在运行期为类动态地添加一些方法或字段。
① 通知和切面
将多处地方具有类似功能的代码(横切关注点)抽取出来,进行模块化为一个方法(通知-Advice)。
将同一事务的不同方法(如前置通知、后置通知)放在一个类中(即,切面–Aspect)。
在方法上利用Aspect表达式定义切点,当有匹配其表达式的目标对象方法执行时,会自动为其建立代理对象-Proxy。
Advice(通知)定义在连接点做什么,为切面增强提供织入接口。在Spring AOP中,它主要描述Spring AOP围绕方法调用而诸如的切面行为。
切面(Aspect): 横切关注点(跨越应用程序多个模块的功能)被模块化的特殊对象--类级别
通知(Advice): 切面必须要完成的工作--即方法(方法级别)
目标(Target): 被通知的对象
代理(Proxy): 向目标对象应用通知之后创建的对象
切面泛指[交叉业务逻辑],类级别,包含了同一类型事务的不同增强方法(通知)。
比如:事务处理和日志处理可以理解为两个切面。
通知(Advice)实际就是对主业务逻辑的一种增强,是一种在目标方法执行之外额外的方法。
如,日志处理–在目标方法执行前后添加日志。
这些被添加日志的方法称为连接点;
·
通知方法执行的位置称为切入点;
·
对目标方法增强的方法称为通知;
·
对日志增强的所有通知方法所属的类称为切面。
② 连接点(Joinpoint)
程序执行的某个特定位置。如类某个方法调用前、调用后、方法抛出异常后等。被拦截到的点,因为 Spring 只支持方法类型的连接点,所以在 Spring 中连接点指的就是被拦截到的方法,实际上连接点还可以是字段或者构造器。
连接点由两个信息确定:
方法(表示程序执行点,即-在哪个目标方法);
相对点(表示方位,即-目标方法的什么位置,如调用前、后。。。)
例如 :ArithmethicCalculator#add()
方法执行前的连接点:
方法为ArithmethicCalculator#add();
相对点为该方法执行前的位置
③ 切入点(pointcut)
匹配连接点(Joinpoint)的断言,AOP 通过切点定位到特定的连接点。换句话说即通过某种定义来决定哪些方法将会被通知(即需要事物处理),我们将这个定义称为切入点(Pointcut)。
Pointcut(切点)决定Advice通知应该作用于哪个连接点,也就是说通过Pointcut来定义需要增强的方法的集合,这些集合的选取可以按照一定的规则来完成。在这种情况下,Pointcut通常意味着标识方法,例如这些需要增强的地方可以由某个正则表达式进行标识或根据某个方法名进行匹配。
通知和一个切入点表达式关联,并在满足这个切入点的连接点上运行(例如,当执行某个特定名称的方法时)。
切入点表达式如何和连接点匹配是AOP的核心:Spring缺省使用AspectJ切入点语法。
每个类都拥有多个连接点,即连接点是程序类中客观存在的事务。也就是说通过某种定义来决定哪些方法将会被通知(即需要事物处理),我们将这个定义评为切入点(Pointcut),而每一个被处理的方法我们称之为连接点(Join Point)。
类比:连接点相当于数据库中的记录,切点相当于查询条件。
切点和连接点不是一对一的关系,一个切入点常常匹配多个连接点.
切点通过 org.springframework.aop.Pointcut 接口进行描述,它使用类和方法作为连接点的查询条件。
注意:被标记为final的方法是不能作为连接点与切入点的。因为final的是不能被修改的,不能被增强的。
④ 通知
在切面的某个特定的连接点(Joinpoint)上执行的动作(切面类中的某个方法)。
通知有各种类型,其中包括“around
”、“before
”和“after
”等通知。许多AOP框架,包括Spring,都是以拦截器做通知模型,并维护一个以连接点为中心的拦截器链。
通知定义了增强代码切入到目标代码的时间点(是目标方法执行之前执行,还是执行之后执行等)和增强功能。
完整通知包括:通知类型+切入点表达式+增强方法。
如下所示:
//抽取公共的切入点表达式
//1、本类引用
//2、其他的切面引用
@Pointcut("execution(public int com.web.aop.MathCalculator.*(..))")
public void pointCut(){};
//@Before在目标方法之前切入;切入点表达式(指定在哪个方法切入)
@Before("pointCut()")
public void logStart(JoinPoint joinPoint){
Object[] args = joinPoint.getArgs();
System.out.println(""+joinPoint.getSignature().getName()+"运行。。。@Before:参数列表是:{"+Arrays.asList(args)+"}");
}
综上,切入点定义切入的位置,通知定义切入的时间和增强功能。通知需要与切入点配合使用。
⑤ 目标对象(Target Object)
目标对象指将要被增强的对象,即包含主业务逻辑的类的对象。被一个或者多个切面(aspect)所通知(advice)的对象。也有人把它叫做 被通知(adviced) 对象。 既然Spring AOP是通过运行时代理实现的,这个对象永远是一个 被代理(proxied) 对象。
⑥ AOP代理
AOP框架创建的对象,用来实现切面契约(aspect contract)(包括通知方法执行等功能)。 在Spring中,AOP代理可以是JDK动态代理或者CGLIB代理。
⑦ 织入
把切面(aspect)连接到其它的应用程序类型或者对象上,并创建一个被通知(adviced)的对象。 这些可以在编译时(例如使用AspectJ编译器),类加载时和运行时完成。
织入是指将切面代码插入到目标对象的过程。代理的invoke方法完成的工作,可以称为织入。
Spring和其他纯Java AOP框架一样,在运行时完成织入。
【3】AOP图示与实例
① AOP图示
② AOP简单实例
package com.web.aop.impl;
import java.util.Arrays;
import java.util.List;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
/*
@Component表示将其放入IOC容器中,使其可以被自动扫描;
@Aspect表示其为一个切面
*/
@Aspect
@Component
public class LoggingAspect {
@Before("execution(int com.web.aop.impl.ArithmeticCalculatorImpl.*(int , int ))")
public void beforMethod(JoinPoint joinPoint){
/*获取方法名*/
String methodName = joinPoint.getSignature().getName();
/*获取方法的参数*/
List<Object> args = Arrays.asList(joinPoint.getArgs());
System.out.println("The method"+methodName+" begins with"+args);
}
/*
* 后置通知:在目标方法执行后执行,无论是否抛出异常;
* 后置通知中不能访问目标方法执行后返回的结果;
* */
@After("execution(* com.web.aop.impl.*.*(int , int ))")
/*表示该包下所有返回类型的所有类的所有方法*/
public void afterMethod(JoinPoint joinPoint){
/*获取方法名*/
String methodName = joinPoint.getSignature().getName();
System.out.println("The method"+methodName+" ends ");
}
}
③ 自定义log注解与AOP整合
① 自定义注解
import java.lang.annotation.Retention;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import java.lang.annotation.RetentionPolicy;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
String value() default "";
}
② AOP日志切片实例
import java.lang.reflect.Method;
import java.util.Date;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import javax.servlet.http.HttpServletRequest;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class LogAspect {
private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);
@Autowired
LogService logService;
@Pointcut("@annotation(com.family.common.annotation.Log)")
public void logPointCut() {
}
@Around("logPointCut()")
public Object around(ProceedingJoinPoint point) throws Throwable {
long beginTime = System.currentTimeMillis();
// 执行方法
Object result = point.proceed();
// 执行时长(毫秒)
long time = System.currentTimeMillis() - beginTime;
//异步保存日志
saveLog(point, time);
return result;
}
void saveLog(ProceedingJoinPoint joinPoint, long time) throws InterruptedException {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
LogDO sysLog = new LogDO();
Log syslog = method.getAnnotation(Log.class);
if (syslog != null) {
// 注解上的描述
sysLog.setOperation(syslog.value());
}
// 请求的方法名
String className = joinPoint.getTarget().getClass().getName();
String methodName = signature.getName();
sysLog.setMethod(className + "." + methodName + "()");
// 请求的参数
Object[] args = joinPoint.getArgs();
try {
String params = JSONUtils.beanToJson(args[0]).substring(0, 4999);
sysLog.setParams(params);
} catch (Exception e) {
}
// 获取request
HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
// 设置IP地址
sysLog.setIp(IPUtils.getIpAddr(request));
// 用户名
UserDO currUser = ShiroUtils.getUser();
if (null == currUser) {
if (null != sysLog.getParams()) {
sysLog.setUserId(-1L);
sysLog.setUsername(sysLog.getParams());
} else {
sysLog.setUserId(-1L);
sysLog.setUsername("获取用户信息为空");
}
} else {
sysLog.setUserId(ShiroUtils.getUserId());
sysLog.setUsername(ShiroUtils.getUser().getUsername());
}
sysLog.setTime((int) time);
// 系统当前时间
Date date = new Date();
sysLog.setGmtCreate(date);
// 保存系统日志
logService.save(sysLog);
}
}
这里我们使用的注解是org.aspectj包下的哦,如下图所示。
【4】Advisor(增强器/顾问)
完成对目标方法的切片增强设计(Advice)和关注点的设计(Pointcut)以后,需要一个对象把它们结合起来,完成这个作用的就是Advisor(通知器)。通过Advisor,可以定义应该使用哪个通知并在哪个关注点使用它,也就是说通过Advisor,把Advice和Pointcut结合起来,这个结合为使用IOC容器配置AOP应用,或者说即开即用地使用AOP基础设施提供了便利。
Advisor是切面的另一种实现,能够将通知以更为复杂的方式织入到目标对象中,是将通知包装为更复杂切面的装配器。Advisor由切入点和Advice组成。
DefaultPointcutAdvisor
方便的切入点驱动的Advisor实现(Convenient Pointcut-driven Advisor implementation)。
这是最常用的Advisor实现。它可以用于任何切入点和advice类型,introductions除外。通常不需要对此类进行子类化,也不需要实现自定义Advisors。
public class DefaultPointcutAdvisor extends AbstractGenericPointcutAdvisor implements Serializable {
private Pointcut pointcut = Pointcut.TRUE;
public DefaultPointcutAdvisor() {
}
public DefaultPointcutAdvisor(Advice advice) {
this(Pointcut.TRUE, advice);
}
// Pointcut 和 Advice
public DefaultPointcutAdvisor(Pointcut pointcut, Advice advice) {
this.pointcut = pointcut;
setAdvice(advice);
}
public void setPointcut(@Nullable Pointcut pointcut) {
this.pointcut = (pointcut != null ? pointcut : Pointcut.TRUE);
}
@Override
public Pointcut getPointcut() {
return this.pointcut;
}
@Override
public String toString() {
return getClass().getName() + ": pointcut [" + getPointcut() + "]; advice [" + getAdvice() + "]";
}
}
在Pointcut接口中Pointcut TRUE = TruePointcut.INSTANCE;
public interface Pointcut {
/**
* Return the ClassFilter for this pointcut.
* @return the ClassFilter (never {@code null})
*/
ClassFilter getClassFilter();
/**
* Return the MethodMatcher for this pointcut.
* @return the MethodMatcher (never {@code null})
*/
MethodMatcher getMethodMatcher();
/**
* Canonical Pointcut instance that always matches.
*/
Pointcut TRUE = TruePointcut.INSTANCE;
}
"advisors
"这个概念来自Spring1.2对AOP的支持,在AspectJ中是没有等价的概念。advisor就像一个小的自包含的切面,这个切面只有一个通知。 切面自身通过一个bean表示,并且必须实现一个通知接口,大多数情况下会和transactional advice一起使用。
Advisor能够将通知以更为复杂的方式织入到目标对象中,是将通知包装为更复杂切面的装配器。Advisor由切入点和Advice组成。如Spring中的事务应用:
<!-- 拦截器方式配置事物 -->
<tx:advice id="transactionAdvice" transaction-manager="transactionManager">
<tx:attributes>
<tx:method name="add*" propagation="REQUIRED"/>
<tx:method name="append*" propagation="REQUIRED"/>
<tx:method name="insert*" propagation="REQUIRED"/>
<tx:method name="save*" propagation="REQUIRED"/>
<tx:method name="update*" propagation="REQUIRED"/>
<tx:method name="modify*" propagation="REQUIRED"/>
<tx:method name="edit*" propagation="REQUIRED"/>
<tx:method name="delete*" propagation="REQUIRED"/>
<tx:method name="remove*" propagation="REQUIRED"/>
<tx:method name="repair" propagation="REQUIRED"/>
<tx:method name="release*" propagation="REQUIRED"/>
<tx:method name="delAndRepair" propagation="REQUIRED"/>
<tx:method name="get*" propagation="SUPPORTS"/>
<tx:method name="find*" propagation="SUPPORTS"/>
<tx:method name="load*" propagation="SUPPORTS"/>
<tx:method name="search*" propagation="SUPPORTS"/>
<tx:method name="datagrid*" propagation="SUPPORTS"/>
<tx:method name="*" propagation="SUPPORTS"/>
</tx:attributes>
</tx:advice>
<aop:config>
<aop:pointcut id="transactionPointcut" expression="execution(* com.sychine.tower.service..*Impl.*(..))"/>
<aop:advisor pointcut-ref="transactionPointcut" advice-ref="transactionAdvice"/>
</aop:config>
若<aop:advisor advice-ref="beanName" pointcut-ref="txPointCut" />
,则该bean的class应为org.aopalliance.aop.Advice
类型。
【Tips】
● <aop:advisor>
:用来定义只有一个通知和一个切入点的切面;
● <aop:aspect>
:用来定义切面,该切面可以包含多个切入点和通知,而且标签内部的通知和切入点定义是无序的。其和advisor的区别就在此,advisor只包含一个通知和一个切入点。
aop:aspect配置实例如下:
<bean id="arithmeticCalculator" class="com.web.aop.impl.xml.ArithmeticCalculatorImpl"></bean>
<!-- 配置切面bean -->
<bean id="loggingAspect" class="com.web.aop.impl.xml.LoggingAspect"></bean>
<bean id="validateAspect" class="com.web.aop.impl.xml.ValidateAspect"></bean>
<!-- ******************************AOP 配置******************************* -->
<aop:config>
<!-- 配置切点表达式 -->
<aop:pointcut id="pointcut" expression="execution(* com.web.aop.impl.xml.ArithmeticCalculatorImpl.*(int, int))" />
<!-- 配置日志切面 -->
<aop:aspect ref="loggingAspect" order="1" >
<aop:before method="beforMethod" pointcut-ref="pointcut"/>
<aop:after method="afterMethod" pointcut-ref="pointcut"/>
<aop:after-returning method="afterReturning" pointcut-ref="pointcut" returning="result"/>
<aop:after-throwing method="afterThrowing" pointcut-ref="pointcut" throwing="exception"/>
<!-- <aop:around method="aroundMethod" pointcut-ref="pointcut" />-->
</aop:aspect>
<!-- 配置验证切面 -->
<aop:aspect ref="validateAspect" order="2" >
<aop:before method="beforMethod" pointcut-ref="pointcut"/>
</aop:aspect>
</aop:config>