18:面向切面编程-Java Spring

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 18:面向切面编程-Java Spring

18.1 AOP是什么

AOP(Aspect-Oriented Programming,面向切面编程)是一种编程范式,旨在解决软件系统中跨越多个组件的横切关注点(cross-cutting concerns)。这些关注点是系统中分散但又相互关联的功能,如日志记录、事务管理、安全认证(如JWT)、性能监控等,它们往往贯穿于多个业务模块,如果按照传统的面向对象编程(OOP)方式实现,会导致代码重复和模块间的紧耦合。AOP通过提供一种新的结构化方法,允许开发者将这些横切关注点从主业务逻辑中分离出来,并集中到专门的“切面”(Aspects)中进行管理和维护,从而提高代码的可读性、可重用性和可维护性。

18.2 Spring 的 AOP 实现机制

Spring AOP 实现基于动态代理技术,具体分为以下步骤:

  1. 切面(Aspect):切面是包含通知(Advice)和切点(Pointcut)定义的模块化单元。通知是实际在特定连接点(Join Point)上执行的代码片段,如前置通知(Before Advice)、后置通知(After Advice)、环绕通知(Around Advice)、异常通知(AfterThrowing Advice)等。切点则是定义了哪些连接点(通常是方法调用)应该受到通知的影响。
  2. 连接点(Join Point):在Spring AOP中,连接点通常指代方法执行、方法调用这样的执行点。理论上,任何在程序执行过程中明确的点都可以作为连接点,但Spring仅支持方法级别的连接点。
  3. 通知(Advice):通知定义了在切点上执行的额外行为。如:
  • 前置通知(Before Advice):在切点方法执行前执行。
  • 后置通知(After Advice):在切点方法正常完成后执行(无论方法是否抛出异常)。
  • 环绕通知(Around Advice):包围切点方法执行,可以控制何时执行切点方法、何时返回结果以及是否抛出异常。
  • 异常通知(AfterThrowing Advice):在切点方法抛出异常后执行。
  • 最终通知(After (finally) Advice):无论切点方法是否正常结束、是否抛出异常,都会执行的通知。
  1. 切点(Pointcut):切点是一个或一组连接点的集合,通过切点表达式(Pointcut Expression)来定义。Spring使用AspectJ Pointcut Expression Language (AJDT/AspectJ PEP)来描述切点,如方法名、参数类型、注解等条件,以便精确匹配需要进行增强的方法。
  2. 代理(Proxy):Spring AOP通过生成代理对象来实现切面的织入。对于使用接口的代理对象,Spring默认使用JDK动态代理;对于没有接口的类,Spring使用CGLIB库来创建子类代理。代理对象在方法调用时,会根据切面的定义执行相应的通知逻辑。

Spring AOP 的实现机制涉及到多个组件和类的协作,以下是一个简化版的示例代码,展示如何使用 Spring AOP 实现一个简单的日志切面。这个例子仅作为理解Spring AOP实现机制的入门参考,实际应用中可能需要考虑更多细节和配置。

首先,定义一个简单的业务接口和实现:

// 业务接口
public interface BusinessService {
    void doBusiness();
}
// 业务实现
@Service
public class BusinessServiceImpl implements BusinessService {
    @Override
    public void doBusiness() {
        System.out.println("Doing business...");
    }
}

然后,创建一个切面(Aspect),包含切点(Pointcut)定义和通知(Advice):

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class LoggingAspect {
    private static final Logger log = LoggerFactory.getLogger(LoggingAspect.class);
    /**
     * 定义切点,匹配所有BusinessService接口下的doBusiness方法
     */
    @Pointcut("execution(* com.example.BusinessService.doBusiness(..))")
    public void businessMethodExecution() {
        // 这里无需编写代码,仅用于定义切点
    }
    /**
     * 定义环绕通知,将在切点方法执行前后执行
     */
    @Around("businessMethodExecution()")
    public void logAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 前置通知:方法执行前记录开始日志
        log.info("Starting method: {}", joinPoint.getSignature().getName());
        // 继续执行原方法
        Object result = joinPoint.proceed();
        // 后置通知:方法执行后记录结束日志
        log.info("Finished method: {}, result: {}", joinPoint.getSignature().getName(), result);
    }
}

在这个示例中:

  • LoggingAspect类使用@Aspect@Component注解,表明它是一个Spring托管的切面组件。
  • @Pointcut注解定义了切点businessMethodExecution,它匹配BusinessService接口的doBusiness方法。
  • @Around注解定义了一个环绕通知logAround,当切点方法被调用时,这个通知方法会被执行。它记录了方法执行前后的日志,并通过joinPoint.proceed()调用继续执行原方法。

确保Spring配置正确启用AOP支持。在Spring Boot项目中,通常只需添加对spring-boot-starter-aop依赖即可自动启用AOP。在XML配置文件中,可以使用<aop:aspectj-autoproxy/>标签开启AOP自动代理。

运行应用程序,调用BusinessServiceImpldoBusiness方法时,你会看到对应的日志输出,这正是通过Spring AOP切面实现的。这个例子展示了Spring AOP如何利用代理模式和切点表达式语言,将日志记录这一横切关注点与业务逻辑分离,实现了非侵入式的日志增强。实际使用时可能还需要配置Spring扫描切面所在的包,确保Spring能够识别并应用这些切面。

18.3 定义 Pointcut

在Spring中,切点定义通常使用AspectJ切点表达式语言编写,该语言提供了丰富的语法来匹配方法签名、类层次、注解等。一个简单的切点定义示例:

@Pointcut("execution(* com.example.service.*.*(..))")
public void serviceLayerMethods() {}

在这个例子中,@Pointcut注解定义了一个名为serviceLayerMethods的切点,其表达式为execution(* com.example.service.*.*(..))。该表达式的含义是匹配com.example.service包及其子包下所有类的所有方法(方法名任意,参数任意)。

18.4 定义 Aspect

在Spring中,切面(Aspect)通常表现为一个带有@Aspect注解的Java类,它包含了切点定义(Pointcut)和通知(Advice)。下面是一个结合JWT认证的简单示例:

@Aspect
@Component
public class JwtAuthenticationAspect {
    @Autowired
    private JwtTokenService jwtTokenService;
    @Pointcut("execution(* com.example.controller.*.*(..)) && @annotation(com.example.security.JwtRequired)")
    public void authenticatedApiMethods() {}
    @Around("authenticatedApiMethods()")
    public Object validateTokenAndProceed(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取请求头中的JWT令牌
        String token = extractTokenFromRequest(joinPoint);
        // 验证令牌有效性
        if (!jwtTokenService.validateToken(token)) {
            throw new UnauthorizedException("Invalid or expired JWT token");
        }
        // 令牌有效,继续执行原方法
        return joinPoint.proceed();
    }
    // ... 其他辅助方法,如extractTokenFromRequest()
}

在这个示例中:

  • JwtAuthenticationAspect使用@Aspect@Component注解,表明它是一个Spring托管的切面。
  • 定义了切点authenticatedApiMethods,匹配所有标注了@JwtRequired注解的com.example.controller包及其子包下的方法。
  • 定义了一个环绕通知validateTokenAndProceed,当匹配的切点方法被调用时,首先提取并验证请求头中的JWT令牌,若无效则抛出异常,否则继续执行原方法。

18.5 AOP 的例子:JWT 认证

上述代码展示了如何使用Spring AOP来处理JWT认证这一横切关注点。当控制器中的某个方法被标记为@JwtRequired时,Spring AOP会自动拦截该方法的调用,通过切面JwtAuthenticationAspect执行JWT令牌的验证逻辑。如果令牌有效,请求才会被允许继续执行至目标方法;否则,抛出异常拒绝访问。

通过这种方式,JWT认证逻辑被集中封装在切面中,与业务逻辑分离,使得代码更易于理解和维护,同时避免了在每个需要保护的控制器方法中手动添加重复的验证代码。


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
29天前
|
Java 开发者
Java多线程编程中的常见误区与最佳实践####
本文深入剖析了Java多线程编程中开发者常遇到的几个典型误区,如对`start()`与`run()`方法的混淆使用、忽视线程安全问题、错误处理未同步的共享变量等,并针对这些问题提出了具体的解决方案和最佳实践。通过实例代码对比,直观展示了正确与错误的实现方式,旨在帮助读者构建更加健壮、高效的多线程应用程序。 ####
|
16天前
|
Java 程序员
Java编程中的异常处理:从基础到高级
在Java的世界中,异常处理是代码健壮性的守护神。本文将带你从异常的基本概念出发,逐步深入到高级用法,探索如何优雅地处理程序中的错误和异常情况。通过实际案例,我们将一起学习如何编写更可靠、更易于维护的Java代码。准备好了吗?让我们一起踏上这段旅程,解锁Java异常处理的秘密!
|
9天前
|
Java Spring
一键注入 Spring 成员变量,顺序编程
介绍了一款针对Spring框架开发的插件,旨在解决开发中频繁滚动查找成员变量注入位置的问题。通过一键操作(如Ctrl+1),该插件可自动在类顶部添加`@Autowired`注解及其成员变量声明,同时保持光标位置不变,有效提升开发效率和代码编写流畅度。适用于IntelliJ IDEA 2023及以上版本。
一键注入 Spring 成员变量,顺序编程
|
18天前
|
Java 开发者 微服务
Spring Boot 入门:简化 Java Web 开发的强大工具
Spring Boot 是一个开源的 Java 基础框架,用于创建独立、生产级别的基于Spring框架的应用程序。它旨在简化Spring应用的初始搭建以及开发过程。
38 6
Spring Boot 入门:简化 Java Web 开发的强大工具
|
20天前
|
设计模式 Java 开发者
Java多线程编程的陷阱与解决方案####
本文深入探讨了Java多线程编程中常见的问题及其解决策略。通过分析竞态条件、死锁、活锁等典型场景,并结合代码示例和实用技巧,帮助开发者有效避免这些陷阱,提升并发程序的稳定性和性能。 ####
|
20天前
|
缓存 Java 开发者
Java多线程编程的陷阱与最佳实践####
本文深入探讨了Java多线程编程中常见的陷阱,如竞态条件、死锁和内存一致性错误,并提供了实用的避免策略。通过分析典型错误案例,本文旨在帮助开发者更好地理解和掌握多线程环境下的编程技巧,从而提升并发程序的稳定性和性能。 ####
|
13天前
|
安全 算法 Java
Java多线程编程中的陷阱与最佳实践####
本文探讨了Java多线程编程中常见的陷阱,并介绍了如何通过最佳实践来避免这些问题。我们将从基础概念入手,逐步深入到具体的代码示例,帮助开发者更好地理解和应用多线程技术。无论是初学者还是有经验的开发者,都能从中获得有价值的见解和建议。 ####
|
13天前
|
Java 调度
Java中的多线程编程与并发控制
本文深入探讨了Java编程语言中多线程编程的基础知识和并发控制机制。文章首先介绍了多线程的基本概念,包括线程的定义、生命周期以及在Java中创建和管理线程的方法。接着,详细讲解了Java提供的同步机制,如synchronized关键字、wait()和notify()方法等,以及如何通过这些机制实现线程间的协调与通信。最后,本文还讨论了一些常见的并发问题,例如死锁、竞态条件等,并提供了相应的解决策略。
38 3
|
24天前
|
Java 程序员
Java编程中的异常处理:从基础到高级
在Java的世界里,异常是程序运行中不可忽视的“惊喜”。它们可能突如其来,也可能悄无声息地潜伏。掌握异常处理的艺术,意味着你能够优雅地面对程序的不完美,并确保它即使在风雨飘摇中也能继续航行。本文将引导你理解Java异常的本质,探索捕获和处理这些异常的方法,并最终学会如何利用自定义异常为你的代码增添力量。
|
19天前
|
开发框架 安全 Java
Java 反射机制:动态编程的强大利器
Java反射机制允许程序在运行时检查类、接口、字段和方法的信息,并能操作对象。它提供了一种动态编程的方式,使得代码更加灵活,能够适应未知的或变化的需求,是开发框架和库的重要工具。
35 2