@Documented 一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中。
@Retention 定义该注解的生命周期。表示需要在什么级别保存该注解信息。
RetentionPolicy.SOURCE 在编译阶段丢弃(注解将被编译器丢弃)。这些注解在编译结束之后就不再有任何意义,所以他们不会写入字节码。@Override,@SuppressWarnings都属于这类注解
。
RetentionPolicy.CLASS 在类加载的时候丢弃。在字节码文件的处理中有用(注解在class文件中可用,但会被VM丢弃)。注解默认使用这种方式。
RetentionPolicy.RUNTIME 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式
@Target 表示该注解用于什么地方。如果不明确指出,该注解可以放在任何地方。一下是一些可用的参数。需要说明的是:属性的注解是兼容的,如果你想给7个属性都添加注解,仅仅排除一
个属性,那么你需要再定义target包含所有的属性
ElementType.TYPE:用于描述类,接口或enum声明
ElementType.FILELD:用于描述实例变量
ElementType.METHOD 方法声明
ElementType.PARAMETER 参数声明
ElementType.CONSTRUCTOR 构造器的声明
ElementType.LOCAL_VARIABLE 局部变量声明
ElementType.ANNOTATION_TYPE 另一个注释
ElementType.PACKAGE 用于记录java文件的package信息
@Inherited 定义该注释和子类的关系(允许子类继承父类中的注解)
@Deprecated,使用了注解为它的元素编译器将发出警告,因为注解@Deprecated是不赞成使用的代码,被弃用的代码。
@SuppressWarnings,关闭不当编译器警告信息。
定义一个注解的方式
@Target(ElementType.METHOD)
@Retention(RetentioinPolicy.RUNTIME)
public @interface Test{}
除了@符号,注解很像是一个接口。定义注解的时候需要用到元注解,上面用到了@Target和@RetentionPolicy,它们的含义在上面的表格中已近给出。
在注解中一般会有一些元素以表示某些值。注解的元素看起来就像接口的方法,唯一的区别在于可以为其制定默认值。没有元素的注解称为标记注解,上面的@Test就是一个标记注解
注解的可用的类型包括以下几种:所有基本类型、String、Class、enum、Annotation、以上类型的数组形式。元素不能有不确定的值,即要么有默认值,要么在使用注解的时候提供元素的值
。而且元素不能使用null作为默认值。注解在只有一个元素且该元素的名称是value的情况下,在使用注解的时候可以省略“value=”,直接写需要的值即可。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
public String id();
public String description() default “no description”;
}
public class PasswordUtils {
@UseCase(id = 47, description = “Passwords must contain at least one numeric”)
public boolean validatePassword(String password) {
return (password.matches("\w*\d\w*"));
}
@UseCase(id = 48)
public String encryptPassword(String password) {
return new StringBuilder(password).reverse().toString();
}
}
使用注解最主要的部分在于对注解的处理,那么就会涉及到注解处理器。
从原理上讲,注解处理器就是通过反射机制获取被检查方法上的注解信息,然后根据注解元素的值进行特定处理。
public static void main(String[] args) {
List useCases = new ArrayList();
Collections.addAll(useCases, 47, 48, 49, 50);
trackUseCases(useCases, PasswordUtils.class);
}
public static void trackUseCases(List useCases, Class<?> cl) {
for (Method m : cl.getDeclaredMethods()) {
UseCase uc = m.getAnnotation(UseCase.class);
if (uc != null) {
System.out.println(“Found Use Case:” + uc.id() + " "
+ uc.description());
useCases.remove(new Integer(uc.id()));
}
}
for (int i : useCases) {
System.out.println(“Warning: Missing use case-” + i);
}
}
Found Use Case:47 Passwords must contain at least one numeric
Found Use Case:48 no description
Warning: Missing use case-49
Warning: Missing use case-50