Java注解一直是我懵懵懂懂的一部分,之前老师虽然讲过,但是那时候就属于听不懂的状态。可是,事实上,我们开发中总能碰到注解。最常见的@Override,就是一个注解。那么,就必须了解了一下什么是注解,注解的作用,注解的语法以及如何定义。
在了解注解之前,我觉得有必要知道什么是元程序。
元程序是处理程序的程序,可以操作目标程序的程序,它可以构造目标程序,也可以将目标程序段组合成更大的目标程序,还可以观察目标程序的结构和其他特性。
如大家熟悉的编译器、解释器、类型检查器、定理证明器、程序生成器、转换系统和程序分析器等等。
1. 什么是注解?
注解(Annotation) 就是Java提供了一种元程序中的元素关联任何信息或者任何元数据(metadata)的途径和方法。Annotion(注解)是一个接口,程序可以通过反射来获取指定程序元素的 Annotion对象,然后通过 Annotion对象 来获取注解里面的元数据。
注解(Annotation)是JDK5.0及以后版本引入的。它可以用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查。从某些方面看,annotation 就像修饰符一样被使用,并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在 Annotation 的 “name=value” 结构对中。
** 2.元数据(metadata)的作用?**
元数据从 metadata 一词译来,就是“关于数据的数据”的意思。
元数据的功能作用有很多,比如:你可能用过 Javadoc 的注释自动生成文档。这就是元数据功能的一种。总的来说,元数据可以用来创建文档,跟踪代码的依赖性,执行编译时格式检查,代替已有的配置文件。如果要对于元数据的作用进行分类,目前还没有明确的定义,不过我们可以根据它所起的作用,大致可分为三类:
- 编写文档:通过代码里标识的元数据生成文档
- 代码分析:通过代码里标识的元数据对代码进行分析
- 编译检查:通过代码里标识的元数据让编译器能实现基本的编译检查
** 3. 自定义注解?**
(1). 以@interface关键字定义
(2). 注解包含成员,成员以无参数的方法的形式被声明。其方法名和返回值定义了该成员的名字和类型。
(3). 成员赋值是通过@Annotation(name=value)的形式,如果成员名称是value的话可以省略“name=”,直接赋值。成员类型为数组,但是只赋值一个元素,则也可以简写。
(4). 注解需要标明注解的生命周期,注解的修饰目标等信息,这些信息是通过元注解实现。
例如:
在开发过程中,我们最常见的注解@Override,我们看一下它的内部是怎么定义的。
- 首先的确使用了@interface定义了名称为Override的注解
- 标名了此注解的修饰目标和注解生命周期, @Target修饰目标 @Retention生命周期
因为@Override注解并没有包含成员,所以下面找个包含成员的@TargetApi注解来参考。
@TargetApi注解包含了成员int value(),的确是无参数的形式,方法名和返回值类型则定义了该成员的名字和类型。完全符合自定义注解中的第二条。
那么下边看一下@TargetApi的赋值
在自定义注解中第三条说明了成员的赋值方式。这个Build.VERSION_CODE.M是一个静态常量,
值为:public static final int M = 23;实际就是把23赋值给@TargetApi;
最后来了解一下这些自定义注解上面作为修饰目标和生命周期的两个注解@Target和@Retention,他们是定义注解的元注解
@Target是注解用来修饰目标的元注解,看图:
可知,@Target本身也修饰它本身的,此注解的成员是ElementType[] value();那么ElementType的值都有哪些呢?
看图可知,ElementType是enum类型。包括以下几种情况:
(1)ANNOTATION_TYPE:指的是在注解上使用的元注解;
(2)CONSTRUCTOR: 指的是在构造器使用的注解;
(3)FIELD:指的在field属性,也包括enum常量使用的注解;
(4)LOCAL_VARIABLE:指的是在局部变量上使用的注解;
(5)METHOD:指的是在方法声明上使用的注解;
(6)PACKAGE:指的是在包上使用的注解;
(7)PARAMETER:指的是在参数上使用的注解;
(8)TYPE:指的是在类,接口(包括注解)或者enum上使用的注解;
以上为注解修饰的范围。
下面介绍另外一个@Retention生命周期注解:
可知,@Retention本身也修饰它本身的,此注解的成员是RetentionPolicy value();那么RetentionPolicy类型的值都有哪些呢?
看图可知,RetentionPolicy是enum类型。包括以下几种情况:
- SOURCE: 注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;
- CLASS: 注解被保留到class文件,jvm加载class文件时候被遗弃。这是默认的生命周期;
- RUNTIME: 注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在,保存到class对象中,可以通过反射来获取。
以上修饰目标的注解和生命周期注解介绍完毕了。对注解的理解是不是更加清晰一些了呢?希望对你们有帮助。
下面了解一下java注解中内置的几个注解吧。
@Override,它的作用是对覆盖超类中方法的方法进行标记,如果被标记的方法并没有实际覆盖超类中的方法,则编译器会发出错误警告;
例如:
Android的Activity类中有
而我们自己建一个MyActivity会继承Activity,这是就会出现@Override注解。
@Deprecated,它的作用是对不应该再使用的方法添加注解,当编程人员使用这些方法时,将会在编译时显示提示信息;
笔者对这个注解,并不了解。因为开发中,目前并没有遇到过。看字面意思,就是它用来标记方法已经作废的意思。
@SuppressWarnings(这个注解也没用到过,不详解了)
其参数有:
deprecation,使用了过时的类或方法时的警告
unchecked,执行了未检查的转换时的警告
fallthrough,当 switch 程序块直接通往下一种情况而没有 break 时的警告
path,在类路径、源文件路径等中有不存在的路径时的警告
serial,当在可序列化的类上缺少serialVersionUID 定义时的警告
finally ,任何 finally 子句不能正常完成时的警告
all,关于以上所有情况的警告
以上部分内容来源百度百科和博客摘取。
发现一篇很好的讲解注解反射机制的文章:Java自定义注解和运行时靠反射获取注解