编译时注解 - 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修饰,否则会报错

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容