一篇文章讓你搞懂ButterKnife使用和原理

我們?cè)谌粘i_(kāi)發(fā)android的過(guò)程中吗蚌,在前端activity或者fragment時(shí)腿倚,無(wú)法避免的會(huì)用到findViewById這類(lèi)的代碼,然后強(qiáng)制類(lèi)型轉(zhuǎn)換出我們所需要的控件類(lèi)型蚯妇,說(shuō)實(shí)話敷燎,對(duì)于追求代碼簡(jiǎn)潔,高可讀箩言,并且想偷懶的程序員來(lái)說(shuō)硬贯,寫(xiě)這樣的重復(fù)代碼,簡(jiǎn)直就是災(zāi)難陨收。一般有倆種解決方法:1.通過(guò)自定義注解饭豹,使用時(shí)通過(guò)反射生成2使用ButterKnife

一.使用反射方式減少findViewById的編寫(xiě)

JAVA反射機(jī)制是在運(yùn)行狀態(tài)中务漩,對(duì)于任意一個(gè)類(lèi)拄衰,都能夠知道這個(gè)類(lèi)的所有屬性和方法;對(duì)于任意一個(gè)對(duì)象饵骨,都能夠調(diào)用它的任意一個(gè)方法和屬性翘悉;這種動(dòng)態(tài)獲取的信息以及動(dòng)態(tài)調(diào)用對(duì)象的方法的功能稱(chēng)為java語(yǔ)言的反射機(jī)制。
為了減少我們findViewById居触,我們都知道可以使用反射的方式進(jìn)行優(yōu)化下面我們來(lái)看下是怎么實(shí)現(xiàn)的:

1.創(chuàng)建注解類(lèi)FindView

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FindView {

    public int value();

    /* parent view id */
    public int parent() default 0;
}

2.在activity或者fragment中妖混,使用以下方式注入ID并且初始化對(duì)象

@SetOnClickListener({R.id.ll_community_switch,R.id.panel_abot,R.id.ll_me_info})
public class MeFragment implements OnClickListener{

    @FindView(R.id.panel_shell)
    private FrameLayout mShellPanel;

    @FindView(R.id.panel_coverture)
    private LinearLayout mPanelCoverture;

    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.ll_community_switch: {
                // TODO 
                break;
            }
        case R.id.ll_panel_abot: {
                // TODO 
                break;
            }
        ......

}

3.添加查找注解到視圖的方法

注解使用的其中一種方式是給類(lèi)/方法/成員變量設(shè)置注解,然后在某個(gè)地方轮洋,對(duì)設(shè)置的注解進(jìn)行解析制市,以期獲取到注解對(duì)應(yīng)的類(lèi)/方法/成員變量的一些屬性或者能力,我們這里正是利用的這個(gè)特性弊予,在activity(onCreate)或者fragment(onActivityCreated)的生命周期中祥楣,加入我們解析注解的代碼,對(duì)注解屬性進(jìn)行初始化操作

// this代表Fragment或者Activity對(duì)象
InjectFinder.injectView(this);  

4.解析注解

在injectView方法中,我們通過(guò)反射方式獲取到activity或者fragment的FindView注解荣堰,然后根據(jù)注解中的ID床未,最終還是通過(guò)findViewById的方法獲取到對(duì)應(yīng)的控件(注:SetOnClickListener注解原理類(lèi)似)

public static <O> void injectView(Class<?> clazz, O o) {
        Class<?> tempClazz = clazz != null ? clazz : (o != null ? o.getClass() : null);
        if (tempClazz != null) {
            // find view
            final SparseArray<View> tempViewArray = new SparseArray<View>();
            Field[] fields = tempClazz.getDeclaredFields();
            if (Assert.notEmpty(fields)) {
                for (Field field : fields) {
                    FindView viewInject = field.getAnnotation(FindView.class);
                    if (viewInject != null) {
                        try {
                            int viewId = viewInject.value();
                            View view = findViewById(o, viewId, viewInject.parent());

                            // Check if the object type is match
                            Class<?> targetType = field.getType();
                            Class<?> viewType = view.getClass();
                            if (!targetType.isAssignableFrom(viewType)) {
                                String err = "Type mismatch! \n" 
                                        + "  The view is   (" + viewType.getName() + ") R.id." 
                                        + view.getContext().getResources().getResourceEntryName(viewId) 
                                        + "#" + String.format("0x%08x", viewId) + "\n" 
                                        +"  Cannot set to (" + targetType.getName() + ") " 
                                        + o.getClass().getName() + "." + field.getName();
                                Log.e(TAG, err);
                                continue;
                            }
                            // 設(shè)置變量值
                            if (setField(o, field, view)) {
                                tempViewArray.append(viewId, view);
                            }
                        } catch (Throwable e) {
                            Log.e(TAG, e);
                        }
                    }
                }
            }

            // 獲取onClicklistener類(lèi)
            boolean isClickClazz = Assert.isInstanceOf(OnClickListener.class, o);

            // 獲取注解的View id
            int[] clickIds = findClickIds(tempClazz);
            if (Assert.notEmpty(clickIds)) {
                for (int id : clickIds) {
                    if (id != 0) {
                        View tempView = tempViewArray.get(id);
                        if (tempView == null) {
                            try {
                                tempView = findViewById(o, id, 0);
                            } catch (Throwable t) {
                                Log.e(TAG, t);
                            }
                        }

                        if (tempView != null) {
                            // 設(shè)置點(diǎn)擊事件
                            if (isClickClazz) {
                                tempView.setOnClickListener(ViewUtils.proxy((OnClickListener) o));
                            }
                        }
                    }
                }
            }
        }
    }

通過(guò)以上幾步,我們知道振坚,通過(guò)反射方式,雖然可以達(dá)到我們的目的斋扰,但是通過(guò)反射時(shí)渡八,先找查找類(lèi)資源,使用類(lèi)加載器創(chuàng)建传货,過(guò)程比較繁瑣屎鳍,所以效率較低
這個(gè)也就是我們?yōu)槭裁词褂肂utterKnife

二.ButterKnife

由于使用反射等方式處理注入,會(huì)存在效率方面的問(wèn)題问裕,所以我們的JakeWharton大神寫(xiě)了ButterKnife框架逮壁,來(lái)幫助我們實(shí)現(xiàn)依賴(lài)注入。

1.ButterKnife優(yōu)勢(shì)

  • 強(qiáng)大的View綁定和Click事件處理功能粮宛,簡(jiǎn)化繁瑣的代碼編寫(xiě)
  • 可以支持Adapter中的VIewHolder綁定問(wèn)題
  • 采用編譯時(shí)通過(guò)注解生成代碼窥淆,對(duì)運(yùn)行時(shí)沒(méi)有侵入,對(duì)比反射方式巍杈,效率倍高
  • 代碼清晰忧饭,可讀性強(qiáng)

2.ButterKnife使用

①在你android project級(jí)別的build.gradle配置文件中,引入android-apt插件
buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // butter knife plugins
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}
②在android module的build.gradle配置文件中筷畦,引入如下依賴(lài)
dependencies {
    /* butterknife */
    compile 'com.jakewharton:butterknife:8.2.1'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.2.1'
}
③ButterKnife使用實(shí)例
a 注入視圖
    @BindView(R.id.toolbar)
    Toolbar toolbar;

    @BindView(R.id.fab)
    FloatingActionButton fab;
b 注入事件
@OnClick(R.id.fab)
public void show(View view){
        Snackbar.make(view, "Replace with your own action",Snackbar.LENGTH_LONG)
                        .setAction("Action", null).show();
}
c 在activity或者fragment初始化的時(shí)候進(jìn)行綁定操作
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    ButterKnife.bind(this);
    setSupportActionBar(toolbar);
}

3.ButterKnife原理分析

可能很多人都覺(jué)得ButterKnife在bind(this)方法執(zhí)行的時(shí)候通過(guò)反射獲取MainActivity中所有的帶有@BindView注解的屬性并且獲得注解中的R.id.xxx值词裤,最后還是通過(guò)反射拿到Activity.findViewById()方法獲取View,并賦值給MainActivity中的某個(gè)屬性鳖宾。這是一種原始的使用反射的方式吼砂,缺點(diǎn)是反射影響App性能,造成卡頓鼎文,并且會(huì)產(chǎn)生大量的臨時(shí)對(duì)象渔肩,頻繁的引發(fā)GC。

ButterKnife顯然沒(méi)有使用這種方式漂问,它用了Java Annotation Processing技術(shù)赖瞒,就是在Java代碼編譯成Java字節(jié)碼的時(shí)候就已經(jīng)處理了@Bind、@OnClick(ButterKnife還支持很多其他的注解)這些注解了蚤假。

Java Annotation Processing是java中用于編譯時(shí)掃描和解析Java注解的工具

你可以你定義注解栏饮,并且自己定義解析器來(lái)處理它們。Annotation processing是在編譯階段執(zhí)行的磷仰,它的原理就是讀入Java源代碼袍嬉,解析注解,然后生成新的Java代碼。新生成的Java代碼最后被編譯成Java字節(jié)碼伺通,注解解析器(Annotation Processor)不能改變讀入的Java 類(lèi)箍土,比如不能加入或刪除Java方法
下圖是Java 編譯代碼的整個(gè)過(guò)程,可以幫助我們很好理解注解解析的過(guò)程:


image.png

4.ButterKnife框架工作流程(知識(shí)點(diǎn)罐监!)

當(dāng)你編譯使用了ButterKnife框架的應(yīng)用程序時(shí)吴藻,ButterKnifeProcessor類(lèi)的process()方法開(kāi)始工作,會(huì)執(zhí)行以下操作:

①.編譯期間通過(guò)反射掃描Java代碼中所有的ButterKnife注解@Bind弓柱、@OnClick沟堡、@OnItemClicked等
②.當(dāng)它發(fā)現(xiàn)一個(gè)類(lèi)中含有任何一個(gè)注解時(shí),ButterKnifeProcessor會(huì)幫你生成一個(gè)Java類(lèi)矢空,名字類(lèi)似<className>$$ViewBinder航罗,這個(gè)新生成的類(lèi)實(shí)現(xiàn)了ViewBinder<T>接口
③.這個(gè)ViewBinder類(lèi)中包含了所有對(duì)應(yīng)的代碼,比如@Bind注解對(duì)應(yīng)findViewById(), @OnClick對(duì)應(yīng)了view.setOnClickListener()等等
④.最后當(dāng)Activity啟動(dòng)ButterKnife.bind(this)執(zhí)行時(shí)屁药,ButterKnife會(huì)去加載對(duì)應(yīng)的ViewBinder類(lèi)調(diào)用它們的bind()方法
舉個(gè)栗子
APP編譯階段執(zhí)行以上①②③步
public class MainActivity extends AppCompatActivity {

    @BindView(R.id.toolbar)
    Toolbar toolbar;

    @BindView(R.id.fab)
    FloatingActionButton fab;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        setSupportActionBar(toolbar);
    }

    @OnClick(R.id.fab)
    public void show(View view){
        Snackbar.make(view, "Replace with your own action", Snackbar.LENGTH_LONG)
                        .setAction("Action", null).show();
    }
}

編譯之后粥血,會(huì)在目錄下生成兩個(gè)文件


image.png

讓我們來(lái)看下這兩個(gè)文件內(nèi)容:

MainActivity_ViewBinder.class
public final class MainActivity_ViewBinder implements ViewBinder<MainActivity> {
  @Override
  public Unbinder bind(Finder finder, MainActivity target, Object source) {
    return new MainActivity_ViewBinding<>(target, finder, source);
  }
}
MainActivity_ViewBinding.class
public class MainActivity_ViewBinding<T extends MainActivity> implements Unbinder {
  protected T target;

  private View view2131492973;

  public MainActivity_ViewBinding(final T target, Finder finder, Object source) {
    this.target = target;

    View view;
    target.toolbar = finder.findRequiredViewAsType(source, R.id.toolbar, "field 'toolbar'", Toolbar.class);
    view = finder.findRequiredView(source, R.id.fab, "field 'fab' and method 'show'");
    target.fab = finder.castView(view, R.id.fab, "field 'fab'", FloatingActionButton.class);
    view2131492973 = view;
    view.setOnClickListener(new DebouncingOnClickListener() {
      @Override
      public void doClick(View p0) {
        target.show(p0);
      }
    });
  }

  @Override
  public void unbind() {
    T target = this.target;
    if (target == null) throw new IllegalStateException("Bindings already cleared.");

    target.toolbar = null;
    target.fab = null;

    view2131492973.setOnClickListener(null);
    view2131492973 = null;

    this.target = null;
  }
}

我們可以看到MainActivity_ViewBinder類(lèi)在執(zhí)行bind方法的時(shí)候會(huì)new一個(gè)MainActivity_ViewBinding對(duì)象,并且傳入了MainActivity實(shí)例酿箭,在MainActivity_ViewBinding對(duì)象執(zhí)行構(gòu)造方法的時(shí)候复亏,需要對(duì)target.XXX,所以我們這里在MainActivity中的BindView注解的屬性七问,不能使用private修飾符蜓耻,那么使用protected修飾是否可以呢?答案是可以的械巡,因?yàn)?strong>ButterKnifeProcessor類(lèi)的process()方法會(huì)在MainActivity的同一個(gè)包下生成BinderBinding類(lèi)刹淌,所以同包下是可以調(diào)用到的。同樣的道理讥耗,onClickListener也是通過(guò)找到view有勾,然后設(shè)置viewonclicklistenertarget.XXX()方法,同樣的調(diào)用target.XXX()方法需要public或者protected修飾古程。

通過(guò)以上的流程我們知道蔼卡,ButterKnife是在編譯時(shí)通過(guò)注解方式解析生成了Binder類(lèi)和Binding,在Activity中調(diào)用了ButterKnife.bind(this)方法后挣磨,通過(guò)BinderBinding的配合雇逞,找到Activity中的類(lèi),并且類(lèi)似與代理一樣的茁裙,為Activity的注解綁定了對(duì)應(yīng)的實(shí)例或者調(diào)用方法塘砸。

ButterKnife.bind 執(zhí)行階段(Activity啟動(dòng)或者Fragment加載)也就是上面的第④步:

最后,執(zhí)行bind方法時(shí)晤锥,我們會(huì)調(diào)用ButterKnife.bind(this):

ButterKnife會(huì)調(diào)用findViewBinderForClass(targetClass)加載MainActivity$$ViewBinder.java類(lèi)
然后調(diào)用ViewBinderbind方法掉蔬,動(dòng)態(tài)注入MainActivity類(lèi)中所有的View屬性和
如果Activity中有@OnClick注解的方法廊宪,ButterKnife會(huì)在ViewBinder類(lèi)中給View設(shè)置onClickListener,并且將@OnClick注解的方法傳入其中
在上面的過(guò)程中可以看到女轿,為什么你用@Bind箭启、@OnClick等注解標(biāo)注的屬性或方法必須是publicprotected的,因?yàn)?strong>ButterKnife是通過(guò)ExampleActivity.this.editText來(lái)注入View

為什么要這樣呢蛉迹?有些注入框架比如roboguice你是可以把View設(shè)置成private的傅寡,答案就是性能。如果你把View設(shè)置成private婿禽,那么框架必須通過(guò)反射來(lái)注入View赏僧,不管現(xiàn)在手機(jī)的CPU處理器變得多快,如果有些操作會(huì)影響性能扭倾,那么是肯定要避免的,這就是ButterKnife與其他注入框架的不同

有一點(diǎn)需要注意
通過(guò)ButterKnife來(lái)注入View時(shí)挽绩,ButterKnifebind(Object, View)bind(View)兩個(gè)方法膛壹,有什么區(qū)別呢?

如果你自定義了一個(gè)View唉堪,比如public class BadgeLayout extends Fragment模聋,那么你可以可以通過(guò)ButterKnife.bind(BadgeLayout)來(lái)注入View

如果你在一個(gè)ViewHolderinflate了一個(gè)xml布局文件,得到一個(gè)View對(duì)象唠亚,并且這個(gè)ViewLinearLayoutFrameLayout等系統(tǒng)自帶View链方,那么不是不能用ButterKnife.bind(View)來(lái)注入View的,因?yàn)?strong>ButterKnife認(rèn)為這些類(lèi)的包名以com.android開(kāi)頭的類(lèi)是沒(méi)有注解功能的(-灶搜。- 這不是廢話嗎祟蚀?),所以這種情況你需要使用ButterKnife.bind(ViewHolder割卖,View)來(lái)注入View前酿。

這表示你是把@Bind、@OnClick等注解寫(xiě)到了這個(gè)ViewHolder類(lèi)中鹏溯,ViewHolder中的View呢罢维?需要從后面那個(gè)View中去找。

總結(jié):

通過(guò)分析丙挽,我們還了解到ButterKnife之所以對(duì)性能影響不大肺孵,是因?yàn)樗褂玫腁PT(編譯時(shí)解析技術(shù)),即注解類(lèi)在編譯時(shí)就通過(guò)反射的方式將注解掃描出來(lái)被編譯成實(shí)際的類(lèi)颜阐,使用時(shí)只需要調(diào)用bind()方法查找平窘,所以應(yīng)用性能不會(huì)受影響。

感謝http://www.reibang.com/p/7a8c0f8de7da

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末瞬浓,一起剝皮案震驚了整個(gè)濱河市初婆,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖磅叛,帶你破解...
    沈念sama閱讀 219,490評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件屑咳,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡弊琴,警方通過(guò)查閱死者的電腦和手機(jī)兆龙,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)敲董,“玉大人紫皇,你說(shuō)我怎么就攤上這事∫刚” “怎么了聪铺?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,830評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)萄窜。 經(jīng)常有香客問(wèn)我铃剔,道長(zhǎng),這世上最難降的妖魔是什么查刻? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,957評(píng)論 1 295
  • 正文 為了忘掉前任键兜,我火速辦了婚禮,結(jié)果婚禮上穗泵,老公的妹妹穿的比我還像新娘普气。我一直安慰自己,他們只是感情好佃延,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,974評(píng)論 6 393
  • 文/花漫 我一把揭開(kāi)白布现诀。 她就那樣靜靜地躺著,像睡著了一般苇侵。 火紅的嫁衣襯著肌膚如雪赶盔。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,754評(píng)論 1 307
  • 那天榆浓,我揣著相機(jī)與錄音于未,去河邊找鬼。 笑死陡鹃,一個(gè)胖子當(dāng)著我的面吹牛烘浦,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播萍鲸,決...
    沈念sama閱讀 40,464評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼闷叉,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了脊阴?” 一聲冷哼從身側(cè)響起握侧,我...
    開(kāi)封第一講書(shū)人閱讀 39,357評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤蚯瞧,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后品擎,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體埋合,經(jīng)...
    沈念sama閱讀 45,847評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,995評(píng)論 3 338
  • 正文 我和宋清朗相戀三年萄传,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了甚颂。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,137評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡秀菱,死狀恐怖振诬,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情衍菱,我是刑警寧澤赶么,帶...
    沈念sama閱讀 35,819評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站脊串,受9級(jí)特大地震影響禽绪,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜洪规,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,482評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望循捺。 院中可真熱鬧斩例,春花似錦、人聲如沸从橘。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,023評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)恰力。三九已至叉谜,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間踩萎,已是汗流浹背停局。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,149評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留香府,地道東北人董栽。 一個(gè)月前我還...
    沈念sama閱讀 48,409評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像企孩,于是被迫代替她去往敵國(guó)和親锭碳。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,086評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容