注解提高篇：自定義注解處理器（APT）

0x01 繼承AbstractProcessor抽象類

---

當定義好Annotation注解后，接下來就需要一個注解處理器來處理我們的自定義注解了。實現Java Annotation一般需要繼承AbstractProcessor抽象類，並且重寫其四個方法來實現提取，解析並處理自定義注解的邏輯如下：

class WondertwoProcessor extends AbstractProcessor {
    //返回注解處理器可處理的注解操作
    @Override
    public Set<String> getSupportedOptions() {
        return super.getSupportedOptions();
    }
    //得到注解處理器可以支持的注解類型
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return super.getSupportedAnnotationTypes();
    }
    //執行一些初始化邏輯
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
    }
    //核心方法，掃描，解析並處理自定義注解，生成***.java文件
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

0x02 重寫核心方法process()

---

由上可知process()方法才是掃描，解析，處理注解的核心方法，動手實戰一下寫一個簡單的WondertwoProcessor來提取自定義注解@CustomizeInterface，然后借助JavaPoet生成Java接口文件。

/**
 * 自定義注解處理器，將類中public方法提取為接口方法（不含static方法）
 * {
 *     Exec: apt -factory annotation3.WondertwoFactory
 *     ProvinceDefiner.java -s ../annotaion3
 * }
 * Created by wondertwo on 2016/10/18.
 */
class WondertwoProcessor extends AbstractProcessor {
    private ProcessingEnvironment envir;

    public WondertwoProcessor(ProcessingEnvironment env) {
        this.envir = env;
    }

    @Override
    public Set<String> getSupportedOptions() {
        return super.getSupportedOptions();
    }

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

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement typeEle : annotations) {
            WondertwoInterface wondertwoInterface = typeEle.getAnnotation(WondertwoInterface.class);
            if (wondertwoInterface == null) break;

            Class clazz = typeEle.getClass();
            if (clazz.getDeclaredMethods().length > 0) {
                try {
                    if (typeEle.getModifiers().contains(Modifier.PUBLIC)
                            && !typeEle.getModifiers().contains(Modifier.STATIC)) {
                        PrintWriter writer = (PrintWriter) envir.getFiler()
                                .createSourceFile(wondertwoInterface.value());
                        writer.println("package " + clazz.getPackage().getName() + ";");
                        writer.println("public interface " + wondertwoInterface.value() + " {");
                        for (Method method : clazz.getDeclaredMethods()) {
                            writer.print("    public ");
                            writer.print(method.getReturnType() + " ");
                            writer.print(method.getName() + " (");
                            int i = 0;
                            for (TypeParameterElement parameter : typeEle.getTypeParameters()) {
                                writer.print(parameter.asType() + " " + parameter.getSimpleName());
                                if (++i < typeEle.getTypeParameters().size())
                                    writer.print(", ");
                            }
                            writer.println(");");
                        }
                        writer.println("}");
                        writer.close();
                    }
                } catch (IOException e) {
                    throw new RuntimeException(e);
                }
            }
        }
        return true;
    }
}

看過《Java編程思想》的同學肯定對上面的實例非常眼熟，書中對應的實例也是提取非靜態公有方法生成接口源文件，但由於是JDK6.0標准已經有很多API發生了很大的變化，本例基於JDK8！

可以看到我們只在process()方法中加入了處理注解，生成.java文件的邏輯，這里是的邏輯是根據自定義注解提取對應類的非靜態public方法，然后將抽取的非靜態共有方法拼接成對應的接口！

0x03 實例探究：Android依賴注解庫ButterKnife

---

不會偷懶的程序員不是一個好程序員，Android開發者對ButterKnife依賴注解庫一定耳熟能詳，當我們UI布局中控件很多的時候ButterKnife無疑顯著提高了開發效率。

作為一個注解庫其實現的原理依然是Java Annotation的方式，我們在Github翻出ButterKnife源碼文件，找到其核心類——注解處理類ButterKnifeProcessor.java，源碼較長刪減后如下：

public final class ButterKnifeProcessor extends AbstractProcessor {
  @Override public synchronized void init(ProcessingEnvironment env) {
    super.init(env);
    elementUtils = env.getElementUtils();
    typeUtils = env.getTypeUtils();
    filer = env.getFiler();
  }
  @Override public Set<String> getSupportedAnnotationTypes() {
    Set<String> types = new LinkedHashSet<String>();
    types.add(Bind.class.getCanonicalName());
    for (Class<? extends Annotation> listener : LISTENERS) {
      types.add(listener.getCanonicalName());
    }
    types.add(BindBool.class.getCanonicalName());
    types.add(BindColor.class.getCanonicalName());
    types.add(BindDimen.class.getCanonicalName());
    types.add(BindDrawable.class.getCanonicalName());
    types.add(BindInt.class.getCanonicalName());
    types.add(BindString.class.getCanonicalName());
    return types;
  }
  @Override public boolean process(Set<? extends TypeElement> elements, RoundEnvironment env) {
    Map<TypeElement, BindingClass> targetClassMap = findAndParseTargets(env);
    for (Map.Entry<TypeElement, BindingClass> entry : targetClassMap.entrySet()) {
      TypeElement typeElement = entry.getKey();
      BindingClass bindingClass = entry.getValue();
      try {
        JavaFileObject jfo = filer.createSourceFile(bindingClass.getFqcn(), typeElement);
        Writer writer = jfo.openWriter();
        writer.write(bindingClass.brewJava());
        writer.flush();
        writer.close();
      } catch (IOException e) {
        error(typeElement, "Unable to write view binder for type %s: %s", typeElement,
            e.getMessage());
      }
    }
    return true;
  }
  @Override public Set<String> getSupportedOptions() {
    return Collections.singleton(OPTION_SDK_INT);
  }
}

如果想要進一步了解ButteKnife掃描，解析，處理注解，生成Java代碼的每一部細節，可以參考文章：淺析ButterKnife