AOP 配置 - XML 配置 AOP - 配置切面与通知

Java - Web - Spring 《AOP 配置 - XML 配置 AOP - 配置切面与通知》

一、引言

在 Java Web 开发中，Spring 框架是一个强大的工具，而面向切面编程（AOP）是 Spring 框架的重要特性之一。AOP 允许我们在不修改原有业务逻辑的基础上，对程序进行增强，例如日志记录、事务管理等。本文将详细介绍如何使用 XML 配置方式来配置 AOP 中的切面与通知。

二、AOP 基本概念

在深入学习 XML 配置 AOP 之前，我们先了解几个重要的 AOP 概念：

• 切面（Aspect）：一个切面可以包含多个通知和切入点，它是通知和切入点的结合。
• 通知（Advice）：通知定义了在目标方法执行的不同阶段要执行的代码，常见的通知类型有前置通知、后置通知、环绕通知等。
• 切入点（Pointcut）：切入点定义了哪些方法会被增强，即通知会在哪些方法上执行。

三、示例项目搭建

我们创建一个简单的 Java Web 项目，使用 Maven 进行依赖管理。在 pom.xml 中添加 Spring AOP 的依赖：

<dependencies>
    <!-- Spring Context -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.3.18</version>
    </dependency>
    <!-- Spring AOP -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>5.3.18</version>
    </dependency>
    <!-- AspectJ -->
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.7</version>
    </dependency>
</dependencies>

四、定义业务接口和实现类

首先，我们定义一个简单的业务接口和实现类：

// 业务接口
public interface UserService {
    void addUser(String username);
}
// 业务实现类
public class UserServiceImpl implements UserService {
    @Override
    public void addUser(String username) {
        System.out.println("添加用户：" + username);
    }
}

五、定义切面类

接下来，我们定义一个切面类，包含不同类型的通知：

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
public class UserServiceAspect {
    // 前置通知
    public void beforeAdvice(JoinPoint joinPoint) {
        System.out.println("前置通知：在方法 " + joinPoint.getSignature().getName() + " 执行之前执行");
    }
    // 后置通知
    public void afterAdvice(JoinPoint joinPoint) {
        System.out.println("后置通知：在方法 " + joinPoint.getSignature().getName() + " 执行之后执行");
    }
    // 环绕通知
    public Object aroundAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        System.out.println("环绕通知：在方法执行之前");
        Object result = proceedingJoinPoint.proceed();
        System.out.println("环绕通知：在方法执行之后");
        return result;
    }
}

六、XML 配置 AOP

在 applicationContext.xml 中进行 AOP 配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                           http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/aop
                           http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!-- 定义业务 Bean -->
    <bean id="userService" class="com.example.service.impl.UserServiceImpl"/>
    <!-- 定义切面 Bean -->
    <bean id="userServiceAspect" class="com.example.aspect.UserServiceAspect"/>
    <!-- 开启 AOP 自动代理 -->
    <aop:aspectj-autoproxy/>
    <!-- 配置切面 -->
    <aop:config>
        <aop:aspect ref="userServiceAspect">
            <!-- 定义切入点 -->
            <aop:pointcut id="userServicePointcut" expression="execution(* com.example.service.UserService.addUser(..))"/>
            <!-- 前置通知 -->
            <aop:before method="beforeAdvice" pointcut-ref="userServicePointcut"/>
            <!-- 后置通知 -->
            <aop:after method="afterAdvice" pointcut-ref="userServicePointcut"/>
            <!-- 环绕通知 -->
            <aop:around method="aroundAdvice" pointcut-ref="userServicePointcut"/>
        </aop:aspect>
    </aop:config>
</beans>

七、测试代码

编写测试代码来验证 AOP 配置是否生效：

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Main {
    public static void main(String[] args) {
        // 加载 Spring 配置文件
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        // 获取业务 Bean
        UserService userService = (UserService) context.getBean("userService");
        // 调用业务方法
        userService.addUser("张三");
    }
}

八、运行结果

运行 Main 类，输出结果如下：

环绕通知：在方法执行之前
前置通知：在方法 addUser 执行之前执行
添加用户：张三
环绕通知：在方法执行之后
后置通知：在方法 addUser 执行之后执行

九、通知类型总结

十、总结

通过本文的介绍，我们学习了如何使用 XML 配置方式来配置 AOP 中的切面与通知。XML 配置方式可以清晰地定义切面、切入点和通知，便于管理和维护。在实际开发中，我们可以根据具体需求选择合适的通知类型，对程序进行增强。希望本文对你理解和使用 Spring AOP 的 XML 配置有所帮助。