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日志并进行多维度分析。
目录
相关文章
|
1天前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
|
1天前
|
缓存 Java 数据库
【Java面试题汇总】Spring篇(2023版)
IoC、DI、aop、事务、为什么不建议@Transactional、事务传播级别、@Autowired和@Resource注解的区别、BeanFactory和FactoryBean的区别、Bean的作用域,以及默认的作用域、Bean的生命周期、循环依赖、三级缓存、
【Java面试题汇总】Spring篇(2023版)
|
3天前
|
缓存 Java 编译器
JAVA并发编程volatile核心原理
volatile是轻量级的并发解决方案,volatile修饰的变量,在多线程并发读写场景下,可以保证变量的可见性和有序性,具体是如何实现可见性和有序性。以及volatile缺点是什么?
|
5天前
|
Java 调度 开发者
Java并发编程:深入理解线程池
在Java的世界中,线程池是提升应用性能、实现高效并发处理的关键工具。本文将深入浅出地介绍线程池的核心概念、工作原理以及如何在实际应用中有效利用线程池来优化资源管理和任务调度。通过本文的学习,读者能够掌握线程池的基本使用技巧,并理解其背后的设计哲学。
|
5天前
|
存储 安全 Java
Java并发编程之深入理解Synchronized关键字
在Java的并发编程领域,synchronized关键字扮演着守护者的角色。它确保了多个线程访问共享资源时的同步性和安全性。本文将通过浅显易懂的语言和实例,带你一步步了解synchronized的神秘面纱,从基本使用到底层原理,再到它的优化技巧,让你在编写高效安全的多线程代码时更加得心应手。
|
6天前
|
缓存 Java 编译器
JAVA并发编程synchronized全能王的原理
本文详细介绍了Java并发编程中的三大特性:原子性、可见性和有序性,并探讨了多线程环境下可能出现的安全问题。文章通过示例解释了指令重排、可见性及原子性问题,并介绍了`synchronized`如何全面解决这些问题。最后,通过一个多窗口售票示例展示了`synchronized`的具体应用。
|
3天前
|
存储 Java
Java编程中的对象序列化与反序列化
【9月更文挑战第12天】在Java的世界里,对象序列化与反序列化是数据持久化和网络传输的关键技术。本文将带你了解如何通过实现Serializable接口来标记一个类的对象可以被序列化,并探索ObjectOutputStream和ObjectInputStream类的使用,以实现对象的写入和读取。我们还将讨论序列化过程中可能遇到的问题及其解决方案,确保你能够高效、安全地处理对象序列化。
|
2天前
|
Java 数据库连接 API
【Java笔记+踩坑】Spring Data JPA
从常用注解、实体类和各层编写方法入手,详细介绍JPA框架在增删改查等方面的基本用法,以及填充用户名日期、分页查询等高级用法。
【Java笔记+踩坑】Spring Data JPA
|
2天前
|
Java 数据库连接 数据格式
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
IOC/DI配置管理DruidDataSource和properties、核心容器的创建、获取bean的方式、spring注解开发、注解开发管理第三方bean、Spring整合Mybatis和Junit
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
|
10天前
|
Java 开发者
【Java编程新纪元】JDK 22:超级构造函数来袭,super(...) 前导语句改写编程规则!
【9月更文挑战第6天】JDK 22的超级构造函数特性是Java编程语言发展史上的一个重要里程碑。它不仅简化了代码编写,还提升了代码的可读性和维护性。我们有理由相信,在未来的Java版本中,还将有更多令人兴奋的新特性等待我们去发现和应用。让我们共同期待Java编程新纪元的到来!