（JAVA）: 注解和元注解的详细介绍，要了解，看源码时会遇到。

冷不防 2023-10-02 19:10 16阅读 0赞

**目录**

一、注解的基本介绍☺☺

二、Annotation的基本介绍☺☺

1、三种基本的Annotaton☺

2、代码示例☺

三、@SuppressWarnings的指定警告类型☺☺

四、元注解☺☺

1、基本介绍☺

2、Retention注解☺

3、Target 注解☺

4、Documented 注解☺

5、Inherited 注解☺

--------------------

![2e8c1821d0284290b5a428e718bccca8.png][]

## 一、注解的基本介绍☺☺ ##

> Annotation(注解)也被称为元数据(Metadata)是JDK1.5及以后版本引入的，用于修饰解释 包、类、方法、属性、构造器、局部变量等数据信息。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。
> 
>  注解是以‘@注解名’在代码中存在的，根据注解参数的个数，我们可以将注解分为：标记注解、单值注解、完整注解三类。和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。
> 
>  另外，你可以在编译时选择代码里的注解是否只存在于源代码级，或者它也能在class文件、或者运行时中出现（SOURCE/CLASS/RUNTIME）。
> 
>  在 JavaSE 中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在 JavaEE 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替 java EE 旧版中所遗留的繁冗代码和 XML 配置等。

--------------------

## 二、Annotation的基本介绍☺☺ ##

> ### 1、三种基本的Annotaton☺ ###
> 
> ▶  **@Override**  : 限定某个方法，是重写父类方法 ,  该注解只能用于方法 
> 
> ▶  **@Deprecated**  : 用于表示某个程序元素 ( 类 ,  方法等 ) 已过时 
> 
> ▶  **@SuppressWarnings**  : 抑制编译器警告
> 
> --------------------
> 
> ### 2、代码示例☺ ###
> 
> **①：@Override**
> 
>     class Son extends Father{
>     
>         @Override
>         public void play(){}
>     
>     }
> 
> **注意：**
> 
>  ▷ @Override 表示子类的 play 方法时重写了父类的 play
> 
> ▷ 这里如果没有写  @Override  还是会重写了父类 ply
> 
>  ▷ 如果你写了@Override 注解，编译器就会去检查该方法是否真的重写了父类的 方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误。
> 
>  ▷@Override 只能修饰方法，不能修饰其它类、包、属性等。
> 
> --------------------
> 
> **②：@Deprecated**
> 
>     @Deprecated
>     class A{
>         @Deprecated
>         public static int name = 1;
>     
>         @Deprecated
>         public void play(){ }
>     }
> 
> **注意：**
> 
> ▷ 已过时不是不能使用，只是不推荐使用，但是仍然可以使用
> 
> ▷ 可以修饰方法，类，字段, 包, 参数 等
> 
> ▷ 它的作用是可以做到新旧版本的兼容和过渡
> 
> --------------------
> 
> **③：****@****SuppressWarnings**
> 
>     @SuppressWarnings ("all")
>     public class word{ }
> 
> **注意：**
> 
> ▷ 关于 SuppressWarnings 作用范围是和你放置的位置相关。比如@SuppressWarnings 放置在 main 方法，那么抑制警告的范围就是 main
> 
> ▷ 通过 @SuppressWarnings 的源码可知，其注解目标为类、字段、函数、函数入参、构造函数和函数的局部变量。

--------------------

## 三、@SuppressWarnings的指定警告类型☺☺ ##

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

## 四、元注解☺☺ ##

> ### 1、基本介绍☺ ###
> 
> **▶ 什么是元注解：**
> 
> 元注解就是解释注解的注解，它注解的对象是我们前面介绍的注解，如：**@Override、@Deprecated** 、**@SuppressWarnings**
> 
> **▶ 四种元注解：**
> 
> ▷ **Retention：**指定注解的作用范围，三种 SOURCE,CLASS,RUNTIME 
> 
> ▷ **Target：**指定注解可以在哪些地方使用 
> 
> ▷ **Documented ：**指定该注解是否会在 javadoc 体现 
> 
> ▷ **Inherited：**子类会继承父类注解
> 
> **▶ 注解的注意事项：**
> 
> ▷ 注解仅存在于源码中，在class字节码文件中不包含 
> 
> ▷ 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得， 
> 
> ▷ 注解会在class字节码文件中存在，在运行时可以通过反射获取到 
> 
> ▷ 首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，前者能作用的地方后者一定也能作用。
> 
> ①：一般如果需要在 **运行时**去动态获取注解信息，那只能用 RUNTIME 注解；
> 
> ②：如果要在 **编译时**进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；
> 
> ③：如果只是做一些 **检查性**的操作如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

--------------------

> ### 2、Retention注解☺ ###
> 
> **▲ 解释：**
> 
> 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间,@Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值（值有三种）。
> 
> **▲ 三种值：**
> 
>  ▷ **RetentionPolicy.SOURCE:** 编译器使用后，直接丢弃这种策略的注释。
> 
>   ▷  **RetentionPolicy.CLASS:** 编译器将把注解记录在 class  文件中 .  当运行  Java  程序时 , JVM  不会保留注解。 这是默认值。
> 
>   ▷  **RetentionPolicy.RUNTIME:** 编译器将把注解记录在 class  文件中 .  当运行  Java  程序时 , JVM  会保留注解 .  程序可以 通过反射获取该注解。
> 
> --------------------
> 
> ### 3、Target 注解☺ ###
> 
> **▲ 解释：**
> 
> 用于修饰 Annotation 定义，指定被修饰的 Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为 value 的成员变量。
> 
> --------------------
> 
> ### 4、**Documented 注解☺** ###
> 
> **▲ 解释：**
> 
> @Documented: 用于指定被该元注解修饰的 Annotation 类将被javadoc 工具提取成文档，即在生成文档时，可以看到该注解。
> 
> **▲** **注意：**
> 
> 定义为@Documented 的注解必须设置Retention值为RUNTIME。
> 
> --------------------
> 
> ### **5、Inherited 注解☺** ###
> 
> **▲ 解释：**
> 
> 被@Inherited 修饰的注解 将具有继承性，如果某个类使用了被 @Inherited修饰的注解，则其子类将自动具有该注解

[2e8c1821d0284290b5a428e718bccca8.png]: https://img-blog.csdnimg.cn/2e8c1821d0284290b5a428e718bccca8.png