现在的Java开发框架大多都会使用注解,如
Spring
,所以这里梳理一下注解方面,为之后深入理解框架做铺垫。
注解又称元数据,在《Java编程思想》中说到:它为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后可以很方便的使用这些数据。在有注解之前,一般会使用注释或者javadoc
在程序代码中保留相应信息,Java1.5之后,可以通过注解来做这些事情,而且就像我们平常看到的Spring
框架注解一样,不仅是保存元数据,我们还可以利用annotation
包下的api
编写注解处理器来处理这些注解,达到影响程序的效果。
注解定义
注解的语法比较简单,声明注解的关键字并不是annotation
或者其他,它使用的是@interface
。下面声明一个标记注解:
/**
**标记注解示例
**/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface AnnotationTest{
}
在上面这个示例中,除了多@
符号外,注解的定义整体上和接口的定义非常相似。上面的标记注解中没有定义任何的字段,就像是一个空接口,其实它和接口除了定义上有interface
关键字重复外,并没有其他一样的地方,两者完全是两个不同的概念。
可以看到,在上面这个简单示例中还使用了其他两个元注解(负责注解其他注解)@Target
和@Retention
用来定义注解,其中@Target
指明该类型的注解可以注解的程序元素的范围,如果没有使用这个元注解,则说明可以使用在任何地方;而@Retention
指明注解被保留的时间长短。保存策略RetentionPolicy
取值为SOURCE
,CLASS
,RUNTIME
,其中SOURCE
指仅存在于源文件中,生成二进制表示时注解会丢失;CLASS
表示会存在在二进制表示中,但是运行时会丢失;RUNTIME
表示会存在在运行时,这为之后的反射处理注释影响程序的运行带来了可能。Java内置了四个元注解,还有如@Documented
表示将此注解包含在Javadoc
中,@Inherited
表示允许子类继承父类的注解。
经过上面这个简单注解之后,我们可以考虑为注解加上元素,如下所示:
/**
**有元素的注解
**/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
@interface AnnotationTest{
String createby();
String lastupdate();
int version() default 1;
}
在这个注解中,存在几个注解的元素,在使用的时候需要为元素赋值。当然,就像int version() default "1"
元素一样,注解的元素可以有默认值default
,其中默认值必须是相同类型的值或表达式,而且不能为null
。
类似于类的字段方法定义,注解元素定义也需要约束,如下所示:
注解内的元素定义约束:
1.元素的定义只能是基本数据类型、String类型、其他注解类型、Class或Class的某种特定泛型的调用和前面几种类型的数组。
2.元素不能声明任何的参数。
3.元素不能有任何throws字句。
4.元素不能定义类型参数 (泛型)。
在使用时,需要为这个注解的所有元素都赋值,如果有默认值可以使用默认值。如下使用所示:
/**
**使用自定义注解
**/
@AnnotationTest(createby="小二",lastupdate="2017-11-05",version=1)
public void test(){
}
不仅是这样用,在上面的约束条件中有提到,注解的元素还可以是一个注解类型,这为注解带来了很大的灵活性,如下:
/**
**注解元素使用注解类型示例
**/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
@interface AnnotationTest{
String createby();
String lastupdate();
Revision version();
}
@interface Revision{
int min() default 1;
int max() default 2;
}
/**
**注解元素是注解的使用
**/
@AnnotationTest(createby="小二",lastupdate="2017-11-05",version=@Revision)
public void test(){
}
//如果没有默认值或默认值不正确,则需要指定值
@AnnotationTest(createby="小二",lastupdate="2017-11-05",version=@Revision(max=3))
public void test(){
}
这里需要提的是,注解还有几个隐式的约束条件,即,注解都隐式的扩展自Annotation
接口,注解元素不是直接或间接的声明为它自己,注解不支持继承extends
。
注解处理器
如果没有注解处理器,那么引入注解这个功能并不比注释来的更有用。在Java1.5
扩展了反射机制的API
用来处理注释。下面看一个简单的注释处理器:
/**
**注解处理器,反射处理
**/
public static void annotationTracker(Class c){
for(Method m:c.getDeclaredMethods()){
AnnotationTest test = m.getAnnotation(AnnotationTest.class);
if(test!=null)
System.out.println("--method name = "+m.getName()+";--annotation value{ create by = "+test.createby()+",lastupdate="+test.lastupdate()+",version = "+test.version().min()+"-"+test.version().max()+"}");
}
}
输出:
--method name = test;--annotation value{ create by = 小二,lastupdate=2017-11-05,version = 1-3}
--method name = test1;--annotation value{ create by = 小二,lastupdate=2017-11-05,version = 1-2}
--method name = test2;--annotation value{ create by = 小二,lastupdate=2017-11-05,version = 0-1}
可以看到,在上面可以通过反射直接获取到注解的值,其前提条件是注解的保存策略必须是Runtime
。在代码中,可以通过获取的值来进行逻辑判断以达到影响程序的效果,这也是很多框架使用注解的本质,但是框架的注解处理器特别复杂。
其实Java
还提供了一个apt
工具来解析处理注释,所以可以考虑使用apt
来处理注释,需要注意的是,apt
工具处理的是java
源文件,而不是编译后的类文件,所以在使用的时候无法使用反射机制来获取信息。详情需要自行查看,这里只记录一下有这样一种方法处理注释。
Java內建注解:
@Override
:使用该注解告知编译器父类的这个方法被重写了。
@Deprecated
:不建议使用的方法,使用时最好说明为什么不建议使用和替代的方法。
@SuppressWarnings
:忽略某个警告信息,范围只在source中,被编译后就不存在。
参考
《Java编程思想》
《Java程序设计语言》