首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >java注解的用法

java注解的用法

原创
作者头像
堕落飞鸟
发布于 2023-04-01 11:16:34
发布于 2023-04-01 11:16:34
8040
举报
文章被收录于专栏:飞鸟的专栏飞鸟的专栏

Java 注解(Annotation)是一种元数据,它可以被添加到类、方法、字段、参数以及其他程序元素上。注解可以提供有关程序元素的信息,例如它们的作用、用法和期望值。在 Java 中,注解用于提供数据、行为和控制信息,以及在运行时生成代码的方式。

Java 中的注解可以分为三类:内置注解、标准注解和自定义注解。内置注解是由 Java SE API 定义的注解,例如 @Override、@Deprecated 和 @SuppressWarnings。标准注解是由其他 Java 规范定义的注解,例如 Servlet API 和 JPA 规范。自定义注解是由开发人员创建的注解,可以根据需要添加到程序元素中。

下面是一些常见的 Java 注解及其用途:

@Override:用于标识一个方法是覆盖了父类的方法。

代码语言:javascript
复制
@Override
public void onClick(View v) {
    // handle click event
}

@Deprecated:用于标识一个方法或类已经过时,不建议使用。

代码语言:javascript
复制
@Deprecated
public void oldMethod() {
    // do something
}

@SuppressWarnings:用于禁止编译器产生警告。

代码语言:javascript
复制
@SuppressWarnings("unchecked")
List<String> list = (List<String>) obj;

@FunctionalInterface:用于标识一个接口是函数式接口,即只有一个抽象方法。

代码语言:javascript
复制
@FunctionalInterface
public interface MyFunctionalInterface {
    void doSomething();
}

@NotNull:用于标识一个参数不能为 null。

代码语言:javascript
复制
public void doSomething(@NotNull String str) {
    // do something with str
}

除了上述常见注解外,Java 还支持自定义注解。自定义注解需要使用 @interface 关键字来定义,并可以包含元素,元素的类型可以是基本类型、枚举类型、Class 类型以及其他注解类型。下面是一个自定义注解的示例:

代码语言:javascript
复制
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    String value();
    int[] nums();
}

在上面的示例中,我们定义了一个 MyAnnotation 注解,该注解包含一个 value 元素和一个 nums 元素,分别用于存储字符串和整数数组类型的数据。

使用自定义注解时,需要将其添加到程序元素上,例如类、方法或字段。下面是一个使用 MyAnnotation 注解的示例:

代码语言:javascript
复制
public class MyClass {
    @MyAnnotation(value = "Hello World", nums = {1, 2, 3})
    public void myMethod() {
        // do something
    }
}

在上面的示例中,我们将 MyAnnotation 注解添加到 MyClass 类中的 myMethod 方法上,并为 value 元素和 nums 元素设置了相应的值。

总的来说,Java 注解是一种非常实用的语言特性,它可以提供有关程序元素的信息,并为代码生成、自动化测试等方面提供便利。通过使用注解,开发人员可以提高代码的可读性、可维护性和可重用性,以及减少代码中的错误和重复代码。

除了上述示例中提到的注解外,Java 还支持许多其他有用的注解,例如:

@Nullable:用于标识一个参数或返回值可以为 null。

代码语言:javascript
复制
public void doSomething(@Nullable String str) {
    // do something with str
}

@Documented:用于指示该注解应该包含在 Javadoc 中。

代码语言:javascript
复制
@Documented
public @interface MyAnnotation {
    // ...
}

@Retention:用于指定注解保留的时间。

代码语言:javascript
复制
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    // ...
}

@Target:用于指定注解可以应用的程序元素类型。

代码语言:javascript
复制
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    // ...
}

@Inherited:用于指定子类是否应该继承父类的注解。

代码语言:javascript
复制
javaCopy code@Inherited
public @interface MyAnnotation {
    // ...
}

在使用注解时,需要注意以下几点:

  1. 注解的元素必须要有默认值。
  2. 注解的元素类型必须是基本类型、枚举类型、Class 类型、注解类型或者它们的数组类型。
  3. 注解类型必须以 @interface 关键字开头。
  4. 注解元素可以有默认值,如果没有设置则使用默认值。
  5. 注解元素必须在使用时显式指定名称和值,例如 @MyAnnotation(value = "Hello World", nums = {1, 2, 3})。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

目录
  • @Override:用于标识一个方法是覆盖了父类的方法。
  • @Deprecated:用于标识一个方法或类已经过时,不建议使用。
  • @SuppressWarnings:用于禁止编译器产生警告。
  • @FunctionalInterface:用于标识一个接口是函数式接口,即只有一个抽象方法。
  • @NotNull:用于标识一个参数不能为 null。
  • @Nullable:用于标识一个参数或返回值可以为 null。
  • @Documented:用于指示该注解应该包含在 Javadoc 中。
  • @Retention:用于指定注解保留的时间。
  • @Target:用于指定注解可以应用的程序元素类型。
  • @Inherited:用于指定子类是否应该继承父类的注解。
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档