SpringBoot整合AOP及使用案例实战

更新时间：2025年12月08日 11:09:57 作者：BileiX

本文详细介绍了Spring AOP中的切入点表达式,重点讲解了execution表达式的语法和用法,通过案例实战,展示了AOP的基本使用、结合自定义注解以及环绕通知的实现,感兴趣的朋友跟随小编一起看看吧

一、引入依赖

<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-aop</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-web</artifactId>
	</dependency>
</dependencies>

二、切入点表达式详解

切入点表达式用于定义在哪些连接点应用增强，可以组合并使用execution、within 、 @annotation 、@within 、@target、args、bean这几种表达式。

本文只介绍最常用的execution表达式。

execution表达式语法：execution([修饰符] 返回类型 [声明类型].方法名(参数) [异常])

* ：匹配任意数量的字符（除了包分隔符.）
.. ：匹配任意数量的字符（包括包分隔符.）或任意数量的参数
+ ：匹配指定类型的子类型

@Aspect
@Component
public class TestAop {
    // 1.匹配特定类的特定方法
    @Pointcut("execution(public void com.example.demo.controller.AopTestController.testAop(..))")
    public void testAopMethod1() {
    }
    // 2.匹配特定类的特定方法，访问修饰符可以省略
    @Pointcut("execution(void com.example.demo.controller.AopTestController.testAop(..))")
    public void testAopMethod2() {
    }
    // 3.匹配特定类的特定方法，返回值可以使用通配符 * 表示任意返回值
    @Pointcut("execution(* com.example.demo.controller.AopTestController.testAop(..))")
    public void testAopMethod3() {
    }
    // 4.包名可以使用通配符表示任意包，但是有几级包就需要写几个 *
    @Pointcut("execution(* *.*.*.*.AopTestController.testAop(..))")
    public void testAopMethod4() {
    }
    // 5.包名可以使用 .. 表示当前包及其子包
    @Pointcut("execution(* *..AopTestController.testAop(..))")
    public void testAopMethod5() {
    }
    // 6.类名和方法名都可以使用 * 来实现通配
    @Pointcut("execution(* *..*.*(..))")
    public void testAopMethod6() {
    }
    // 7. 匹配特定接口的所有实现方法
    @Pointcut("execution(* com.example.demo.controller.AopTestController+.*(..))")
    public void testAopMethod7() {
    }
}

三、案例实战

1. AOP基本使用

① 待增强的业务代码：

@RestController
public class AopTestController {
    @GetMapping("/testAop")
    public Object testAop() {
        return "testAop";
    }
    @GetMapping("/testAopException")
    public Object testAopException() {
        return 1 / 0;
    }
}

② AOP切面：

@Aspect
@Component
public class AopTestAspect {
    @Pointcut("execution(public * com.example.demo.controller.AopTestController.testAop(..)) " +
            "|| execution(public * com.example.demo.controller.AopTestController.testAopException(..))")
    public void log() {
    }
    @Before("log()")
    public void deBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        System.out.println("URL : " + request.getRequestURL().toString());
        System.out.println("HTTP_METHOD : " + request.getMethod());
        System.out.println("CLASS_METHOD : " + joinPoint);
        System.out.println("ARGS : " + Arrays.toString(joinPoint.getArgs()));
        System.out.println("前置通知：方法执行前执行...");
    }
    //返回通知
    @AfterReturning(returning = "result", pointcut = "log()")
    public void doAfterReturning(Object result) {
        System.out.println("返回通知：方法成功执行并返回后执行...");
        System.out.println("方法的返回值: " + result);
    }
    //异常通知
    @AfterThrowing(throwing = "exception", pointcut = "log()")
    public void doThrowing(JoinPoint joinPoint, Exception exception) {
        System.out.println("异常通知：方法异常时执行...");
        System.out.println("产生异常的方法：" + joinPoint);
        System.out.println("异常种类：" + exception);
    }
    //后置通知
    @After("log()")
    public void doAfter(JoinPoint joinPoint) {
        System.out.println("后置通知：最后且一定执行...");
    }
}

③ 控制台打印：

2. AOP结合自定义注解

① 自定义注解：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LogAnnotation {
    String desc() default " ";
}

② 待增强的业务代码：

@RestController
public class AopTestController {
    @GetMapping("testAopAnnotation")
    @LogAnnotation(desc = "测试注解类型:testAopAnnotation")
    public Object testAopAnnotation() {
        return "testAopAnnotation";
    }
}

③ AOP切面：

@Aspect
@Component
public class AopAnnotationTestAspect {
    @Pointcut(value = "@annotation(com.example.demo.annotation.LogAnnotation)")
    public void logAction() {
    }
    @Before("logAction() && @annotation(logAnnotation)")
    public void doBefore(JoinPoint joinPoint, LogAnnotation logAnnotation) {
        System.out.println("前置通知：方法执行前执行...");
        System.out.println("doBefore注解的值：" + logAnnotation.desc());
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        System.out.println("URL: " + attributes.getRequest().getRequestURL().toString());
    }
    @AfterReturning(returning = "result", pointcut = "logAction() && @annotation(logAnnotation)")
    public void doAfterReturning(Object result, LogAnnotation logAnnotation) {
        System.out.println("doAfterReturning注解的值：" + logAnnotation.desc());
        System.out.println("返回通知：方法成功执行并返回后执行...");
        System.out.println("方法的返回值: " + result);
    }
    @AfterThrowing(throwing = "exception", pointcut = "logAction() && @annotation(logAnnotation)")
    public void doThrows(JoinPoint joinPoint, Exception exception, LogAnnotation logAnnotation) {
        System.out.println("doThrows注解的值" + logAnnotation.desc());
        System.out.println("异常通知：方法异常时执行...");
        System.out.println("产生异常的方法：" + joinPoint);
        System.out.println("异常种类：" + exception);
    }
    @After("logAction() && @annotation(logAnnotation)")
    public void doAfter(JoinPoint joinPoint, LogAnnotation logAnnotation) {
        System.out.println("doAfter注解的值：" + logAnnotation.desc());
        System.out.println("后置通知：最后且一定执行...");
    }
}

④ 控制台打印：

3. 环绕通知

1. 非注解模式

① 待增强业务代码：

@RestController
public class AopTestController {
    @GetMapping("/testAopAround")
    public Object testAopAround() {
        return "testAopAround";
    }
}

② AOP切面：

@Aspect
@Component
public class AopAroundTestAspect {
    @Pointcut("execution(public * com.example.demo.controller.AopTestController.testAopAround(..))")
    public void logAround() {
    }
    @Around("logAround()")
    public Object aroundAdvice(ProceedingJoinPoint proceedingJoinPoint) {
        try {
            Object[] args = proceedingJoinPoint.getArgs();
            System.out.println("通知类中的aroundAdvice方法执行前...");
            // 明确调用切入点方法
            Object resValue = proceedingJoinPoint.proceed(args);
            System.out.println("通知类中的aroundAdvice方法执行后...返回值：" + resValue);
            return resValue;
        } catch (Throwable e) {
            System.out.println("通知类中的aroundAdvice方法执行异常...");
            throw new RuntimeException(e);
        } finally {
            System.out.println("通知类中的aroundAdvice方法执行完成...");
        }
    }
}

③ 控制台打印：

2. 注解模式

① 自定义注解：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LogAnnotation {
    String desc() default " ";
}

② 待增强的业务代码：

@RestController
public class AopTestController {
    @GetMapping("/testAopAroundAnnotation")
    @LogAnnotation(desc = "测试注解类型:testAopAroundAnnotation")
    public Object testAopAroundAnnotation(){
        return "testAopAroundAnnotation";
    }
}

③ AOP切面：

@Aspect
@Component
public class AopAroundAnnotationTestAspect {
    @Pointcut(value = "@annotation(com.example.demo.annotation.LogAnnotation)")
    public void logAroundAnnotation() {
    }
    @Around("logAroundAnnotation() && @annotation(logAnnotation)")
    public Object aroundAnnotationAdvice(ProceedingJoinPoint proceedingJoinPoint, LogAnnotation logAnnotation) {
        try {
            System.out.println("logAnnotation注解的值：" + logAnnotation.desc());
            Object[] args = proceedingJoinPoint.getArgs();
            System.out.println("通知类中的aroundAnnotationAdvice方法执行前...");
            // 明确调用切入点方法
            Object resValue = proceedingJoinPoint.proceed(args);
            System.out.println("通知类中的aroundAnnotationAdvice方法执行后...返回值：" + resValue);
            return resValue;
        } catch (Throwable e) {
            System.out.println("通知类中的aroundAnnotationAdvice方法执行异常...");
            throw new RuntimeException(e);
        } finally {
            System.out.println("通知类中的aroundAnnotationAdvice方法执行完成...");
        }
    }
}

④ 控制台打印：

到此这篇关于SpringBoot整合AOP及使用案例实战的文章就介绍到这了,更多相关SpringBoot整合AOP内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

扩展tk.mybatis的流式查询功能实现
mybatis查询默认是一次获取全部，如果数据过于庞大，就会导致OOM问题，本文就介绍了tk.mybatis 流式查询，具有一定的参考价值，感兴趣的可以了解一下
2021-12-12
大数据 java hive udf函数的示例代码（手机号码脱敏）
这篇文章主要介绍了大数据 java hive udf函数（手机号码脱敏）,的相关知识，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-06-06
JPA中EntityListeners注解的使用详解
这篇文章主要介绍了JPA中EntityListeners注解的使用详解，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-01-01
Java查找并高亮PDF文本过程解析
这篇文章主要介绍了Java查找并高亮PDF文本过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
Java图片处理之获取gif图一帧图片的两种方法
这篇文章主要给大家介绍了关于Java图片处理之获取gif图一帧图片的两种方法，分别是利用Java原生代码和使用im4java调用ImageMagick来实现，两种方法都给出来示例代码供大家参考学习，需要的朋友们下面来一起看看吧。
2017-10-10
Java随手笔记8之包、环境变量和访问控制及maven profile实现多环境打包
这篇文章主要介绍了Java随手笔记8之包、环境变量和访问控制及maven profile实现多环境打包的相关资料,需要的朋友可以参考下
2015-11-11
Java解密微信小程序手机号的方法
这篇文章主要为大家详细介绍了Java解密微信小程序手机号的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-12-12
SpringBoot自定义Starter的教程指南
SpringBoot的Starter自动配置机制极大地简化了依赖管理和应用配置,使得开发者可以以最少的配置快速启动和运行Spring应用,有时,标准的Starter可能无法满足特定需求,需要创建自定义Starter,所以本文给大家介绍了SpringBoot自定义Starter的教程指南
2024-11-11
深度解析Spring AOP @Aspect 原理、实战与最佳实践教程
文章系统讲解了Spring AOP核心概念、实现方式及原理,涵盖横切关注点分离、代理机制（JDK/CGLIB）、切入点类型、性能优化、常见陷阱及解决方案,并对比了SpringAOP与AspectJ的编译时织入特性,强调合理应用场景与避免滥用的重要性,感兴趣的朋友一起看看吧
2025-06-06
Java函数式编程(十一)：遍历目录
这篇文章主要介绍了Java函数式编程(十一)：遍历目录,本文是系列文章的第11篇,其它文章请参阅本文底部的相关文章,需要的朋友可以参考下
2014-09-09