你真的会用Java自定义注解吗？

注解： 注解为咱们在代码中添加信息提供一种形式化的方法，使咱们能够在源码、编译时、运行时很是方便的使用这些数据。

注解是在JAVA SE5中引入的，注解让代码更干净易读而且能够实现编译期类型检查等。当建立描述性质的类或接口时，若是有重复性的工做，就能够考虑使用注解来简化或自动化该过程。咱们可让注解保存在源代码中，而且利用Annotation API处理注解，获得咱们想要的数据并加以处理，注解的使用比较简单，JAVA SE5内置了3种：

• @Override 表示当前类中的方法将覆盖父类中的方法，若是不写也不会有错，可是@Override能够起到检查做用，如方法名拼写错误，编译器就会报警告信息。
• @Deprecated 表示被标注的方法已经被废弃了，若是使用编译器会发出警告信息。
• @SuppressWarnings 关闭不当的编译器警告信息。除非你肯定编译器的警告信息是错误的，不然最好不要使用这个注解。

定义注解

先来看内置注解@Override是怎么被定义的，它位于package java.lang之下：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
复制代码

@Target、@Retention称为元注解：元注解负责注解其余的注释，如： @Target定义声明的注解的做用域（做用在类上仍是方法上） @Retention定义注解在哪一个级别可用，在源代码中（SOURCE）、类文件中（CLASS）、仍是运行时（RUNTIME）。 除了@Target、@Retention还有@Documented及@Inherited，下面用一个表格来分别列出他们各自的做用：

@Retention做用范围以下图所示：

注解处理器

首先来自定义一个注解：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnotationInfo {

String[] value();

int requestCode() default 0;
}
复制代码

• 注解中定义的方法没有参数，且返回类型仅限于原始类型，字符串，枚举，注解或以上类型的集合
• 注解中定义的方法能够有默认值

运行时解析注解

@Target(ElementType.METHOD)指明了咱们的注解是做用在方法上的 @Retention(RetentionPolicy.RUNTIME)表示注解在程序运行时期也会存在，即注解信息也会加载到虚拟机VM中，因此能够经过反射来获取注解的相关信息：

public class AnnotationExample {

/**
* 注解模拟请求权限
*/
@AnnotationInfo(value = {"android.permission.CALL_PHONE", "android.permission.CAMERA"}, requestCode = 10)
public void requestPermission() {
//其余逻辑
}
}
复制代码

接着来编写一个运行时解析注解的Java类：AnnotationRuntimeProcessor.java

public class AnnotationRuntimeProcessor {

public static void main(String[] args) {
try {
//获取AnnotationExample的Class对象
Class<?> cls = Class.forName("com.javastudy.Annotation.AnnotationExample");
//获取AnnotationExample类中的方法
Method[] methods = cls.getDeclaredMethods();
for (Method method : methods) {
//过滤不含自定义注解AnnotationInfo的方法
boolean isHasAnnotation = method.isAnnotationPresent(AnnotationInfo.class);
if (isHasAnnotation) {
method.setAccessible(true);
//获取方法上的注解
AnnotationInfo aInfo = method.getAnnotation(AnnotationInfo.class);
if (aInfo == null) return;
//解析注解上对应的信息
String[] permissions = aInfo.value();
System.out.println("value: " + Arrays.toString(permissions));

int requestCode = aInfo.requestCode();
System.out.println("requestCode: " + requestCode);
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
复制代码

上面的逻辑很简单，反射拿到有注解对应类的Class对象，筛选含有注解的方法，最后获取方法上的注解并解析，运行结果以下：

value: [android.permission.CALL_PHONE, android.permission.CAMERA]
requestCode: 10
复制代码

编译时解析注解

AbstractProcessor是javax下的API，java和javax都是Java的API(Application Programming Interface)包，java是核心包，javax的x是extension的意思，也就是扩展包。通常继承AbstractProcessor须要实现下面的几个方法：

public class ProcessorExample extends AbstractProcessor {

@Override
public synchronized void init(ProcessingEnvironment processingEnvironment) {
//processingEnvironment提供各类工具类 如Elements Filer Types SourceVersion等
super.init(processingEnvironment);
}

/**
* 扫描 评估和处理注解代码 生成Java代码
*
* @param set 注解类型
* @param roundEnvironment 有关当前和之前的信息环境 查询出包含特定注解的被注解元素
* @return 返回true 表示注解已声明 后续Processor不会再处理 false表示后续Processor会处理他们
*/
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
return false;
}

@Override
public SourceVersion getSupportedSourceVersion() {
return super.getSupportedSourceVersion();
}

@Override
public Set<String> getSupportedAnnotationTypes() {
return super.getSupportedAnnotationTypes();
}
}
复制代码

• init(ProcessingEnvironment env): 每个注解处理器类都必须有一个空的构造函数。然而，这里有一个特殊的init()方法，它会被注解处理工具调用，并输入ProcessingEnviroment参数。ProcessingEnviroment提供不少有用的工具类Elements, Types和Filer。后面咱们将看到详细的内容。
• process(Set (? extends TypeElement) annotations, RoundEnvironment env): 这至关于每一个处理器的主函数main()。你在这里写你的扫描、评估和处理注解的代码，以及生成Java文件。输入参数RoundEnviroment，可让你查询出包含特定注解的被注解元素。后面咱们将看到详细的内容。
• getSupportedAnnotationTypes(): 这里你必须指定，这个注解处理器是注册给哪一个注解的。注意，它的返回值是一个字符串的集合，包含本处理器想要处理的注解类型的合法全称。换句话说，你在这里定义你的注解处理器注册到哪些注解上。
• getSupportedSourceVersion(): 用来指定你使用的Java版本。一般这里返回SourceVersion.latestSupported()。然而，若是你有足够的理由只支持Java 6的话，你也能够返回SourceVersion.RELEASE_6。推荐使用前者。