ButterKniffe框架
2018-09-01 本文已影响0人
166f9fc9d18b
利用apt技术，实现ButterKniffe框架的findViewById() 功能
1：配置
-
1.1:新建moudle （java lib）——butterknife-annotion
该lib用于实现所有的注解（该项目中的 BindView 注解）
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.SOURCE)
public @interface BindView {
int value();
}
-
1.2:新建moudle （java lib）——butterknife-complier
该lib用于编写注解处理器（具体细节后面详细说明）
-
1.3:在项目的build.gradle文件中添加如下代码
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
-
1.4:在app的build.gradle文件中添加如下代码
apply plugin: 'com.neenbedankt.android-apt'
dependencies {
//引入注解
compile project(':butterknife-annotion')
//指定该项目的注解 由 该项目的注解处理器来处理
apt project(':butterkniffe-complier')
}
2：开发注解处理器
-
2.1:在 butterknife-complier 的build.gradle下引入注解和auto-service
dependencies {
//引入注解
compile project(':butterknife-annotion')
//用于指定某个注解处理器来处理注解
compile 'com.google.auto.service:auto-service:1.0-rc2'
}
-
2.2:编写注解处理器 ButterKniffeProcess
-
2.2.1:新建类 ButterKniffeProcess 继承 AbstractProcessor ，并在该类上添加注解 @AutoService
@AutoService(Processor.class)
public class ButterKniffeProcess extends AbstractProcessor {
}
-
2.2.2:实现三个方法
//供该注解处理器处理的注解
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> types = new LinkedHashSet<>();
types.add(BindView.class.getCanonicalName());
return types;
}
//支持jdk的版本
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
//具体的处理
}
-
2.2.3:编写process方法
-
2.2.3.1:获取所有的 BindView注解
//当 process 方法触发时，主工程中含有BindView这个注解的类都会被解析成一个Element 传进来(保存在集合中)
Set<? extends Element> elementSet = roundEnvironment.getElementsAnnotatedWith(BindView.class);
-
2.2.3.2:遍历每个BindView注解，获取该注解所处的类，将每个类作为键，注解的集合作为值保存在一个Map集合中。每个类都会对应的生成一个 新的类(MainActicity$ViewBinder类)
//key是activity(全类名=包名+类名) 值(成员变量集合,BindView注解作用在成员变量上)
Map<String, List<VariableElement>> cacheMap = new HashMap<>();
//遍历BindView注解
for (Element element : elementSet) {
//BindView注解作用在成员变量上 VariableElement 对应于成员变量
VariableElement variableElement = (VariableElement) element;
//通过variableElement 获取类名（此为全类名=包名+类名）
String activityName= getActivityName(variableElement);
//判断集合中是否存在该类名为键的集合
List<VariableElement> list = cacheMap.get(activityName);
if (list == null) {
//没有就新建注解集合，并放入map集合中
list=new ArrayList<>();
cacheMap.put(activityName, list);
}
//将该注解添加进注解集合中
list.add(variableElement);
}
//通过variableElement 获取全类名的实现
private String getActivityName(VariableElement variableElement) {
//通过variableElement 获取包名的实现
String packageName = getPackageName(variableElement);
//通过 variableElement 获取类节点，类似于获取父节点
TypeElement typeElement = (TypeElement) variableElement.getEnclosingElement();
return packageName+"."+typeElement.getSimpleName().toString();
}
//通过variableElement 获取包名的实现
private String getPackageName(VariableElement variableElement) {
//获取父标签 通过成员变量获取类的标签
TypeElement typeElement= (TypeElement) variableElement.getEnclosingElement();
//processingEnv 两个作用(可以理解为上下文)
// 1：找到父标签
// 2: 提供生成java代码的工具
Name qualifiedName = processingEnv.getElementUtils().getPackageOf(typeElement).getQualifiedName();
String packageName = qualifiedName.toString();
return packageName;
}
-
2.2.3:为每一个activity生成 Class
-
2.2.3.1:遍历Map集合
Iterator iterator=cacheMap.keySet().iterator();
while (iterator.hasNext()) {
}
-
2.2.3.2:新建 Class
//得到MainActivity名字
String activityName = (String) iterator.next();
//得到mainActivity 控件成员变量的集合(BindView注解修饰的成员变量)
List<VariableElement> caheElements = cacheMap.get(activityName);//需要用到的零配件
//得到新建类的名字
String newActivityBinder = activityName + "$ViewBinder";
//获取用于创建类的工厂工具
Filer filer = processingEnv.getFiler();
try {
//创建新的类
JavaFileObject javaFileObject= filer.createSourceFile(newActivityBinder);
//包名
String packageName = getPackageName(caheElements.get(0));
////相当于工人
Writer writer= javaFileObject.openWriter();
//新建的类名
String activitySimpleName = caheElements.get(0).getEnclosingElement().getSimpleName().toString() + "$ViewBinder";
//头 新建头部()
writeHeader(writer, packageName, activityName, activitySimpleName);
//中间部分
for (VariableElement variableElement : caheElements) {
//获取注解
BindView bindView = variableElement.getAnnotation(BindView.class);
//获取注解的值 (即控件的id)
int id = bindView.value();
//获取控件的 name(即该控件的命名 mTextView)
String fieldName = variableElement.getSimpleName().toString();
//获取控件的Type(即该控件的类型 TextView)
TypeMirror typeMirror=variableElement.asType();
//编写 findViewById(id) 方法
writer.write("target." + fieldName + "=(" + typeMirror.toString() + ")target.findViewById(" + id + ");");
//换行
writer.write("\n");
}
//结尾部分
writer.write("\n");
writer.write("}");
writer.write("\n");
writer.write("}");
writer.close();
} catch (IOException e) {
e.printStackTrace();
}
//书写头部
private void writeHeader(Writer writer, String packageName, String activityName, String activitySimpleName) {
try {
//第一行，包
writer.write("package "+packageName+";");
writer.write("\n");
//导入 ViewBinder 注解（只需要导入该类，其他的类不用导入，apt会自动导入）
writer.write("import com.dongnao.butterknifeframwork.ViewBinder;");
writer.write("\n");
//书写类，其中泛型为类名，而不是全类名
writer.write("public class " + activitySimpleName +
" implements ViewBinder<" + activityName + "> {");
writer.write("\n");
//书写方法，用来findViewById
writer.write(" public void bind( "+activityName+" target) {");
writer.write("\n");
} catch (IOException e) {
e.printStackTrace();
}
}
