springboot 切面拦截自定义注解
使用切面来拦截被该注解标记的方法
- 依赖
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId>
</dependency>
1. 定义自定义注解
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyCustomAnnotation {// 可以根据需要定义注解的属性String value() default "";
}
上述代码定义了一个名为 MyCustomAnnotation 的自定义注解,@Retention(RetentionPolicy.RUNTIME) 表示该注解在运行时仍然有效,@Target(ElementType.METHOD) 表示该注解只能用于方法上。
2. 定义切面类
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;@Aspect
@Component
public class CustomAnnotationAspect {// 定义切入点表达式,拦截被 MyCustomAnnotation 注解标记的方法@Before("@annotation(myCustomAnnotation)")public void beforeMethod(JoinPoint joinPoint, MyCustomAnnotation myCustomAnnotation) {System.out.println("方法 " + joinPoint.getSignature().getName() + " 执行前,自定义注解属性值: " + myCustomAnnotation.value());}@After("@annotation(myCustomAnnotation)")public void afterMethod(JoinPoint joinPoint, MyCustomAnnotation myCustomAnnotation) {System.out.println("方法 " + joinPoint.getSignature().getName() + " 执行后,自定义注解属性值: " + myCustomAnnotation.value());}
}
在这个切面类中:
@Aspect 注解表明该类是一个切面类。
@Before(“@annotation(myCustomAnnotation)”) 定义了一个前置通知,当被 MyCustomAnnotation 注解标记的方法执行前,这个方法会被调用。
@After(“@annotation(myCustomAnnotation)”) 定义了一个后置通知,当被 MyCustomAnnotation 注解标记的方法执行后,这个方法会被调用。
JoinPoint 参数可以获取到被拦截方法的相关信息,如方法签名等。
3. 使用自定义注解
import org.springframework.stereotype.Service;@Service
public class MyService {@MyCustomAnnotation(value = "示例注解属性值")public void myMethod() {System.out.println("执行 myMethod 方法");}
}
在 MyService 类的 myMethod 方法上使用了 MyCustomAnnotation 注解。
4. 启用
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy;@SpringBootApplication
@EnableAspectJAutoProxy
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
运行测试代码后,会看到在 myMethod 方法执行前后,切面类中的前置通知和后置通知方法会被调用,并输出相应的日志信息。
这就是使用切面拦截自定义注解的基本步骤和示例,你可以根据实际需求对注解和切面进行更复杂的扩展和定制。