Java 自定义注解是一种特殊的接口(本质是接口,继承了Annotation类),它允许开发者定义注解类型,类似于创建一种新的“标签”或“标记”,可以将其应用于类、方法、变量等元素上,为这些元素添加特定的元数据信息。
自定义注解的定义使用 @interface
关键字。在注解的定义中,可以声明各种属性,属性可以有默认值。属性的类型可以是基本数据类型、字符串、枚举、其他注解类型或这些类型的数组。
自定义注解可以包含方法(称为注解元素),这些元素可以有默认值,并且可以有特定的数据类型。
自定义注解的创建遵循以下步骤:
- 定义注解:使用
@interface
关键字定义注解,可以包含注解元素。 - 指定保留策略:使用
@Retention
元注解指定注解的保留时间,可以是源代码(SOURCE
)、类文件(CLASS
)或运行时(RUNTIME
)。 - 指定目标:使用
@Target
元注解指定注解可以应用到哪些 Java 元素上,如类型、方法、构造函数、字段等。 - 定义元素:在注解接口中定义注解元素,这些元素可以有默认值。
import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; // 使用 @Retention 指定注解在运行时可访问 @Retention(RetentionPolicy.RUNTIME) // 使用 @Target 指定注解可以应用于方法上 @Target(ElementType.METHOD) public @interface MyCustomAnnotation { // 定义注解元素,可以有默认值 String value() default "Default Value"; }
使用自定义注解:
public class MyClass { // 将自定义注解应用于方法上 @MyCustomAnnotation(value = "Hello, Coze!") public void myMethod() { // 方法实现 } }
通过反射,可以在运行时检查和读取注解信息:
public class AnnotationTest { public static void main(String[] args) throws NoSuchMethodException { Method method = MyClass.class.getMethod("myMethod"); if (method.isAnnotationPresent(MyCustomAnnotation.class)) { MyCustomAnnotation annotation = method.getAnnotation(MyCustomAnnotation.class); System.out.println("注解的 value 属性: " + annotation.value()); } } }
总结:自定义注解是一种强大的工具,它可以帮助开发者在不修改现有代码的情况下,增加新的功能或约束,提高代码的可维护性和可扩展性