【Java二十周年】Java注解处理器

一、序言

Java的世界中，也许你会有个疑问，为什么@Override能够让编译器验证这个函数是否被有效重载，为什么Hibernate的注解能够使的数据库操作如此简便，今天，我们就来揭开注解的神秘面纱，了解一下Java编译器不为人知的一面。

注解的语法比较简单，除了@符号的使用之外，它基本与Java固有语法一致。Java SE5内置了三种标准注解：

1. @Override，表示当前的方法定义将覆盖超类中的方法。

2. @Deprecated，使用了注解为它的元素编译器将发出警告，因为注解@Deprecated是不赞成使用的代码，被弃用的代码。

3. @SuppressWarnings，关闭编译器警告信息。

二、运行时注解的使用

在刚刚认识注解时，我想了很久，不知道这东西能做什么，但今天，我要给大家演示一个神奇的功能，自动函数调用。

我们通过注解，来描述一个函数应该被如何调用，这种自动的函数调用，也许能够较为方便的被例如聊天机器人等程序使用。

首先我们来创建一个注解，注解的语法稍有特殊，使用@interface来声明。

package com.abs.autocontext;

import java.lang.annotation.*;

/**
 * 这个注解是用来自动调用函数使用
 * Created by sxf on 15-3-15.
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AutoCall {
   
    String name();
    String tip() default "";
}

这里我们会发现，注解的声明也用到了注解- -!
其实，为了表明注解的功能及使用条件，注解在定义时，可以附加如下注解标签：

注解	功能介绍
@Target	表示该注解可以用于什么地方，可能的ElementType参数有： CONSTRUCTOR：构造器的声明 FIELD：域声明（包括enum实例） LOCAL_VARIABLE：局部变量声明 METHOD：方法声明 PACKAGE：包声明 PARAMETER：参数声明 TYPE：类、接口（包括注解类型）或enum声明
@Retention	表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括： SOURCE：注解将被编译器丢弃 CLASS：注解在class文件中可用，但会被VM丢弃 RUNTIME：VM将在运行期间保留注解，因此可以通过反射机制读取注解的信息。
@Document	将注解包含在Javadoc中
@Inherited	允许子类继承父类中的注解

注解的使用

然后我们来创建一个带有一定功能的实现类，使用一下我们刚刚创建的注解：

package com.abs.autocontext;

/**
 * 功能测试类
 * Created by sxf on 15-3-15.
 */
public class TestA{
   

    public TestA(String name) {
        this.name = name;
    }

    String name;

    @AutoCall(name="打印")
    public void printName() {
        System.out.println("Hello "+name);
    }

    @AutoCall(name="打电话", tip="给谁打电话呢？")
    public void call(String... str) {
        System.out.println("正在打电话给"+str);
    }

    @AutoCall(name="发短信", tip="给谁发短信呢？")
    public void send(String... str) {
        StringBuilder sb = new StringBuilder();
        boolean flag = true;
        for (String s : str) {
            if (flag) flag = false; else sb.append("、");
            sb.append(s);
        }
        System.out.println("正在发短信给"+sb.toString());
    }
}

AutoCall注解中的name属性，是表示该方法的调用名字，我们希望，通过这个name，来找到这个方法。
tip属性，则是在调用过程中，显示用的提示语，例如，我通过，发短信，找到这个函数，那么我将它的tip属性取出并显示，这个函数就会问我，给谁发短线呢？

光有这个类还不能解决问题，这个类并不能自己找到带有注解的函数，运行时注解，需要我们自己添加代码，在合适的时候，通过反射，查询我们要用到的函数。

我们于是考虑实现一个基类BaseClass，然后让刚刚我们编写的TestA从这个基类继承，然后在基类中添加部分功能，使得这个类能通过注解的名字找到对应的函数。

package com.abs.autocontext;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

/**
 * 自动调用框架的基类
 * Created by sxf on 15-3-15.
 */
public class BaseClass {
   

    Map<String, Method> methodCache = new HashMap<>();

    public BaseClass() {
        Class<? extends BaseClass> myclass = this.getClass();
        System.out.println(myclass.getName());
        Method methods[] = myclass.getMethods();
        for (Method m: methods) {
            AutoCall autocall = m.getDeclaredAnnotation(AutoCall.class);
            if (autocall != null) {
                methodCache.put(autocall.name(), m);
            }
        }
    }

    public Method findMethod(String name) {
        if (name == null)