Java 注解

2025 年 4 月 21 日 | 阅读 5 分钟

Java 注解是一种标记，用于表示与类、接口、方法或字段关联的元数据，以提供一些额外的 Java 编译器和 JVM 可以使用的信息。

Java 中的注解用于提供额外信息，因此它是 XML 和 Java 标记接口的替代选项。

首先，我们将学习一些内置注解，然后我们将开始创建和使用自定义注解。

内置 Java 注解

Java 中有几种内置注解。有些注解应用于 Java 代码，有些应用于其他注解。

应用于 Java 代码的内置 Java 注解

@Override
@SuppressWarnings
@Deprecated

应用于其他注解的内置 Java 注解

@Target
@Retention
@Inherited
@Documented

理解内置注解

首先让我们理解内置注解。

@Override

@Override 注解确保子类方法正在重写父类方法。如果不是这样，则会发生编译时错误。

有时我们会犯一些低级错误，比如拼写错误等。所以最好标记 @Override 注解，它提供了方法已被重写的保证。

示例

class Animal{
void eatSomething(){System.out.println("eating something");}
}

class Dog extends Animal{
@Override
void eatsomething(){System.out.println("eating foods");}//should be eatSomething
}

class TestAnnotation1{
public static void main(String args[]){
Animal a=new Dog();
a.eatSomething();
}}

输出

Comple Time Error

@SuppressWarnings

@SuppressWarnings 注解：用于抑制编译器发出的警告。

示例

import java.util.*;
class TestAnnotation2{
@SuppressWarnings("unchecked")
public static void main(String args[]){
ArrayList list=new ArrayList();
list.add("sonoo");
list.add("vimal");
list.add("ratan");

for(Object obj:list)
System.out.println(obj);

}}

编译并运行

输出

sonoo
vimal
ratan

如果删除 @SuppressWarnings("unchecked") 注解，则在编译时会显示警告，因为我们正在使用非泛型集合。

@Deprecated

@Deprecated 注解标记该方法已弃用，因此编译器会打印警告。它通知用户该方法可能在未来的版本中被删除。因此，最好不要使用此类方法。

示例

class A{
void m(){System.out.println("hello m");}

@Deprecated
void n(){System.out.println("hello n");}
}

class TestAnnotation3{
public static void main(String args[]){

A a=new A();
a.n();
}}

编译时

Note: Test.java uses or overrides a deprecated API.

Note: Recompile with -Xlint:deprecation for details.

运行时

hello n

Java 自定义注解

Java 自定义注解或 Java 用户定义注解易于创建和使用。@interface 关键字用于声明一个注解。例如：

在这里，MyAnnotation 是自定义注解的名称。

Java 自定义注解签名要点

程序员应该记住几个要点。

方法不应有任何 throws 子句
方法应返回以下之一：原始数据类型、String、Class、enum 或这些数据类型的数组。
方法不应有任何参数。
定义注解时，应在 interface 关键字前加上 @。
可以为方法分配默认值。

注解类型

有三种类型的注解。

标记注解
单值注解
多值注解

1) 标记注解

没有方法的注解称为标记注解。例如：

@Override 和 @Deprecated 是标记注解。

2) 单值注解

只有一个方法的注解称为单值注解。例如：

@interface MyAnnotation{
int value();
}

我们也可以提供默认值。例如：

@interface MyAnnotation{
int value() default 0;
}

如何应用单值注解

让我们看看应用单值注解的代码。

值可以是任何东西。

3) 多值注解

有多个方法的注解称为多值注解。例如：

@interface MyAnnotation{
int value1();
String value2();
String value3();
}
}

我们也可以提供默认值。例如：

@interface MyAnnotation{
int value1() default 1;
String value2() default "";
String value3() default "xyz";
}

如何应用多值注解

让我们看看应用多值注解的代码。

Java 中用于自定义注解的内置注解

@Target
@Retention
@Inherited
@Documented

@Target

@Target 标签用于指定注解的使用类型。

java.lang.annotation. ElementType 枚举声明了许多常量，用于指定注解要应用的元素类型，例如 TYPE、METHOD、FIELD 等。让我们看看 ElementType 枚举的常量：

元素类型	注解可以应用于何处
类型	类、接口或枚举
字段	域
方法	方法
构造函数	构造函数
局部变量	局部变量
注解类型	注解类型
参数	参数

指定类注解的示例

@Target(ElementType.TYPE)
@interface MyAnnotation{
int value1();
String value2();
}

指定类、方法或字段注解的示例

@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
@interface MyAnnotation{
int value1();
String value2();
}

@Retention

@Retention 注解用于指定注解的可用级别。

RetentionPolicy	可用性
RetentionPolicy.SOURCE	指源代码，在编译过程中被丢弃。它不会出现在编译后的类文件中。
RetentionPolicy.CLASS	指 .class 文件，可供 Java 编译器使用，但不能供 JVM 使用。它包含在类文件中。
RetentionPolicy.RUNTIME	指运行时，可供 Java 编译器和 JVM 使用。

指定 RetentionPolicy 的示例

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation{
int value1();
String value2();
}

自定义注解示例：创建、应用和访问注解

让我们看一个创建、应用和访问注解的简单示例。

示例

//Creating annotation
import java.lang.annotation.*;
import java.lang.reflect.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@interface MyAnnotation{
int value();
}

//Applying annotation
class Hello{
@MyAnnotation(value=10)
public void sayHello(){System.out.println("hello annotation");}
}

//Accessing annotation
class TestCustomAnnotation1{
public static void main(String args[])throws Exception{

Hello h=new Hello();
Method m=h.getClass().getMethod("sayHello");

MyAnnotation manno=m.getAnnotation(MyAnnotation.class);
System.out.println("value is: "+manno.value());
}}

编译并运行

输出

value is: 10

下载此示例

实际场景中内置注解是如何使用的？

在实际场景中，Java 程序员只需要应用注解。他/她不需要创建和访问注解。创建和访问注解由实现提供者执行。Java 编译器或 JVM 会根据注解执行一些额外的操作。

@Inherited

默认情况下，注解不会被子类继承。@Inherited 注解标记注解以供子类继承。

@Inherited
@interface ForEveryone { }//Now it will be available to subclass also

@interface ForEveryone { }
class Superclass{}

class Subclass extends Superclass{}

@Documented

@Documented 标记注解以便包含在文档中。

下一主题Java 中的自动装箱与拆箱

我们提供所有技术（如 Java 教程、Android、Java 框架）的教程和面试问题

联系信息

G-13, 2nd Floor, Sec-3, Noida, UP, 201301, India

hr@tpointtech.com

+91-9599086977

关注我们

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Java 教程

控制语句

Java Object 类

Java 继承

Java 多态

Java 抽象

Java 封装

Java 数组

Java OOPs 杂项

Java 字符串

Java 正则表达式

异常处理

Java 内部类

Java 多线程

Java 同步

Java I/O

Java 文件处理

Java 序列化

Java 网络

Java 反射

Java 集合

Java 5 特性

Java 8 特性

Java JDBC

RMI

国际化

Java 项目