首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >Java 注解知识点小结

Java 注解知识点小结

作者头像
windealli
发布于 2023-10-13 11:33:37
发布于 2023-10-13 11:33:37
4780
举报
文章被收录于专栏:windealliwindealli

一、引言

Java Annotation,即Java注解。

Java Annotation作为Java最重要的feature之一,广泛应用于Java应用开发中。

Java 注解 为Java开发者提供了一种强大的方式来在代码中添加元数据信息,从而影响编译、运行时行为以及整个应用程序的结构。

本文旨在深入介绍Java注解的相关概念,从而帮助读者更好地运用这个强大的编程工具,构建灵活的、可拓展、可维护的Java应用程序。

二、Java Annotation简介

Java注解(Annotation)是一种元数据标记机制,用于向Java源代码中添加元数据信息。

它们是Java语言的一项重要特性,允许程序员在源代码中嵌入有关程序的额外信息,而这些信息可以在编译、运行时或甚至是在程序运行期间被读取和处理。

下面是一个使用内置Override注解的简单示例。

代码语言:javascript
复制
class Animal {
    void makeSound() {
        System.out.println("Animal makes a sound");
    }
}

class Dog extends Animal {
    @Override
    void makeSound() {
        System.out.println("Dog barks");
    }
}

注解Override用于标记一个方法覆盖了父类中的方法。

Java提供了许多内置的注解,用于不同的用途。以下是一些常用的注解。

  • @Override: 用于标记一个方法覆盖了父类中的方法。
  • @Deprecated: 用于标记一个类、方法或字段已经过时,不推荐使用。
  • @SuppressWarnings: 用于抑制编译器警告。
  • @SafeVarargs: 用于标记方法是类型安全的可变参数方法。

三、Java注解的语法

Java注解的语法可以从 声明注解、使用注解、如何访问注解信息三方面来理解

声明注解

注解的声明使用 @interface 关键字,后跟注解的名称。注解名称遵循Java标识符的命名规范。

注解可以包含成员,成员可以是基本数据类型、枚举、字符串、Class类型、其他注解或它们的数组形式。

下面代码声明了一个名为MyAnnotation的注解。

使用注解

可以在类、方法、字段等元素上使用注解。使用注解时,将 @ 符号后跟注解的名称,可以为注解的成员指定值。

代码语言:javascript
复制
@MyAnnotation(value = "MainClass", count = 5, type = String.class, elements = {ElementType.METHOD, ElementType.FIELD})
public class MyClass {
    @MyAnnotation("Field")
    private String myField;

    @MyAnnotation("Greeting")
    public void sayHello() {
        System.out.println("Hello, World!");
    }
}

上面的示例,分别为MyClass类、myField字段、saHello方法使用注解,并分别为全部或者部分成员制定了值。

访问注解成员

在编译时或运行时,可以使用反射机制访问注解信息。

代码语言:javascript
复制
MyAnnotation classAnnotation = MyClass.class.getAnnotation(MyAnnotation.class);
String value = classAnnotation.value(); // 获取类注解的"value"成员的值

MyAnnotation fieldAnnotation = MyClass.class.getDeclaredField("myField").getAnnotation(MyAnnotation.class);
String fieldValue = fieldAnnotation.value(); // 获取字段注解的"value"成员的值

MyAnnotation methodAnnotation = MyClass.class.getDeclaredMethod("sayHello").getAnnotation(MyAnnotation.class);
String methodValue = methodAnnotation.value(); // 获取方法注解的"value"成员的值

四、元注解

元注解(Meta-Annotation)是一种特殊的注解,用于注解其他注解,定义和控制其他注解行为。

换句话说,元注解即注解的注解

以下是几种常见的元注解:

  1. @Retention: 用于指定注解的保留策略,即注解在何时可见。常见的保留策略包括:
    • RetentionPolicy.SOURCE:注解仅在源代码级别可见,在编译后不会包含在class文件中。
    • RetentionPolicy.CLASS:注解在编译后会包含在class文件中,但在运行时不可见(默认值)。
    • RetentionPolicy.RUNTIME:注解在运行时可见,并可以通过反射机制访问。
  2. @Target: 用于指定注解可以应用的目标元素类型,例如类、方法、字段等。常见的目标类型包括:
    • ElementType.TYPE:类、接口、枚举。
    • ElementType.METHOD:方法。
    • ElementType.FIELD:字段。
    • ElementType.PARAMETER:方法参数。
    • 等等。
  3. @Documented: 用于指定注解是否应该包含在生成的Java文档中。如果一个注解标记了 @Documented,则它将出现在生成的文档中。
  4. @Inherited: 用于指定注解是否应该被子类继承。如果一个类标记了带有 @Inherited 的注解,子类会继承这个注解。
  5. @Repeatable: 用于指定某个注解是否支持多次应用在同一个元素上,从而简化注解的使用。这个元注解是Java 8中引入的。

以下是一个示例,演示如何使用元注解来定义自定义注解:

代码语言:javascript
复制
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 "Default Value";
}

在上述示例中,@Retention(RetentionPolicy.RUNTIME) 和 @Target(ElementType.METHOD) 是两个元注解,它们分别指定了自定义注解 @MyCustomAnnotation 的保留策略和作用目标。元注解帮助定义了 @MyCustomAnnotation 注解的行为。

元注解是自定义注解的基础,允许开发人员以灵活的方式定义和控制注解的行为。

通过选择不同的元注解和组合方式,可以创建适合特定需求的自定义注解。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2023-09-21,如有侵权请联系 cloudcommunity@tencent.com 删除
目录
  • 一、引言
  • 二、Java Annotation简介
  • 三、Java注解的语法
    • 声明注解
    • 使用注解
    • 访问注解成员
  • 四、元注解
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档