【重拾Java系列】—— 注解

注解

• 什么是注解？
  Annotation也被成为元数据，和注释类似，不影响程序的逻辑顺序，但注解可以被编译或运行，用于修饰解释 包、类、方法、属性、构造器、局部变量等数据信息。

• Annotation基本信息：
  使用它时要在其前面加上@，并把该Annotation当做修饰符使用，用于修饰它支持的程序元素。

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

一、Override-重写方法

• 写不写@Override都不影响重写方法的执行，区别在于下面：
  （1）如果没写，编译器会去判断该方法在父类中是否存在，如果存在那么就是重写了父类的方法，如果不存在就是创建一个新的方法；
  （2）如果写了@Override注解，编译器就会去检查该方法是否真的重写了父类的方法，如果重写了，则编译通过，如果没有构成重写，则编译错误。

• 在Override.java的源文件中

package java.lang;
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

解读源码：
@interface代表的并不是接口，而是说明Override是注解类
@Target说明了Annotation所修饰的对象范围（注解的作用目标）

@Target(ElementType.TYPE)     接口、类、枚举
@Target(ElementType.FIELD)     字段、枚举的常量
@Target(ElementType.METHOD)     方法
@Target(ElementType.PARAMETER)     方法参数
@Target(ElementType.CONSTRUCTOR)     构造函数
@Target(ELementType.LOCAL_VARIABLE)     局部变量
@Target(ElementType.ANNOTATION_TYPE)     注解
@Target(ElementType.PACKAGE)     包

@Rentention：说明了注解的保留位置

@Retention(RetentionPolicy.SOURCE) 注解仅存在于源码中，在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS) 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得
@Retention(RetentionPolicy.RUNTIME) 注解会在class字节码文件中存在，在运行时可以通过反射获取到

补充部分：
@Document: 说明注解将被包含在javadoc中
@Inherited: 说明子类可以继承父类中的注解

二、Deprecated-修饰过时元素

public class Deprecated_ {
    public static void main(String[] args) {
        //创建该类的对象
        DeprecatedTest deprecatedTest = new DeprecatedTest();
        //调用过时的方法
        deprecatedTest.sunny();
        System.out.println(deprecatedTest.num);
    }
}
@Deprecated
class DeprecatedTest{
    @Deprecated
    public void sunny(){

    }
    @Deprecated
    int num = 10;
}

• 利用 @Deprecated 修饰某个元素时，只是说明该元素过时了，但仍然可以使用，在调用该元素时，会提示有中划线。

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

三、SuppressWarnings-抑制警告

• 当我们不想看到警告，可以利用@SuppressWarnings来不显示警告。

• 通过{""}中的参数，可以指定抑制哪种类型的警告信息。

• SuppressWarnings的作用范围与其所在位置相关。

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

对于String [] value() 的参数：（可根据警告来写相应的抑制，也可以利用all直接抑制全部警告）

参数	作用
==all ==	抑制所有警告
boxing	抑制装箱、拆箱相关的警告
cast	抑制强转相关的警告
dep-ann	抑制过时注解相关的警告
fallthrough	抑制没有break的switch语句的警告
finally	抑制finally块没有return的警告
hiding	抑制隐藏本地变量的警告
incomplete-switch	抑制switch语句case不完整的警告
nls	抑制创建无法翻译的字符串的警告
null	抑制可能为空的警告
rawtypes	抑制使用泛型作为类参数时没有指明参数类型的警告
restriction	抑制使用不建议或禁止的引用的警告
serial	抑制一个可序列化类中没有 serialVersionUID 的警告
static-access	抑制不正确的静态访问的相关警告
synthetic-access	抑制未优化的内部类访问相关的警告
unchecked	抑制未经检查的操作（比如强转）的警告
unqualified-field-access	抑制不合格的属性访问的警告
unuesd	抑制未使用代码相关的警告
FieldCanBeLocal	抑制全局变量只使用一次，可以被当做局部变量的警告