Android ButterKnife框架实现原理

2024-08-21 10:08
文章标签 实现 android 原理 框架 butterknife

本文主要是介绍Android ButterKnife框架实现原理，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

介绍

ButterKnife相信大家都很熟悉了，网上介绍其使用方法的文章很多，还不知道ButterKnife是啥的小伙伴可以先去了解一下。
ButterKnife用一个注解就替代了findViewById方法。用起来非常方便，但是你有没有想过为啥就不用写findViewById方法了呢，难道代码就真的没有跑findViewById了吗。
来来来，我们来自己手写一个ButterKnife，来学习一下他的技术。

效果

先看一下Demo的效果吧，先展示出来效果大家才有看下去的动力，毕竟光说不练假把式。

在这里插入图片描述
上面代码就是在activity中的使用，是不是跟ButterKnife一样。

@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);MyButterKnife.bind(this);}

当然同样需要在onCreate中bind一下。
下面是实际的运行效果。
在这里插入图片描述
△开始时候TextView显示的是Text1，当点击第一个Button后改变TextView的text。
在这里插入图片描述
△点击按钮后的结果，字符串发生的改变，Button，TextView，String都是通过我们自己实现的ButterKnife绑定的。

在这里插入图片描述

实现

话不多说，动手开干。
个人精力有限仅实现了BindString、BindView、OnClick，其他的小伙伴们可以自己试着实现，原理都是一样的。
首先看一下Demo的目录结构。

目录结构
先说明一下各个module的作用：

  • annotation：声明的注解，java library。
  • annotation_processor:注解处理器，java library。
  • app：测试用的app，application。
  • butterknife:调用findViewById方法，android library。

annotation module

第一步先声明我们自己的注解，这里声明了三个

在这里插入图片描述
以BingString为例，举个栗子。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface BindString {int value();
}

@interface就是声明注解，这个注解有value，如果需要多个value就将int改成数组。
@Retention(RetentionPolicy.CLASS) 可以理解成注解存在的生命周期。有三种：

  1. @Retention(RetentionPolicy.SOURCE) 注解只存在源码中，编译时将被编译器丢弃，比如我们常见的@Override
  2. @Retention(RetentionPolicy.CLASS) 编译器将注解记录在类文件中，但不会加载到JVM中。
  3. @Retention(RetentionPolicy.RUNTIME) 注解信息会保留在源文件、类文件中，在执行的时也加载到Java的JVM中，因此可以反射性的读取。

@Target(ElementType.FIELD)是表明这个注解用来修饰属性，像我们自定义的OnClick注解就要用@Target(ElementType.METHOD)来修饰，因为OnClick是添加到方法上面的。

annotation_processor module

这个模块是重点，主要的操作都是放到了这个模块里面。
它的作用就是在编译的时候根据标签，为activity生成一个activity$$BindView文件，并在构造方法中调用findViewById方法。所以ButterKnife并不是说就不会调用findViewById方法，而是它替我们写好了这些代码。

在这里插入图片描述
当新建好这个module后第一步修改build.gradle文件，添加相关依赖。
Android Studio 3.4+的版本是以下这种写法。

dependencies {implementation fileTree(dir: 'libs', include: ['*.jar'])implementation project(path: ':annotation')annotationProcessor'com.google.auto.service:auto-service:1.0-rc4'compileOnly 'com.google.auto.service:auto-service:1.0-rc3'
}

然后需要封装一个ElementClassify ，作用是将同一个类里面的注解放到一起。然后跟这个类对应起来，方便我们生成新的类时候使用。

import java.util.List;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.VariableElement;/*** 内部包含一个类中的所有带注解的元素*/
public class ElementClassify {//view的节点listpublic List<VariableElement> viewElements;//onclick的节点listpublic List<ExecutableElement> methodElements;//string的节点listpublic List<VariableElement> stringElements;public List<VariableElement> getStringElements() {return stringElements;}public void setStringElements(List<VariableElement> stringElements) {this.stringElements = stringElements;}public List<VariableElement> getViewElements() {return viewElements;}public void setViewElements(List<VariableElement> viewElements) {this.viewElements = viewElements;}public List<ExecutableElement> getMethodElements() {return methodElements;}public void setMethodElements(List<ExecutableElement> methodElements) {this.methodElements = methodElements;}
}

重点来了，下面就是注解处理器，这里主要是进行分类，把注解的元素和包含它的类用Map对应起来，然后生成一个名叫类名$$ViewBinder的文件。

import com.google.auto.service.AutoService;
import com.honeywell.annotation.BindString;
import com.honeywell.annotation.BindView;
import com.honeywell.annotation.OnClick;import java.io.IOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Name;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.type.TypeMirror;
import javax.tools.Diagnostic;
import javax.tools.JavaFileObject;@AutoService(Processor.class)
public class AnnotationProcessor extends AbstractProcessor {private Filer filer;public void logUtil(String message) {Messager messager = processingEnv.getMessager();messager.printMessage(Diagnostic.Kind.NOTE, message);}@Overridepublic synchronized void init(ProcessingEnvironment processingEnvironment) {super.init(processingEnvironment);logUtil("processor init ============================");filer = processingEnvironment.getFiler();}@Overridepublic boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {logUtil("processor process ============================");Map<TypeElement, ElementClassify> parseTargets = classifyElementWithClass(roundEnvironment);//如果map为空说明没有注解 什么都不用做if (parseTargets.size() <= 0) {return false;}Iterator<TypeElement> iterator = parseTargets.keySet().iterator();String newClassName;String packageName;Writer writer = null;//遍历map  为每一个acitvity生成$$ViewBinder文件while (iterator.hasNext()) {TypeElement classElement = iterator.next();ElementClassify elementClassify = parseTargets.get(classElement);newClassName = classElement.getSimpleName().toString();newClassName = newClassName + "$$ViewBinder";packageName = getPackageName(classElement);try {JavaFileObject javaFileObject = filer.createSourceFile(packageName + "." + newClassName);writer = javaFileObject.openWriter();StringBuffer stringBuffer = getStringBuffer(packageName, newClassName, classElement, elementClassify);writer.write(stringBuffer.toString());} catch (IOException e) {e.printStackTrace();} finally {if (writer != null) {try {writer.close();} catch (IOException e) {e.printStackTrace();}}}}return false;}/*** 生成新的class文件* @param packageName* @param newClassName* @param classElement* @param elementClassify* @return*/private StringBuffer getStringBuffer(String packageName, String newClassName, TypeElement classElement,ElementClassify elementClassify) {StringBuffer stringBuffer = new StringBuffer();stringBuffer.append("package " + packageName + ";\n");stringBuffer.append("import android.view.View;\n");stringBuffer.append("import android.util.Log;\n");stringBuffer.append("public class " + newClassName + "{\n");stringBuffer.append("\tpublic " + newClassName + "(final " + classElement.getQualifiedName() + " target){\n");stringBuffer.append("\t\tLog.d(\"gsy\",\"constractor\");\n");if (elementClassify != null && elementClassify.getViewElements() != null && elementClassify.getViewElements().size() > 0) {List<VariableElement> viewElements = elementClassify.getViewElements();for (VariableElement variableElement : viewElements) {TypeMirror typeMirror = variableElement.asType();Name name = variableElement.getSimpleName();int resId = variableElement.getAnnotation(BindView.class).value();stringBuffer.append("\t\ttarget." + name + " =(" + typeMirror + ")target.findViewById(" + resId + ");\n");}}if (elementClassify != null && elementClassify.getMethodElements() != null && elementClassify.getMethodElements().size() > 0) {List<ExecutableElement> methodElements = elementClassify.getMethodElements();for (ExecutableElement executableElement : methodElements) {int[] resIds = executableElement.getAnnotation(OnClick.class).value();String methodName = executableElement.getSimpleName().toString();for (int id : resIds) {stringBuffer.append("\t\t(target.findViewById(" + id + ")).setOnClickListener(new View.OnClickListener() {\n");stringBuffer.append("\t\t\tpublic void onClick(View p0) {\n");stringBuffer.append("\t\t\t\ttarget." + methodName + "(p0);\n");stringBuffer.append("\t\t\t}\n\t\t});\n");}}}if(elementClassify != null && elementClassify.getStringElements() != null && elementClassify.getStringElements().size() > 0){List<VariableElement> stringElements = elementClassify.getStringElements();for (VariableElement variableElement:stringElements){int id = variableElement.getAnnotation(BindString.class).value();Name name = variableElement.getSimpleName();stringBuffer.append("\t\ttarget."+name+" = target.getResources().getString("+id+");\n");}}stringBuffer.append("\t}\n}\n");return stringBuffer;}/*** 获取包名* @param classElement* @return*/private String getPackageName(Element classElement) {PackageElement packageElement = processingEnv.getElementUtils().getPackageOf(classElement);return packageElement.getQualifiedName().toString();}/*** 声明注解器支持的java版本* @return*/@Overridepublic SourceVersion getSupportedSourceVersion() {return processingEnv.getSourceVersion();}/*** 声明要处理的注解* @return*/@Overridepublic Set<String> getSupportedAnnotationTypes() {Set<String> annotationSet = new HashSet<>();annotationSet.add(BindView.class.getCanonicalName());annotationSet.add(OnClick.class.getCanonicalName());annotationSet.add(BindString.class.getCanonicalName());return annotationSet;}//TypeElement 对应class ElementClassify 对应class中的注解元素对应的方法或者变量private Map<TypeElement, ElementClassify> classifyElementWithClass(RoundEnvironment roundEnvironment) {//建立类和方法、变量的对应关系 便于生成新的class文件Map<TypeElement, ElementClassify> classElementMap = new HashMap<>();//通过roundEnvironment获取到添加了BindView注解的所有元素Set<? extends Element> viewElementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(BindView.class);//通过roundEnvironment获取到添加了OnClick注解的所有方法Set<? extends Element> methodElementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(OnClick.class);//通过roundEnvironment获取到添加了BindString注解的所有元素Set<? extends Element> stringElementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(BindString.class);//处理view 首先遍历view元素 然后封装到ElementClassify中for (Element viewElement : viewElementsAnnotatedWith) {//VariableElement可以理解为一个变量元素VariableElement variableElement = (VariableElement) viewElement;//获取到变量所在的class节点TypeElement classElement = (TypeElement) variableElement.getEnclosingElement();//先从map中取ElementClassifyElementClassify elementClassify = classElementMap.get(classElement);//List用来存放注解的对象节点List<VariableElement> viewElements;if (elementClassify != null) {//取出viewElements = elementClassify.getViewElements();logUtil("view list size="+viewElements.size());//如果list为空 新建一个 并放入ElementClassifyif (viewElements == null) {viewElements = new ArrayList<>();elementClassify.setViewElements(viewElements);}} else {elementClassify = new ElementClassify();viewElements = new ArrayList<>();elementClassify.setViewElements(viewElements);if (!classElementMap.containsKey(classElement)) {//将activity节点和list对应起来logUtil("viewlist size ="+elementClassify.getViewElements().size());classElementMap.put(classElement, elementClassify);}}logUtil(variableElement.getSimpleName().toString());//将节点放入ListviewElements.add(variableElement);}//处理methodfor (Element methodElement : methodElementsAnnotatedWith) {//ExecutableElement元素对应methodExecutableElement executableElement = (ExecutableElement) methodElement;TypeElement typeElement = (TypeElement) methodElement.getEnclosingElement();List<ExecutableElement> methodList;ElementClassify elementClassify = classElementMap.get(typeElement);if (elementClassify != null) {methodList = elementClassify.getMethodElements();if (methodList == null) {methodList = new ArrayList<>();elementClassify.setMethodElements(methodList);}} else {elementClassify = new ElementClassify();methodList = new ArrayList<>();elementClassify.setMethodElements(methodList);if (!classElementMap.containsKey(typeElement)) {classElementMap.put(typeElement, elementClassify);}}methodList.add(executableElement);}//处理stringfor (Element stringElement : stringElementsAnnotatedWith) {//VariableElementVariableElement variableElement = (VariableElement) stringElement;//获得所在的类TypeElement typeElement = (TypeElement) stringElement.getEnclosingElement();List<VariableElement> stringList;ElementClassify elementClassify = classElementMap.get(typeElement);if (elementClassify != null) {stringList = elementClassify.getStringElements();if (stringList == null) {stringList = new ArrayList<>();elementClassify.setStringElements(stringList);}} else {stringList = new ArrayList<>();elementClassify = new ElementClassify();elementClassify.setStringElements(stringList);if(!classElementMap.containsKey(typeElement)){classElementMap.put(typeElement,elementClassify);}}stringList.add(variableElement);}return classElementMap;}}

代码中都添加了注释，大家自己看一下就行，最好是可以自己动手撸一遍。我自己写时候踩了个坑，这个类要添加注解@AutoService(Processor.class)，因为自动补全的功能给我写成了@AutoService(Processo.class)，找了好久才发现。

butterknife module

这个module作用就是调用上一步生成的$$ViewBinder中的构造方法。
在这里插入图片描述
MyButterKnife就一个方法，bind方法，通过反射机制运行ViewBind中的 构造方法

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;public class MyButterKnife {/*** 通过反射的方式运行***$$ViewBinder* 达到运行findViewById方法* @param activity*/public static void bind(Object activity){String name = activity.getClass().getName();String bindName = name+"$$ViewBinder";try {Class<?> clazz = Class.forName(bindName);Constructor<?> constructor = clazz.getConstructor(activity.getClass());constructor.newInstance(activity);} catch (ClassNotFoundException e) {e.printStackTrace();} catch (NoSuchMethodException e) {e.printStackTrace();} catch (IllegalAccessException e) {e.printStackTrace();} catch (InstantiationException e) {e.printStackTrace();} catch (InvocationTargetException e) {e.printStackTrace();}}
}

app module

app就不用贴了吧，就是一些简单的布局，再啰嗦一下依赖方法，在build.gradle的dependencies下面添加上对刚才三个模块的引用，注意注解处理器模块要用annotationProcessor project。

	implementation project(path: ':annotation')annotationProcessor project(path: ':annotation_processor')implementation project(path: ':butterknife')

总结

当所有代码写完后先build一下。如果代码没有问题会有中间文件$$ViewBinder.class文件生成。路径在build/intermediates/javac下面，举个栗子：
在这里插入图片描述
红框中就是注解处理器生成的中间文件，它们是在编译时生成的，我们看一下它的内容：
在这里插入图片描述
是不是恍然大悟，写了那么多就是为了生成这些findViewById、setOnClickListener代码。本文只是讲述了一下实现过程，对于注解、apt、反射等知识点没有过多讲解，小伙伴要是想学习可以网上搜一下，各种博客一大把。
最后奉上源码，github：源码路径
csdn下载：csdn下载路径
水平有限，如有错误欢迎指正讨论。

这篇关于Android ButterKnife框架实现原理的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1092859。

相关文章

Oracle查询优化之高效实现仅查询前10条记录的方法与实践

Oracle查询优化之高效实现仅查询前10条记录的方法与实践

《Oracle查询优化之高效实现仅查询前10条记录的方法与实践》：本文主要介绍Oracle查询优化之高效实现仅查询前10条记录的相关资料,包括使用ROWNUM、ROW_NUMBER()函数、FET... 目录1. 使用 ROWNUM 查询2. 使用 ROW_NUMBER() 函数3. 使用 FETCH FI
阅读更多...
Python脚本实现自动删除C盘临时文件夹

Python脚本实现自动删除C盘临时文件夹

《Python脚本实现自动删除C盘临时文件夹》在日常使用电脑的过程中,临时文件夹往往会积累大量的无用数据,占用宝贵的磁盘空间,下面我们就来看看Python如何通过脚本实现自动删除C盘临时文件夹吧... 目录一、准备工作二、python脚本编写三、脚本解析四、运行脚本五、案例演示六、注意事项七、总结在日常使用
阅读更多...
Java实现Excel与HTML互转

Java实现Excel与HTML互转

《Java实现Excel与HTML互转》Excel是一种电子表格格式,而HTM则是一种用于创建网页的标记语言,虽然两者在用途上存在差异,但有时我们需要将数据从一种格式转换为另一种格式,下面我们就来看看... Excel是一种电子表格格式，广泛用于数据处理和分析，而HTM则是一种用于创建网页的标记语言。虽然两
阅读更多...
Java中Springboot集成Kafka实现消息发送和接收功能

Java中Springboot集成Kafka实现消息发送和接收功能

《Java中Springboot集成Kafka实现消息发送和接收功能》Kafka是一个高吞吐量的分布式发布-订阅消息系统,主要用于处理大规模数据流,它由生产者、消费者、主题、分区和代理等组件构成,Ka... 目录一、Kafka 简介二、Kafka 功能三、POM依赖四、配置文件五、生产者六、消费者一、Kaf
阅读更多...
使用Python实现在Word中添加或删除超链接

使用Python实现在Word中添加或删除超链接

《使用Python实现在Word中添加或删除超链接》在Word文档中,超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能,本文将为大家介绍一下Python如何实现在Word中添加或... 在Word文档中，超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能。通过添加超
阅读更多...
windos server2022里的DFS配置的实现

windos server2022里的DFS配置的实现

《windosserver2022里的DFS配置的实现》DFS是WindowsServer操作系统提供的一种功能,用于在多台服务器上集中管理共享文件夹和文件的分布式存储解决方案,本文就来介绍一下wi... 目录什么是DFS？优势：应用场景：DFS配置步骤什么是DFS？DFS指的是分布式文件系统（Distr
阅读更多...
NFS实现多服务器文件的共享的方法步骤

NFS实现多服务器文件的共享的方法步骤

《NFS实现多服务器文件的共享的方法步骤》NFS允许网络中的计算机之间共享资源,客户端可以透明地读写远端NFS服务器上的文件,本文就来介绍一下NFS实现多服务器文件的共享的方法步骤,感兴趣的可以了解一... 目录一、简介二、部署1、准备1、服务端和客户端：安装nfs-utils2、服务端：创建共享目录3、服
阅读更多...
C#使用yield关键字实现提升迭代性能与效率

C#使用yield关键字实现提升迭代性能与效率

《C#使用yield关键字实现提升迭代性能与效率》yield关键字在C#中简化了数据迭代的方式,实现了按需生成数据,自动维护迭代状态,本文主要来聊聊如何使用yield关键字实现提升迭代性能与效率,感兴... 目录前言传统迭代和yield迭代方式对比yield延迟加载按需获取数据yield break显式示迭
阅读更多...
Python实现高效地读写大型文件

Python实现高效地读写大型文件

《Python实现高效地读写大型文件》Python如何读写的是大型文件,有没有什么方法来提高效率呢,这篇文章就来和大家聊聊如何在Python中高效地读写大型文件,需要的可以了解下... 目录一、逐行读取大型文件二、分块读取大型文件三、使用 mmap 模块进行内存映射文件操作（适用于大文件）四、使用 pand
阅读更多...
python实现pdf转word和excel的示例代码

python实现pdf转word和excel的示例代码

《python实现pdf转word和excel的示例代码》本文主要介绍了python实现pdf转word和excel的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、引言二、python编程1，PDF转Word2，PDF转Excel三、前端页面效果展示总结一
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2