# ButterKnife 源码分析

引言

在Android开发中我们会用到ButterKnife框架来简化绑定layout中的视图。这里我们主要分析ButterKnife框架中的流程。

简单使用

在Activity中使用

public class ButterKnifeDemo extends Activity {
  @Bind(R.id.toolbar)
  Toolbar toolbar;
  @Bind(R.id.listView)
  ListView listView;
  @Bind(R.id.fab)
  FloatingActionButton fab;
  @Override
  public void onCreate(Bundle savedInstance) {
      super.onCreate(savedInstance);
      setContentView(R.layout.activity_main);
      ButterKnife.bind(this); 
   }
}

在非Activity中使用

View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.bind(this, view);

这篇博客我们详细讲用法,只说原理,其他用法可以参考这篇博客

ButterKnife分析 产生疑问

 @Bind(R.id.***)
 TextView textView;//采用注解

注解:注解也称为元数据,为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便的使用这些数据。->简而言之就是换种方式定义数据。

如果想详细了解注解->传送门。

@Bind注解的定义:

 @Retention(CLASS) @Target(FIELD)
   public @interface Bind {
   /** View ID to which the field will be bound. */
   int[] value(); 
 }

@Retention(CLASS) -> 注解在类文件中可用
@Target(FIELD) -> 注解可以用于类文件中的域(包括enum实例)
int[] value(); -> 定义属性value

注解写完后,就是绑定:

 ButterKnife.bind(this);

我们来看下bind()源码:

ButterKnife_bind.jpg
ButterKnife_bind_bind.jpg

看第二张图片你会发现:

 Class<?> targetClass = target.getClass();
 ViewBinder<Object> viewBinder = findViewBinderForClass(targetClass);
 viewBinder.bind(finder, target, source);

获取到要绑定视图当前类,即Activity或者Fragment. 然后找到ViewBinder类并实例化进行绑定视图。


在这里你会产生疑问,我并没有在Activity或者Fragment中定义ViewBinder,哪里来的呢?

解决疑问

ButterKnife采用的是Java Annotation Processing 在编译时增加代码生成.class文件。与反射动态代理不同的是,一个是编译时,一个是运行时,性能当然是前者好。如果你要详细了解,请点击Java Annotation Processing

了解完Java Annotation Processing,查看ButterKnife,找到ButterKnife的核心代码就是ButterKnifeProcessor这个类。看下主要方法process.

@Override public boolean process(Set<? extends TypeElement> elements, RoundEnvironment env) {
Map<TypeElement, BindingClass> targetClassMap = findAndParseTargets(env);

for (Map.Entry<TypeElement, BindingClass> entry : targetClassMap.entrySet()) {
  TypeElement typeElement = entry.getKey();
  BindingClass bindingClass = entry.getValue();

  try {
    JavaFileObject jfo = filer.createSourceFile(bindingClass.getFqcn(), typeElement);
    Writer writer = jfo.openWriter();
    writer.write(bindingClass.brewJava());
    writer.flush();
    writer.close();
  } catch (IOException e) {
    error(typeElement, "Unable to write view binder for type %s: %s", typeElement,
        e.getMessage());
  }
}

return true;
}

解析下ButterKnife的工作流程:

  • 扫描ButterKnife的注解
  • 扫描的注解类中写入Java代码,即实现ViewBinder接口的类。
  • 编译生成.class文件
  • 然后程序运行执行.bind() method.

生成实现ViewBinder接口的类后,就和前面发出疑问的流程相符合。

总结

  • Java有两种自动生成代码,一种是运行时即反射动态代理,将接口动态代理为具体的类。另外一种就是javac编译的工具Java Annoation Processer,在编译时生成java代码。当然后者性能上更好,只是为了方便开发者,前面则是用代理动态的生成代码,可以称之为无实际的java代码。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 博文出处:ButterKnife源码分析,欢迎大家关注我的博客,谢谢! 0x01 前言 在程序开发的过程中,总会有...
    俞其荣阅读 2,064评论 1 18
  • butterknife注解框架相信很多同学都在用,但是你真的了解它的实现原理吗?那么今天让我们来看看它到底是怎么实...
    打不死的小强qz阅读 653评论 0 4
  • 主目录见:Android高级进阶知识(这是总目录索引) 前面我们已经讲完[编译期注解的使用例子]大家应该对这个流程...
    ZJ_Rocky阅读 1,496评论 0 8
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,008评论 25 708
  • 关于作者 杰克·特劳特,全球最顶尖的营销战略家,“定位”之父。在40多年的实战中不断开创与完善了定位理论。目前是特...
    海淘小公主Princess阅读 878评论 0 51