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

推荐阅读更多精彩内容

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