java中的常用注解

注解

  注解(Annotation)也被称为元数据(Metadata)，用于修饰解释 包、类、方法、属性、构造器、局部变量等数据信息。 和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。

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

---

1 基本介绍

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

  3个基本的 Annotation：

1. @Override: 限定某个方法，是重写父类方法，该注解只能用于方法。
2. @Deprecated: 用于表示某个程序元素（类、方法等）已过时，通常是因为所修饰的结构危险或存在更好的选择。
3. @SuppressWarnings: 抑制编译器警告。

---

2 Annotation 应用

  下面进行案例演示。

(1) @Override 注解的使用

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

源码展示：(具体的解释将在后面展开), @interface 表示一个注解类，@Target, @Retention 是修饰注解的注解，称为元注解。

public class Test {
    public static void main(String[] args) {
        
    }
}
class Father {
    public void say() {
        System.out.println("我是Father类的say()方法");
    }
}
class Son extends Father {
    @Override
    public void say() {
        System.out.println("我是Son类重写的say()方法");
    }
    //老韩解读
    //1. @Override 注解放在 say() 方法上，表示子类的say方法重写了父类的say
    //2. 这里如果没有写 @Override 还是重写了父类say
    //3. 如果你写了@Override 注解，编译器就会去检查该方法是否真的重写了父类的
    //方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误
    /*
    @Override
    public void f() {}
    解释：使用了 Override 注解，编译器会检查该方法是否构成了重写，
    	如果父类没有此方法，编译也无法通过
    */  
}

总结：

1. @Override 表示指定重写父类的方法（从编译层面验证），如果父类没有 say() 方法，则会报错。
2. 如果不写 @Override 注解，而父类仍有 public void say() {} ,仍然构成重写。
3. @Override 只能修饰方法，不能修饰其他类、包、属性等。

---

(2) @Deprecated 注解的使用

  用于表示某个程序元素（类、方法等）已过时。

源码展示：

//修饰类表示类已过时
@Deprecated
class A {
    //修饰属性，表示属性已过时
    @Deprecated
    private int n;
    
    //修饰方法，表示方法已过时
    @Deprecated
    public void say(){}
    
    //1.@Deprecated修饰某个元素,表示该元素已经过时
	//2.即不在推荐使用，但是仍然可以使用
    //3.可以修饰方法，类，字段, 包, 参数 等等
	//4.@Deprecated 可以做版本升级过渡使用
}

  使用 @Deprecated 修饰的元素在 IDEA 中会有如下效果：

总结：

1. 用于表示某个程序元素（类、方法等）已过时。
2. 可以修饰方法、类、字段、包、参数等。
3. @Deprecated 可以做版本升级过渡使用。

---

(3) @SuppressWarnings 注解的使用

  抑制编译器的警告。

源码为：

常见的指定的警告类型：

//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 作用范围是和你放置的位置相关,比如 @SuppressWarnings 放置在 main方法，那么抑制警告的范围就是 main 通常我们可以放置具体的语句, 方法, 类。

  该注解类有数组 String[] values() 设置一个数组比如 {“rawtypes”, “unchecked”, “unused”}.

//作用于类
@SuppressWarnings({"all"})
class Test {
}

//也可以指定多个警告类型
class Test2 {
    @SuppressWarnings({"unused","unchecked"})
    private int n;
    public void say{}
}

---

3 元注解

  JDK 的元注解用于修饰其他的注解。

3.1 元注解的种类

1. Retention ：指定注解的作用范围，三种 SOURCE, CLASS, RUNTIME 。
2. Target ：指定注解可以在哪些地方使用。
3. Documented ：指定该注解是否会在javadoc体现。
4. Inherited ：子类会继承父类注解。

(1) @Retention 元注解

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

@Retention 的三种值：

1. RetentionPolicy.SOURCE: 编译器使用后，直接丢弃这种策略的注释。
2. RetentionPolicy.CLASS: 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。这是默认值
3. RetentionPolicy.RUNTIME:编译器将把注解记录在 class 文件中。 当运行 Java 程序时, JVM 会保留注解.，程序可以通过反射获取该注解。

(2) @Target 元注解

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

@Deprecated 源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE})
public @interface Deprecated {
    /**
     * Returns the version in which the annotated element became deprecated.
     * The version string is in the same format and namespace as the value of
     * the {@code @since} javadoc tag. The default value is the empty
     * string.
     *
     * @return the version string
     * @since 9
     */
    String since() default "";

    /**
     * Indicates whether the annotated element is subject to removal in a
     * future version. The default value is {@code false}.
     *
     * @return whether the element is subject to removal
     * @since 9
     */
    boolean forRemoval() default false;
}

(3) @Documented 元注解

  用于指定被该元注解 修饰的 Annotation 类将被 javadoc 工具提取成文档时，可以看到该注解。（定义为 Documented 的注解必须设置 Retention 值为 RUNTIME）

源码为：

(4) @Inherited 注解

  被它修饰的 Annotation 将具有继承性，如果某个类使用了被 @Inherited 修饰的 Annotation,则其子类将自动具有该注解。（使用较少，了解即可）