Spring AOP切面 AfterReturning 所有controller 页面

转载

definitely 2024-09-04 20:59:24

文章标签 java spring boot 分布式架构 mvc 文章分类 架构后端开发

Spring AOP实现面向切面编程，提升系统扩展性和复用性

一、AOP 和面向切面编程

1 简介
2 实现原理

切面（Aspect）的概念和作用
切点（Pointcut）的定义和使用方法
通知（Advice）的类型和含义
切入点表达式（AspectJ expression）的语法和用法
Spring AOP 的实现原理

二、如何在Spring中使用AOP

1. 引入Spring AOP的依赖
2. 配置切面类（Aspect class）
3. 配置通知（Advice）
4. 配置切点（Pointcut）
5. 配置切入点表达式（AspectJ expression）
6. 使用AOP增强功能

三、AOP在实际应用中的案例分析

1. 日志记录
2. 结果缓存
3. 分布式事务处理
4. 安全验证

四、小结回顾

1. AOP的优点和应用场景
2. Spring AOP的特点和实现方式
3. 面向切面编程的未来发展趋势

一、AOP 和面向切面编程

1 简介

AOP（Aspect-Oriented Programming面向切面编程）是一种用于解决传统 OOP（Object-Oriented Programming 面向对象编程）难以解决的问题的编程思想。AOP 能够将系统中的横切关注点（例如日志、安全、事务等），从主逻辑中分离出来使得代码更加清晰、模块化、易于扩展和维护。

面向切面编程就是将一个系统的多个模块中的“横切关注点”，例如安全性、日志记录、事务管理等将它们独立地分解对待并划分为关注点，从而达到对系统进行分层、聚焦关注点维护管理等目的。面向切面编程的优点在于增强系统的可维护性、扩展性和灵活性，降低了系统的耦合度，增加了代码的重用性。

2 实现原理

Spring AOP 库是一个流行的使用 AOP 编程技术的库。Spring 的 AOP 和 AspectJ 的 AOP 有相似之处，但是使用起来更加简单。

切面（Aspect）的概念和作用

切面指的是系统中横跨多个模块（通用模块）的关注点；切入点可以看作是 “切面” 的入口，一种程序执行的配置方式。AOP 的核心思想就是通过切面（Aspect）将横切关注点（如日志或事务管理）从原来的主逻辑中抽离出来，实现关注点的解耦和重用。

切点（Pointcut）的定义和使用方法

切点是作用在与连接点集相交的切面上的一个逻辑定位标识符，可以用来区分关注点对特定类、方法或方法参数等对象进行管理。在 Spring AOP 中，切点采用 AspectJ 表达式语言语法，其定义常用语法格式如下：

//定义切点表达式，拦截 com.example.service 包及其所有子包下的所有 public 方法
execution(public * com.example.service..*(..))

通知（Advice）的类型和含义

通知是对具体方法执行前、执行后、或方法执行后抛出异常时进行增强操作的代码定义。常见的通知方式如下：

前置通知（Before Advice）：在方法执行前增强操作；
后置通知（After Advice）：在方法执行后增强操作；
返回通知（After-returning Advice）：在方法成功返回后增强操作；
异常通知（After-throwing Advice）：在方法抛出异常后增强操作；
环绕通知（Around Advice）：在方法执行前后都增强操作。

切入点表达式（AspectJ expression）的语法和用法

切入点表达式（AspectJ expression）用来描述切点，是 AOP 库的一部分，详细的语法和使用方法可以参考 AspectJ 官方文档（https://www.eclipse.org/aspectj/）。

Spring AOP 的实现原理

Spring AOP 的实现原理是基于 Java 的动态代理机制实现的，在运行时通过创建 Spring 代理对象，在代理对象中处理通知和切面逻辑，从而实现 AOP 的目的。

二、如何在Spring中使用AOP

在本文中将详细介绍如何在Spring中使用AOP，以及如何实现AOP的增强功能。我们将涉及到以下内容：

引入Spring AOP的依赖
配置切面类（Aspect class）
配置通知（Advice）
配置切点（Pointcut）
配置切入点表达式（AspectJ expression）
使用AOP增强功能

1. 引入Spring AOP的依赖

首先需要在Maven项目的依赖中引入Spring AOP的相关依赖：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>${spring.version}</version>
</dependency>

2. 配置切面类（Aspect class）

需要创建一个切面类用于定义切入点（Pointcut）和通知（Advice）。这个类需要使用 @Aspect 注解进行标记，这个注解可以告诉 Spring 这是一个切面类。

@Aspect
@Component
public class LoggingAspect {

    // 切入点
    @Pointcut("execution(* com.example.model.User.doSomething(..))")
    private void userAction() {}

    // 通知
    @Before("userAction()")
    public void beforeUserAction() {
        System.out.println("记录用户操作日志：用户正在执行操作...");
    }
}

在这个类中定义了一个切入点 userAction()，这个切入点表示需要被拦截的方法。同时还定义了一个通知 beforeUserAction()，这个通知会在方法执行前执行，并且输出一条日志记录。

3. 配置通知（Advice）

在上一步中已经定义了通知 beforeUserAction()，但是我们还需要将这个通知与具体的方法绑定起来。为了达到这个目的需要使用 @Before、@After、@AfterReturning、@AfterThrowing 和 @Around 注解来标记不同类型的通知。

在这个案例中需要使用 @Before 注解来标记通知，并将这个通知与我们上一步定义的 userAction() 切入点绑定起来：

@Before("userAction()")
public void beforeUserAction() {
    System.out.println("记录用户操作日志：用户正在执行操作...");
}

4. 配置切点（Pointcut）

切点（Pointcut）用于定义在什么样的条件下，切面（Aspect）会进行拦截操作。Spring中支持的切入点命名方式有两种：@Pointcut 注解和 XML 配置文件。

@Pointcut("execution(* com.example.model.User.doSomething(..))")
private void userAction() {}

5. 配置切入点表达式（AspectJ expression）

切入点表达式（AspectJ expression）用于描述切点的范围。Spring AOP 通过使用 AspectJ 表达式实现切入点的定义，其语法和使用方法与 AspectJ 非常相似。

@Pointcut("execution(* com.example.model.User.doSomething(..))")
private void userAction() {}

6. 使用AOP增强功能

现在已经定义了切入点（Pointcut）和通知（Advice），只需要在对应的方法上添加 @Aspect 注解即可：

@Component
public class User {

    public void doSomething() {
        System.out.println("用户正在执行操作...");
    }

}

这个案例中定义了一个 User 类，其中包含了一个 doSomething() 方法。在这个方法上添加 @Aspect 注解即可启用 AOP 功能：

@Component
@Aspect
public class LoggingAspect {

    @Pointcut("execution(* com.example.model.User.doSomething(..))")
    private void userAction() {}

    @Before("userAction()")
    public void beforeUserAction() {
        System.out.println("记录用户操作日志：用户正在执行操作...");
    }

}

现在调用 User 类中的 doSomething() 方法时，Spring AOP 会自动拦截这个方法，并在方法执行前输出一条日志。

三、AOP在实际应用中的案例分析

1. 日志记录

在实际应用中经常需要记录系统中各个操作的日志，这个时候就可以使用 AOP 技术进行实现。我们可以在 AOP 中定义一个切面（Aspect），并在其中添加一个通知（Advice）来实现日志记录的功能。

具体的实现步骤如下：

在 AOP 中定义一个切入点（Pointcut），用于指定需要被拦截的方法。
在切面中添加一个通知（Advice），用于在方法执行前或执行后输出日志。
在应用中使用上面定义的切面来拦截需要记录日志的方法。

下面是一个示例代码：

@Aspect
@Component
public class LoggingAspect {

    // 定义一个切入点，用于指定需要记录日志的方法
    @Pointcut("execution(* com.example.service.UserService.*(..))")
    public void log() {}

    // 在方法执行前输出日志
    @Before("log()")
    public void beforeLog() {
        System.out.println("记录日志：用户正在执行操作...");
    }

    // 在方法执行后输出日志
    @After("log()")
    public void afterLog() {
        System.out.println("记录日志：用户操作完成。");
    }
}

2. 结果缓存

在应用中有些方法需要执行一些复杂的计算操作来生成结果，这个时候我们可以使用缓存技术来提高系统性能。在 AOP 中可以使用切面来实现结果缓存的功能，具体实现步骤如下：

在 AOP 中定义一个切入点，用于指定需要被缓存的方法。
在切面中添加一个缓存对象，用于存储方法的执行结果。
在通知（Advice）中判断缓存对象中是否已经存在方法的执行结果，如果存在则直接返回执行结果，否则执行方法并将结果存入缓存对象中。

下面是一个示例代码：

@Aspect
@Component
public class CachingAspect {

    // 定义一个缓存对象
    private Map<String, Object> cache = new ConcurrentHashMap<>();

    // 定义一个切入点，用于指定需要缓存的方法
    @Pointcut("execution(* com.example.service.UserServiceImpl.*(..))")
    public void cache() {}

    // 在方法执行前判断执行结果是否已经被缓存了
    @Around("cache()")
    public Object cacheResult(ProceedingJoinPoint point) throws Throwable {
        // 获取方法名和参数
        String key = point.getSignature().getName() + Arrays.toString(point.getArgs());
        // 如果结果已经被缓存，则直接返回结果
        if(cache.containsKey(key)) {
            System.out.println("从缓存中获取结果...");
            return cache.get(key);
        }
        // 否则执行方法，并将结果缓存起来
        Object result = point.proceed();
        cache.put(key, result);
        System.out.println("将结果缓存起来...");
        return result;
    }
}

3. 分布式事务处理

在分布式系统中很难通过传统的事务处理方式来维护多个系统之间的数据一致性。因此可以使用 AOP 技术来实现分布式事务的处理。

具体实现步骤如下：

在 AOP 中定义一个切入点，用于指定需要进行分布式事务处理的方法。
在通知中使用分布式协议，如2PC或3PC，来保证多个系统之间的数据一致性。
在实际应用中，需要使用支持分布式事务的数据库或消息中间件。

下面是一个示例代码：

@Aspect
@Component
public class TransactionAspect {

    // 定义一个切入点，用于指定需要进行分布式事务处理的方法
    @Pointcut("execution(* com.example.service.UserService.transfer(..))")
    public void transaction() {}

    // 在通知中使用分布式协议来保证多个系统之间的数据一致性
    @Around("transaction()")
    public Object handleTransaction(ProceedingJoinPoint point) throws Throwable {
        // 开始分布式事务
        // ...
        Object result = null;
        try {
            // 执行方法
            result = point.proceed();
            // 提交分布式事务
            // ...
        } catch (Exception e) {
            // 回滚分布式事务
            // ...
        }
        return result;
    }
}

4. 安全验证

在应用中经常需要对一些敏感操作进行安全验证，使用 AOP 技术可以非常方便地实现这一功能。

具体实现步骤如下：

在 AOP 中定义一个切入点，用于指定需要进行安全验证的方法。
在切面中添加一个通知，用于验证用户的安全权限。
在实际应用中，需要存储用户的安全验证信息，并在进行安全验证时进行比对。

下面是一个示例代码：

@Aspect
@Component
public class SecurityAspect {

    // 定义一个切入点，用于指定需要进行安全验证的方法
    @Pointcut("execution(* com.example.service.UserService.deleteUser(..))")
    public void security() {}

    // 在通知中进行安全验证，判断用户是否有删除权限
    @Before("security()")
    public void checkSecurity() {
        // 获取用户的安全验证信息，并进行比对
        // ...
        if(!hasPermission) {
            throw new SecurityException("您没有删除用户的权限！");
        }
    }
}

四、小结回顾

1. AOP的优点和应用场景

AOP 技术可以提高开发效率，减少重复代码，增强系统可维护性和可扩展性。常见的应用场景包括日志记录、结果缓存、分布式事务处理和安全验证等。

2. Spring AOP的特点和实现方式

Spring AOP 是基于代理的 AOP 技术由于使用了代理技术，因此无需对原始类进行修改即可实现 AOP 功能。Spring AOP 支持多种 AOP 实现方式，包括基于注解、基于 XML 和基于 API 的方式。

3. 面向切面编程的未来发展趋势

随着云计算和大数据技术的发展面向切面编程技术将会越来越受到重视，未来的发展趋势主要包括更加灵活和可扩展的切面定义方式、更加智能化和自适应的切面应用方式以及更加统一和标准化的切面管理方式等。

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：Android 电话号码固话客服电话校验

下一篇：java使用HikariConfig查询postgre集合并获取

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯