Spring Boot中的自定义注解

三文鱼先生

已于 2023-05-26 11:37:20 修改

阅读量1.5k

点赞数 2

分类专栏： ChatGpt学习问答文章标签： spring boot java spring 注解 ChatGpt

于 2023-05-25 17:03:30 首次发布

本文链接：https://blog.csdn.net/qq_44717657/article/details/130869793

版权

ChatGpt学习问答专栏收录该内容

4 篇文章 0 订阅

订阅专栏

Spring Boot中的自定义注解

前言
什么是注解
在Spring Boot中自定义注解是什么
自定义注解的组成部分有哪些
更加详细的元注解说明
自定义注解常用的场景有哪些
一个简单的自定义注解的示例，及分析

前言

以下内容为本人学习Spring Boot的自定义注解与ChatGpt提问后对其回答进行部分修改（有的错误实在是离谱 = =）、格式调整等操作后的答案，可能对于其中部分细节（是错是对，能力有限有的看不出来 = =），并未做深入探究，大家感兴趣的话可以自行验证。

什么是注解

注解（Annotation）是Java语言的一种特殊语法元素，用于在源代码中添加元数据信息。它可以在编译阶段、运行时或者在开发工具中被读取和处理。注解提供了一种在程序中插入元数据的方式，用于对代码进行标记和配置，以实现特定的功能和行为。

注解以@符号开头，紧跟注解名称和一对括号，可以包含一些参数和值。注解可以应用于类、方法、字段、参数等元素上，并可以通过反射机制获取和处理。

Java内置了一些常用的注解，例如@Override、@Deprecated、@SuppressWarnings等，它们在编译器和工具中起到了特殊的作用。

注解在Java中的应用非常广泛，特别在框架和库的开发中起到了重要的作用。在Spring Boot等框架中，注解被广泛用于配置、路由、依赖注入等方面，简化了开发过程，提高了代码的可读性和可维护性。注解还在ORM（对象关系映射）、单元测试、Web开发等领域发挥了重要作用。

在Spring Boot中自定义注解是什么

在Spring Boot中，自定义注解是指开发人员根据自己的需求，通过使用Java的注解机制自定义的注解。Spring Boot框架本身也大量使用注解，例如@Controller、@RequestMapping等。开发人员可以根据自己的业务需求，通过自定义注解来实现一些特定的功能或逻辑。

自定义注解可以在Spring Boot应用中用于以下目的：

标记和识别特定的类、方法、字段等元素，以便在运行时进行处理。例如，可以自定义一个注解来标记需要进行权限验证的方法，然后在AOP切面中拦截这些方法并进行权限检查。
添加额外的元数据信息，以便在运行时获取和使用。例如，可以自定义一个注解来标记需要进行日志记录的方法，然后在AOP切面中拦截这些方法并记录日志。
配置和控制特定的功能或行为。例如，可以自定义一个注解来指定某个方法需要使用缓存，然后在AOP切面中拦截这些方法并处理缓存逻辑。

通过自定义注解，开发人员可以在Spring Boot应用中实现更加灵活和可扩展的功能，减少样板代码，并提高代码的可读性和维护性。

请注意，在使用自定义注解时，一般需要结合其他的Spring Boot特性和机制，例如AOP、反射、自定义注解处理器等，来实现具体的功能和逻辑。

自定义注解的组成部分有哪些

自定义注解由以下几个组成部分构成：

注解声明：使用 @interface 关键字定义一个注解。注解声明定义了注解的名称以及可选的元注解和成员。
元注解：元注解用于修饰注解声明。元注解提供了关于注解自身的信息。常用的元注解包括 @Retention、@Target、@Documented、@Inherited 等。
成员变量：注解可以具有成员变量，这些成员变量被称为注解的成员。成员变量在注解中以方法的形式声明，并且可以指定默认值。成员变量可以是基本数据类型、枚举类型、字符串类型、Class 类型、其他注解类型或以上类型的数组。
保留策略注解：使用 @Retention 元注解来指定注解的保留策略。保留策略定义了注解在编译时、类加载时或运行时的生命周期。常用的保留策略包括 RetentionPolicy.SOURCE、
RetentionPolicy.CLASS 以及 RetentionPolicy.RUNTIME。
目标注解：使用 @Target 元注解来指定注解可以应用的目标元素类型。目标元素类型可以是类、接口、方法、字段等。常用的目标元素类型包括
ElementType.TYPE
ElementType.METHOD
ElementType.FIELD
ElementType.PARAMETER 等。
元素获取方法：注解可以通过反射机制获取其中的成员变量值。通过在注解声明中定义相应的方法，并使用 default 关键字指定默认值，可以在使用注解时直接获取成员变量的值。

更加详细的元注解说明

@Retention：@Retention 元注解用于指定注解的保留策略，即注解在什么时候有效。它接受一个参数，即 RetentionPolicy 枚举类型，包括以下三个选项：

RetentionPolicy.SOURCE：注解只在源代码中保留，不会被编译进字节码文件，也不会在运行时可用。

RetentionPolicy.CLASS：注解会被编译进字节码文件中，但在运行时不可用，这是默认的保留策略。

RetentionPolicy.RUNTIME：注解会被编译进字节码文件中，并在运行时可通过反射机制获取和使用。
@Target：@Target 元注解用于指定注解可以应用的目标元素类型。它接受一个参数，即 ElementType 枚举类型，包括以下选项之一或多个：

ElementType.TYPE：类、接口、枚举类型。

ElementType.METHOD：方法。

ElementType.FIELD：字段（成员变量）。

ElementType.PARAMETER：方法参数。

ElementType.CONSTRUCTOR：构造函数。

ElementType.LOCAL_VARIABLE：局部变量。

ElementType.ANNOTATION_TYPE：注解。

ElementType.PACKAGE：包。
@Documented：@Documented 元注解用于指定被该注解标记的元素是否应包含在生成的文档中。当一个注解被 @Documented 注解标记时，该注解的信息会包含在生成的 API 文档中，方便用户查阅。
@Inherited：@Inherited 元注解用于指定注解是否可以被继承。当一个被 @Inherited 注解标记的注解被用于一个父类时，子类也会继承该注解。注意，@Inherited 只适用于类级别的注解，对于方法、字段等级别的注解不起作用。

这些元注解提供了更多的元数据信息，用于修饰自定义注解的行为和使用方式。通过使用这些元注解，我们可以更精确地控制自定义注解的应用场景和可见性。

自定义注解常用的场景有哪些

自定义注解可以根据实际需求应用于不同的场景。以下是一些常见的使用场景：

配置和标记：自定义注解可以用于配置和标记特定的类、方法、字段等元素。通过在代码中使用注解，可以将一些特定的配置信息与代码关联起来，以便在运行时进行处理。例如，在Spring Boot中，使用注解来配置路由映射、数据源、缓存等。
AOP（面向切面编程，主要是这个）：自定义注解可以用于定义切点，即指定在哪些方法或类中应用特定的切面逻辑。通过自定义注解，可以将横切关注点（如日志记录、事务管理）与业务逻辑进行解耦，并在运行时动态地将切面逻辑织入到目标代码中。
权限控制：自定义注解可以用于标记需要进行权限控制的方法或类。通过自定义注解，可以在运行时拦截方法调用并进行权限检查。这样可以简化权限控制的实现，使代码更加可读和可维护。
数据校验：自定义注解可以用于对输入参数进行校验。通过在方法的参数上添加注解，可以在运行时对参数进行检查，确保其满足特定的规则或约束。例如，在Spring Boot中，可以使用注解来进行表单验证、数据合法性检查等。
文档生成：自定义注解可以用于生成文档或其他形式的元数据。通过在代码中添加注解，可以将相关信息提取出来，用于生成API文档、接口文档、配置文件等。
扩展框架：自定义注解可以用于扩展框架或库的功能。通过自定义注解，可以为框架添加额外的元数据信息，以实现更灵活的配置和行为。例如，在JUnit框架中，可以使用自定义注解来定义测试用例、设置测试环境等。

以上只是一些常见的使用场景，实际上，自定义注解的应用范围非常广泛，可以根据具体的需求和场景进行灵活的使用。

一个简单的自定义注解的示例，及分析

下面是一个简单的自定义注解的示例及其各部分的分析：

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 MyAnnotation {
    String value() default "";
    int number() default 0;
}

在上述示例中，我们定义了一个名为 MyAnnotation 的自定义注解，它具有以下特征：

@Retention(RetentionPolicy.RUNTIME)：通过 @Retention 元注解指定了注解的保留策略为 RUNTIME，表示该注解在运行时仍然可用，可以通过反射获取。
@Target(ElementType.METHOD)：通过 @Target 元注解指定了注解的适用目标为方法，表示该注解可以应用于方法上。
public @interface MyAnnotation：使用 @interface 关键字声明一个自定义注解，注解的名称为 MyAnnotation。

注解的成员变量定义如下：

String value() default "";：定义了一个名为 value 的成员变量，类型为 String，并设置了默认值为空字符串。
int number() default 0;：定义了一个名为 number 的成员变量，类型为 int，并设置了默认值为0。

通过以上定义，我们可以在代码中使用 @MyAnnotation 注解，并为其成员变量指定值或使用默认值。例如：

@MyAnnotation(value = "example", number = 42)
public void myMethod() {
    // 方法体
}

在这个示例中，@MyAnnotation 注解应用于 myMethod 方法，并为注解的成员变量 value 和 number 指定了值。

通过反射机制，我们可以获取应用了 @MyAnnotation 注解的方法，并获取注解的成员变量值。例如：

Method method = MyClass.class.getMethod("myMethod");

if (method.isAnnotationPresent(MyAnnotation.class)) {
    MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
    String value = annotation.value();
    int number = annotation.number();
    
    System.out.println("Annotation value: " + value);
    System.out.println("Annotation number: " + number);
}