SpringBoot（十七）自定义注解

客官°小女子只卖身不卖艺 2024-03-22 06:20 177阅读 0赞

目录

自定义注解

前置知识：Java注解之 @Target、@Retention、@Documented简介

@Target({ElementType.TYPE}) 注解

@Retention({RetentionPolicy.Runtime}) 注解

@Documented注解

自定义注解案例

1、pom依赖

2、自定义注解类

3、切面类

4、应用

5、测试

自定义注解

在SpringBoot中，我们可以通过自定义注解来简化代码的编写和提高代码的可读性。下面是使用自定义注解的步骤：

前置知识：Java注解之 @Target、@Retention、@Documented简介

@Target({ElementType.TYPE}) 注解

表示当前注解(@CheckToken)可以打在什么东西上面,此处可以放在类上与方法上

ElementType 这个枚举类型的常量提供了一个简单的分类：注解可能出现在Java程序中的语法位置（这些常量与元注解类型(@Target)一起指定在何处写入注解的合法位置）

  1. package java.lang.annotation;
  2. ​
  3. /**
  4. ​
  5.  * The constants of this enumerated type provide a simple classification of the
  6. ​
  7.  * syntactic locations where annotations may appear in a Java program. These
  8. ​
  9.  * constants are used in {@link Target java.lang.annotation.Target}
  10. ​
  11.  * meta-annotations to specify where it is legal to write annotations of a
  12. ​
  13.  * given type.
  14. ​
  15.  * @author  Joshua Bloch
  16. ​
  17.  * @since 1.5
  18. ​
  19.  * @jls 9.6.4.1 @Target
  20. ​
  21.  * @jls 4.1 The Kinds of Types and Values
  22.    */
  23.    public enum ElementType {
  24.    /** 类, 接口 (包括注解类型), 或 枚举 声明 */
  25.    TYPE,
  26. ​
  27.    /** 字段声明（包括枚举常量） */
  28.    FIELD,
  29. ​
  30.    /** 方法声明(Method declaration) */
  31.    METHOD,
  32. ​
  33.    /** 正式的参数声明 */
  34.    PARAMETER,
  35. ​
  36.    /** 构造函数声明 */
  37.    CONSTRUCTOR,
  38. ​
  39.    /** 局部变量声明 */
  40.    LOCAL_VARIABLE,
  41. ​
  42.    /** 注解类型声明 */
  43.    ANNOTATION_TYPE,
  44. ​
  45.    /** 包声明 */
  46.    PACKAGE,
  47. ​
  48.    /**
  49. ​
  50.     * 类型参数声明
  51.       *
  52.     * @since 1.8
  53.       */
  54.       TYPE_PARAMETER,
  55. ​
  56.    /**
  57. ​
  58.     * 使用的类型
  59.       *
  60.     * @since 1.8
  61.       */
  62.       TYPE_USE
  63.       }
  64.       字段声明（包括枚举常量） */
  65.       FIELD,
  66. ​
  67.    /** 方法声明(Method declaration) */
  68.    METHOD,
  69. ​
  70.    /** 正式的参数声明 */
  71.    PARAMETER,
  72. ​
  73.    /** 构造函数声明 */
  74.    CONSTRUCTOR,
  75. ​
  76.    /** 局部变量声明 */
  77.    LOCAL_VARIABLE,
  78. ​
  79.    /** 注解类型声明 */
  80.    ANNOTATION_TYPE,
  81. ​
  82.    /** 包声明 */
  83.    PACKAGE,
  84. ​
  85.    /**
  86. ​
  87.     * 类型参数声明
  88.       *
  89.     * @since 1.8
  90.       */
  91.       TYPE_PARAMETER,
  92. ​
  93.    /**
  94. ​
  95.     * 使用的类型
  96.       *
  97.     * @since 1.8
  98.       */
  99.       TYPE_USE
  100.       }

@Retention({RetentionPolicy.Runtime}) 注解

RetentionPolicy这个枚举类型的常量描述保留注解的各种策略，它们与元注解(@Retention)一起指定注释要保留多长时间

  1. package java.lang.annotation;
  2. /**
  3. ​
  4.  * Annotation retention policy.  The constants of this enumerated type
  5.  * describe the various policies for retaining annotations.  They are used
  6.  * in conjunction with the {@link Retention} meta-annotation type to specify
  7.  * how long annotations are to be retained.
  8.    *
  9.  * @author  Joshua Bloch
  10.  * @since 1.5
  11.    */
  12.    public enum RetentionPolicy {
  13.    /**
  14.     * 注解只在源代码级别保留，编译时被忽略
  15.       */
  16.       SOURCE,
  17.       /**
  18.     * 注解将被编译器在类文件中记录
  19.     * 但在运行时不需要JVM保留。这是默认的
  20.     * 行为.
  21.       */
  22.       CLASS,
  23.       /**
  24.        *注解将被编译器记录在类文件中
  25.        *在运行时保留VM，因此可以反读。
  26.     * @see java.lang.reflect.AnnotatedElement
  27.       */
  28.       RUNTIME
  29.       }
  30.       注解将被编译器在类文件中记录
  31.     * 但在运行时不需要JVM保留。这是默认的
  32.     * 行为.
  33.       */
  34.       CLASS,
  35.       /**
  36.        *注解将被编译器记录在类文件中
  37.        *在运行时保留VM，因此可以反读。
  38.     * @see java.lang.reflect.AnnotatedElement
  39.       */
  40.       RUNTIME
  41.       }

@Documented注解

Documented注解表明这个注解是由 javadoc记录的，在默认情况下也有类似的记录工具。 如果一个类型声明被注解了文档化，它的注解成为公共API的一部分。

自定义注解案例

本文以案例验证token为目的开发注解

1、pom依赖

  1. <!--aop启动器-->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-aop</artifactId>
  5. </dependency>

2、自定义注解类

  1. /**
  2.  * 自定义注解类
  3.  */
  4. //表示当前注解(@CheckToken)可以打在什么东西上面,此处可以放在类上与方法上
  5. @Target({ElementType.METHOD, ElementType.TYPE})
  6. @Retention(RetentionPolicy.RUNTIME) //运行时执行
  7. @Documented//指定被修饰的该Annotation可以被javadoc工具提取成文档
  8. public @interface CheckToken {
  9. //    String value() default "";
  10. }

3、切面类

  1. /**
  2.  * 切面类
  3.  */
  4. @Aspect//切面注解
  5. @Component
  6. @SuppressWarnings({"unused"})
  7. public class CheckTokenAspect {
  9.     //日志对象
  10.     public static final Logger logger = LoggerFactory.getLogger(CheckTokenAspect.class);
  11. ​
  12.     //切入点到自定义注解
  13.     @Pointcut("@annotation(com.yka.annotation.CheckToken)")
  14.     public void annotationPointcut() {
  16.     }
  18.     //前置通知
  19.     @Before("annotationPointcut()")
  20.     public void beforePointcut(JoinPoint joinPoint) throws Exception {
  21.         // 请求开始时间
  22.         ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  23.         String token  = sra.getRequest().getHeader("token");
  24. ​
  25.         //控制台日志打印
  26.         logger.info("token为："+token);
  27.         if (token == null || "".equals(token)) {
  28.             throw new Exception("token为空");//报错打印
  29.         }
  30.         //校验token
  31.     }
  33.     @Around("annotationPointcut()")
  34.     public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
  35.         return joinPoint.proceed();
  36.     }
  38.     /**
  39.      * 在切入点return内容之后切入内容（可以用来对处理返回值做一些加工处理）
  40.      * @param joinPoint
  41.      */
  42.     @AfterReturning("annotationPointcut()")
  43.     public void doAfterReturning(JoinPoint joinPoint) {
  44.     }
  46. }

4、应用

  1. @RestController
  2. public class AopController {
  3.     @PostMapping("/testPost")
  4.     @CheckToken//自定义注解
  5.     public String postTest(){
  6.         return "aaaaaaaaaaaa";
  7.     }
  8. }

5、测试

测试有token请求体，测试成功

666a5d5d199347bba00564123e473e7b.png

日志打印

c61df65a682b4efe9117fa1a5d62a2bf.png

测试没有token请求体，测试失败

67c4aa37551844549c15e6667b542545.png

日志打印：

801ec20cd32c413ab70e44f1fc4421a1.png

发表评论

表情：
评论列表 （有 0 条评论，177人围观）

还没有评论，来说两句吧...

相关阅读

    相关 springBoot自定义注解

    1.自定义注解一般用拦截或者在处理业务逻辑之前进行的操作，比如我们需要在每次处理前端发出的请求时进行认证token的操作，这时就需要自定义注解 2.自定义注解的实现

    我就是我我就是我/ 0 赞/ 180 阅读

    相关 springboot自定义注解

    在我们使用springboot的时候，需要使用自定义的注解，如日志的获取及保存，权限的前期判断，都可以自定义注解来实现功能， 自定义注解的核心原理，还是使用了spring自身

    忘是亡心i忘是亡心i/ 0 赞/ 97 阅读

    相关 SpringBoot自定义注解

    文章目录 简介 demo（自定义用户信息注解） 简介 在很多业务场景中，我们一般会对重复的代码进行抽取注册成一个工具类，但是每次都要引入该方法，显然不

    Dear 丶Dear 丶/ 0 赞/ 370 阅读