ButterKnife框架原理和使用

来源:互联网 发布:网络宣传部职责 编辑:程序博客网 时间:2024/06/04 23:13

大部分Android开发者应该都知道@JakeWharton 大神的ButterKnife注解库,使用这个库我们可以不用写很多无聊的findViewById()和setOnClickListener()等代码。 
ButterKnife项目的主页在这里:http://jakewharton.github.io/butterknife/ 简单介绍一下使用方法:

public class ExampleActivity extends Activity {      @Bind(R.id.title) EditText titleView;      @Bind(R.id.subtitle) EditText subtitleView;      @Override protected void onCreate(Bundle savedInstanceState) {       super.onCreate(savedInstanceState);       setContentView(R.layout.example_activity);       ButterKnife.bind(this);     }   }

但是这个库是如何工作的呢?可能很多人都觉得ButterKnife在bind(this)方法执行的时候通过反射获取ExampleActivity中所有的带有@Bind注解的属性并且获得注解中的R.id.xxx值,最后还是通过反射拿到Activity.findViewById()方法获取View,并赋值给ExampleActivity中的某个属性。这是一个注解库的实现方式,比较原始,一个很大的缺点就是在Activity运行时大量使用反射会影响App的运行性能,造成卡顿以及生成很多临时Java对象更容易触发GC。


ButterKnife显然没有使用这种方式,它用了Java Annotation Processing技术,就是在Java代码编译成Java字节码的时候就已经处理了@Bind、@OnClick(ButterKnife还支持很多其他的注解)这些注解。

Java Annotation Processing

Annotation processing 是javac中用于编译时扫描和解析Java注解的工具。Annotation processing是在编译阶段执行的,它的原理就是读入Java源代码,解析注解,然后生成新的Java代码。新生成的Java代码最后被编译成Java字节码,注解解析器(Annotation Processor)不能改变读入的Java 类,比如不能加入或删除Java方法 
下图是Java 编译代码的整个过程,可以帮助我们很好理解注解解析的过程: 
这里写图片描述

ButterKnife 工作流程

当你编译你的Android工程时,ButterKnife工程中ButterKnifeProcessor类的process()方法会执行以下操作: 
开始它会扫描Java代码中所有的ButterKnife注解@Bind、@OnClick、@OnItemClicked等 
当它发现一个类中含有任何一个注解时,ButterKnifeProcessor会帮你生成一个Java类,名字类似$$ViewBinder,这个新生成的类实现了ViewBinder接口。这个ViewBinder类中包含了所有对应的代码,比如@Bind注解对应findViewById(), @OnClick对应了view.setOnClickListener()等等。最后当Activity启动ButterKnife.bind(this)执行时,ButterKnife会去加载对应的ViewBinder类调用它们的bind()方法。

比如:

class ExampleActivity extends Activity {     @Bind(R.id.user) EditText username;     @Bind(R.id.pass) EditText password;    @Override public void onCreate(Bundle savedInstanceState) {         super.onCreate(savedInstanceState);         setContentView(R.layout.simple_activity);         ButterKnife.bind(this);         // TODO Use fields…     }     @OnClick(R.id.submit) void submit() {     // TODO call server…     }}
编译成功后,下面的代码生成了:public class ExampleActivity$$ViewBinder<T extends         io.bxbxbai.samples.ui.ExampleActivity> implements ViewBinder<T> {     @Override public void bind(final Finder finder, final T target, Object source) {          View view;          view = finder.findRequiredView(source, 21313618, “field ‘user’”);          target.username = finder.castView(view, 21313618, “field ‘user’”);          view = finder.findRequiredView(source, 21313618, “field ‘pass’”);          target.password = finder.castView(view, 21313618, “field ‘pass’”);          view = finder.findRequiredView(source, 21313618, “field ‘submit’ and method ‘submit’”);          view.setOnClickListener(            new butterknife.internal.DebouncingOnClickListener() {               @Override public void doClick(android.view.View p0) {      target.submit();           }        });      }     @Override public void reset(T target) {           target.username = null;           target.password = null;     }}

用一张图来说明一下:


这里写图片描述

ButterKnife.bind 执行阶段

最后,执行bind方法时,我们会调用ButterKnife.bind(this): 
ButterKnife会调用findViewBinderForClass(targetClass)加载ExampleActivity$$ViewBinder.java类。然后调用ViewBinder的bind方法,动态注入ExampleActivity类中所有的View属性。 
如果Activity中有@OnClick注解的方法,ButterKnife会在ViewBinder类中给View设置onClickListener,并且将@OnClick注解的方法传入其中。

在上面的过程中可以看到,为什么你用@Bind、@OnClick等注解标注的属性或方法必须是public或protected的,因为ButterKnife是通过ExampleActivity.this.editText来注入View的。因为如果你把View设置成private,那么框架必须通过反射来注入View,不管现在手机的CPU处理器变得多快,如果有些操作会影响性能,那么是肯定要避免的,这就是ButterKnife与其他注入框架的不同。

ButterKnife的特点

方便的处理View的绑定和点击事件 
方便的处理ListView/RecycleView中ViewHolder的绑定事件 
增强代码可读性

eg: 
public class FancyFragment extends Fragment { 
@Bind(R.id.button1) Button button1; 
@Bind(R.id.button2) Button button2;

    @Override     public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState){      View view = inflater.inflate(R.layout.fancy_fragment, container, false);      ButterKnife.bind(this, view);      // TODO Use fields...      return view;    }

}

原创粉丝点击