SpringBoot 自定义Annotation

最新推荐文章于 2025-05-30 14:16:49 发布

原创最新推荐文章于 2025-05-30 14:16:49 发布 · 879 阅读

1 ·

CC 4.0 BY-SA版权

Springboot 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了如何在SpringBoot应用中创建并使用自定义Annotation，结合AOP实现特定逻辑。首先在Maven pom.xml文件中添加了Spring AOP和AspectJ的依赖，接着定义了一个名为`SingleLocalCache`的注解，用于标记需要缓存结果的方法。然后创建了一个切面类`SingleLocalCacheAspect`，通过`@Before`、`@AfterReturning`和`@Around`注解在方法执行前后插入自定义逻辑。最后在`TestController`中展示了如何使用这个自定义注解。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. Maven pom.xml 文件添加AOP相关的jar包

<dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-aop</artifactId>
            <version>5.0.1.RELEASE</version> <scope>compile</scope>
       </dependency>
       <dependency>
           <groupId>org.aspectj</groupId>
           <artifactId>aspectjweaver</artifactId>
            <version>1.8.12</version> <scope>compile</scope>
       </dependency>

2. 自定义Annotation

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 SingleLocalCache {

   boolean cache() default false;

   String key();

}

3. 写一个切面编程的方法来实现你想要的逻辑

import java.lang.reflect.Method;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class SingleLocalCacheAspect {
    // 在方法执行前执行
    @Before("@annotation(com.cisco.webex.config.SingleLocalCache)")
    public Object beforeExecute(JoinPoint joinPoint) {
            //MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            //Method method = signature.getMethod();
           return null;
    }
     //方法返回后执行
    @AfterReturning(value = "@annotation(com.cisco.webex.config.SingleLocalCache)",
           returning = "result")
   public void afterReturning(JoinPoint joinPoint, Object result) {
       System.out.println("=====after return===");
       System.out.println("result: " + result.toString());
   }
    //同时处理方法执行前和执行后
    @Around("@annotation(com.cisco.webex.config.SingleLocalCache)")
   public void around(ProceedingJoinPoint joinPoint) throws Throwable {
       long startTime = System.currentTimeMillis();

//这一行会执行你的方法

joinPoint.proceed();

       long timeTaken = System.currentTimeMillis() - startTime;
   }

}

4. 接下来具体使用自定义的Annotation

@CrossOrigin
@RestController
public class TestController {

   @RequestMapping(method = RequestMethod.GET, value="/test")
   @SingleLocalCache(cache=true,key="test")
   public String getSiteName(@RequestParam(value = "test") String test) {
       return null;
   }


}

参考文章

https://docs.spring.io/spring/docs/2.5.x/reference/aop.html

http://www.springboottutorial.com/spring-boot-and-aop-with-spring-boot-starter-aop

https://www.journaldev.com/2583/spring-aop-example-tutorial-aspect-advice-pointcut-joinpoint-annotations