1.AOP的意义
AOP的意义在于浮现更清晰的逻辑,它能够在业务逻辑不知情(即业务逻辑不需要做任何的改动)的情况下对业务代码的功能进行增强,能够让你的业务逻辑去关注自己本身的业务,而不去想一些其他的事情。这些其他的事情包括:事务提交、方法执行之前的权限检测、日志打印、方法调用事件等等。Spring的声明式事务就是由AOP来实现的。
2.AOP的基本概念
- Join Point(连接点):在Spring AOP中连接点总是代表一次方法的执行,基本上方法执行的前后,或是抛出异常时都是一个连接点。
- Advice(通知):它是在连接点执行的动作,在方法执行前后做什么。
- Pointcut(切入点):说明了如何匹配连接点,即筛选指定了应该拦截哪些方法的执行。
- Aspect(切面):切面是通知和切入点的结合,通知指明了动作的内容和动作的执行时机,切入点指明了动作的执行地点。
- Introduction(引入):为现有类型声明额外的方法和属性。
- Target object(目标对象):AOP代理的目标对象。
- AOP proxy(AOP代理对象):AOP的代理对象,可以是JDK动态代理,也可以是CGLIB代理。
- Weaving(织入):连接切面与目标对象或类型创建代理的过程。
3.Spring AOP的常用注解
@EnableAspectJAutoProxy:开启AspectJ的支持,会对打上@Aspect注解的类进行Proxy。Aspect是Spring的AOP实现方式之一。
@Aspect:用来声明当前的类是一个切面。需要注意的是,仅仅添加@Aspect注解是无法将当前类变为一个Bean的,需要添加一个@Component注解或是使用JavaConfig方式将其声明为一个Bean。
@Before:指定Advice是在方法执行前执行的。
@After:指定Advice在方法执行之后执行。
@AfterReturning:指定Advice在方法成功返回之后执行。
@AfterThrowing:指定Advice在方法抛出异常之后执行。
@Around:在方法执行前后都可以做处理。
@Order:指定切面执行顺序,数值越小,优先级越高。
4.声明切入点
在Spring官方文档关于@AspectJ的章节中可以看到声明切入点的例子,声明之后项目中就可以使用anyOldTransfer
来引入这个切入点了。
@Pointcut("execution(* transfer(..))")// the pointcut expression
private void anyOldTransfer() {}// the pointcut signature
在实际开发中,execution
的方式较为常见,例如想要拦截所有public方法就可以这么做:
execution(public * *(..))
拦截所有set方法可以这么做:
execution(* set*(..))
拦截某个Service中方法的执行可以这么做:
execution(* com.xyz.service.AccountService.*(..))
拦截某个package下所有方法的执行可以这么做:
execution(* com.xyz.service..*.*(..))
以上可以看出execution的用途已经相当广,其他诸如within
、this
、target
的用法子啊此就不多做阐述了,在Spring的官方文档中都可以了解到它们。
5.实际Demo演示
演示的Demo是基于JPA的数据库CRUD的Demo,本次我要拦截的是repository中方法的执行。
新建aspect包,在该包下新建PerformanceAspect
类。内容如下:
@Aspect
@Component
@Slf4j
public class PerformanceAspect {
// @Around("execution(* xeathen.spring.springdemo.repository..*(..))")
@Around("repositoryOps()")
public Object logPerformance(ProceedingJoinPoint pjp) throws Throwable {
long startTime = System.currentTimeMillis();
String name = "-";
String result = "Y";
try {
name = pjp.getSignature().toShortString();
return pjp.proceed();
} catch (Throwable t) {
result = "N";
throw t;
} finally {
long endTime = System.currentTimeMillis();
log.info("{};{};{}ms", name, result, endTime - startTime);
}
}
@Pointcut("execution(* xeathen.spring.springdemo.repository..*(..))")
private void repositoryOps() {
}
}
首先如上文所说的,@Aspect
和@Component
注解不能少,剩下的内容就是编写Advice和Pointcut。
注意,这里两种方式定义切入点,一种是单独使用@Pointcut注解,还有一种是直接在@Around中一直配置Pointcut。这里我拦截了repository包下所有的方法的执行。
@Around注解有一些特殊,可以看到logPerformance
方法中传入了一个ProceedingJoinPoint
参数,被拦截的方法的执行动作就是由这个参数开启的,也就是pjp.proceed();
从代码中可以看到我们在方法执行之前取得startTime
,在方法执行结束之后取得endTime
,由此就能得出方法的执行时间。
pjp.getSignature().toShortString();
可以获取到拦截的方法名。
别忘了,启动类不能缺少开启对 AspectJ
的支持,即添加@EnableAspectJAutoProxy
。
一切就绪之后,来看一下程序的运行效果:
Repository动作的耗时就这样被记录了下来,不过在实际项目中并不能将这些记录直接输出在console中,而是需要分门别类的记录在文件中,相关的内容等日后在加以补充吧^^。