注解提高篇:自定义注解处理器(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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,050评论 4 370
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,538评论 1 306
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 111,673评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,622评论 0 218
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,047评论 3 295
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,974评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,129评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,893评论 0 209
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,654评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,828评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,297评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,619评论 3 262
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,326评论 3 243
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,176评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,975评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,118评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,909评论 2 278

推荐阅读更多精彩内容