java切面获取注解的属性值

转载

mob64ca1417736e 2024-11-06 12:24:54

文章标签 java切面获取注解的属性值 spring java 后端 Java 文章分类 Java 后端开发

在Java开发中，切面是一种强大的技术，可以用于在程序的不同阶段执行特定的操作。在本文中，我们将讨论如何使用切面将方法的参数传递到切面方法中，并对切面的使用进行详细介绍。

什么是切面？

切面是面向切面编程（AOP）的一部分，它允许开发人员在程序的不同阶段执行额外的操作。切面可以用于日志记录、性能监控、安全性检查等。在Java中，切面通常通过注解和切面类来实现。

创建一个自定义注解

首先，我们将创建一个自定义注解，用于标记需要在切面中处理的方法。例如：

import java.lang.annotation.*;

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface BrowseHistory {
}

切面的使用

Before、After和Around方法

在切面中，我们可以使用@Before、@After和@Around注解来定义不同类型的切面方法。

@Before：在目标方法执行之前执行。
@After：在目标方法执行之后执行。
@Around：可以在目标方法执行前后都执行，并且可以控制目标方法的执行。

下面是一个示例切面类，演示了这些方法的使用：

@Aspect
@Slf4j
public class YourAspect {

    @Before("@annotation(browseHistory)")
    public void before(JoinPoint joinPoint, BrowseHistory browseHistory) {
        // 执行目标方法之前的逻辑
    }

    @After("@annotation(browseHistory)")
    public void after(JoinPoint joinPoint, BrowseHistory browseHistory) {
        // 执行目标方法之后的逻辑
    }

    @Around("@annotation(browseHistory)")
    public Object around(ProceedingJoinPoint joinPoint, BrowseHistory browseHistory) throws Throwable {
        // 执行目标方法之前的逻辑
        Object result = joinPoint.proceed(); // 调用目标方法
        // 执行目标方法之后的逻辑
        return result;
    }
}

注解传参的使用

除了简单地标记需要处理的方法外，自定义注解还可以用来传递参数。例如，我们可以对自定义注解进行扩展，以便传递额外的信息到切面方法中：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface BrowseHistory {
    String value() default "";
    int priority() default 0;
}

然后，在切面方法中可以获取这些参数并进行相应的处理：

@Around("@annotation(browseHistory)")
public Object around(ProceedingJoinPoint joinPoint, BrowseHistory browseHistory) throws Throwable {
    String value = browseHistory.value(); // 获取注解参数值
    int priority = browseHistory.priority(); // 获取注解参数值
    // Your logic here
    return joinPoint.proceed();
}

将方法的参数传递到切面方法中

假设我们有一个方法如下：

public void yourMethod(@RequestParam String param1, @RequestParam int param2) {
    // Your method implementation
}

然后，我们可以使用切面将方法的参数传递到切面方法中，如下所示：

@Aspect
@Slf4j
public class YourAspect {

    @Around("@annotation(browseHistory)")
    public Object around(ProceedingJoinPoint joinPoint, BrowseHistory browseHistory) throws Throwable {
        Object[] methodArgs = joinPoint.getArgs(); // 获取方法的参数
        for (Object arg : methodArgs) {
            if (arg instanceof String) {
                String param1 = (String) arg; // 可以根据参数类型进行处理
                // Your logic here
            } else if (arg instanceof Integer) {
                int param2 = (Integer) arg; // 可以根据参数类型进行处理
                // Your logic here
            }
        }
        return joinPoint.proceed();
    }
}

在这个示例中，我们使用了@Around注解来定义切面方法，通过ProceedingJoinPoint获取方法的参数信息，并对参数进行处理。

关于切面的使用场景

切面还可以用于以下方面：

异常处理：可以使用切面来捕获方法抛出的异常，并进行相应的处理。
日志记录：切面可以用于记录方法的调用信息，包括方法名、参数值等。
性能监控：可以使用切面来监控方法的执行时间，并进行性能分析。
事务管理：切面可以用于管理方法的事务，例如开启、提交、回滚事务等操作。

注意：如果依赖切面的a模块和b模块配置的切面不在一个服务中，切面不会生效

原因：

切面生效范围: 切面的生效范围取决于 Spring 容器的扫描范围。默认情况下，Spring 容器只会扫描当前模块 (即 b 模块) 的包路径，以及其子包路径。
模块隔离: a 模块和 b 模块通常是相互隔离的，它们各自拥有自己的 Spring 容器。
依赖关系: 虽然 a 模块依赖 b 模块，但这并不意味着 b 模块的切面能够自动应用到 a 模块中。

解决方案：

将切面配置在 a 模块中： 最直接的解决方案是将切面配置在 a 模块中，这样才能保证切面能够生效。
使用 @EnableAspectJAutoProxy 注解： 在 a 模块的配置类中添加 @EnableAspectJAutoProxy 注解，以开启 AspectJ 自动代理功能，让 b 模块中的切面能够被 a 模块的 Spring 容器识别和应用。
手动配置代理： 如果不能修改 a 模块，可以使用 ProxyFactoryBean 手动配置代理，将 b 模块中的切面应用到 a 模块的 Bean 上。

示例：

在 a 模块的配置类中添加 @EnableAspectJAutoProxy 注解：
Java复制

@Configuration
@EnableAspectJAutoProxy
public class AModuleConfig {
    // ... other configurations
}

在 b 模块中定义切面：
Java复制

@Aspect
public class BModuleAspect {
    @Around("execution(* com.example.a.module.service.*.*(..))")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        // 切面逻辑
    }
}

注意：