手写 ButterKnife BindView

先建三个module，分别为Butterknife ButterKnife-Annotions ButterKnife-compiler,其中butterknife为Android Module其余的都是Java Module
。

ButterKnife-Annotions：提供注解。
ButterKnife-compiler: 依赖ButterKnife-Annotions,生成代码的module。
Butterknife：应用直接使用的库。

Butterknife-Annotions添加注解

@Retention(CLASS)
@Target(FIELD)
public @interface BindView {
    int value();
}

ButterKnife-compiler添加依赖

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    implementation 'com.google.auto.service:auto-service:1.0-rc3'
    implementation 'com.squareup:javapoet:1.9.0'
    implementation project(':ButterKnife-Annotions')
}

写一个生成代码的类ButterKnifeProcessor继承AbstractProcessor

public class ButterKnifeProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
}

我们的步骤是:

  1. 添加注解@AutoService(Processor.class)
  2. 确定好我们需要生成代码的JAVA版本
  3. 确定生成代码
  4. 生成代码
import com.zzw.butterknife_annotions.BindView;

import java.lang.annotation.Annotation;
import java.util.LinkedHashSet;
import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;

//1. 添加注解 @AutoService(Processor.class)
@AutoService(Processor.class)
public class ButterKnifeProcessor extends AbstractProcessor {

    //2. 指定处理的版本 >1.7

    @Override
    public SourceVersion getSupportedSourceVersion() {
        //最高版本
        return SourceVersion.latestSupported();
    }

    //3. 指定处理的注解
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new LinkedHashSet<>();
        for (Class<? extends Annotation> annotation : getSupportedAnnotations()) {
            types.add(annotation.getCanonicalName());
        }
        return types;
    }

    //4. 在这执行生成类
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }


    private Set<Class<? extends Annotation>> getSupportedAnnotations() {
        Set<Class<? extends Annotation>> annotations = new LinkedHashSet<>();
        annotations.add(BindView.class);
        return annotations;
    }
}

我们确定一下这个环境编译是否是正确的
Butterknife里面添加ButterKnife-compiler依赖

api project(':ButterKnife-compiler')

app添加Butterknife依赖和compiler生成代码依赖

implementation project(':Butterknife')
annotationProcessor project(':ButterKnife-compiler')

在app的MainActivity添加注解


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

这个时候运行程序报错了提示

C:\Users\Swartz\Desktop\githubdemo\AptDemo\ButterKnife-compiler\src\main\java\com\zzw\butterknife_compiler\ButterKnifeProcessor.java
Error:(21, 20) 错误: 编码GBK的不可映射字符
Error:(25, 12) 错误: 编码GBK的不可映射字符
Error:(25, 17) 错误: 编码GBK的不可映射字符
Error:(29, 20) 错误: 编码GBK的不可映射字符
Error:(39, 20) 错误: 编码GBK的不可映射字符
Error:Execution failed for task ':Butterknife:javaPreCompileDebug'.
> Annotation processors must be explicitly declared now.  The following dependencies on the compile classpath are found to contain annotation processor.  Please add them to the annotationProcessor configuration.
    - ButterKnife-compiler.jar (project :ButterKnife-compiler)
  Alternatively, set android.defaultConfig.javaCompileOptions.annotationProcessorOptions.includeCompileClasspath = true to continue with previous behavior.  Note that this option is deprecated and will be removed in the future.
  See https://developer.android.com/r/tools/annotation-processor-error-message.html for more details.

这个是因为我们在ButterKnifeProcessor这个类使用了中文，所以我们在ButterKnife-compiler中指定编码集

tasks.withType(JavaCompile){
    options.encoding='UTF-8'
}

这个时候我们在ButterKnifeProcessor里面process函数添加打印

System.out.print("11111");

然后随便修改一下MainActivity的代码，重新编译在Gradle Console里面就可以看到打印了。这里需要修改MainActivity代码是因为我们是编译时生成，as为了节省时间是重新编译修改了的类，如果不修改的话可以能会不编译。

环境ok了，这下我们就需要重点放在生成代码这块了，这块又分为以下步骤:

  1. 因为这getSupportedAnnotationTypes添加的所有注解都会走到process函数，所以我们要将注解按照类来分离。比如AActivity对应那些有那些注解，BActivity里面有那些注解。
  2. 生成代码

package com.zzw.butterknife_compiler;

import com.google.auto.service.AutoService;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;
import com.zzw.butterknife_annotions.BindView;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
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.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.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;


//1. 添加注解 @AutoService(Processor.class)
@AutoService(Processor.class)
public class ButterKnifeProcessor extends AbstractProcessor {
    //决定生成的文件在哪个文件夹
    private Filer mFiler;
    //决定生成的生成包名用
    private Elements mElementUtils;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        mFiler = processingEnv.getFiler();
        mElementUtils = processingEnv.getElementUtils();
    }


    //2. 指定处理的版本 >1.7

    @Override
    public SourceVersion getSupportedSourceVersion() {
        //最高版本
        return SourceVersion.latestSupported();
    }

    //3. 指定处理的注解
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new LinkedHashSet<>();
        for (Class<? extends Annotation> annotation : getSupportedAnnotations()) {
            types.add(annotation.getCanonicalName());
        }
        return types;
    }

    //4. 在这执行生成类
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        //4.1 注解分类
        //拿到所有的注解标记的元素
        Set<? extends Element> elements=  roundEnv.getElementsAnnotatedWith(BindView.class);
        //分类集合
        Map<Element , List<Element>>  elementMap= new LinkedHashMap<>();
        //进行分类
        for (Element element : elements) {
            //拿到属于哪个类
            Element  enclosingElement = element.getEnclosingElement();
            List<Element>  viewBindElements =  elementMap.get(enclosingElement);
            if(viewBindElements ==null){
                viewBindElements = new ArrayList<>();
                elementMap.put(enclosingElement,viewBindElements);
            }
            viewBindElements.add(element);
        }
        //4.2 生成代码
        for (Map.Entry<Element,List<Element>> entry : elementMap.entrySet()) {
            Element enclosingElement =   entry.getKey();
            List<Element> viewBindElements =  entry.getValue();

            //类信息
            //  public final class xxxActivity_ViewBinding implements Unbinder
            final String activityNameStr = enclosingElement.getSimpleName().toString();
            ClassName activityClassName =   ClassName.bestGuess(activityNameStr);
            TypeSpec.Builder classBuilder = TypeSpec.classBuilder( activityNameStr +"_ViewBinding")
                    .addModifiers(Modifier.FINAL,Modifier.PUBLIC)
                    //添加实现
                    .addSuperinterface(ClassName.get("com.zzw.butterknife","Unbinder"))
                    //添加属性
                    .addField(activityClassName,"target",Modifier.PRIVATE);

            //方法信息
            //实现unbinder方法
            MethodSpec.Builder unbindMethodBuilder  = MethodSpec.methodBuilder("unbind")
                    .addAnnotation(Override.class)
                    .addModifiers(Modifier.PUBLIC);

            unbindMethodBuilder.addStatement("$T target = this.target",activityClassName);
            unbindMethodBuilder.addStatement("if (target == null) throw new IllegalStateException(\"Bindings already cleared.\");");

            //构造函数
            MethodSpec.Builder constructorMethodBuilder = MethodSpec.constructorBuilder()
                    .addModifiers(Modifier.PUBLIC)
                    .addParameter(activityClassName,"target");
            constructorMethodBuilder.addStatement("this.target = target");


            //findViewById
            for (Element viewBindElement : viewBindElements) {
                //target.textView1 = Utils.findViewById(target,R.id.text_view1);
                String filedName =  viewBindElement.getSimpleName().toString();
                ClassName utilsClassName = ClassName.get("com.zzw.butterknife","Utils");
                int resId = viewBindElement.getAnnotation(BindView.class).value();
                constructorMethodBuilder.addStatement("target.$L = $T.findViewById(target,$L)",filedName,utilsClassName,resId);

                unbindMethodBuilder.addStatement("target.$L = null" ,filedName);
            }


            //添加构造函数到类里面
            classBuilder.addMethod(constructorMethodBuilder.build());
            //添加unbinder方法到类里面
            classBuilder.addMethod(unbindMethodBuilder.build());

            try {
                //拿到包名
                String packageName =mElementUtils.getPackageOf(enclosingElement).getQualifiedName().toString();
                JavaFile.builder(packageName,classBuilder.build())
                        .addFileComment("butterknife 自动生成")//注释
                        .build()
                        .writeTo(mFiler);
            } catch (IOException e) {
                e.printStackTrace();
                System.out.print("异常");
            }
        }
        return false;
    }


    private Set<Class<? extends Annotation>> getSupportedAnnotations() {
        Set<Class<? extends Annotation>> annotations = new LinkedHashSet<>();
        annotations.add(BindView.class);
        return annotations;
    }
}

生成的代码如下：

// butterknife 自动生成
package com.zzw.app;

import com.zzw.butterknife.Unbinder;
import com.zzw.butterknife.Utils;
import java.lang.Override;

public final class MainActivity_ViewBinding implements Unbinder {
  private MainActivity target;

  public MainActivity_ViewBinding(MainActivity target) {
    this.target = target;
    target.textView1 = Utils.findViewById(target,2131165301);
    target.textView2 = Utils.findViewById(target,2131165302);
  }

  @Override
  public void unbind() {
    MainActivity target = this.target;
    if (target == null) throw new IllegalStateException("Bindings already cleared.");;
    target.textView1 = null;
    target.textView2 = null;
  }
}

我们可以自动生成代码了，这个时候我们可以通过这个来实现findViewById
我们在Butterknife module里面建Butterknife这个类

package com.zzw.butterknife;

import android.app.Activity;

import java.lang.reflect.Constructor;

/**
 * Des:
 * Created by zzw on 2018/1/29.
 */

public class Butterknife {

    public static Unbinder bind(Activity activity){
        //xxxActivity_ViewBinding viewBinding = new xxxActivity_ViewBinding(activity);
        try{
          Class<? extends Unbinder> bindClass= (Class<? extends Unbinder>) Class.forName(activity.getClass().getName()+"_ViewBinding");
          Constructor<? extends Unbinder> bindConstructor=  bindClass.getDeclaredConstructor(activity.getClass());
            return bindConstructor.newInstance(activity);
        }catch (Exception e){
            e.printStackTrace();
            return Unbinder.EMPTY;
        }
    }
}

MainActivity

package com.zzw.app;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.TextView;

import com.zzw.aptdemo.R;
import com.zzw.butterknife.Butterknife;
import com.zzw.butterknife.Unbinder;
import com.zzw.butterknife_annotions.BindView;

public class MainActivity extends AppCompatActivity {


    @BindView(R.id.text_view1)
    TextView textView1;
    @BindView(R.id.text_view2)
    TextView textView2;

    private Unbinder mUnbinder;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mUnbinder = Butterknife.bind(this);

        textView1.setText("你好 大哥");
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        mUnbinder.unbind();
    }
}

该文中Butterknife module用到的类:

import android.support.annotation.UiThread;

/**
 * Des:
 * Created by zzw on 2018/1/29.
 */

public interface Unbinder {
    @UiThread
    void unbind();

    Unbinder EMPTY = new Unbinder() {
        @Override public void unbind() { }
    };
}


package com.zzw.butterknife;

import android.app.Activity;
import android.view.View;

/**
 * Des:
 * Created by zzw on 2018/1/29.
 */

public class Utils {
    public static <T extends View>T findViewById(Activity activity,int viewId){
        return activity.findViewById(viewId);
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,651评论 6赞 501
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,468评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,931评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,218评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,234评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,198评论 1赞 299
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,084评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,926评论 0赞 274
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,341评论 1赞 311
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,563评论 2赞 333
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,731评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,430评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,036评论 3赞 326
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,676评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,829评论 1赞 269
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,743评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,629评论 2赞 354

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,080评论 25赞 707
  • 注解学习笔记
    什么是注解注解分类注解作用分类 元注解 Java内置注解 自定义注解自定义注解实现及使用编译时注解注解处理器注解处...
    Mr槑阅读 1,075评论 0赞 3
  • ButterKnife使用和原理
    俗话说的好“不想偷懒的程序员，不是好程序员”，我们在日常开发android的过程中，在前端activity或者fr...
    蛋西阅读 4,966评论 0赞 14
  • ButterKnife源码分析
    博文出处：ButterKnife源码分析，欢迎大家关注我的博客，谢谢！ 0x01 前言 在程序开发的过程中，总会有...
    俞其荣阅读 2,025评论 1赞 18
  • Android图片上传（头像裁切+原图原样）
    先看一下效果图： （一）头像裁切、上传服务器（效果图） 一般都是有圆形显示头像的，这里我自定义了一个ImageVi...
    kingZXY2009阅读 5,481评论 5赞 15