编译注解----实例

这个 demo 是这篇博客里的一个例子,光看没看懂,又照着写了一遍也还是很懵,为了更好的理解,几乎把每一句核心代码都打印,都注释了,这样才略懂了一些在编译时生成代码这个流程。

下面这个方法是最懵的,所以注释写了很多,里面的各种元素都比较抽象,看的时候,甚至是第一次写的时候,都不知道在写什么,通过打印把抽象的东西,还原成我们熟悉的东西就好理解多了。

/**
 *
 * @param set  包含的是所有使用的[注解的信息],例如BindView,ContentView
 * @param roundEnvironment 返回的是所有被注解的[元素],例如类,属性等
 * @return
 */
 @Override
 public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
//        mMessager.printMessage(Diagnostic.Kind.NOTE,"process...");
​
 // 防止处理多次,要清空
 mProxyMap.clear();
​
 System.out.println("mProxyMap"+mProxyMap.toString());
 // 获取全部的带有 bindview 注解的 element
 Set<? extends Element> elseWithBind = roundEnvironment.getElementsAnnotatedWith(BindView.class);
 System.out.println("elseWithBind: " + elseWithBind.toString());
 //elseWithBind: [mTextView, mImageView]
​
 // 对bindview 进行循环,构建 proxyInfo 信息
 for (Element element : elseWithBind) {
 // 检查 element 的合法性
 checkSAnnotationValid(element,BindView.class);
​
 // 强转成属性元素
 VariableElement variableElement = (VariableElement) element;
 System.out.println("variableElement: "+variableElement);
//            variableElement: mTextView
​
 System.out.println("-----"+ element.getEnclosingElement());
​
 // 要获取类元素的类名,直接用 element 也可以,强转不是必须的。
 // 属性元素的外层一定是类元素
 TypeElement typeElement = (TypeElement) variableElement.getEnclosingElement();
 System.out.println("typeElement: "+typeElement);
 // typeElement: com.limiao.annotationdemo.MainActivity
​
 // 获取类元素的类名(全路径名)
 String fqClassName = typeElement.getQualifiedName().toString();
 System.out.println("fqClassName: "+fqClassName);
//            fqClassName: com.limiao.annotationdemo.MainActivity
​
 System.out.println("mProxyMap: "+mProxyMap);
​
 ProxyInfo proxyInfo = mProxyMap.get(fqClassName);
 if (proxyInfo == null){
 proxyInfo = new ProxyInfo(mElementUtils,typeElement);
 // 以 class 名称为 key,保存到 mProxy 中
 mProxyMap.put(fqClassName,proxyInfo);
 }
​
 System.out.println("proxyInfo:"+proxyInfo);
​
 // 获取 bindview 注解,把信息放入 proxyInfo 中
 BindView bindAnnotation = element.getAnnotation(BindView.class);
 int id = bindAnnotation.value();
 mMessager.printMessage(Diagnostic.Kind.NOTE,"proxyInfo:" + proxyInfo.toString());
 mMessager.printMessage(Diagnostic.Kind.NOTE,"variableElement:" + variableElement);
 mMessager.printMessage(Diagnostic.Kind.NOTE,"id:" + id);
 // 上面的强转要用到这里,作为参数
 proxyInfo.injectVarialbles.put(id,variableElement);
 }
​
 // 获取所有的 ContentView 注解,操作原理和上面的 bindview 一样
 Set<? extends Element> contentAnnotations = roundEnvironment.getElementsAnnotatedWith(ContentView.class);
 for (Element element : contentAnnotations) {
 TypeElement typeElement = (TypeElement) element;
 String fqClassName  = typeElement.getQualifiedName().toString();
 ProxyInfo proxyInfo = mProxyMap.get(fqClassName);
 if (proxyInfo == null) {
 proxyInfo = new ProxyInfo(mElementUtils,typeElement);
 mProxyMap.put(fqClassName,proxyInfo);
 }
 ContentView contentViewAnnotation = element.getAnnotation(ContentView.class);
 proxyInfo.contentViewId = contentViewAnnotation.value();
 }
​
 // 循环生成源文件
 for (String key : mProxyMap.keySet()) {
 ProxyInfo proxyInfo = mProxyMap.get(key);
 try {
 System.out.println("ProxyClassFullName: "+proxyInfo.getProxyClassFullName());
 System.out.println("TypeElement: "+proxyInfo.getTypeElement());
 // 创建一个 javaFile 文件
 // 第一个参数:创建的文件名,包含全路径
 // 第二个参数:与此文件的创建有因果关联的类型或包或模块元素,可以为null(文档的说明)
//                JavaFileObject jfo = processingEnv.getFiler().createSourceFile(proxyInfo.getProxyClassFullName(),proxyInfo.getTypeElement());
//                试了一下,如果第二个参数为 null ,也没有关系,还能正常编译运行
 JavaFileObject jfo = processingEnv.getFiler().createSourceFile(proxyInfo.getProxyClassFullName(),null);
 Writer writer = jfo.openWriter();
 writer.write(proxyInfo.generateJavaCode());
 writer.flush();
 writer.close();
 } catch (IOException e) {
​
 e.printStackTrace();
 error(proxyInfo.getTypeElement(),"unable to write injector for type %s: %s",proxyInfo.getTypeElement(),e.getMessage());
 }
 }
​
 return true;
​
 }

参考的这篇博客的作者关于编译注解写了一个系列的文章,都很好,这里整理一下贴出来,方便查阅。

深入理解编译注解(一)从实战理解什么是编译注解

深入理解编译注解(二)annotationProcessor与android-apt

深入理解编译注解(三)依赖关系 apt/annotationProcessor与Provided的区别

深入理解编译注解(四)常用接口介绍

深入理解编译注解(五)RetentionPolicy.SOURCE 和 RetentionPolicy.CLASS区别讨论

深入理解编译注解(六)Butterknife的实现原理

demo github 地址

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

推荐阅读更多精彩内容