java注解初探

2018-02-27 11:33:20来源:https://www.jianshu.com/p/2972782a4ee0作者:YYOmomo人点击

分享


我们IDE编程时经常会自动给我们添加Override、Deprecated等以及三方框架注解,这些注解是怎么定义以及工作的,我们该怎么自定义注解,这些可能是一个入门程序猿所不了解的,这篇文章以及下一篇如何编写自定义注解将一点点的介绍注解概念以及如何自定义注解,希望能给一些对注解有困惑的开发一点帮助


基本概念

Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和着任何元数据(metadata)的途径和方法,Annotion是一个接口,程序可以通过反射来获取指定程序元素的Annotion对象,然后通过Annotion对象来获取注解里面的元数据。
  Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查。从某些方面看,annotation就像修饰符一样被使用,并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在Annotation的“name=value”结构对中。
  Annotation的成员在Annotation类型中以无参数的方法的形式被声明。其方法名和返回值定义了该成员的名字和类型。在此有一个特定的默认语法:允许声明任何Annotation成员的默认值:一个Annotation可以将name=value对作为没有定义默认值的Annotation成员的值,当然也可以使用name=value对来覆盖其它成员默认值。这一点有些近似类的继承特性,父类的构造函数可以作为子类的默认构造函数,但是也可以被子类覆盖。
  Annotation能被用来为某个程序元素(类、方法、成员变量等)关联任何的信息。需要注意的是,这里存在着一个基本的规则:Annotation不能影响程序代码的执行,无论增加、删除 Annotation,代码都始终如一的执行。


首先看下我们最长用到的JDK内置注解


@Target({ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

Override注解又使用了注解?没错,@Target和@Retention是元注解(用于给其注解其他注解,一般自定义注解都要使用),到这里我们可以给注解分下类:
根据注解使用方法和用途,我们可以将annotation分三类:
1、系统注解:JDK提供了三个系统注解Override(标记此方法是覆盖了父类的方法)、Deprecated(用于标记方法等过时,一般都会有新的API提供)、SuppressWarnnings(用于通知java编译器禁止特定的编译警告)
2、元注解:Java5.0定义了4个标准的meta-annotation类型
①@Target:用于说明Annotation所修饰的范围,系统代码如下


@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Target {
ElementType[] value();
}

ElementType是个枚举类型,取值有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
②@Retention:定义Annotation被保留的时间长短即注解生命周期限制


@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Retention {
RetentionPolicy value();
}

RetentionPolicy也是个枚举类型,取值有:
1.SOURCE:在源文件中有效(即源文件保留,被编译器丢弃)
2.CLASS:在class文件中有效(即class保留,被编译但虚拟机忽略)
3.RUNTIME:在运行时有效(即运行时保留,class装载的时候读取)


③@Documented:用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化


@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Documented {
}

④@Inherited:用于标记注解是被继承的,如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类


@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Inherited {
}

3、自定义注解:自定义注解一般包含编译注解和运行时注解,根据系统提供API以及相关机制在编译或者运行时获取想要的数据,自定义注解形式和系统注解以及元注解一样,下文会有自定义注解的Demo。


从上面的元注解来看,注解又分为:
1、标记注解,比如@Override、@Inherited、@Documented。这类注解是没有元素的,用于标记元素特性比如过时、覆盖父类方法等
2、单值注解,只有一个元素的注解,比如@Target、@Retention等
3、完整注解 ,除了①和②的所有注解


自定义注解

为了下面我们自定义注解Demo,我们先了解一下自定义注解的写法。使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum、Annotation以及这些类型的数组)。可以通过default来声明参数的默认值。


注解元素定义形式如:


public @interface 注解名 {定义体}//public 可以省略
public String name() default "fieldName";//元素定义样式</pre>

使用形式:


@注解名(name1= value1,name2 = value2)

单值注解定义和使用还有简写方式:


元素定义:


String value() default “value”

使用形式:


@注解名(value)

定义注解和使用注解都很容易,关键还是要处理注解,如果没有处理注解的方法那么注解就仅仅相当于注释了。所以创建注解处理器是很重要的,获取注解之前我们肯定要先获取注解作用的Target比如:
Class:类定义
Constructor:构造器定义
Field:类的成员变量
Method:类中的方法
Package:类的包定义(有点不懂@**@)
这几个都是AnnotatedElement接口实现类,运行时注解可以通过java.lang.reflect包下的反射API运行时获取,含的获取注解的方法如下:
方法1:<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解,如果该类型注解不存在,则返回null。
  方法2:Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
  方法3:boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false.
  方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。(如果没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响。


由于篇幅的原因自定义注解(编译时注解以及运行时注解Demo)将在下一篇博客如何编写自定义注解中介绍



最后用一张思维导图来总结一下注解


image

参考文献:深入理解java注解








最新文章

123

最新摄影

闪念基因

微信扫一扫

第七城市微信公众平台