![v2-84eaac52ee0b5d6310806b81a2705b3c_1440w.jpg?source=172ae18b](http://img-02.proxy.5ce.com/view/image?&type=2&guid=f9d8554f-e82f-eb11-8da9-e4434bdf6706&url=https://pic4.zhimg.com/v2-84eaac52ee0b5d6310806b81a2705b3c_1440w.jpg?source=172ae18b)
Java 注解(Annotation)又称之为 Java 标注、元数据,是 Java 1.5 之后加入的一种特殊语法,通过注解可以标注 Java 中的类、方法、属性、参数、包等,可以通过反射原理对这些元数据进行访问,注解的使用不会影响程序的正常运行,只会对编译器警告等辅助工具产生影响。
注解功能
- 编译器可以使用注解来检测错误和取消警告;
- 使用注解可以生成特定代码,如 ButtferKnife 使用注解简化 findViewById等;
- 某些注解可以在运行时进行检查和操作。
定义注解
注解的定义使用 @interface 作为关键字,实际上表示自动继承了 java.lang.annotation.Annotation 接口,定义格式参考如下:
@元注解
配置参数里面的类型包括基本类型、String、class、枚举以及相关类型的数组,可以使用 default 设置配置参数的默认值,定义一个注解具体如下:
@Target
内置注解
- @Override
- @Deprecated
- @SuppressWarnings
下面是上面三个内置注解的声明:
//表示当前的方法将覆盖超类中的方法,编译时进行格式检查
根据对上面三个注解的声明来看,@SuppressWarnings 中定义了一个数组,这个数组表示在该注解上具体的目标是那些,如可在 SuppressWarnings 上使用的值,常用的具体如下:
- deprecation:使用了过时的类或方法时的警告
- unused:有未使用的变量时的警告
- unchecked:执行了未检查的转换时的警告
- fallthrough:当 switch 程序块直接通往下一种情况而没有 break 时的警告
- path:在类路径、源文件路径等中有不存在的路径时的警告
- serial:当在可序列化的类上缺少serialVersionUID 定义时的警告
- finally :任何 finally 子句不能正常完成时的警告
- all:关于以上所有情况的警告
下面看一个案例,具体如下:
public
上面的代码如果使用 eclipse 等其他 IDE 时会出现两个警告,一是使用了过时的 API,二是变量 date 赋值后没有被使用过,警告截图如下:
![v2-b42b0861170640bb915db180d687ec67_b.png](http://img-03.proxy.5ce.com/view/image?&type=2&guid=f9d8554f-e82f-eb11-8da9-e4434bdf6706&url=https://pic4.zhimg.com/v2-b42b0861170640bb915db180d687ec67_b.png)
当然, IDE 会提示是否添加 SuppressWarnings 来取消这些警告,前文中可以看到注解 @SuppressWarnings 的声明中需要配置参数,这个参数是一个数组,数组名称是 value,可以省略这个名称, 具体如下:
//不省略
public void test2() {
@SuppressWarnings(value= {"deprecation", "unused"})
long date = Date.parse("2018-04-22");
}
//省略
public void test2() {
@SuppressWarnings({"deprecation", "unused"})
long date = Date.parse("2018-04-22");
}
来张截图说明一下使用 @SuppressWarnings 的效果,具体如下:
![v2-700d5b031fee83f44ef195f9832ce397_b.png](http://img-02.proxy.5ce.com/view/image?&type=2&guid=f9d8554f-e82f-eb11-8da9-e4434bdf6706&url=https://pic4.zhimg.com/v2-700d5b031fee83f44ef195f9832ce397_b.png)
如果只想取消一种警告可以这样写,具体如下:
//第一种
注意:如果在定义注解的配置参数名称为 value,那么可以在配置注解时可以省略 value,反之,使用其他名称,则必须采用第一种方式,要指定配置参数名称。
当然其他注解和 @SuppressWarnings 也比较类似, @Override、@Deprecated 由它们的声明可知直接使用即可,不需要指定具体目标,在其声明注解时用到了 @Documented、@Retention、@Target 等,这些用来注解其他注解的特殊注解称之为元注解,具体请看下文。
元注解
- @Target
- @Retention
- @Documented
- @Inherited
@Target
@Target 用来描述注解的使用范围,它的声明如下:
@Documented
由 @Target 声明可知使用 @Target 注解必须指定具体的 Java 成员,也就是该注解要使用到哪个位置,具体由枚举 ElementType 中定义,具体如下:
public
@Retention
@Retention 表示在什么级别保存该注解的信息,它的声明如下:
@Documented
由 @Retention 的声明可知,使用 @Retention 时,必须指定保存celue(RetentionPolicy),具体值如下:
public
@Documented 和 @Inherited 都没有配置参数,是一种标记注解,@Documented 表示将该注解显示到用户文档中,@Inherited 表示该注解只有使用在类上才会有效,而且该注解会被子类继承。
类型注解
在对元注解的说明中可知从 Java8 开始新增了类型注解,如果在注解 @Target 使用这种注解,表明该注解可以在对应的任何地方使用,如在 @Target 中指定 TYPE_PARAMETER 就可在自定义类型的声明处使用该注解,如在 @Target 中指定 TYPE_USE 就可在任何类型前添加该类之间,主要是方便 Java 开发者使用类型注解和相关插件(Checker Framework)来检查来在编译期检查运行时的异常。
下面分别定义指定 TYPE_PARAMETER 和 TYPE_USE 的注解,具体如下:
//1. TYPE_PARAMETER
然后,在下面的案例中使用这两个注解,具体如下:
/**
其实注解的语法比较简单,仅仅定义注解对实际开发是没有帮助的,觉得注解只有在运行时通过反射获取注解信息才是最重要的,注解与反射相关的内容会在以后的推文中学习,到此对注解的认识就结束了。