注解Annotation - Java

最新推荐文章于 2024-06-05 21:00:00 发布

aPurpleBerry

最新推荐文章于 2024-06-05 21:00:00 发布

阅读量894

点赞数 20

分类专栏： Java SE 文章标签： java

本文链接：https://blog.csdn.net/yavlgloss/article/details/134688541

版权

Java SE 专栏收录该内容

64 篇文章 0 订阅

订阅专栏

注解Annotation

一、介绍
二、使用
三、三个基本的Annotation
四、JDK内置的基本注解类型
五、JDK的元注解

一、介绍

注解（Annotation）也被称为元数据（Metadata），用于修饰解释包、
类、方法、属性、构造器、局部变量等数据信息。
和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。
在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替 java EE 旧版中所遗留的繁冗代码和 XML 配置等。

二、使用

使用 Annotation时要在其前面增加@符号，并把该Annotation当成一个修饰符使用。用于修饰它支持的程序元素。

三、三个基本的Annotation

@Override：限定某个方法，是重写父类方法，该注解只能用于方法
@Deprecated：用于表示某个程序元素（类，方法等）已过时
@SuppressWarnings：抑制编译器警告

四、JDK内置的基本注解类型

1、@Override

@Override：限定某个方法，是重写父类方法，该注解只能用于方法。

class Father{//父类
    public void fly(){
        int i = 0;
        System.out.println("Father fly...");
    }
    public void say(){}
}

class Son extends Father {//子类
    @Override   //说明
    public void fly() {
        System.out.println("Son fly....");
    }
    @Override
    public void say() {}
}

第十行：

@Override 注解放在fly方法上，表示子类的fly方法时重写了父类的fly
这里如果没有写 @Override 还是重写了父类fly
如果你写了@Override注解，编译器就会去检查该方法是否真的重写了父类的方法，如果的确重写了，则编译通过；如果没有构成重写，则编译错误。
看看 @Override的定义

解读：如果以后看代码中，发现 @interface，这表示一个注解类
补充说明：@interface不是interface（不是接口），是注解类，是jdk1.5之后加入的。

【使用说明】
① @Override表示指定重写父类的方法（从编译层面验证)，如果父类没有fly方法，则会报错
② 如果不写@Override注解，而父类仍有 public void fly(){}，仍然构成重写
③ @Override只能修饰方法，不能修饰其它类，包，属性等等
④ 查看@Override注解的源码为@Target(ElementType.METHOD)，说明只能修饰方法
⑤ @Target是修饰注解的注解，称为元注解

2、@Deprecated

用于表示某个程序元素（类，方法，字段，包，参数等等）已过时。

在这里插入图片描述

@Deprecated 修饰某个元素，表示该元素已经过时
即不在推荐使用，但是仍然可以使用
查看 @Deprecated注解类的源码：

（1）用@interface修饰：表示是一个注解类。
（2）@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE}) ：表示可以在这些地方使用。
（3）可以做版本升级过渡。比如 JDK8 升级到 JDK11，有一个类进行了升级，告诉用户这个类已经不推荐使用。

3、@SuppressWarnings

抑制编译器警告。

在这里插入图片描述
有很多警告，但运行没问题。

1、当我们不希望看到这些警告的时候，可以使用 SuppressWarnings 注解来抑制警告信息
2、在{“”} 中，可以写入你希望抑制(不显示)警告信息

@SuppressWarnings({“”})

3、可以指定的警告类型有：

all，抑制所有警告
boxing，抑制与封装/拆装作业相关的警告
cast，抑制与强制转型作业相关的警告
dep-ann，抑制与淘汰注释相关的警告
deprecation，抑制与淘汰的相关警告
fallthrough，抑制与switch陈述式中遗漏break相关的警告
finally，抑制与未传回finally区块相关的警告
hiding，抑制与隐藏变数的区域变数相关的警告
incomplete-switch，抑制与switch陈述式(enum case)中遗漏项目相关的警告
javadoc，抑制与javadoc相关的警告
nls，抑制与非nls字串文字相关的警告
null，抑制与空值分析相关的警告
rawtypes，抑制与使用raw类型相关的警告
resource，抑制与使用Closeable类型的资源相关的警告
restriction，抑制与使用不建议或禁止参照相关的警告
serial，抑制与可序列化的类别遗漏serialVersionUID栏位相关的警告
static-access，抑制与静态存取不正确相关的警告
static-method，抑制与可能宣告为static的方法相关的警告
super，抑制与置换方法相关但不含super呼叫的警告
synthetic-access，抑制与内部类别的存取未最佳化相关的警告
sync-override，抑制因为置换同步方法而遗漏同步化的警告
unchecked，抑制与未检查的作业相关的警告
unqualified-field-access，抑制与栏位存取不合格相关的警告
unused，抑制与未用的程式码及停用的程式码相关的警告

如何精准定位
鼠标光标放在右侧，这里显示 raw use => 和raw有关，所以选择rawtypes

4、关于SuppressWarnings 作用范围是和你放置的位置相关
比如 @SuppressWarnings放置在 main方法，那么抑制警告的范围就是 main。
通常我们可以放置具体的语句，方法，类。

5、@SuppressWarnings 源码
在这里插入图片描述

（1）放置的位置
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
（2）该注解类有一个数组 String[] value();
可以设置一个数组比如{“rawtypes” ,“unchecked”, “unused”}

五、JDK的元注解

JDK的元Annotation 用于修饰其他Annotation。

元注解：本身作用不大，了解即可。看源码时，可以知道它是干什么的。

元注解的种类(使用不多，了解，不用深入研究)
1、Retention——指定注解的作用范围,三种SOURCE,CLASS,RUNTIME
2、Target——指定注解可以在哪些地方使用
3、Documented——指定该注解是否会在javadoc体现
4、Inherited——子类会继承父类注解

1、Retention

基本说明：只能用于修饰一个 Annotation定义，用于指定该Annotation可以保留多长时间，Rentention包含一个 RetentionPolicy类型的成员变量，使用@Rentention时必须为该value成员变量指定值：
在这里插入图片描述
@Retention的三种值
（1）RetentionPolicy.SOURCE：编译器使用后，直接丢弃这种策略的注释
（2）RetentionPolicy.CLASS：编译器将把注解记录在class文件中。当运行Java程序时，JVM不会保留注解。这是默认值。
（3）RetentionPolicy.RUNTIME：编译器将把注解记录在class文件中。当运行Java程序时，JVM会保留注解。程序可以通过反射获取该注解。

进一步解释说明这三种值
《java源文件》通过【javac】编译成《class文件》，再通过【java】运行，运行时加载到JVM中运行。
RetentionPolicy.SOURCE 作用在《java源文件》
RetentionPolicy.CLASS 作用在《class文件》
RetentionPolicy.RUNTIME 当在JVM运行时，还保留。

案例 - @override
在这里插入图片描述
说明：Override的作用域在SOURCE，当编译器编译时生效，不会入到.class文件，也不会再runtime(运行时)生效。

2、Target

基本说明
用于修饰Annotation定义，用于指定被修饰的Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为value的成员变量。

在这里插入图片描述
案例 - @Deprecated

3、Documented

基本说明
@Documented：用于指定被该元Annotation修饰的Annotation类将被 javadoc工具提取成文档。即在生成文档时，可以看到该注释。

案例 - @Deprecated
在这里插入图片描述
怎么理解？这是@Deprecated（过时）的源代码，元注解Documented对其进行了注解。意思是只要用了@Deprecated，那么在生成 javadoc文件的时候，会保留这个注解。

4、Inherited

基本说明
被它修饰的Annotation将具有继承性，如果某个类使用了被@Inherited修饰的Annotation，则其子类将自动具有该注解。

实际应用中使用少。

本笔记是对韩顺平老师的Java课程做出的梳理。方便本人和观看者进行复习。
课程请见： https://www.bilibili.com/video/BV1fh411y7R8/?spm_id_from=333.999.0.0&vd_source=ceab44fb5c1365a19cb488ab650bab03