简陋复刻:ButterKnife - Android 框架学习

ButterKnife : 黄油刀, 一如既往的优雅。能简化Activity上UI的代码,让Activity更加优雅,省去多余的findViewById, setOnClickListener等繁琐的操作。

原理分析:

在这里,就简单全部用MainActivity作为例子,代入感强一点。项目是开源的,github上面大家可以下来慢慢看。

MainActiviy 声明注解,通过Apt技术,编译生成MainActiviy&&ViewBinder。 调用ButterKnife.bind中通过反射找到MainActiviy&&ViewBinder, 模板代码在里面实现findViewById方法。原理并不难。

Apt (Annotation Processing Tool) 技术大家并不陌生,Butterknife, EventBus,Dagger

apt编译过程

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();
        }


    }

最后看看效果,愉悦~~~~~

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