ButterKnife : 黄油刀, 一如既往的优雅。能简化Activity上UI的代码,让Activity更加优雅,省去多余的findViewById, setOnClickListener等繁琐的操作。
原理分析:
在这里,就简单全部用MainActivity作为例子,代入感强一点。项目是开源的,github上面大家可以下来慢慢看。
MainActiviy 声明注解,通过Apt技术,编译生成MainActiviy&&ViewBinder。 调用ButterKnife.bind中通过反射找到MainActiviy&&ViewBinder, 模板代码在里面实现findViewById方法。原理并不难。
Apt (Annotation Processing Tool) 技术大家并不陌生,Butterknife, EventBus,Dagger
android-apt是一个gradle插件,Android Gradle 插件 2.2 版本的发布, annotationProcessor 的功能来完全代替 android-apt ,Android Gradle插件现在已经支持annotationProcessor,并警告和或阻止说不在更新android-apt ,并推荐大家使用 Android 官方插件annotationProcessor。
源码地址:
https://github.com/Amberllo/ButterKnifeTest
只是简陋的写了BindView和findViewById,有兴趣的朋友,可以跑跑。
复刻思路:
1.让Activity 语法跟真正的Butterknife一模一样
2.建立Apt环境, 并能断点调试(断点调试真的很重要,能节省很多时间)
3.在Processor类的process函数,补上写文件的函数,刚开始哪怕是生成个txt文件也好
4.生成文件成功后,慢慢打磨,动态生成 MainActivity$$ViewBinder文件,并补上findViewById的逻辑。
begin
建立工程:app,添加真正的依赖Butterknife
implementation 'com.jakewharton:butterknife:8.4.0'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.4.0'
public class MainActivity extends AppCompatActivity {
@BindView(R.id.textView)
TextView textView;
@BindView(R.id.button)
Button button;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Butterknife.bind(this);
textView.setText("123");
}
}
让我们的MainActivity 和 SecondActivity ,真正用起来
参照源码,建立module,
app的依赖改为
implementation project(":butterknife")
annotationProcessor project(":butterknife-compiler")
butterknife和butterknife-compile, 依赖butterkinfe-annotation
建立由于apt技术使用到javax的类,在rt.jar里,android的sdk把这部分阉割了,所以得建个JavaModule
建立apt环境
(1)在butterkinfe-compile工程,新建类BindProcessor,继承AbstraceProcessor,重载process函数
@AutoService(Processor.class)
public class BindProcessor extends AbstractProcessor {
//操作文件
Filer filer;
//调试用的控制器,断点调试失败的情况下,打印就靠这个了
Messager messager;
//操作Element的工具类,有这个少折腾很多活了
Elements elementUtils;
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
this.filer = processingEnv.getFiler();
this.messager = processingEnv.getMessager();
this.elementUtils = processingEnv.getElementUtils();
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
/**
* key: activity的完整命名空间
* value: 注释信息
* */
Map<String, List<Element>> bindViews = makeData(roundEnv);
//生成文件
makeFile(bindViews);
return false;
}
@Override
public Set<String> getSupportedAnnotationTypes() {
//注册对应注解
Set<String> set = new HashSet<>();
set.add(BindView.class.getName());
return set;
}
}
(2)Processor自身也需要要注册,正如activity得在Manifest注册一样,编译时才会被检测到
注册Processor,有两种方式:
最原始的方式: 要在java同级resources/META-INF/services, 创建 javax.annotation.processing.Processor 文件,文件写入注解类的完整命名空间
当然一般创建这个文件,每次注解都得手动注册,反人类了。
Google为我们提供了Auto-service, 替我们自动创建这个文件。
implementation 'com.google.auto.service:auto-service:1.0-rc2'
并在类名声明@AutoService(Processor.class)
(3)尽管注册了Processor,但Processor不会向注解产生反应。@SupportedAnnotationType或者重载getSupportedAnnotationTypes函数
(4)建立断点调试环境
agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
把Activity用到@BindView,改成自己的类,并修改gradle.properties
android.enableD8 = true
org.gradle.daemon=true
org.gradle.jvmargs=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
(5)在init或者process函数给个断点,稳妥起见把generated文件夹删除干净,点击debug按钮后, 点几隔壁的🔨锤子,可以开始调试看看Processor有没有生效。
1.检验gradle不要用5以上,我那一直没生效...默默把gradle版本降回4.10.2,生效了.....
2.如果端口5005被占用,就改别的端口吧..反正我没报这个错。
3.android.enableD8要打开,不然还是会有奇奇怪怪的问题。
最后愉快的进入断点了,愉悦~~
开始补充写文件的操作
APT能调试了,可以开始写文件了。目标是生成MainActivity$$ViewBinder.java
在这里,也直接找了工具类JavaPoet神器, 写文件的细节,没有深入研究,大家断点慢慢调试。框架写好了,剩下的花时间慢慢打磨吧。
private Map<String, List<Element>> makeData(RoundEnvironment roundEnv) {
Map<String, List<Element>> bindViews = new HashMap<>();
Set<? extends Element> bindViewElements = roundEnv.getElementsAnnotatedWith(BindView.class);
for (Element element : bindViewElements) {
TypeElement classElement = (TypeElement) element.getEnclosingElement();
//com.amberllo.butterknife.app.MainActivity
String qualifiedName = classElement.getQualifiedName().toString();
List<Element> list = bindViews.get(qualifiedName);
if (list == null) {
list = new ArrayList<>();
bindViews.put(qualifiedName, list);
}
list.add(element);
}
return bindViews;
}
private void makeFile(Map<String, List<Element>> bindViews) {
for (Map.Entry<String, List<Element>> entry : bindViews.entrySet()) {
String className = entry.getKey(); //Activity类名
List<Element> elements = entry.getValue(); //Activity 里面的注解元素
makeFile(className, elements);
}
}
private void makeFile(String tag, List<Element> elements) {
try {
TypeElement typeElement = elementUtils.getTypeElement(tag);
ClassName className = ClassName.get(typeElement);
String clazzName = className.simpleName();
String packageName = className.packageName();
String clazzFullName = className.reflectionName();
MethodSpec.Builder bindMethodBuilder = MethodSpec.methodBuilder("bind")
.addModifiers(Modifier.PUBLIC)
.returns(void.class)
.addParameter(Object.class, "target")
.addAnnotation(Override.class)
.addCode(" " + clazzFullName + " activity = (" + clazzFullName + ")target; \n");
for (Element element : elements) {
String varName = element.getSimpleName().toString();
BindView annotation = element.getAnnotation(BindView.class);
int viewId = annotation.value();
bindMethodBuilder.addCode(" activity." + varName + " = activity.findViewById(" + viewId + ");\n");
}
TypeSpec activityClass = TypeSpec.classBuilder(clazzName + "$$ViewBinder")
.addSuperinterface(ViewBinder.class)
.addModifiers(Modifier.PUBLIC)
.addMethod(bindMethodBuilder.build())
.build();
JavaFile javaFile = JavaFile.builder(packageName, activityClass).build();
javaFile.writeTo(filer);
} catch (Exception e) {
e.printStackTrace();
}
}