java 注解全面解析-mile米乐体育

1.基本语法

注解定义看起来很像接口的定义。事实上，与其他任何接口一样，注解也将会编译成class文件。

@target(elementtype.method)

@retention(retentionpolicy.runtime)

public @interface test {}

除了@符号以外，@test的定义很像一个空的接口。定义注解时，需要一些元注解（meta－annotation），如@target和@retention

@target用来定义注解将应用于什么地方（如一个方法或者一个域）

@retention用来定义注解在哪一个级别可用，在源代码中（source），类文件中（class）或者运行时（runtime）

在注解中，一般都会包含一些元素以表示某些值。当分析处理注解时，程序可以利用这些值。没有元素的注解称为标记注解（marker annotation）

四种元注解，元注解专职负责注解其他的注解，所以这四种注解的target值都是elementtype.annotation_type

2. 注解元素

– 注解元素可用的类型如下：

– 所有基本类型（int,float,boolean,byte,double,char,long,short）

– string

– class

– enum

– annotation

– 以上类型的数组

如果使用了其他类型，那编译器就会报错。也不允许使用任何包装类型。注解也可以作为元素的类型，也就是注解可以嵌套。

元素的修饰符，只能用public或default。

– 默认值限制

编译器对元素的默认值有些过分挑剔。首先，元素不能有不确定的值。也就是说，元素必须要么具有默认值，要么在使用注解时提供元素的值。

其次，对于非基本类型的元素，无论是在源代码中声明，还是在注解接口中定义默认值，都不能以null作为值。这就是限制，这就造成处理器很难表现一个元素的存在或缺失状态，因为每个注解的声明中，所有的元素都存在，并且都具有相应的值。为了绕开这个限制，只能定义一些特殊的值，例如空字符串或负数，表示某个元素不存在。

@target(elementtype.method)

@retention(retentionpolicy.runtime)

public @interface mocknull {

public int id() default -1;

public string description() default “”;

}

3. 快捷方式

何为快捷方式呢？先来看下springmvc中的controller注解

@target({elementtype.type})

@retention(retentionpolicy.runtime)

@documented

@component

public @interface controller {

string value() default “”;

}

可以看见target应用于类、接口、注解和枚举上，retention策略为runtime运行时期，有一个string类型的value元素。平常使用的时候基本都是这样的：

@controller(“/your/path”)

public class mockcontroller { }

这就是快捷方式，省略了名－值对的这种语法。下面给出详细解释：

注解中定义了名为value的元素，并且在应用该注解的时候，如果该元素是唯一需要赋值的一个元素，那么此时无需使用名－值对的这种语法，而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素，当然了，这限制了元素名必须为value。

4. jdk1.8注解增强

type_parameter和type_use

在jdk1.8中elementtype多了两个枚举成员，type_parameter和type_use，他们都是用来限定哪个类型可以进行注解。举例来说，如果想要对泛型的类型参数进行注解：

public class annotationtypeparameter<@testtypeparam t> {}

那么，在定义@testtypeparam时，必须在@target设置elementtype.type_parameter，表示这个注解可以用来标注类型参数。例如：

@target(elementtype.type_parameter)

@retention(retentionpolicy.runtime)

public @interface testtypeparam {}

elementtype.type_use用于标注各种类型，因此上面的例子也可以将type_parameter改为type_use，一个注解被设置为type_use，只要是类型名称，都可以进行注解。例如有如下注解定义：

@target(elementtype.type_use)

@retention(retentionpolicy.runtime)

public @interface test {}

那么以下的使用注解都是可以的:

list<@test comparable> list1 = new arraylist<>();

list list2 = new arraylist<@test comparable>();

@test string text;

text = (@test string)new object();

java.util. @test scanner console;

console = new java.util.@test scanner(system.in);

ps：以上@test注解都是在类型的右边，要注意区分1.8之前的枚举成员，例如：

@test java.lang.string text;

在上面这个例子中，显然是在进行text变量标注，所以还使用当前的@target会编译错误，应该加上elementtype.local_variable。

@repeatable注解

@repeatable注解是jdk1.8新加入的，从名字意思就可以大概猜出他的意思（可重复的）。可以在同一个位置重复相同的注解。举例：

@target(elementtype.type)

@retention(retentionpolicy.runtime)

public @interface filter {

string [] value();

}

如下进行注解使用:

@filter({“/admin”,”/main”})

public class mainfilter { }

换一种风格:

@filter(“/admin”)

@filter(“/main”)

public class mainfilter {}

在jdk1.8还没出现之前，没有办法到达这种“风格”，使用1.8，可以如下定义@filter：

@target(elementtype.type)

@retention(retentionpolicy.runtime)

@repeatable(filters.class)

public @interface filter {

string  value();

}

@target(elementtype.type)

@retention(retentionpolicy.runtime)

public @interface filters {

filter [] value();

}

实际上这是编译器的优化，使用@repeatable时告诉编译器，使用@filters来作为收集重复注解的容器，而每个@filter存储各自指定的字符串值。

jdk1.8在annotatedelement接口新增了getdeclaredannotationsbytype和getannotationsbytype，在指定@repeatable的注解时，会寻找重复注解的容器中。相对于，getdeclaredannotation和getannotation就不会处理@repeatable注解。举例如下：

@filter(“/admin”)

@filter(“/filter”)

public class filterclass {

public static void main(string[] args) {

class filterclassclass = filterclass.class;

filter[] annotationsbytype = filterclassclass.getannotationsbytype(filter.class);

if (annotationsbytype != null) {

for (filter filter : annotationsbytype) {

system.out.println(filter.value());

}

}

system.out.println(filterclassclass.getannotation(filter.class));

}

}

日志如下:

/admin

/filter

null