AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

java 元数据 和 元注解

2023-04-04 141
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： java 元数据 和 元注解。帮你看懂源码。
  • 基本介绍
  • 三种基本注解
  • @Override
  • @Deprecated
  • @SuppressWarnings
  • 四种元注解
  • @Retention
  • @Target
  • @Documented
  • @@Inherited

一、基本介绍

1.概述

java注解（Annotation）[ˌ  ænəˈ  teɪʃn]，又称java标注，也被称为元数据（关于数据的数据，描述数据的数据)（Metadata）[ˈ  metədeɪtə]，可用于修饰或者解释包、类、方法、属性、构造器，局部变量等数据信息。

java注解和注释一样，不会影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。在javaSE中，注解的功能比较单一，例如标记过时的功能，忽略警告等等。但注解在javaEE中占据了更重要的角色，尤其是在使用框架时，例如用来配置应用程序的任何切面，代替javaEE旧版中所残留的冗余代码和XML配置等等。

2.使用

使用Annotation时，要在它前面增加“@”符号，并把该注解当作一个修饰符来使用。以修饰它支持的程序元素。

二、3种基本注解

0.总览 :

  • @Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
  • @Deprecated - 标记某个程序元素（类或者方法等）已过时。如果使用该方法，会报编译警告。
  • @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

1.“@Override”：

①含义

Override就是重写的意思，如下 :

image.png

②源码

@Override最大的价值在于它的判断功能。通过Ctrl + b/B 可以查看@Override源码，如下 : 

/** Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.*********************/packagejava.lang;
importjava.lang.annotation.*;
/*** Indicates that a method declaration is intended to override a* method declaration in a supertype. If a method is annotated with* this annotation type compilers are required to generate an error* message unless at least one of the following conditions hold:** <ul><li>* The method does override or implement a method declared in a* supertype.* </li><li>* The method has a signature that is override-equivalent to that of* any public method declared in {@linkplain Object}.* </li></ul>** @author  Peter von der Ah&eacute;* @author  Joshua Bloch* @jls 8.4.8 Inheritance, Overriding, and Hiding* @jls 9.4.1 Inheritance and Overriding* @jls 9.6.4.4 @Override* @since 1.5*/@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public@interfaceOverride {
}

其实，@Override源码中，最重要的无非最后两行。“@interface”表示Override是一个注解类，而不是接口。

“@Override”只能修饰方法，不能修饰其他程序元素（比如类，包，属性等）。这一点，其实源码中也有体现——Override源码中的“@Target(ElementType.METHOD)”明确指出了修饰的元素类型是METHOD（方法）。

PS : “@Target”是用于修饰注解的注解，我们称之为“元注解”。

2.“@Deprecated”：

①含义

Deprecated就是不赞成的意思，如下 :

image.png

②源码

“@Deprecated”可以标记过时的程序元素。仍然通过Ctrl + b/B 快捷键追溯一下Deprecated的源码，如下 : (这次仅截取关键部分）

packagejava.lang;
importjava.lang.annotation.*;
importstaticjava.lang.annotation.ElementType.*;
@Documented@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE})
public@interfaceDeprecated {
Stringsince() default"";
booleanforRemoval() defaultfalse;
}

同样，“@interface”表示Deprecated是一个注解类。而“@Target”元注解中，也标注出了@Deprecated可以修饰的数据元素，从左往右依次为 : {构造器，属性，局部变量，方法，包，模块，参数，类型(即类）}。

③使用

“@Deprecated”修饰的程序元素并非无法使用，只是不建议使用。来举个栗子。

演示 : 

packageadvanced.Annotation;
/*** @author : Cyan_RA9* @version : 5.0*/publicclassDeprecated_ {
@Deprecatedpublicvoidf() {
System.out.println("这方法没啥屁用，不建议使用。你非要用当我没说。。。");
    }
}
classTest {
publicstaticvoidmain(String[] args) {
Deprecated_deprecated_=newDeprecated_();
deprecated_.f();
    }
}

运行结果 :

image.png

其实，当你在调用@Deprecated注解修饰的方法时，IDEA就会给出提示，如下图所示 :

image.png

可以明显看到被“@Deprecated”注解修饰的f() 方法是被删除线“      ”标注的。

④补充

啥时候用“@Deprecated”比较多？

比如，当JDK进行版本更迭的时候，新版本的JDK对旧版本的某些类或者某些方法进行了更新，可能会定义新的类型，这时候就会在旧版本的对应类型或者对应方法前打上@Deprecated标注，提醒java人们这是旧的啦，建议你用新的捏。

3.“@SuppressWarnings” :

①含义

SuppressWarnings就是抑制警告，禁止警告的意思，如下 : （Warnings小学词汇）

image.png

②格式

“@SuppressWarnings”的使用与前面两个注解略有出入。使用格式如下 : 

@SuppressWarnings("explanation1", "explanation2", "explanation3", ......)
//双引号中的说明信息不同，达到的抑制警告效果便不同。

③属性说明汇总

“@SuppressWarnings”中常见的属性说明有 :

"all"

抑制所有警告

"boxing"

抑制与“封装/拆装”相关的警告

"cast"

抑制与"强转类型"相关的警告

"dep-ann"

抑制与"淘汰注释"相关的警告

"deprecation"

抑制与"淘汰"相关的警告

"fallthrough"

抑制与"switch陈述式中遗漏break"相关的警告

"finally"

抑制与"未传回finally区块"相关的警告

"hiding"

抑制与"隐藏变数的区域变数"相关的警告

"incomplete-switch"

抑制与"switch陈述式(enum case)中遗漏项目"相关的警告

"javadoc"

抑制与"javadoc"相关的警告

"nls"

抑制与"非nls字串文字"相关的警告

"resource"

抑制与"使用Closeable类型的资源"相关的警告

"null"

抑制与"空值分析"相关的警告

"rawtypes"

抑制与"使用raw类型"相关的警告（泛型)

"restriction"

抑制与"使用不建议或禁止参照"相关的警告

"serial"

抑制与"可序列化的类别遗漏serialVersionUID栏位"相关的警告

"static-access"

抑制与"静态存取不正确"相关的警告

"static-method"

抑制与"可能宣告为static的方法"相关的警告

"super"

抑制与"置换方法相关但不含super呼叫"的警告

"synthetic-access"

抑制与"内部类别的存取未最佳化"相关的警告

"sync-override"

抑制"因置换同步方法而遗漏同步化"的警告

"unchecked"

抑制与"未检查的作业"相关的警告

"unqualified-field-access"

抑制与"栏位存取不合格"相关的警告

"unused"

抑制与"未用的程式码和停用的程式码"相关的警告（变量未使用）

部分属性演示 : 

packageadvanced.Annotation;
importjava.util.ArrayList;
importjava.util.List;
/*** @author : Cyan_RA9* @version : 5.0*/@SuppressWarnings({})
publicclassSuppressWarnings_ {
publicstaticvoidmain(String[] args) {
Listlist=newArrayList();
list.add("");
list.add(1);
list.add(1);
inti;
System.out.println(list.get(2));
    }
}

警告信息如下图所示 :

image.png

这时候可以通过在注解“@SuppressWarnings”中分别添加"rawtypes", "unchecked", "unused"属性说明来去除警告信息。如下图所示 :

image.png

添加属性说明后，⚠全部消失了，如下图所示 :

image.png

⑤作用域

关于@SuppressWarnings注解的作用域 : 取决于该注解的定义位置。

eg : 当它放在main方法前时，抑制警告的范围就是main函数；当它定义在类上，作用域就是整个类；当然，也可以在固定的警告语句上面使用@SuppressWarnings注解，通过传入指定的属性说明实现精准的消除警告。

⑥源码

通过Ctrl + b/B快捷键快速追溯到SuppressWarnings注解类的源码，源码如下 : （仅截取关键部分）

packagejava.lang;
importjava.lang.annotation.*;
importstaticjava.lang.annotation.ElementType.*;
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.SOURCE)
public@interfaceSuppressWarnings {
String[] value();
}

同样的。"@interface"元注解表明SuppressWarnings是一个注解类。而“@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})”表明了@SuppressWarnings注解的使用范围，从左往后依次是”{类型（类），属性，方法，参数，构造器，局部变量，模块}“。

三、4种元注解

0.总览 :

在Java中，将“修饰注解的注解”称为元注解。元注解使用并不多，本身作用也没多大，了解即可。可以看懂源码就足够了。

  • @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问（保存时间）。
  • @Documented - 标记这些注解是否包含在javadoc用户文档中。
  • @Target - 标记这个注解应该是哪种 Java 成员（可以作用于哪些程序元素）。
  • @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

1.“@Retention”：

①含义

Retention就是保持，保留的意思，如下图所示 :

image.png

②使用

“@Retention”只能用于修饰一个注解定义，用于指定该注解可以保留多长时间，@Retention元注解中包含一个RetentionPolicy类型的成员变量，使用@Retention元注解时，必须为该成员变量指定值。

RetentionPolicy成员变量的三种值 :

RetentionPolicy.SOURCE

编译器使用后，直接丢弃这种策略的注解

RetentionPolicy.CLASS

编译器将把注解记录在class文件中，当运行程序时，jvm不会保留注解，这是成员变量的默认值

RetentionPolicy.RUNTIME

编译器将把注解记录在class文件中，当运行程序时，jvm会保留注解，程序可以通过反射获取该注解。

③示意图

三种成员变量值的效果如下 :

image.png

演示 :

以Override的源码为例，如下：（仅截取关键部分）

packagejava.lang;
importjava.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public@interfaceOverride {
}

注意看，“@Retention(RetentionPolicy.SOURCE)”中，RetentionPolicy类枚举常量是SOURCE，这就表示“@Override”注解生效的范围仅仅在.java的源文件中，不会在.class文件中生效，也不会在程序运行时被jvm读取。

2."@Target" :

①含义

Target就是目标的意思，如下图所示 :

image.png

②使用

”@Target“元注解可以指明当前注解可以作用于哪些程序元素。之前的三大基本注解中，均演示过”@Target“元注解。如下 :


image.png


③源码

Target元注解源码如下：（仅截取了重要部分)

packagejava.lang.annotation;
@Documented@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public@interfaceTarget {
ElementType[] value();
}

可以看到Target底层是一个ElementType类型的数组。而通过Ctrl + b/B追溯源码，我们可以看到ElementType本质上是一个枚举类。如下 : 

packagejava.lang.annotation;
publicenumElementType {
/** Class, interface (including annotation interface), enum, or record* declaration */TYPE,
/** Field declaration (includes enum constants) */FIELD,
/** Method declaration */METHOD,
/** Formal parameter declaration */PARAMETER,
/** Constructor declaration */CONSTRUCTOR,
/** Local variable declaration */LOCAL_VARIABLE,
/** Annotation interface declaration (Formerly known as an annotation type.) */ANNOTATION_TYPE,
/** Package declaration */PACKAGE,
/*** Type parameter declaration** @since 1.8*/TYPE_PARAMETER,
/*** Use of a type** @since 1.8*/TYPE_USE,
/*** Module declaration.** @since 9*/MODULE,
/*** Record component** @jls 8.10.3 Record Members* @jls 9.7.4 Where Annotations May Appear** @since 16*/RECORD_COMPONENT;
}

ElementType枚举类中的这些枚举常量，其实就是我们说的”程序元素“。即注解可作用于的程序成分。

3.”@Documented“ :

①含义

Documented就是登记在案，文件化的意思，如下图所示 :

image.png

②使用

“@Documented”元注解修饰的注解类，会在javadoc文件中显式地呈现。

演示 :

先定义一个注解类Demo，并在该注解类中使用@Documented元注解修饰。如下 : 

packageadvanced.Annotation;
importjava.lang.annotation.*;
/*** @author : Cyan_RA9* @version : 2.0*/@Documented@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.METHOD)
public@interfaceDemo {
//自定义一个注解类。}

然后在定义一个测试类Test_EX，并在测试类中定义两个方法，用自定义的注解”@Demo“去修饰方法。如下 : 

packageadvanced.Annotation.test;
importadvanced.Annotation.Demo;
/*** @author : Cyan_RA9* @version : 1.0*/classTest_EX {
@Demopublicvoidgreet() {
System.out.println("Hello!");
    }
@Demopublicvoideat() {
System.out.println("美汁儿美汁儿~");
    }
}

然后通过IDEA自带的生成javadoc的功能生成该测试类的javadoc文件，如下GIF图所示 :

image.png

可以看到，greet方法和eat方法的”@Demo“都保留在了生成的javadoc文件中。

4.”@Inherited“ ：

①含义

Inherited就是继承的意思，如下所示 :

image.png

②使用

如果每个类使用了注解，而这种注解恰好被”@Inherited“元注解修饰，那么该类的子类同样会自动拥有父类的注解。

System.out.println("END-----------------------------------------------");

文章标签：
Java
数据格式
XML
编译器
关键词：
Java元数据
Java元注解
Cyan_RA9
目录
相关文章
Java开发者
|
28天前
|
Java 编译器 数据库
Java 中的注解（Annotations）：代码中的 “元数据” 魔法
Java注解是代码中的“元数据”标签，不直接参与业务逻辑，但在编译或运行时提供重要信息。本文介绍了注解的基础语法、内置注解的应用场景，以及如何自定义注解和结合AOP技术实现方法执行日志记录，展示了注解在提升代码质量、简化开发流程和增强程序功能方面的强大作用。
Java开发者
68 5
杀死一只知更鸟debug
|
3月前
|
Java 编译器 程序员
Java注解，元注解，自定义注解的使用
本文讲解了Java中注解的概念和作用，包括基本注解的用法（@Override, @Deprecated, @SuppressWarnings, @SafeVarargs, @FunctionalInterface），Java提供的元注解（@Retention, @Target, @Documented, @Inherited），以及如何自定义注解并通过反射获取注解信息。
杀死一只知更鸟debug
48 0
Java注解，元注解，自定义注解的使用
众所周知
|
6月前
|
IDE Java 编译器
深入解析JAVA注解：元数据如何改变编程世界
【6月更文挑战第29天】Java注解，作为元数据机制，为代码增添上下文信息，改变编程方式。注解标记在类、方法等上，不直接影响执行，但为编译器等提供额外信息。分为元注解、编译时和运行时注解，用于元数据提供、代码简化、提高可读性及自动化。示例展示了定义`@Loggable`注解来标记日志记录方法。注解广泛应用于依赖注入、ORM、Web服务等，提升效率和灵活性，是现代Java开发的关键。未来其应用将更广泛。
众所周知
90 3
土木林森
|
6月前
|
XML Java 编译器
JAVA注解大揭秘：元数据，你真的了解它吗？
【6月更文挑战第29天】Java注解是元数据机制，用于为代码添加不改变逻辑的额外信息。它们在编译检查（如`@Override`）、配置（如Spring的`@Autowired`）和自定义元数据中发挥作用。自定义注解如`@Loggable`可配合AOP实现日志记录，简化代码并增强可维护性。通过定义切面类和使用`@Before`、`@After`，可以拦截并处理带注解的方法，展示注解在实际应用中的灵活性。
土木林森
82 1
龙大吉
|
6月前
|
IDE Java 数据库连接
JAVA注解：元数据，代码的“身份证”？！
【6月更文挑战第29天】Java注解，作为代码的“身份证”，提供元数据，用于编译时检查、自动生成代码和框架集成。例如，@Override确保方法重写正确，@Deprecated标记过时，@Autowired在Spring中实现依赖注入。Lombok的@Getter/@Setter简化getter/setter。注解提升代码质量和效率，是现代Java开发的关键实践。
龙大吉
39 0
众所周知
|
6月前
|
IDE Java 数据库连接
JAVA注解：那些年，我们错过的代码元数据！
【6月更文挑战第29天】Java注解，非执行代码的元数据，常被误解为注释。其实，它们支持编译时检查（如@Override）、自动生成代码、依赖注入（如Spring）和ORM映射（如Hibernate）。通过自定义注解，如示例中的`@MyAnnotation`，可在运行时通过反射增强方法功能。别再错过注解的力量，让它们提升代码的灵活性和可维护性！
众所周知
37 0
Water
|
Java
Java -- 元注解
@Target(ElementType.ANNOTATION_TYPE)：指定该注解可以用于注解类、接口或枚举类型。 @Retention(RetentionPolicy.RUNTIME)：指定该注解的保留策略，即在程序运行时也可以访问到该注解。 @Documented：指定该注解应该被包含在 Java 文档中。 @Inherited：指定该注解可以继承自父类。
Water
66 0
武梓龙_Wzill
|
Java 容器
Java-元注解
Java-元注解
武梓龙_Wzill
97 0
阿仇_Parsifal
|
Java 编译器
JAVA-元注解和注解
JAVA-元注解和注解
阿仇_Parsifal
99 0
黑格（Haig）
|
Java
Java注解--元注解
元注解的个人总结
黑格（Haig）
70 0

热门文章

最新文章

  • 1
    Java volatile关键字：你真的懂了吗？
  • 2
    java小工具util系列2：字符串工具
  • 3
    Java爬虫：数据采集的强大工具
  • 4
    Java多线程并发编程：同步机制与实践应用
  • 5
    Java中的异常处理：从基础到高级
  • 6
    深入理解Java异常处理机制
  • 7
    Liunx部署java项目Tomcat、Redis、Mysql教程
  • 8
    Java爬虫：深入解析商品详情的利器
  • 9
    java实现从HDFS上下载文件及文件夹的功能，以流形式输出，便于用户自定义保存任何路径下
  • 10
    Java 异常处理：机制、策略与最佳实践
  • 1
    【Java开发指南 | 第三十一篇】Java 包(package)
    83
  • 2
    【Java开发指南 | 第二十九篇】Java接口
    50
  • 3
    【Java开发指南 | 第二十八篇】Java封装
    60
  • 4
    【Java开发指南 | 第二十六篇】Java多态
    41
  • 5
    【Java开发指南 | 第二十四篇】Java继承
    61
  • 6
    【Java开发指南 | 第九篇】访问实例变量和方法、继承、接口
    59
  • 7
    【Java开发指南 | 第八篇】Java变量、构造方法、创建对象
    93
  • 8
    Java Stream API详解与使用
    99
  • 9
    Java医院绩效考核系统源码B/S+avue+MySQL助力医院实现精细化管理
    82
  • 10
    《手把手教你》系列技巧篇（四十三）-java+ selenium自动化测试-处理https 安全问题或者非信任站点-上篇（详解教程）
    134

    • 相关课程

    更多
  • Java面试疑难点解析 - 面试技巧及语言基础
  • Java面试疑难点解析 - Java Web开发
  • Java面试疑难点解析 - 系统架构及项目设计
  • Java编程入门
  • Java面向对象编程
  • Java高级编程

    • 相关电子书

    更多
  • Spring Cloud Alibaba - 重新定义 Java Cloud-Native
  • The Reactive Cloud Native Arch
  • JAVA开发手册1.5.0

    • 相关实验场景

    更多
  • 阿里云平台上进行Java程序的编译与运行
  • 使用Java面向对象编写网络通信程序应用
  • 手动部署Java Web环境（Alibaba Cloud Linux 2）
  • 搭建Java Web开发环境（Anolis OS）
  • RocketMQ中使用Java客户端发送消息和消费的应用
  • 部署基于Dragonwell的Java运行环境
    • 下一篇
    手把手教你白嫖阿里云服务器(免费领服务器)