简易ButterKnife

最新推荐文章于 2021-03-10 23:45:30 发布
最新推荐文章于 2021-03-10 23:45:30 发布
阅读量261 收藏
点赞数
CC 4.0 BY-SA版权
分类专栏： # Android学习记录
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Duckdan/article/details/104903795
本文介绍如何使用APT(Annotation Processing Tool)自动生成代码，通过简易ButterKnife框架示例，展示了如何在Android开发中实现视图绑定和事件监听器的自动化生成，提升开发效率。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

一、APT的使用

用于APP在编译时期生成代码，要在AndroidStudio项目中创建Java Library工程。
1.1 build.gradle源码
apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //另外一个Java Library,用来生成Annotation
    implementation project(path: ':annotations')
    //注册一个APT功能
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'
    //有这个才能够在编译时期调用annotationProcessor
    compileOnly 'com.google.auto.service:auto-service:1.0-rc4'
    //javaPoet：使用oop思想生成代码
    implementation 'com.squareup:javapoet:1.12.1'

}


// 防止java控制台输出中文乱码
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}

sourceCompatibility = "7"
targetCompatibility = "7"
1.2 AbstractProcessor派生类源码
package com.piaopiao.annonation_compiler;

import com.google.auto.service.AutoService;
import com.piaopiao.annotations.BindView;
import com.piaopiao.annotations.OnClick;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.ParameterizedTypeName;
import com.squareup.javapoet.TypeSpec;

import java.io.IOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashMap;
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.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier;
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)
//允许/支持的注解类型，让注解处理器处理
@SupportedAnnotationTypes({Constants.BIND_VIEW, Constants.ON_CLICK})
//指定JDK编译版本
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class AnnotationsCompiler extends AbstractProcessor {

    //1.日志打印工具类
    private Messager messager;

    //3.需要一个用来生成文件的对象
    Filer filer;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        filer = processingEnv.getFiler();
        messager = processingEnv.getMessager();
    }


    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnvironment) {
        javaPoet(roundEnvironment);
//        writerJava(roundEnvironment);
        return true;

    }

    /**
     * 手写java类
     * @param roundEnv
     */
    private void writerJava(RoundEnvironment roundEnv) {
        //类    TypeElement
        //方法  ExecutableElement
        //属性  VariableElement
        //需要开始进行分类
        Map<String, List<Element>> mapElement = new HashMap<>();

        //字段
        Set<? extends Element> elementsAnnotatedWithField = roundEnv.getElementsAnnotatedWith(BindView.class);
        for (Element element : elementsAnnotatedWithField) {
            VariableElement variableElement = (VariableElement) element;
            //得到activity名字(全类名)
            String activityName = variableElement.getEnclosingElement().getSimpleName().toString();
            List<Element> variableElements = mapElement.get(activityName);
            if (variableElements == null) {
                variableElements = new ArrayList();
                mapElement.put(activityName, variableElements);
            }
            variableElements.add(variableElement);
        }

        //方法
        Set<? extends Element> elementsAnnotatedWithMethod = roundEnv.getElementsAnnotatedWith(OnClick.class);
        for (Element element : elementsAnnotatedWithMethod) {
            ExecutableElement executableElement = (ExecutableElement) element;
            //得到activity名字(全类名)
            String activityName = executableElement.getEnclosingElement().getSimpleName().toString();
            //找到方法元素
            List<Element> executableElements = mapElement.get(activityName);
            if (executableElements == null) {
                executableElements = new ArrayList();
                mapElement.put(activityName, executableElements);
            }
            executableElements.add(executableElement);
        }

        if (mapElement.size() > 0) {
            Writer writer = null;
            Iterator<String> iterator = mapElement.keySet().iterator();
            while (iterator.hasNext()) {
                //开始生成对应的文件
                String activityName = iterator.next();
                List<Element> elements = mapElement.get(activityName);
                //得到包名
                TypeElement enclosingElment = (TypeElement) elements.get(0).getEnclosingElement();
                String packageName = processingEnv.getElementUtils().getPackageOf(enclosingElment).toString();
                //写入文件
                try {
                    JavaFileObject sourceFile = filer.createSourceFile(packageName + "." + activityName + "_ViewBinding");
                    writer = sourceFile.openWriter();
                    //package com.example.butterknife_framework_demo;
                    writer.write("package " + packageName + ";\n");
                    //import com.example.butterknife_framework_demo.IBinder;
                    writer.write("import " + packageName + ".IBinder;\n");
                    //public class MainActivity_ViewBinding implements IBinder<com.example.butterknife_framework_demo.MainActivity> {
                    writer.write("public class " + activityName + "_ViewBinding implements IBinder<" + packageName + "." + activityName + ">{\n");
                    //@Override
                    writer.write("@Override\n");
                    //public void bind(com.example.butterknife_framework_demo.MainActivity target) {
                    writer.write("public void bind(final " + packageName + "." + activityName + " target){\n");
                    //target.textView = (android.widget.TextView) target.findViewById(2131165359);
                    for (Element element : elements) {
                        if (element instanceof VariableElement) {
                            //得到名字
                            String variableName = element.getSimpleName().toString();
                            //得到ID
                            int id = element.getAnnotation(BindView.class).value();
                            //得到类型
                            TypeMirror typeMirror = element.asType();
                            //target.textView = (android.widget.TextView) target.findViewById(2131165359);
                            writer.write("target." + variableName + "=(" + typeMirror + ")target.findViewById(" + id + ");\n");
                        } else if (element instanceof ExecutableElement) {//方法
                            //方法名
                            String executableName = element.getSimpleName().toString();
                            int[] viewIds = element.getAnnotation(OnClick.class).value();
                            for (int id : viewIds) {
                                writer.write("target.findViewById(" + id + ").setOnClickListener( new android.view.View.OnClickListener(){\n");
                                //        void onClick(View v);
                                writer.write("public void onClick(android.view.View view){\n");
                                writer.write("target." + executableName + "(view);");
                                writer.write("\n}\n});");
                            }
                        }

                    }
                    writer.write("\n}\n}");

                } catch (Exception e) {
                    e.printStackTrace();
                } finally {
                    if (writer != null) {
                        try {
                            writer.close();
                        } catch (IOException e) {
                            e.printStackTrace();
                        }
                    }
                }

            }
        }
    }

    /**
     * 利用javaPoet生成java类
     * @param roundEnv
     */
    private void javaPoet(RoundEnvironment roundEnv) {
        //类    TypeElement
        //方法  ExecutableElement
        //属性  VariableElement
        //需要开始进行分类
        Map<String, List<Element>> mapElement = new HashMap<>();

        //字段
        Set<? extends Element> elementsAnnotatedWithField = roundEnv.getElementsAnnotatedWith(BindView.class);
        for (Element element : elementsAnnotatedWithField) {
            VariableElement variableElement = (VariableElement) element;
            //得到activity名字(全类名)
            String activityName = variableElement.getEnclosingElement().getSimpleName().toString();
            List<Element> variableElements = mapElement.get(activityName);
            if (variableElements == null) {
                variableElements = new ArrayList();
                mapElement.put(activityName, variableElements);
            }
            variableElements.add(variableElement);
        }

        //方法
        Set<? extends Element> elementsAnnotatedWithMethod = roundEnv.getElementsAnnotatedWith(OnClick.class);
        for (Element element : elementsAnnotatedWithMethod) {
            ExecutableElement executableElement = (ExecutableElement) element;
            //得到activity名字(类名)
            String activityName = executableElement.getEnclosingElement().getSimpleName().toString();
            //找到方法元素
            List<Element> executableElements = mapElement.get(activityName);
            if (executableElements == null) {
                executableElements = new ArrayList();
                mapElement.put(activityName, executableElements);
            }
            executableElements.add(executableElement);
        }

        //writerClass(mapElement);
        if (mapElement.size() > 0) {
            Iterator<String> iterator = mapElement.keySet().iterator();
            while (iterator.hasNext()) {
                //开始生成对应的文件
                String activityName = iterator.next();
                List<Element> elements = mapElement.get(activityName);
                //得到包名
                TypeElement enclosingElment = (TypeElement) elements.get(0).getEnclosingElement();
                String packageName = processingEnv.getElementUtils().getPackageOf(enclosingElment).toString();


                MethodSpec.Builder methodSpecBuilder = MethodSpec.methodBuilder("bind")
                        .addModifiers(Modifier.PUBLIC)
                        .addParameter(ClassName.get(enclosingElment), "target", Modifier.FINAL)
                        .addAnnotation(Override.class)
                        .returns(void.class);
                for (Element element : elements) {
                    if (element instanceof VariableElement) {
                        //得到名字
                        String variableName = element.getSimpleName().toString();
                        //得到ID
                        int id = element.getAnnotation(BindView.class).value();
                        //得到类型
                        TypeMirror typeMirror = element.asType();

                        methodSpecBuilder.addStatement("target.$N=($T)target.findViewById($L)", variableName, typeMirror, id);
                    } else if (element instanceof ExecutableElement) {//方法
                        //方法名
                        String executableName = element.getSimpleName().toString();
                        int[] viewIds = element.getAnnotation(OnClick.class).value();
                        for (int id : viewIds) {
                            // 匿名内部类实现的接口
                            ClassName viewClick = ClassName.get("android.view.View", "OnClickListener");

                            // 重写的方法
                            MethodSpec clickMethod = MethodSpec.methodBuilder("onClick")
                                    .addModifiers(Modifier.PUBLIC)
                                    .addAnnotation(Override.class)
                                    .addParameter(ClassName.get("android.view", "View"), "view")
                                    .addStatement("target.$N(view)", executableName)
                                    .build();
                            // 创建匿名内部类
                            TypeSpec typeClick = TypeSpec.anonymousClassBuilder("")
                                    .addSuperinterface(viewClick)
                                    .addMethod(clickMethod)
                                    .build();

                            methodSpecBuilder.addStatement("target.findViewById($L).setOnClickListener($L)", id, typeClick);

                        }

                    }
                }
                //创建方法
                MethodSpec methodSpec = methodSpecBuilder.build();
				//获取接口
                ClassName iBinder = ClassName.get(packageName, "IBinder");
				//获取对应的Activity
                ClassName activityClassName = ClassName.get(packageName, activityName);

                TypeSpec typeSpec = TypeSpec
                        .classBuilder(activityName + "_ViewBinding")
                        //添加泛型
                        .addSuperinterface(ParameterizedTypeName.get(iBinder, activityClassName))
                        .addModifiers(Modifier.PUBLIC)
                        .addMethod(methodSpec).build();

                JavaFile javaFile = JavaFile.builder(packageName, typeSpec).build();

                try {
                	//生成类
                    javaFile.writeTo(filer);
                } catch (Exception e) {
                    e.printStackTrace();
                    messager.printMessage(Diagnostic.Kind.NOTE, "生成文件出现异常：：" + e.getMessage());
                }
            }
        }
    }
}

二、简易ButterKnife的用法

package com.piaopiao.ymhbutterknife;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.view.View;
import android.widget.TextView;
import android.widget.Toast;

import com.piaopiao.annotations.BindView;
import com.piaopiao.annotations.OnClick;

public class MainActivity extends AppCompatActivity {


    @BindView(R.id.tv)
    TextView textView;

    @BindView(R.id.tv1)
    TextView textView1;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        YmhButterKnife.binder(this);
        textView.setText("第一个点击事件");
        textView1.setText("第二个点击事件");
    }

    @OnClick({R.id.tv, R.id.tv1})
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.tv:
                Toast.makeText(this, "第一个按钮", Toast.LENGTH_SHORT).show();
                break;
            case R.id.tv1:
                Toast.makeText(this, "第二个按钮", Toast.LENGTH_SHORT).show();
                break;
        }

    }

}

三、编译效果

package com.piaopiao.ymhbutterknife;

import android.view.View;
import android.view.View.OnClickListener;
import android.widget.TextView;
import java.lang.Override;

public class MainActivity_ViewBinding implements IBinder<MainActivity> {
  @Override
  public void bind(final MainActivity target) {
    target.textView=(TextView)target.findViewById(2131165325);
    target.textView1=(TextView)target.findViewById(2131165326);
    target.findViewById(2131165325).setOnClickListener(new OnClickListener() {
      @Override
      public void onClick(View view) {
        target.onClick(view);
      }
    });
    target.findViewById(2131165326).setOnClickListener(new OnClickListener() {
      @Override
      public void onClick(View view) {
        target.onClick(view);
      }
    });
  }
}

四、APT的调试

4.1 调试步骤
点击Debug按钮进入调试模式，再进行rebuild就可以进行调试了
4.2 注意事项
1. 如果按照上述步骤仍然无法进入调试模式，那么将所有模块的build目录都删除
2. APT生成对应模块代码的时候应该把该模块的build目录删掉

推荐文章

JavaPoet的使用指南
JavaPoet使用详解
JavaPoet的基本使用

源代码

JAVAB源码实现-SimpleButterKnife_JavaPoet:仿照ButterKnife源码，实现一个简易的ButterKnife
05-19
在Android开发中，ButterKnife是一个非常流行的视图注入库，极大地简化了UI元素与Java代码之间的绑定。本文将深入探讨如何仿照ButterKnife的源码，利用JavaPoet库来实现一个简单的视图注入框架——SimpleButterKnife...
java简易版开心农场源码-MasteringAndroidDataBinding-master:MasteringAndroidDataBi
06-05
java简易版开心农场源码 精通 Android Data Binding QQ 交流群：324112728 ，或者 官方虽然已经给出了教程 - ，但是实践之后发现槽点实在太多，于是就有了这个教程，针对每个知识点给出更详实的例子同时也总结了遇到...
浅析ButterKnife的实现 (四) —— OnClick
Rukey7的博客
08-15 6611
讲完了View注解，下面来介绍怎么给View设置点击监听。 @OnClick 定义个用来设置点击监听的注解：
Butterknife @OnClick绑定多控件id
热门推荐
燃烧那滴泪的专栏
07-12 2万+
package com.example.hh; import android.annotation.SuppressLint; import android.app.Activity; import android.graphics.drawable.Drawable; import android.os.Bundle; import android.widget.TextView; impor
Butterknife.OnClick中防止按键过快的点击的的一种解决方案。
小北的博客
06-08 7608
按键的防抖就是判断一下两次点击的时间差，但是如果在Butterknife.OnClick中写，每次都要写一堆代码 其实我们希望的最理想的解决方案是：@OnClick({R.id.record, R.id.combine}) public void onClick(View view) { if (AntiShake.check(view.getId())) { //判断是否多次点击
butterknife @OnClick的简单使用流程
nn690960430的博客
06-11 4894
@SuppressLint("ResourceType") @OnClick({R.id.image_control, R.id.image_say, R.id.image_playback, R.id.ptz_top_btn,R.id.ptz_bottom_btn,R.id.ptz_left_btn,R.id.ptz_right_btn}) public void onClick(View v) { switch (v.getId()){ ...
ButterKnife 点击事件没反应的解决方案
清风哥哥的专栏
10-13 3029
Butterknife8.0在使用的时候，有个小小的问题，不知道是设计如此还是确实存在这样的一个bug。请看我的代码：@OnClick({R.id.tg_isCloseToConn, R.id.btn_close_conn_confirm, R.id.tv_net_name, R.id.close_conn_l_net_content}) public void onClick(View v
仿照ButterKnife源码，实现简易版JavaPoet框架
在实现简易ButterKnife的过程中，我们将利用JavaPoet来动态创建Java类，这些类将作为注入和绑定视图的桥梁。 接下来，我们来看一下在简易ButterKnife中需要实现的核心功能。首先是对视图的绑定，这通常涉及到在...
Butterknife在Android应用中的简易使用示例
标题“ButterknifeTestDemo”和描述“本代码是一份简单使用Butterknife的样例代码”直接指向了一个与Android开发紧密相关的知识点，即Butterknife库的使用。标签“android butterknife”进一步明确了这一点。为了...
利用Apt与JavaPoet快速实现ButterKnife代码
### 知识点：简易实现ButterKnife代码 #### 标题解析 简易实现ButterKnife代码，指的是使用一些Java编程技术来简化Android开发中对视图(View)的引用。ButterKnife是一个专注于Android系统上的注解处理器，它能通过...
Butterknife bindview @OnClick绑定多控件id
shenggaofei的博客
10-08 1万+
大家好，Android开发的兄弟们都知道，每次初始化控件，设置相应的事件，写的那点过程多而且恶心。我们先一块回顾下不堪的曾经~那些年，我们是这样初始化控件：     每次的习惯上来写一个initView()方法tvContent = (TextView) findViewById(R.id.btn_content);遇到项目大的时候，这里面的东西，也曾占据半壁江山。苦不堪言，当然也曾封装过方
ButterKnife8.4.0 onclick点击事件没反应
冬瓜去哪儿的博客
03-06 497
首先看看是否只添加了 implementation ‘com.jakewharton:butterknife:8.4.0’， 而没有添加 annotationProcessor ‘com.jakewharton:butterknife-compiler:8.8.1’ 如果项目里moudle app 依赖着lirbrary compile ‘com.jakewharton:butterknife:8...
ButterKnife源码之--为什么我写的ButterKnife中OnClick注解有问题
zhiChao的博客
12-05 729
事情的经过是这样的： 我们知道ButterKnife的初始化时这样的ButterKnife.bind(this);，那我也希望自己封装的框架也是这个样子的，所以我打算这样Bind_MusicCutActivity.bindView(this);看上去没什么不一样，并且对findViewById的支持也没什么问题，问题出在哪了呢？出在我上一篇写OnClick的时候。 //我对findOnGrante...
ButterKnife的使用详解
LayneYao的博客
03-15 846
今天来讲解一下注解框架ButterKnife，此框架由Android之神Jake Wharton开源的。 GitHub的链接地址：https://github.com/JakeWharton/butterknife ButterKnife框架的优点： 强大的View绑定和Click事件处理功能，简化代码，提升开发效率 方便的处理Adaper里的ViewHolder绑定问题 运行时不会影响a...
Android仿butterknife注解实现bindview和onCLick（基于运行时注解）
henkun的博客
07-27 1247
白日登山望烽火，黄昏饮马傍交河。 行人刁斗风沙暗，公主琵琶幽怨多。 野云万里无城郭，雨雪纷纷连大漠。 胡雁哀鸣夜夜飞，胡儿眼泪双双落。 闻道玉门犹被遮，应将性命逐轻车。 年年战骨埋荒外，空见蒲桃入汉家。唐·李颀《古从军行》
ButterKnife的学习和使用
shan286的专栏
04-05 370
最近去面试有不少公司都有问到ButterKnife这个框架，作为一个特老实的孩子，我也是没用过就老老实实地承认没用过。结果前两天在网上看了一下ButterKnife的用法，两个小时不到就搞懂了，所以说还是要多学习、多接触、多使用。趁热打铁，于是自己写了一个简单的demo吧，毕竟光看不练还是会有问题的，有些坑早踩晚踩都是踩。
ButterKnife的使用和原理
weixin_43750332的博客
03-10 1万+
ButterKnife的使用和原理 参考文档： ButterKnife的使用：https://segmentfault.com/a/1190000016460847 ButterKnife的原理：https://juejin.cn/post/6844904181158019079 一、前言 ButterKnife是一个专注于Android系统的View注入框架,以前总是要写很多findViewById来找到View对象，有了ButterKnife可以很轻松的省去这些步骤。 使用ButterKnife对性能基
ButterKnife学习之—ButterKnife是怎么用的
dujie_2019的博客
03-05 354
ButterKnife学习之—ButterKnife是什么样的前言为何要用ButterKnifeButterKnife介绍简单示例ButterKnife基本原理开始使用如何导入ButterKnife如何使用ButterKnife1、绑定2、各种注解方式多Layout的Bind代码混淆总结 前言 要成为一名优秀的Android开发者，除了丰富的项目经验外，还需要有一份完备的知识体系，在这里我们一起成...
为什么ButterKnife不支持带参的OnClick -- 注解支持的类型
zhiChao的博客
12-04 517
看ButterKnife源码 public @interface OnClick { /** View IDs to which the method will be bound. */ @IdRes int[] value() default { View.NO_ID }; } 在实际的使用中呢，也很方便，直接在方法上加上注解就可以，但是我们发现它的注解方法只支持不带参的方法，或者参数...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值