butterknife源码分析手写简单的butterknife

butterknife工具在项目中比较常用
分三个模块模块之间的UML关系图

Paste_Image.png

其中
butterknife-annotations
butterknife-compiler
为Java工程
butterknife
为android工程
有很多工能都没用到
Paste_Image.png

仿butterknife自定义BindView

一、创建三个library

1.compiler
 @AutoService(Processor.class)
public class ButterKnifeProcessor extends AbstractProcessor {

 /**
 * 用来指定支持的 AnnotationTypes
 *
 * @return
 */
@Override
public Set<String> getSupportedAnnotationTypes() {
    Set<String> types = new LinkedHashSet<>();
    for (Class<? extends Annotation> annotation : getSupportedAnnotations()) {
        types.add(annotation.getCanonicalName());
    }
    return types;
}

/**
 * 参考了 ButterKnife 的写法
 *
 * @return
 */
private Set<Class<? extends Annotation>> getSupportedAnnotations() {
    Set<Class<? extends Annotation>> annotations = new LinkedHashSet<>();
    annotations.add(BindView.class);
    return annotations;
}

/**
 * 用来指定支持的 SourceVersion
 *
 * @return
 */
@Override
public SourceVersion getSupportedSourceVersion() {
    return SourceVersion.latestSupported();
}

@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
    // 调试打印
    System.out.println("------------------------------------>");
    System.out.println("------------------------------------>");
    return false;
}
}

添加依赖

     compile 'com.google.auto.service:auto-service:1.0-rc3'
     compile 'com.squareup:javapoet:1.8.0'
    compile project(':annotations')
    compile files('libs/tools.jar')

如果我们在代码的任何地方有注解,都会来到 process 这个方法里面。

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
    // 调试打印
    // System.out.println("------------------------------------>");
    // System.out.println("------------------------------------>");

    Set<? extends Element> bindViewElements = roundEnvironment.getElementsAnnotatedWith(BindView.class);

    // 解析 Element
    Map<Element, List<Element>> analysisElementMap = new LinkedHashMap<>();
    for (Element bindViewElement : bindViewElements) {
        Element enclosingElement = bindViewElement.getEnclosingElement();

        List<Element> elements = analysisElementMap.get(enclosingElement);
        if (elements == null) {
            elements = new ArrayList<>();
            analysisElementMap.put(enclosingElement, elements);
        }

        elements.add(bindViewElement);
    }

    // 生成 java 类
    for (Map.Entry<Element, List<Element>> entry : analysisElementMap.entrySet()) {
        Element enclosingElement = entry.getKey();
        List<Element> elements = entry.getValue();

        String classNameStr = enclosingElement.getSimpleName().toString();

        ClassName unbinderClassName = ClassName.get("com.butterknife", "Unbinder");
        // 组装类:  xxx_ViewBinding implements Unbinder
        TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder(classNameStr + "_ViewBinding")
                .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                .addSuperinterface(unbinderClassName);

        ClassName callSuperClassName = ClassName.get("android.support.annotation", "CallSuper");
        // 组装unbind 方法
        MethodSpec.Builder unbindMethodBuilder = MethodSpec.methodBuilder("unbind")
                .addAnnotation(Override.class)
                .addAnnotation(callSuperClassName)
                .addModifiers(Modifier.PUBLIC)
                .returns(TypeName.VOID);

        ClassName uiThreadClassName = ClassName.get("android.support.annotation", "UiThread");
        ClassName parameterClassName = ClassName.bestGuess(classNameStr);
        // 组装构造函数: public xxx_ViewBinding(xxx target)
        MethodSpec.Builder constructorBuilder = MethodSpec.constructorBuilder()
                .addAnnotation(uiThreadClassName)
                .addModifiers(Modifier.PUBLIC)
                .addParameter(parameterClassName, "target");

        // 添加 target.textView1 = Utils.findViewById(target,R.id.tv1);
        for (Element bindViewElement : elements) {
            String filedName = bindViewElement.getSimpleName().toString();
            ClassName utilClassName = ClassName.get("com.butterknife", "Utils");
            int resId = bindViewElement.getAnnotation(BindView.class).value();
            constructorBuilder.addStatement("target.$L = $T.findViewById(target,$L)",
                    filedName, utilClassName, resId);
        }

        typeSpecBuilder.addMethod(constructorBuilder.build());
        typeSpecBuilder.addMethod(unbindMethodBuilder.build());

        try {
            // 写入生成 java 类
            String packageName = mElementUtils.getPackageOf(enclosingElement).getQualifiedName().toString();
            JavaFile.builder(packageName, typeSpecBuilder.build())
                    .addFileComment("ButterKnife自动生成")
                    .build().writeTo(mFiler);
        } catch (IOException e) {
            e.printStackTrace();
            System.out.println("翻车了");
        }
    }

    return false;
}
2.annotations

创建BindView

 @Target(ElementType.FIELD)
 @Retention(RetentionPolicy.CLASS)
  public @interface BindView {
  int value();
  }
3.butterknife

创建Unbinder

public interface Unbinder {
@UiThread
void unbind();

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

创建Utils

 public class Utils {
public static final <T extends View> T findViewById(Activity activity, int viewId) {
    return (T) activity.findViewById(viewId);
}
}

创建 ButterKnife

public class ButterKnife {
private ButterKnife() {
    throw new AssertionError("No instances.");
}

public final static Unbinder bind(Activity activity) {
    String viewBindingClassName = activity.getClass().getName() + "_ViewBinding";
    try {
        Class<? extends Unbinder> viewBindingClass = (Class<? extends Unbinder>) Class.forName(viewBindingClassName);
        Constructor<? extends Unbinder> viewBindingConstructor = viewBindingClass.getDeclaredConstructor(activity.getClass());
        Unbinder unbinder = viewBindingConstructor.newInstance(activity);
        return unbinder;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return Unbinder.EMPTY;
}
}

二、使用

1.module的builder

依赖

   compile project(':annotations')
   compile project(':butterknife')
   apt project(':compiler')

添加

   apply plugin: 'com.neenbedankt.android-apt'
2.工程的builder
   repositories {
    jcenter()
    mavenCentral()
  }
dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    // NOTE: Do not place your application dependencies here; they belong
    // in the individual module build.gradle files
}
3.使用
 public class MainActivity extends Activity {
@BindView(R.id.tv_text)
TextView textView1;
private Unbinder bind;
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

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

推荐阅读更多精彩内容

  • 博文出处:ButterKnife源码分析,欢迎大家关注我的博客,谢谢! 0x01 前言 在程序开发的过程中,总会有...
    俞其荣阅读 2,025评论 1 18
  • 主目录见:Android高级进阶知识(这是总目录索引) 前面我们已经讲完[编译期注解的使用例子]大家应该对这个流程...
    ZJ_Rocky阅读 1,484评论 0 8
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 简介 butterknife来自于 著名的大神JakeWharton,github 上是这么描述它的功能和原理的。...
    好大一只龍阅读 2,309评论 1 4
  • 讲述Spring AOP概念的文章,书籍已经不少了,我这里主要说下自己对Spring AOP的理解与它的用法。 A...
    Real_man阅读 650评论 0 5