springboot中的5种通知的小例子
1.环境搭建
- pom中导入
<!--增加AOP需要的包--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
application.properties文件中配置
#Spring AOP
spring.aop.auto=true
spring.aop.proxy-target-class=true
类上面增加@Aspect标注
2.切入点表达式
/** * 定义一个方法, 用于声明切入点表达式. 一般地, 该方法中再不需要添入其他的代码. * 使用 @Pointcut 来声明切入点表达式. * 后面的其他通知直接使用方法名来引用当前的切入点表达式. * (..)表示任意参数 / @Pointcut("execution(public int com.jztey.omronhealth.service.ArithmeticCalculator.(..))") public void declareJointPointExpression() { }
3.前置通知
//声明该方法执行之前执行,前置通知
//直接导入切面点,上面的
@Before("declareJointPointExpression()")
public void beforeMethod(JoinPoint joinPoint) {
String methodName = joinPoint.getSignature().getName();
Object[] args = joinPoint.getArgs();
System.out.println("这是切面开始打印出来的--->The method " + methodName + " begins with " + Arrays.asList(args));
}
4.后置通知
//后置通知:在目标方法执行后(无论是否发生异常),执行通知
//在后置通知中还不能访问目标方法的执行的结果,不是在执行方法后调用的
/**
* 这是切面开始打印出来的--->The method add begins with [3, 5]
* 这是切面结束打印出来的--->The method add ends
* 和--->8
*/
@After("declareJointPointExpression()")
public void afterMethod(JoinPoint joinPoint) {
String methodName = joinPoint.getSignature().getName();
System.out.println("这是切面结束打印出来的--->The method " + methodName + " ends");
}
5.带有返回值通知
/**
* 带有返回值的切面
* 在方法法正常结束受执行的代码
* 返回通知是可以访问到方法的返回值的!
* 可以使用returning = "result"进行获取后得到
*/
@AfterReturning(value = "declareJointPointExpression()",
returning = "result")
public void afterReturning(JoinPoint joinPoint, Object result) {
String methodName = joinPoint.getSignature().getName();
System.out.println("The method " + methodName + " ends with " + result);
}
6.异常通知
/**
* 异常处理切面
* 在目标方法出现异常时会执行的代码.
* 可以访问到异常对象; 且可以指定在出现特定异常时在执行通知代码
*/
@AfterThrowing(value = "declareJointPointExpression()",
throwing = "e")
public void afterThrowing(JoinPoint joinPoint, Exception e) {
String methodName = joinPoint.getSignature().getName();
System.out.println("The method " + methodName + " occurs excetion:" + e);
}
7.环绕通知
/**
-
环绕切面,一般用的不是很多,类似于动态代理,可以包含前面4种的任意个
-
环绕通知需要携带 ProceedingJoinPoint 类型的参数.
-
环绕通知类似于动态代理的全过程: ProceedingJoinPoint 类型的参数可以决定是否执行目标方法.
-
且环绕通知必须有返回值, 返回值即为目标方法的返回值 / / @Around("execution(public int com.atguigu.spring.aop.ArithmeticCalculator.*(..))") public Object aroundMethod(ProceedingJoinPoint pjd){
Object result = null; String methodName = pjd.getSignature().getName(); try { //前置通知 System.out.println("The method " + methodName + " begins with " + Arrays.asList(pjd.getArgs())); //执行目标方法 result = pjd.proceed(); //返回通知 System.out.println("The method " + methodName + " ends with " + result); } catch (Throwable e) { //异常通知 System.out.println("The method " + methodName + " occurs exception:" + e); throw new RuntimeException(e); } //后置通知 System.out.println("The method " + methodName + " ends"); return result;
} */
优先级
/**
- 可以使用 @Order 注解指定切面的优先级, 值越小优先级越高 */ @Order(2)
完整的切面例子
//通过添加 @Aspect 注解声明一个 bean 是一个切面!
/**
-
可以使用 @Order 注解指定切面的优先级, 值越小优先级越高 */ @Order(2) @Aspect @Component @Slf4j public class LoggingAspect {
/**
- 定义一个方法, 用于声明切入点表达式. 一般地, 该方法中再不需要添入其他的代码.
- 使用 @Pointcut 来声明切入点表达式.
- 后面的其他通知直接使用方法名来引用当前的切入点表达式.
- (..)表示任意参数 / @Pointcut("execution(public int com.jztey.omronhealth.service.ArithmeticCalculator.(..))") public void declareJointPointExpression() { }
//声明该方法执行之前执行,前置通知 //直接导入切面点,上面的 @Before("declareJointPointExpression()") public void beforeMethod(JoinPoint joinPoint) { String methodName = joinPoint.getSignature().getName(); Object[] args = joinPoint.getArgs();
System.out.println("这是切面开始打印出来的--->The method " + methodName + " begins with " + Arrays.asList(args));
}
//后置通知:在目标方法执行后(无论是否发生异常),执行通知 //在后置通知中还不能访问目标方法的执行的结果,不是在执行方法后调用的
/**
- 这是切面开始打印出来的--->The method add begins with [3, 5]
- 这是切面结束打印出来的--->The method add ends
- 和--->8 */ @After("declareJointPointExpression()") public void afterMethod(JoinPoint joinPoint) { String methodName = joinPoint.getSignature().getName(); System.out.println("这是切面结束打印出来的--->The method " + methodName + " ends"); }
/**
- 带有返回值的切面
- 在方法法正常结束受执行的代码
- 返回通知是可以访问到方法的返回值的!
- 可以使用returning = "result"进行获取后得到 */ @AfterReturning(value = "declareJointPointExpression()", returning = "result") public void afterReturning(JoinPoint joinPoint, Object result) { String methodName = joinPoint.getSignature().getName(); System.out.println("The method " + methodName + " ends with " + result); }
/**
- 异常处理切面
- 在目标方法出现异常时会执行的代码.
- 可以访问到异常对象; 且可以指定在出现特定异常时在执行通知代码 / @AfterThrowing(value = "declareJointPointExpression()", throwing = "e") public void afterThrowing(JoinPoint joinPoint, Exception e) { String methodName = joinPoint.getSignature().getName(); System.out.println("The method " + methodName + " occurs excetion:" + e); } /*
-
环绕切面,一般用的不是很多,类似于动态代理,可以包含前面4种的任意个
-
环绕通知需要携带 ProceedingJoinPoint 类型的参数.
-
环绕通知类似于动态代理的全过程: ProceedingJoinPoint 类型的参数可以决定是否执行目标方法.
-
且环绕通知必须有返回值, 返回值即为目标方法的返回值 / / @Around("execution(public int com.atguigu.spring.aop.ArithmeticCalculator.*(..))") public Object aroundMethod(ProceedingJoinPoint pjd){
Object result = null; String methodName = pjd.getSignature().getName(); try { //前置通知 System.out.println("The method " + methodName + " begins with " + Arrays.asList(pjd.getArgs())); //执行目标方法 result = pjd.proceed(); //返回通知 System.out.println("The method " + methodName + " ends with " + result); } catch (Throwable e) { //异常通知 System.out.println("The method " + methodName + " occurs exception:" + e); throw new RuntimeException(e); } //后置通知 System.out.println("The method " + methodName + " ends"); return result;
} */ }