java——注释；元注解（了解）

注解（Annotation）

一、注释的理解

1、注解(Annotation)也被称为元数据(Metadata)，用于修饰解释包、类、方法、属性、构造器、局部变量等数据信息。

2、和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。

3、在 JavaSE 中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在 JavaEE 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替 java EE 旧版中所遗留的繁冗代码和 XML 配置等。

二、基本的Annotation介绍

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

三个基本的 Annotation:

1、@Override: 限定某个方法，是重写父类方法, 该注解只能用于方法

2、@Deprecated: 用于表示某个程序元素(类, 方法等)已过时

3、@SuppressWarnings: 抑制编译器警告

@Override注解

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {}
//补充说明：@interface 的说明：@interface不是interface，是注解类是jdk5.0之后加入的

注：@Override 使用说明

1、@Override表示指定重写父类的方法（从编译层面验证)，如果父类“该方法”，则会报错

2、如果不写@Override 注解，而父类仍有“该方法”，仍然构成重写

注：如果你写了@Override 注解，编译器就会去检查该方法是否真的重写了父类的方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误

3、@Override 只能修饰方法，不能修饰其它类，包，属性等等

4、查看@Override注解源码为@Target(ElementType.METHOD),说明只能修饰

5、@Target 是修饰注解的注解，称为元注解，记住这个概念.

@Deprecated注解

@Deprecated:用于表示某个程序元素(类，方法等)已过时 

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

注：@Deprecated的说明

1、用于表示某个程序元素（类，方法等)已过时

2、可以修饰方法，类，字段，包，参数 等等

3、@Target(value={CONSTRUCTOR, FIELD, LOCAL VARIABLE, METHOD,PACKAGE, PARAMETER, TYPE})

4、@Deprecated的作用可以做到新旧版本的兼容和过渡

 @SuppressWarnings 注解

@SuppressWarnings:抑制编译器警告

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

1、当我们不希望看到这些警告的时候，可以使用 SuppressWarnings 注解来抑制警告信息

2、在{""} 中，可以写入你希望抑制(不显示)警告信息

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，抑制与未用的程式码及停用的程式码相关的警告***

注：@SuppressWarnings注解的说明

1、unchecked 是忽略没有检查的警告

2、rawtypes是忽略没有指定泛型的警告(传参时没有指定泛型的警告错误）

3、unused是忽略没有使用某个变量的警告错误

4、@SuppressWarnings可以修饰的程序元素为，查看@Target

5、生成@SupperssWarnings时，不用背，直接点击左侧的黄色提示，就可以选择（注意可以指定生成的位置）

---

JDK的元 Annotation（元注解）

 一、元注解的基本介绍

JDK 的元 Annotation 用于修饰其他 Annotation

元注解： 本身作用不大，理解元注解，看源码时，可以知道他是干什么

二、元注解的种类

1、Retention //指定注解的作用范围，三种 SOURCE,CLASS,RUNTIME

2、Target // 指定注解可以在哪些地方使用

3、Documented //指定该注解是否会在 javadoc 体现

4、Inherited //子类会继承父类注解

@Retention 注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)//这个就是@retention的取值
public @interface Override {}

1、基本说明：

只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间, @Rentention 包含一个 RetentionPolicy类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:

2、@Retention 的三种值

1) RetentionPolicy.SOURCE: 编译器使用后，直接丢弃这种策略的注释

2) RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。 这是默认值

3) RetentionPolicy.RUNTIME:编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 会保留

说明：Override 的作用域在 SOURCE，当编译器编译时生效，不会写入到.class 文件，也不会再runtime(运行时)生效

@Target注解

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

1、基本说明：

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

2、@Target的源码说明@Documented

@Retention(RetentionPolicy.RUNTIME)// 它的作用范围是 RUNTIME

@Target(ElementType.ANNOTATION TYPE)//这里的ANNOTATION TYPE说明@Target只能修筛注解

public @interface Target{//说明它是注解

ElementType[] value();//可以简单看一下ElementType的取值/∥通过Enum 比如：TYPE等

}

@Documented注释

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

基本说明

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

说明：定义为Documented的注解必须设置Retention值为RUNTIME。

一个Deprecated 注解@Documented,则javadoc会看到Deprecated

@Inherited注解

基本说明：

被它修饰的 Annotation 将具有继承性。如果某个类使用了被@lnherited修饰的 Annotation,则其子类将自动具有该注解[说明：实际应用中，使用较少，了解即可]

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