SpringBoot利用自定义注解实现AOP
java
本文主要讲解利用SpringBoot
的自定义注解来实现AOP
思想。
在开始所有的操作之前,需要导入aop坐标:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
如何自定义注解?
实际上注解本质上是一个@interface
类,在这个类前面可以通过一些注解来限制这个注解类的使用范围,比如@Target
、@Retention
等等,有关这方面的文章用搜索引擎可以搜出一大把。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WriteLog {
String note() default "";
}
自定义注解AOP的切面
切面是有一系列切点与增强组成,所以在@Aspect
所注解的类中,需要配置切点与增强,
切点
使用@Pointcut
注解,然并通过@annontation
、execution()
等方法缺陷切点的范围;
这里因为是使用自定义注解的形式来指定切点,所以是使用@annontation
的形式,前提是需要在被增强的方法或者类前面添加自定义的注解。
/**
* 定义切点
* @param writeLog
*/
@Pointcut("@annotation(writeLog)")
public void writeLogPoincut(WriteLog writeLog) {
}
/**
* 还可以这样定义,但是这样增强就无法获取切点信息
*/
@Pointcut("@annotation(com.songwh.annontation.annontation.WriteLog)")
public void writeLogPoincut() {
}
增强
在AOP
中的增强主要是以下几种:
- Before,在被增强的代码执行之前执行;
- After,在被增强的代码执行之后执行
- AfterReturning,在被增强的代码正确返回后执行,通过
returning
可以获取返回值; - Around,在被增强的代码执行前和执行后都会执行,主要是通过
ProceedingJoinPoint.process()
方法来调用被增强代码; - AgterThrowing,在被增强代码出现异常后执行,可以捕捉到异常的信息,可以通过
throwing
来获取异常对象。
@Component
@Aspect
public class WriteLogAspect {
private final static Logger LOGGER = LoggerFactory.getLogger(WriteLogAspect.class);
private final static String POINT_CUT = "writeLogPoincut(writeLog)";
/**
* 定义切点
* @param writeLog
*/
@Pointcut("@annotation(writeLog)")
public void writeLogPoincut(WriteLog writeLog) {
}
/**
* 还可以这样定义,但是这样,增强就无法获取切点信息
*/
// @Pointcut("@annotation(com.songwh.annontation.annontation.WriteLog)")
// public void writeLogPoincut() {
//
// }
/**
* 在主程序出现异常后执行
* @param joinPoint
* @param ex
* @param writeLog
*/
@AfterThrowing(value = POINT_CUT, throwing = "ex")
public void doAfterThrowing(JoinPoint joinPoint, Throwable ex, WriteLog writeLog) {
commonLog(joinPoint, writeLog, "AfterThrowing");
LOGGER.info("出现异常:" + ex.getMessage());
}
/**
* 在主程序执行前执行
* @param joinPoint
* @param writeLog
*/
@Before(value = POINT_CUT)
public void doBefore(JoinPoint joinPoint, WriteLog writeLog) {
commonLog(joinPoint, writeLog, "Before");
}
/**
* 在主程序执行后的增强
* @param joinPoint
* @param writeLog
*/
@After(value = POINT_CUT)
public void doAfter(JoinPoint joinPoint, WriteLog writeLog) {
commonLog(joinPoint, writeLog, "After");
}
/**
* 正确返回后执行的增强
* @param joinPoint
* @param rt
* @param writeLog
*/
@AfterReturning(value = POINT_CUT, returning = "rt")
public void doAfterReturning(JoinPoint joinPoint, Object rt, WriteLog writeLog) {
commonLog(joinPoint, writeLog, "AfterReturning");
LOGGER.info("返回值:" + rt);
}
/**
* 此处必须有返回值,不然是无法
*
* @param proceedingJoinPoint
* @param writeLog
* @return
*/
@Around(value = POINT_CUT)
public Object doAround(ProceedingJoinPoint proceedingJoinPoint, WriteLog writeLog) throws Throwable {
commonLog(proceedingJoinPoint, writeLog, "doAround-before");
Object proceed = null;
// 如果需要使用异常捕获AfterThrowing,此处的异常一改抛出,不能try catch
proceed = proceedingJoinPoint.proceed();
//此处对返回值的修改是有效的
proceed = "around修改后的返回值";
commonLog(proceedingJoinPoint, writeLog, "doAround-after");
return proceed;
}
private void commonLog(JoinPoint joinPoint, WriteLog writeLog, String action) {
Object[] args = joinPoint.getArgs();
LOGGER.info("******************" + action + ":" + writeLog.note() + "******************");
LOGGER.info("方法名:" + joinPoint.getSignature().getName());
LOGGER.info("参数:" + new Gson().toJson(args));
}
}
AOP的运行顺序
在面向切面编程的过程中AOP
的执行顺序是:Around-before
>>Befer
>>主程序执行
>>Around-after
>>After
>>AfterReturning
>>End
。
各切点增强的执行顺序
如果是AfterThrowing
则则执行顺序是:Around-before
>>Befer
>>主程序执行
>>AfterThrowing
>>End
。
程序出现异常的增强执行顺序
重点
Around
增强执行后的返回值一定要返回,否则返回值是null
;- 如果既有
Around
又有AfterThrowing
两个增强,那么Around
增强里面执行主程序的异常不能进行try catch
,否则,AfterThrowing
将无法正常捕获异常。![enter
原文地址:https://www.cnblogs.com/alltoforever/p/10308365.html
时间: 2024-11-05 13:34:59