AOP的基本概念
术语
术语 | 描述 |
---|---|
方面/切面(Aspect ) | 通常是一个类,里面可以定义切入点和通知 |
通知(Advice ) | 所谓通知是指拦截到 Joinpoint 之后所要做的事情就是通知 |
切入点(Pointcut ) | 所谓切入点是指我们要对哪些 Joinpoint 进行拦截的定义 |
连接点(Join point ) | 普通方法 |
织入(Weaving ) | 是指把增强应用到目标对象来创建新的代理对象的过程。spring采用动态代理织入,而AspectJ采用编译期织入和类装载期织入 |
目标对象(Target object ) | 被切面织入的代理对象 |
通知的类型
名称 | 标签 | 说明 |
---|---|---|
前置通知 | <aop:before> | 用于配置前置通知。指定增强的方法在切入点方法之前执行 |
后置通知 | <aop:after-returning> | 用于配置后置通知。指定增强的方法在切入点方法之后执行 |
环绕通知 | <aop:around> | 用于配置环绕通知。指定增强的方法在切入点方法之前和之后都执行 |
异常抛出通知 | <aop:throwing> | 用于配置异常抛出通知。指定增强的方法在出现异常时执行 |
最终通知 | <aop:after> | 用于配置最终通知。无论增强方式执行是否有异常都会执行 |
使用注解实现通知
@Aspect
public class AnnotationPointcut {
/**
* 日志切入点
*/
@Pointcut("@annotation(com.yzj.jep.app.base.constant.Log)")
public void logPointCut(){}
@Before("execution(* com.kuang.service.UserServiceImpl.*(..))")
public void before(){}
@After("execution(* com.kuang.service.UserServiceImpl.*(..))")
public void after(){}
@Around("execution(* com.kuang.service.UserServiceImpl.*(..))")
public void around(ProceedingJoinPoint jp) throws Throwable {}
@AfterReturning(pointcut = "@annotation(com.yzj.jep.app.base.constant.Log)")
public void doAfter(JoinPoint joinPoint){}
@AfterThrowing(value = "logPointcut()", throwing = "exception")
public void afterThrowing(Exception exception) {}
}
注解实现通知高级
若想要在通知方法获取被通知方法的参数共有两种方式:自动获取、手动指定
-
自动获取参数:通知类型可以通过参数JoinPoint或者 ProceedingJoinPoint 自动获取被通知方法的参数值并调用该方法
-
手动指定参数:即在配置切面时,需在切面的通知与切面的切点中明确指定参数。
自动获取参数(略)
手动指定获取参数
- 在@pointcut中切入表达式中使用args声明匹配的参数,注意使用&&连接args
- 在@pointcut中切入表达式中使用参数argNames用来接收AspectJ表达式中的参数,
argNames属性是用于指定在表达式中应用的参数名与Advice方法参数是如何对应的 - 在通知方法中定义参数
// args、argNames的参数名与testArgs()方法中参数名 保持一致
@Before(value = "execution(* com.wener.example.aop.aspect.*.*(..))&& args(id,name)", argNames = "id,name")
public void testArgs(Object id, Object name) {}
// 也可以不用argNames
@Before(value = "execution(* com.wener.example.aop.aspect.*.*(..))&& args(id,name)")
public void testArgs(Object id, Object name) {}
@Around(value = "execution(* com.wener.example.aop.aspect.*.*(..))&&(args(id,name,..))", argNames = "pjp,id,name")
public Object testAroundArgs(ProceedingJoinPoint pjp, Object id, Object name) throws Throwable {}
Spring切点表达式
切面表达式主要由:designators(指示器,匹配java方法),wildcards(通配符),operators(操作运算符)三部分组成
指示器
主要作用就是通过什么样的方式来匹配java类的哪些方法,按着作用来分主要分为 匹配方法(execution),匹配注解(@within,@target,@args,@annotation),匹配包/类型(within()),匹配对象(target,this),匹配参数(args)
支持的指示器
指示器 | 描述 |
---|---|
execution() | 用于匹配方法执行的连接点 |
within() | 用于匹配指定的类及其子类中的所有方法 |
this() | 匹配可以向上转型为this指定的类型的代理对象中的所有方法 |
target() | 匹配可以向上转型为target指定的类型的目标对象中的所有方法 |
args() | 用于匹配运行时传入的参数列表的类型为指定的参数列表类型的方法 |
@within() | 用于匹配持有指定注解的类的所有方法 |
@target() | 用于匹配的持有指定注解目标对象的所有方法 |
@args() | 用于匹配运行时 传入的参数列表的类型持有 注解列表对应的注解的方法 |
@annotation() | 用于匹配持有指定注解的方法 |
bean | bean(Bean的id或名字通配符)匹配特定名称的Bean对象 |
三种通配符
通配符 | 说明 |
---|---|
* | 匹配任何数量字符 |
… | 匹配任何数量字符的重复,如包及其子包、任何数量参数 |
+ | 匹配指定类型的子类型;仅能作为后缀放在类型模式后边 |
操作运算符
AspectJ使用 且(&&)、或(||)、非(!)来组合切入点表达式,由于在xml风格下,由于在XML中使用“&&”需要使用转义字符“&&”来代替之,所以很不方便,因此Spring ASP 提供了and、or、not来代替&&、||、!
execution指示器
粒度最小是达到方法级别,而execution表达式可以用于明确指定方法返回类型,类名,方法名和参数名等与方法相关的部件,并且在Spring中,大部分需要使用AOP的业务场景也只需要达到方法级别即可,因而execution表达式的使用是最为广泛的
execution([方法的可见性] 返回类型 [方法所在类的全路径名] 方法名(参数类型列表) [方法抛出的异常类型])
栗子
-
切面类
@Component @Aspect public class ExecutionAspect { @Pointcut("execution(public * com.wener.example.aop.execution.ExecutionService.test())") public void execuPoint() { } @Before("execution(public * com.wener.example.aop.execution.ExecutionService.add(..))") public void execuBefore() { System.out.println("核心方法之前!!!"); } @Before("execution(public * com.wener.example.aop.execution.ExecutionService.test(..))") public void execuAfter() { System.out.println("核心方法之后!!!"); } }
常见表达式
方法签名定义切入点
匹配所有目标类的public方法,第一个为返回类型,第二个为方法名
execution(public * * (..))
execution(* save* (..))
匹配所有目标类以xxx开头的方法,第一个*代表返回任意类型
execution(* xxx*(..))
匹配目标类所有以xxx结尾的方法,并且其方法的参数表第一个参数可为任意类型,第二个参数必须为String
execution(* *xxx(*,String))
类定义切入点
匹配Service接口及其实现子类中的所有方法
execution(* com.xxx.Service.*(..))
通过包定义切入点
匹配service包下的所有类的所有方法,但不包括子包
execution(* com.xxx.service.*(..))
匹配service包下的所有类的所有方法,包括子包。
# 注意 (当".."出现再类名中时,后面必须跟" * ",表示包、子孙包下的所有类**)
execution(* com.xxx.service..*(..))
匹配xxx包及其子包下的所有后缀名为service的类中,所有方法名必须以select为前缀的方法
execution(* com.xxx..*.*service.select*(..))
方法形参定义切入点
匹配所有方法名为add,且有两个参数,其中,第一个的类型为int 第二个参数是String
execution(* add(int, String))
匹配所有方法名为add,且至少含有一个参数,并且第一个参数为int的方法
execution(* add(int, ..))
注解定义切入点
匹配所有持有com.yzj.jep.app.base.constant包下@Log注解的方法
@Pointcut("@annotation(com.yzj.jep.app.base.constant.Log)")
AOP使用场景
- Authentication 权限管理
- Log 日志记录
- Transactions 事务处理
- Exception 异常处理
- safety control 安全控制
- Caching 缓存
- performance 性能统计 等等