AOP 切面编程

简介: AOP(面向切面编程)通过动态代理在不修改源码的前提下,对方法进行增强。核心概念包括连接点、通知、切入点、切面和目标对象。常用于日志记录、权限校验、性能监控等场景,结合Spring AOP与@Aspect、@Pointcut等注解,实现灵活的横切逻辑管理。

什么是 AOP ?

AOP

  • Aspect Oriented Programming(面向切面编程、面向方面编程),其实就是面向特定方法编程。

实现:

  • 动态代理是面向切面编程最主流的实现。而SpringAOPSpring框架的高级技术,旨在管理bean对象的过程中,主要通过底层的动态代理机制,对特定的方法进行编程。

AOP 核心概念

  • 连接点: JoinPoint, 可以被AOP控制的方法(暗含方法执行时的相关信息)
  • 通知: Advice, 指哪些重复的逻辑,也就是共性功能(最终体现为一个方法)
  • 切入点: PointCut, 匹配连接点的条件,通知仅会在切入点方法执行时被应用
  • 切面: Aspect, 描述通知与切入点的对应关系(通知+切入点)
  • 目标对象: Target, 通知所应用的对象

场景说明

例如现有一个场景:定位执行耗时较长的业务方法,统计各个业务层方法的执行耗时

@Component
@Aspect // 切面类
@Slf4j
public class TimeAspect {
   
    @Around ("execution (* com.itheima.service.impl.DeptServiceImpl.list ())")  // 切面表达式
    public Object recordTime (ProceedingJoinPoint joinPoint) throws Throwable {
    
    long begin = System.currentTimeMillis ();
        // 调用原始操作
    Object result = joinPoint.proceed (); 
    long end = System.currentTimeMillis ();
    log.info("执行耗时 : {} ms", (end-begin));
    return result;
    }
}

// 目标对象
@Service
public class DeptServiceImpl implements DeptService {
   
    @Autowired
    private DeptMapper deptMapper;

    // region-begin 连接点 
    @Override
    public List<Dept> list() {
   
        List<Dept> deptList = deptMapper.list(); // 切入点
        return deptList;
    }

    @Override
    public void delete(Integer id) {
   
        deptMapper.delete(id);
    }

    @Override
    public void save(Dept dept) {
   
        dept.setCreateTime(LocalDateTime.now());
        dept.setUpdateTime(LocalDateTime.now());
        deptMapper.save(dept);
    }
    // region-end 连接点 
}

对于aop的五大核心概念,我们可以使用更加通俗易懂的类比来说明:

可以用 "学校检查卫生" 来类比:

  • 连接点:学校里所有可能被检查的班级(每个班级都是一个潜在的检查点)
  • 通知:检查卫生的具体操作流程(比如看地面是否干净、桌椅是否整齐,这是一套固定重复的动作)
  • 切入点:筛选要检查的班级的条件(比如 "只查一年级的班级" 或 "只查偶数号的班级")
  • 切面:检查计划(把 "检查流程" 和 "筛选条件" 结合起来,比如 "用标准流程检查所有一年级班级")
  • 目标对象:最终被检查的那些班级(符合筛选条件,实际接受检查的对象)

简单来说就是:学校(AOP)要检查卫生(通知),所有的班级都可能被抽查到(连接点),但是只会查到一年级的(切入点),"用标准流程查一年级班级" 这个整体安排就是切面,而被查到的那些一年级班级就是目标对象。

特别注意:连接点

  • 在Spring中用JoinPoint抽象了连接点,用它可以获得方法执行时的相关信息,如目标类名、方法名、方法参数等。

    • 对于 @Around 通知,获取连接点信息只能使用 ProceedingJoinPoint
    • 对于其他四种通知,获取连接点信息只能使用 JoinPoint,它是 ProceedingJoinPoint 的父类型

通知类型

通知类型

  1. **@Around**:环绕通知,此注解标注的通知方法在目标方法前、后都被执行(常用)
  2. @Before:前置通知,此注解标注的通知方法在目标方法前被执行
  3. @After:后置通知,此注解标注的通知方法在目标方法后被执行,无论是否有异常都会执行
  4. @AfterReturning:返回后通知,此注解标注的通知方法在目标方法后被执行,有异常不会执行
  5. @AfterThrowing:异常后通知,此注解标注的通知方法发生异常后执行

注意事项

  • @Around环绕通知需要自己调用 ProceedingJoinPoint.proceed() 来让原始方法执行,其他通知不需要考虑目标方法执行
  • @Around环绕通知方法的返回值,必须指定为Object,来接收原始方法的返回值。

通知顺序

当有多个切面的切入点都匹配到了目标方法,目标方法运行时,多个通知方法都会被执行。

执行顺序

  1. 不同切面类中,默认按照切面类的类名字母排序:
    • 目标方法前的通知方法:字母排名靠前的先执行
    • 目标方法后的通知方法:字母排名靠前的后执行
  1. @Order(数字) 加在切面类上来控制顺序
    • 目标方法前的通知方法:数字小的先执行
    • 目标方法后的通知方法:数字小的后执行

@PointCut

该注解的作用是将公共的切点表达式抽取出来,需要用到时引用该切点表达式即可。

@Pointcut("execution(* com.itheima.service.impl.DeptServiceImpl.*(..))")
public void pt(){
   }

@Around("pt()")
public Object recordTime(ProceedingJoinPoint joinPoint) throws Throwable {
   
    // 方法体内容
}

切入点表达式

execution

execution 主要根据方法的返回值、包名、类名、方法名、方法参数等信息来匹配,语法为:

execution(访问修饰符? 返回值 包名.类名.?方法名(方法参数) throws 异常?)
  • 可以使用通配符描述切入点

    • *:单个独立的任意符号,可以通配任意返回值、包名、类名、方法名、任意类型的一个参数,也可以通配包、类、方法名的一部分
      execution(* com.**.service.**.update*(*))
    • ..:多个连续的任意符号,可以通配任意层级的包,或任意类型、任意个数的参数
      execution(* com.itheima..DeptService.*(..))

切入点表达式-@annotation

  • @annotation切入点表达式,用于匹配标识有特定注解的方法。
    @annotation(com.itheima.anno.Log)
@Before("@annotation(com.itheima.anno.Log)")
public void before(){
   
    log.info("before ....");
}

Spring 实战代码演示

依赖导入

引入aop依赖

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

日志响应拦截

主要作用:对controller上的

@Around("execution(* com.lantzuc.lanucbackend.controller.*.*(..))")
public Object doInterceptor(ProceedingJoinPoint joinPoint) throws Throwable {
   
    // 开始计时
    StopWatch stopWatch = new StopWatch();
    stopWatch.start();

    // 获取请求路径
    RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
    HttpServletRequest servletRequest = ((ServletRequestAttributes) requestAttributes).getRequest();

    // 生成唯一请求id
    String requestId = UUID.randomUUID().toString();
    String url = servletRequest.getRequestURI();

    // 获取请求参数
    Object[] args = joinPoint.getArgs();
    String reqParams = "[" + StringUtils.join(args, ", ") + "]";

    // 输出请求日志
    log.info("request start,id: {}, path: {}, ip: {}, params: {}", requestId, url,
             servletRequest.getRemoteHost(), reqParams);

    // 执行原方法
    Object result = joinPoint.proceed();

    // 输出原日志
    stopWatch.stop();
    long totalTimeMillis = stopWatch.getTotalTimeMillis();
    log.info("request end, id: {}, cost: {}ms", requestId, totalTimeMillis);

    return result;
}

结果显示

2025-10-15 17:13:48.649  INFO 23396 --- [nio-8080-exec-5] c.l.lanucbackend.aop.LogInterceptor      : request start,id: ad4061ee-d5ed-47f3-bf2e-e0567867fabc, path: /api/user/login, ip: 0:0:0:0:0:0:0:1, params: [UseLoginRequest(userAccount=Lantz, userPassword=12345678), org.apache.catalina.connector.RequestFacade@6ce7aed7]

2025-10-15 17:13:49.265  INFO 23396 --- [nio-8080-exec-5] c.l.lanucbackend.aop.LogInterceptor      : request end, id: ad4061ee-d5ed-47f3-bf2e-e0567867fabc, cost: 623ms

相比原来没有添加日志拦截的,我们可以更加清晰地看到对某一路径发送请求的状态,比如请求路径,请求参数,IP 地址等等信息,而且我们还可以获悉到某一请求的执行时间是多少,可以在后续有针对的目的优化

权限响应拦截

首先要创建一个注解:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AuthCheck {
   
    /**
     * 必须有某一个角色(默认无)
     * @return
     */
    String mustRole() default "";
}

然后再编写权限校验拦截代码:

@Around("@annotation(authCheck)")
public Object doInterceptor(ProceedingJoinPoint joinPoint, AuthCheck authCheck) throws Throwable {
   

    String mustRole = authCheck.mustRole();
    RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
    HttpServletRequest httpServletRequest = ((ServletRequestAttributes) requestAttributes).getRequest();
    // 当前登录用户
    User loginUer = userService.getLoginUer(httpServletRequest);
    UserRoleEnum mustRoleEnum = UserRoleEnum.getEnumByValue(mustRole);
    // 不需要权限,放行
    if (mustRoleEnum == null) {
   
        return joinPoint.proceed();
    }

    // 必须有该权限才放行
    UserRoleEnum userRoleEnum = UserRoleEnum.getEnumByValue(loginUer.getUserRole());
    if (userRoleEnum == null) {
   
        throw new BusinessException(ErrorCode.NO_AUTH);
    }
    // 如果被封号,直接拒绝
    if (UserRoleEnum.BAN.equals(userRoleEnum)) {
   
        throw new BusinessException(ErrorCode.NO_AUTH);
    }
    // 必需有管理员权限
    if (UserRoleEnum.ADMIN.equals(mustRoleEnum)) {
   
        // 用户没有管理员权限,拒绝
        if (!UserRoleEnum.ADMIN.equals(userRoleEnum)) {
   
            throw new BusinessException(ErrorCode.NO_AUTH);
        }
    }

    // 通过管理权限,放行
    return joinPoint.proceed();
}

controller中使用:

@GetMapping("/search")
@AuthCheck(mustRole = ADMIN_ROLE) // 需要管理员权限
public List<User> searchUser(String userName, HttpServletRequest request){
   
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    if (StringUtils.isNotBlank(userName)) {
   
        queryWrapper.like("userName", userName);
    }
    List<User> userList = userService.list(queryWrapper);
    return userList.stream().map(user -> userService.getSafetyUser(user)).collect(Collectors.toList());
}

测试结果:

如果登录用户为管理员则正常通过,如果不是,则会报错:

img

Postman Body显示:

{
   
  "code": 40101,
  "data": null,
  "message": "无权限",
  "description": ""
}

记得如果使用了jwt鉴权,在Postman中测试的时候记得选择Bearer Token然后粘贴进去登录时候产生的Token

相关文章
|
2月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
405 0
|
1月前
|
XML Java 数据格式
《深入理解Spring》:AOP面向切面编程深度解析
Spring AOP通过代理模式实现面向切面编程,将日志、事务等横切关注点与业务逻辑分离。支持注解、XML和编程式配置,提供五种通知类型及丰富切点表达式,助力构建高内聚、低耦合的可维护系统。
|
3月前
|
人工智能 监控 安全
Spring AOP切面编程颠覆传统!3大核心注解+5种通知类型,让业务代码纯净如初
本文介绍了AOP(面向切面编程)的基本概念、优势及其在Spring Boot中的使用。AOP作为OOP的补充,通过将横切关注点(如日志、安全、事务等)与业务逻辑分离,实现代码解耦,提升模块化程度、可维护性和灵活性。文章详细讲解了Spring AOP的核心概念,包括切面、切点、通知等,并提供了在Spring Boot中实现AOP的具体步骤和代码示例。此外,还列举了AOP在日志记录、性能监控、事务管理和安全控制等场景中的实际应用。通过本文,开发者可以快速掌握AOP编程思想及其实践技巧。
|
3月前
|
监控 Java Spring
AOP切面编程快速入门
AOP(面向切面编程)通过分离共性逻辑,简化代码、减少冗余。它通过切点匹配目标方法,在不修改原方法的前提下实现功能增强,如日志记录、性能监控等。核心概念包括:连接点、通知、切入点、切面和目标对象。Spring AOP支持多种通知类型,如前置、后置、环绕、返回后、异常通知,灵活控制方法执行流程。通过@Pointcut可复用切点表达式,提升维护性。此外,结合自定义注解,可实现更清晰的切面控制。
324 5
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
AOP(面向切面编程)能够帮助我们在不修改现有代码的前提下,为应用程序添加新的功能或行为。Micronaut框架中的AOP模块通过动态代理机制实现了这一目标。AOP将横切关注点(如日志记录、事务管理等)从业务逻辑中分离出来,提高模块化程度。在Micronaut中,带有特定注解的类会在启动时生成代理对象,在运行时拦截方法调用并执行额外逻辑。例如,可以通过创建切面类并在目标类上添加注解来记录方法调用信息,从而在不侵入原有代码的情况下增强应用功能,提高代码的可维护性和可扩展性。
294 1
|
7月前
|
人工智能 监控 Java
面向切面编程(AOP)介绍--这是我见过最易理解的文章
这是我见过的最容易理解的文章,由浅入深介绍AOP面向切面编程,用科普版和专家版分别解说,有概念,有代码,有总结。
|
安全 Java 编译器
什么是AOP面向切面编程?怎么简单理解?
本文介绍了面向切面编程(AOP)的基本概念和原理,解释了如何通过分离横切关注点(如日志、事务管理等)来增强代码的模块化和可维护性。AOP的核心概念包括切面、连接点、切入点、通知和织入。文章还提供了一个使用Spring AOP的简单示例,展示了如何定义和应用切面。
1393 1
什么是AOP面向切面编程?怎么简单理解?
|
XML Java 开发者
论面向方面的编程技术及其应用(AOP)
【11月更文挑战第2天】随着软件系统的规模和复杂度不断增加,传统的面向过程编程和面向对象编程(OOP)在应对横切关注点(如日志记录、事务管理、安全性检查等)时显得力不从心。面向方面的编程(Aspect-Oriented Programming,简称AOP)作为一种新的编程范式,通过将横切关注点与业务逻辑分离,提高了代码的可维护性、可重用性和可读性。本文首先概述了AOP的基本概念和技术原理,然后结合一个实际项目,详细阐述了在项目实践中使用AOP技术开发的具体步骤,最后分析了使用AOP的原因、开发过程中存在的问题及所使用的技术带来的实际应用效果。
291 5
|
XML Java 数据格式
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
这篇文章是Spring5框架的AOP切面编程教程,通过XML配置方式,详细讲解了如何创建被增强类和增强类,如何在Spring配置文件中定义切入点和切面,以及如何将增强逻辑应用到具体方法上。文章通过具体的代码示例和测试结果,展示了使用XML配置实现AOP的过程,并强调了虽然注解开发更为便捷,但掌握XML配置也是非常重要的。
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
【9月更文挑战第9天】AOP(面向切面编程)通过分离横切关注点提高模块化程度,如日志记录、事务管理等。Micronaut AOP基于动态代理机制,在应用启动时为带有特定注解的类生成代理对象,实现在运行时拦截方法调用并执行额外逻辑。通过简单示例展示了如何在不修改 `CalculatorService` 类的情况下记录 `add` 方法的参数和结果,仅需添加 `@Loggable` 注解即可。这不仅提高了代码的可维护性和可扩展性,还降低了引入新错误的风险。
143 13
下一篇
oss云网关配置