Java-注解annotation

川长思鸟来 2024-04-17 06:29 0阅读 0赞

## 什么是注解： ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9odWFuZ2hhaXRhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70][]

之后使用反射机制获取注解的值信息

## Java内置常用3个注解： ##

### 首先使用@interface关键字定义注解 ###

### @Override 重写注解 ###

重写注解 @Override   
会按注解指令 覆盖 父类中的一个类，如果没有覆盖就会报编译错误

源码：

@Target(ElementType.METHOD)
    @Retention(RetentionPolicy.SOURCE)
    public @interface Override {
    }

### @Deprecated 方法过时注解 ###

不推荐使用或者有更好的方法

源码：

@Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
    public @interface Deprecated {
    }

### @SuppressWarnings 镇压警告 ###

其注解目标为类、字段、函数、函数入参、构造函数和函数的局部变量。而家建议注解应声明在最接近警告发生的位置。

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>关键字</td> 
   <td>用途</td> 
  </tr> 
  <tr> 
   <td>all</td> 
   <td>to suppress all warnings</td> 
  </tr> 
  <tr> 
   <td>boxing&nbsp;</td> 
   <td>to suppress warnings relative to boxing/unboxing operations</td> 
  </tr> 
  <tr> 
   <td>cast</td> 
   <td>to suppress warnings relative to cast operations</td> 
  </tr> 
  <tr> 
   <td>dep-ann</td> 
   <td>to suppress warnings relative to deprecated annotation</td> 
  </tr> 
  <tr> 
   <td>deprecation</td> 
   <td>to suppress warnings relative to deprecation</td> 
  </tr> 
  <tr> 
   <td>fallthrough</td> 
   <td>&nbsp;to suppress warnings relative to missing breaks in switch statements</td> 
  </tr> 
  <tr> 
   <td>finally&nbsp;</td> 
   <td>to suppress warnings relative to finally block that don’t return</td> 
  </tr> 
  <tr> 
   <td>hiding</td> 
   <td>to suppress warnings relative to locals that hide variable</td> 
  </tr> 
  <tr> 
   <td>incomplete-switch</td> 
   <td>&nbsp;to suppress warnings relative to missing entries in a switch statement (enum case)</td> 
  </tr> 
  <tr> 
   <td>nls</td> 
   <td>&nbsp;to suppress warnings relative to non-nls string literals</td> 
  </tr> 
  <tr> 
   <td>null</td> 
   <td>to suppress warnings relative to null analysis</td> 
  </tr> 
  <tr> 
   <td>rawtypes</td> 
   <td>to suppress warnings relative to un-specific types when using generics on class params</td> 
  </tr> 
  <tr> 
   <td>restriction</td> 
   <td>to suppress warnings relative to usage of discouraged or forbidden references</td> 
  </tr> 
  <tr> 
   <td>serial</td> 
   <td>to suppress warnings relative to missing serialVersionUID field for a serializable class</td> 
  </tr> 
  <tr> 
   <td>static-access</td> 
   <td>o suppress warnings relative to incorrect static access</td> 
  </tr> 
  <tr> 
   <td>synthetic-access&nbsp;</td> 
   <td>&nbsp;to suppress warnings relative to unoptimized access from inner classes</td> 
  </tr> 
  <tr> 
   <td>unchecked</td> 
   <td>&nbsp;to suppress warnings relative to unchecked operations</td> 
  </tr> 
  <tr> 
   <td>unqualified-field-access</td> 
   <td>to suppress warnings relative to field access unqualified</td> 
  </tr> 
  <tr> 
   <td>unused</td> 
   <td>to suppress warnings relative to unused code</td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

## 元注解： ##

其他注解的注解

**      **元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解有以下几种：

*  @Target
 *  @Retention
 *  @Documented
 *  @Inherited

### **@Target（核心）** ###

**　　**用于描述注解的范围，即注解在哪用。它说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）等。取值类型（ElementType）有以下几种：

1.  　　CONSTRUCTOR:用于描述构造器
2.  　　FIELD:用于描述域即类成员变量
3.  　　LOCAL\_VARIABLE:用于描述局部变量
4.  　　METHOD:用于描述方法
5.  　　PACKAGE:用于描述包
6.  　　PARAMETER:用于描述参数
7.  　　TYPE:用于描述类、接口(包括注解类型) 或enum声明
8.  　　TYPE\_PARAMETER:1.8版本开始，描述类、接口或enum参数的声明
9.  　　TYPE\_USE:1.8版本开始，描述一种类、接口或enum的使用声明

代码：

@Target({ElementType.METHOD, ElementType.TYPE})
    public @interface Log {
        ......
    }

### **@Retention（核心，框架默认runtime）** ###

用于描述注解的生命周期，表示需要在什么级别保存该注解，即保留的时间长短。取值类型（RetentionPolicy）有以下几种：

1.  　　SOURCE:在源文件中有效（即源文件保留）
2.  　　CLASS:在class文件中有效（即class保留）
3.  　　RUNTIME:在运行时有效（即运行时保留）

代码：

@Target({ElementType.METHOD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Log {
    　　......
    }

### **@Documented** ###

用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。它是一个标记注解，没有成员。

代码：

@Target({ElementType.METHOD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Log {
    　　......
    }

### **@Inherited** ###

用于表示某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

## 实例： ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9odWFuZ2hhaXRhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9odWFuZ2hhaXRhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/d5962298b5e0436fb41583a37439c0e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9odWFuZ2hhaXRhby5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/1845b065a4f4431fbc3880857908937c.png