编译时注解 - ButterKnife源码分析和手写

1. ButterKnife介绍


  • ButterKnife采用的是编译时注解;
  • 用来解决findViewById 和 setOnClickListener,还包括资源的注入、IOC,运行时注解和编译时注解;
  • ButterKnife原理架构图如下:


    图片.png

app需要依赖3个ButterKnife相关的library:
1>:ButterKnife是AndroidLibrary
2>:ButterKnife_Annotation,是JavaLibrary,用于生成运行时注解;
3>:Butter_compiler,是JavaLibrary,用于生成代码;

2. ButterKnife原理


采用的是编译时注解,说白了就是用apt生成代码,比如MainActivity,会生成一个MainActivity_ViewBinding,下边举例说明:
1>:自己手动写一个MainActivity_ViewBinding,用于演示ButterKnife原理:

/**
 * Email: 2185134304@qq.com
 * Created by Novate 2018/5/5 9:56
 * Version 1.0
 * Params:
 * Description:    自己手动写MainActivity_ViewBinding ,用于演示ButterKnife原理
*/

public final class MainActivity_ViewBinding {
    private MainActivity target ;


    /**
     * 如果有多个控件,这里会生成多个findViewById
     */
    @UiThread
    public MainActivity_ViewBinding(MainActivity target){
        this.target = target ;
        target.textView1 = (TextView) target.findViewById(R.id.tv1);
        // target.textView2 = (TextView) target.findViewById(R.id.tv3);
        // target.textView3 = (TextView) target.findViewById(R.id.tv3);
    }

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

2>:在MainActivity中,创建MainActivity_VIewBinding实例对象,此时就相当于已经给TextView设置了 findViewById了,然后直接调用setText()设置数据即可:

public class MainActivity extends AppCompatActivity {


    TextView textView1 ;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        MainActivity_ViewBinding viewBinding = new MainActivity_ViewBinding(this) ;
        textView1.setText("textView1");
    }

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

3>:运行结果如下:


图片.png

ButterKnife原理如下:

1>:只要点击运行按钮,ButterKnife就会生成一个MainActivity_ViewBinding类;
2>:然后在MainActivity_ViewBinding这个类的构造方法中,会把MainActivity传递进来,而tartget.textView1就是MainActivity中的textView1,然后在构造方法中进行findViewById(),也就是说只要构造方法一调用,就说明MainActivity中的TextView已经被findViewById()找到了;
3>:最后直接调用setText()给textView1设置数据即可;

注意:

  • 上边代码是我自己手动写的,其实ButterKnife是直接用apt生成的代码;
  • 在MainActivity_ViewBinding中的构造方法中,如果MainActivity中有3个、5个、8个控件,在MainActivity_ViewBinding的构造方法中都会直接调用对应控件的findViewById(),自己只需要直接在MainActivity中去操作对应控件就ok

接下来我们自己手写一个ButterKnife

3. 手写ButterKnife


apt只是生成代码的工具,
其实只要能够生成 XXXActivity_ViewBinding类就可以了,apt其实就是 mirror(模块的知识),在thinking in java这本书籍中

但是如果没有修改代码的话,是不会生成XXXActivity_ViewBinding类的

4. ButterKnife源码用到了反射,且唯一用到反射的地方就是onCreate()方法中的ButterKnife.bind(this)

1>:ButterKnife源码用到了反射,且唯一用到反射的地方就是onCreate()方法中的ButterKnife.bind(this) ,MainActivity_ViewBinding 类可以让BindView.bind()方法给我们去写:

public class SecondActivity extends AppCompatActivity {

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


    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // ButterKnife唯一用到反射的,就是这句代码,让ButterKnife.bind()方法给我们写下边的代码
        ButterKnife.bind(this) ;
//        MainActivity_ViewBinding viewBinding = new MainActivity_ViewBinding(this) ;

    }
}

2>:ButterKnife.bind()方法如下

/**
 * Email: 2185134304@qq.com
 * Created by Novate 2018/5/5 11:55
 * Version 1.0
 * Params:
 * Description:    ButterKnife.bind()方法如下
*/

public class ButterKnife {
    public static Unbinder bind(Activity activity) {
        // xxxActivity_ViewBinding viewBinding = new xxxActivity_ViewBinding(this);
        try {
            Class<? extends Unbinder> bindClassName = (Class<? extends Unbinder>)
                    Class.forName(activity.getClass().getName() + "_ViewBinding");
            // 构造函数
            Constructor<? extends Unbinder> bindConstructor = bindClassName.getDeclaredConstructor(activity.getClass());
            Unbinder unbinder = bindConstructor.newInstance(activity);
            // 返回 Unbinder
            return unbinder;
        } catch (Exception e) {
            e.printStackTrace();
        }

        return Unbinder.EMPTY;
    }
}

5. 对ButterKnife源码的思考


TextView textView1;不能用private修饰,否则会报错

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

推荐阅读更多精彩内容