Android 打造编译时注解解析框架

时间 2019-11-13

原文原文链接

说道注解，居然还有各类分类，得，这记不住，咱们从注解的做用来反推其分类，帮助你们记忆，而后举例强化你们的记忆，话说注解的做用：html

一、标记一些信息，这么说可能太抽象，那么我说，你见过@Override、@SuppressWarnings等，这类注解就是用于标识，能够用做一些检验java

二、运行时动态处理，这个你们见得应该最多，在运行时拿到类的Class对象，而后遍历其方法、变量，判断有无注解声明，而后作一些事情。相似上述三篇博文中的作法。android

三、编译时动态处理，这个呢？就是咱们今天的主角了，通常这类注解会在编译的时候，根据注解标识，动态生成一些类或者生成一些xml均可以，在运行时期，这类注解是没有的~~会依靠动态生成的类作一些操做，由于没有反射，效率和直接调用方法没什么区别~~~json

关于3，你们不明白，没事，下文会详谈，使用这类注解的项目有：ParcelableGenerator、butterknife 、androidannotaion等。数组

做用谈完了，那么若是你看到一个注解的声明你如何去判断他的做用呢？例如：微信

[java] view plain copy网络

@Retention(RetentionPolicy.CLASS) app
@Target ({ ElementType.FIELD, ElementType.TYPE }) 框架
public @interface InjectView eclipse
{
int value();
}

1秒钟告诉我，它的做用是什么？哈，你们可能会郁闷，擦，我咋知道。其实能够看这个注解上面的@Retention后面的值，设置的为CLASS，说明就是编译时动态处理的。

这个值是一个枚举：有三个：SOURCE、RUNTIME、CLASS ，到这里，是否是，搜噶，这三个11对应于上面三个做用。

好了，说完了注解的做用以及判断方式，那么你们能够看到除了@Retention还有个@Target，@Target的值呢是一个ElementType[]数组。什么意思呢？就是标明这个注解能标识哪些东西，好比类、变量、方法、甚至是注解自己（元注解）等。这个在：Android 进阶教你打造 Android 中的 IOC 框架【ViewInject】（上）有详细说明。

好了，到此注解告一段落，你们只要记得注解的做用，以及如何去定义一个注解就好。

接下来进入咱们的主题编译时注解。

对了，我建立了一个公众号，会推送一些开源项目、最新博客、视频等，关于博客涉及到的东西，也会提早给你们通知，能够关注一下，谢谢，左侧栏目，微信扫描便可。

三、编译时注解

那咱们说一下编写过程。

一、建立一个类，继承AbstractProcessor

[java] view plain copy

package com.zhy.util.ioc.processor;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
@SupportedAnnotationTypes("com.zhy.util.ioc.annotation.InjectView")
@SupportedSourceVersion(SourceVersion.RELEASE_6)
public class ViewInjectProcessorBeta extends AbstractProcessor
{
@Override
public boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv)
{
// TODO Auto-generated method stub
return false;
}
}

这个类上能够添加注解：

@SupportedAnnotationTypes的值为当前类支持的注解的完整类路径，支持通配符。

@SupportedSourceVersion 标识该处理器支持的源码版本

除此之外还有一个@SupportedOptions，这个通常是命令行时候用的，设置一些选项，but，命令行我不熟，所以：略。

注：若是你们找不到AbstractProcessor，记得右键build-path add library把jdk加进来。

二、建立resources等文件。

这个对项目的一个结构有着固定的要求，下面我经过一张图来讲：

能够看到，在咱们的项目中呢，还须要建立一个resources这样的source folder ，右键 new sources folder便可。

而后在里面建立META-INF/services/javax.annotation.processing.Processor文件，这个文件中去写咱们处理器的类完整路径。

通过上述两部，咱们的编写环境就OK了。

四、完整例子

下面咱们经过一个例子来给你们演示编译时动态生成数据，咱们的效果是这样的，用户编写一堆bean，例如User类，咱们经过注解提取属性动态生成一个json文件，以及一个代理类，注意是编译时生成。

注：如下为一个教学示例，无任何使用价值。

那么咱们依然分为步骤来作：

一、建立编写环境

javax.annotation.processing.Processor里面写的是：com.zhy.annotationprocess.processor.BeanProcessor

咱们还建立了一个注解：

[java] view plain copy

package com.zhy.annotationprocess.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ ElementType.FIELD, ElementType.TYPE })
@Retention(RetentionPolicy.CLASS)
public @interface Seriable
{
}

哈，一秒钟告诉我，哪一类做用的注解。

二、动态生成数据

一、首先明确一下咱们的目标：

咱们有不少bean类，例如：

[java] view plain copy

public class User
{
@Seriable
private String username;
@Seriable
private String password;
private String three;
private String four;
}

[java] view plain copy

@Seriable
public class Article
{
private String title ;
private String content ;
}

看到有两个普通的bean，上面声明了咱们的注解，若是类上声明注解咱们就将其全部的变量都生成一个json描述文件；若是仅仅是成员变量呢？那咱们只提取声明的成员变量来动态生成。

相似以下的描述文件：

[html] view plain copy

{class:"com.zhy.Article",
fields:
{
content:"java.lang.String",
title:"java.lang.String"
}
}

是否是以为没撒用处，其实用处大大滴，之后咱们会验证。

二、编写BeanProcessor

[java] view plain copy

package com.zhy.annotationprocess.processor;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import com.zhy.annotationprocess.annotation.Seriable;
@SupportedAnnotationTypes("com.zhy.annotationprocess.annotation.Seriable")
@SupportedSourceVersion(SourceVersion.RELEASE_6)
public class BeanProcessor extends AbstractProcessor
{ // 元素操做的辅助类
Elements elementUtils;
@Override
public synchronized void init(ProcessingEnvironment processingEnv)
{
super.init(processingEnv);
// 元素操做的辅助类
elementUtils = processingEnv.getElementUtils();
}
@Override
public boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv)
{
// 得到被该注解声明的元素
Set<? extends Element> elememts = roundEnv
.getElementsAnnotatedWith(Seriable.class);
TypeElement classElement = null;// 声明类元素
List<VariableElement> fields = null;// 声明一个存放成员变量的列表
// 存放两者
Map<String, List<VariableElement>> maps = new HashMap<String, List<VariableElement>>();
// 遍历
for (Element ele : elememts)
{
// 判断该元素是否为类
if (ele.getKind() == ElementKind.CLASS)
{
classElement = (TypeElement) ele;
maps.put(classElement.getQualifiedName().toString(),
fields = new ArrayList<VariableElement>());
} else if (ele.getKind() == ElementKind.FIELD) // 判断该元素是否为成员变量
{
VariableElement varELe = (VariableElement) ele;
// 获取该元素封装类型
TypeElement enclosingElement = (TypeElement) varELe
.getEnclosingElement();
// 拿到key
String key = enclosingElement.getQualifiedName().toString();
fields = maps.get(key);
if (fields == null)
{
maps.put(key, fields = new ArrayList<VariableElement>());
}
fields.add(varELe);
}
}
for (String key : maps.keySet())
{
if (maps.get(key).size() == 0)
{
TypeElement typeElement = elementUtils.getTypeElement(key);
List<? extends Element> allMembers = elementUtils
.getAllMembers(typeElement);
if (allMembers.size() > 0)
{
maps.get(key).addAll(ElementFilter.fieldsIn(allMembers));
}
}
}
generateCodes(maps);
return true;
}
private void generateCodes(Map<String, List<VariableElement>> maps)
{
File dir = new File("f://apt_test");
if (!dir.exists())
dir.mkdirs();
// 遍历map
for (String key : maps.keySet())
{
// 建立文件
File file = new File(dir, key.replaceAll("\\.", "_") + ".txt");
try
{
/**
* 编写json文件内容
*/
FileWriter fw = new FileWriter(file);
fw.append("{").append("class:").append("\"" + key + "\"")
.append(",\n ");
fw.append("fields:\n {\n");
List<VariableElement> fields = maps.get(key);
for (int i = 0; i < fields.size(); i++)
{
VariableElement field = fields.get(i);
fw.append(" ").append(field.getSimpleName()).append(":")
.append("\"" + field.asType().toString() + "\"");
if (i < fields.size() - 1)
{
fw.append(",");
fw.append("\n");
}
}
fw.append("\n }\n");
fw.append("}");
fw.flush();
fw.close();
} catch (IOException e)
{
e.printStackTrace();
}
}
}
}

代码略长，可是注释很清除，我来解释一下，基本分为两个过程：一、找出标识注解的类或成员变量，封装到maps中；二、遍历maps为每一个类建立json文件。咱们把文件输出到了f://apt_test文件夹中，若是你没有f盘神马的，自行修改目录。

三、使用

到此，咱们写完了~~那么如何用呢？

一、导出jar

为了更好的演示，以及省篇幅，我录成gif

注意我选择的一些复选框，和一些默认复选框的选中状态，我将其放在桌面上~~

二、新建一个android或java项目

将jar拷贝到libs下，若是是java项目，须要本身建立lib文件夹，本身手动引用。

而后就开始编写bean吧：我这里就写了两个类，一个User，一个Article，上面贴过代码了。

三、启用annotation processor

这里我是eclipse，你们若是是maven项目或者是别的什么IDE，自行进行网络搜索，这里有个Android Studio下的使用，本身点击哈，其实命令行也能够。

下面咱们eclipse依然是个gif，否则得截一堆图片：

假设咱们的jar已经拷贝到项目中了，进行以下操做

操做完成之后，那么就能够去f://apt_test中

打开便可看到：

[java] view plain copy

{class:"com.zhy.User",
fields:
{
username:"java.lang.String",
password:"java.lang.String"
}
}

[java] view plain copy

{class:"com.zhy.Article",
fields:
{
content:"java.lang.String",
title:"java.lang.String"
}
}

ok，这样的话，咱们一个简单的annotation processor的教程就搞定了~~若是想学，必定要去试，各类试，不要怕麻烦，要是简单谁都会，那还有什么意义~~

这是一个很是简单的例子，那么具体到咱们的项目中如何使用呢？鉴于篇幅，可能只能在下一篇给你们继续了。不过库的雏形已经造成：

五、HyViewInject

ok，这就是基于上述的一个库，主要用于Android的控件的注入，相似butterknife，尚在完善中，欢迎你们使用，fork or star ,咱们一块儿完善。

sample的效果图：

第一个Activity中一个TextView和ListView，第二个Activity一个TextView和Fragment，主要测试了Activity、Fragment、Adapter中注入控件。