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日志并进行多维度分析。
目录
相关文章
|
9天前
|
设计模式 安全 Java
Java编程中的单例模式:理解与实践
【10月更文挑战第31天】在Java的世界里,单例模式是一种优雅的解决方案,它确保一个类只有一个实例,并提供一个全局访问点。本文将深入探讨单例模式的实现方式、使用场景及其优缺点,同时提供代码示例以加深理解。无论你是Java新手还是有经验的开发者,掌握单例模式都将是你技能库中的宝贵财富。
14 2
|
4天前
|
JSON Java Apache
非常实用的Http应用框架,杜绝Java Http 接口对接繁琐编程
UniHttp 是一个声明式的 HTTP 接口对接框架,帮助开发者快速对接第三方 HTTP 接口。通过 @HttpApi 注解定义接口,使用 @GetHttpInterface 和 @PostHttpInterface 等注解配置请求方法和参数。支持自定义代理逻辑、全局请求参数、错误处理和连接池配置,提高代码的内聚性和可读性。
|
11天前
|
Java API Apache
Java编程如何读取Word文档里的Excel表格,并在保存文本内容时保留表格的样式?
【10月更文挑战第29天】Java编程如何读取Word文档里的Excel表格,并在保存文本内容时保留表格的样式?
60 5
|
6天前
|
安全 Java 编译器
JDK 10中的局部变量类型推断:Java编程的简化与革新
JDK 10引入的局部变量类型推断通过`var`关键字简化了代码编写,提高了可读性。编译器根据初始化表达式自动推断变量类型,减少了冗长的类型声明。虽然带来了诸多优点,但也有一些限制,如只能用于局部变量声明,并需立即初始化。这一特性使Java更接近动态类型语言,增强了灵活性和易用性。
87 53
|
13天前
|
人工智能 前端开发 Java
基于开源框架Spring AI Alibaba快速构建Java应用
本文旨在帮助开发者快速掌握并应用 Spring AI Alibaba,提升基于 Java 的大模型应用开发效率和安全性。
基于开源框架Spring AI Alibaba快速构建Java应用
|
1天前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
9 2
|
5天前
|
存储 安全 Java
Java多线程编程的艺术:从基础到实践####
本文深入探讨了Java多线程编程的核心概念、应用场景及其实现方式,旨在帮助开发者理解并掌握多线程编程的基本技能。文章首先概述了多线程的重要性和常见挑战,随后详细介绍了Java中创建和管理线程的两种主要方式:继承Thread类与实现Runnable接口。通过实例代码,本文展示了如何正确启动、运行及同步线程,以及如何处理线程间的通信与协作问题。最后,文章总结了多线程编程的最佳实践,为读者在实际项目中应用多线程技术提供了宝贵的参考。 ####
|
2天前
|
监控 安全 Java
Java中的多线程编程:从入门到实践####
本文将深入浅出地探讨Java多线程编程的核心概念、应用场景及实践技巧。不同于传统的摘要形式,本文将以一个简短的代码示例作为开篇,直接展示多线程的魅力,随后再详细解析其背后的原理与实现方式,旨在帮助读者快速理解并掌握Java多线程编程的基本技能。 ```java // 简单的多线程示例:创建两个线程,分别打印不同的消息 public class SimpleMultithreading { public static void main(String[] args) { Thread thread1 = new Thread(() -> System.out.prin
|
4天前
|
存储 缓存 安全
在 Java 编程中,创建临时文件用于存储临时数据或进行临时操作非常常见
在 Java 编程中,创建临时文件用于存储临时数据或进行临时操作非常常见。本文介绍了使用 `File.createTempFile` 方法和自定义创建临时文件的两种方式,详细探讨了它们的使用场景和注意事项,包括数据缓存、文件上传下载和日志记录等。强调了清理临时文件、确保文件名唯一性和合理设置文件权限的重要性。
12 2
|
5天前
|
Java UED
Java中的多线程编程基础与实践
【10月更文挑战第35天】在Java的世界中,多线程是提升应用性能和响应性的利器。本文将深入浅出地介绍如何在Java中创建和管理线程,以及如何利用同步机制确保数据一致性。我们将从简单的“Hello, World!”线程示例出发,逐步探索线程池的高效使用,并讨论常见的多线程问题。无论你是Java新手还是希望深化理解,这篇文章都将为你打开多线程的大门。