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

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

一.使用反射方式減少findViewById的編寫

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

1.創(chuàng)建注解類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.添加查找注解到視圖的方法

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

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

4.解析注解

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

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類
            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));
                            }
                        }
                    }
                }
            }
        }
    }

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

二.ButterKnife

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

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

  • 強(qiáng)大的View綁定和Click事件處理功能,簡(jiǎn)化繁瑣的代碼編寫
  • 可以支持Adapter中的VIewHolder綁定問題
  • 采用編譯時(shí)通過注解生成代碼,對(duì)運(yùn)行時(shí)沒有侵入,對(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配置文件中,引入如下依賴
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原理分析

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

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

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

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


image.png

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

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

①.編譯期間通過反射掃描Java代碼中所有的ButterKnife注解@Bind、@OnClick、@OnItemClicked等
②.當(dāng)它發(fā)現(xiàn)一個(gè)類中含有任何一個(gè)注解時(shí),ButterKnifeProcessor會(huì)幫你生成一個(gè)Java類,名字類似<className>$$ViewBinder,這個(gè)新生成的類實(shí)現(xiàn)了ViewBinder<T>接口
③.這個(gè)ViewBinder類中包含了所有對(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類調(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

讓我們來看下這兩個(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類在執(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類的process()方法會(huì)在MainActivity的同一個(gè)包下生成BinderBinding類,所以同包下是可以調(diào)用到的。同樣的道理,onClickListener也是通過找到view,然后設(shè)置viewonclicklistenertarget.XXX()方法,同樣的調(diào)用target.XXX()方法需要public或者protected修飾。

通過以上的流程我們知道,ButterKnife是在編譯時(shí)通過注解方式解析生成了Binder類和Binding,在Activity中調(diào)用了ButterKnife.bind(this)方法后,通過BinderBinding的配合,找到Activity中的類,并且類似與代理一樣的,為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
然后調(diào)用ViewBinderbind方法,動(dòng)態(tài)注入MainActivity類中所有的View屬性和
如果Activity中有@OnClick注解的方法,ButterKnife會(huì)在ViewBinder類中給View設(shè)置onClickListener,并且將@OnClick注解的方法傳入其中
在上面的過程中可以看到,為什么你用@Bind、@OnClick等注解標(biāo)注的屬性或方法必須是publicprotected的,因?yàn)?strong>ButterKnife是通過ExampleActivity.this.editText來注入View

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

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

如果你自定義了一個(gè)View,比如public class BadgeLayout extends Fragment,那么你可以可以通過ButterKnife.bind(BadgeLayout)來注入View

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

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

總結(jié):

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

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

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