Android注解使用之ButterKnife 8.0注解使用介紹

前言:

App項目開發(fā)大部分時候還是以UI頁面為主,這時我們需要調(diào)用大量的findViewById以及setOnClickListener等代碼蔬捷,控件的少的時候我們還能接受幔翰,控件多起來有時候就會有一種想砸鍵盤的沖動凭疮。所以這個時候我們想著可以借助注解的方式讓我們從這種繁重的工作中脫離出來,也讓代碼變得更加簡潔,便于維護睛约,今天主要學(xué)習(xí)一下只專注View鼎俘、Resource、Action注解框架ButterKnife辩涝。

ButterKnife介紹

ButterKnife是一個專注于Android系統(tǒng)的View而芥、Resource、Action注入框架膀值。

官網(wǎng):http://jakewharton.github.io/butterknife/

gitHub:https://github.com/JakeWharton/butterknife/

ButterKnife使用前后對比:

看看沒有使用View注解之前我們是如何做的

1.)使用之前

public class ExampleActivity extends AppCompatActivity {
    private final static String TAG = ExampleActivity.class.getSimpleName();
    String butterKnifeStr;
    Drawable butterKnifeDrawable;
    Button butterKnifeBtn;
    ImageView butterKnifeIv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butter_knife);
        initResource();
        initViews();
    }

    private void initViews() {
        butterKnifeBtn = (Button) findViewById(R.id.btn_butter_knife);
        butterKnifeBtn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Log.e(TAG, "onButterKnifeBtnClick");
            }
        });
        butterKnifeIv = (ImageView) findViewById(R.id.iv_butter_knife);
        butterKnifeBtn.setText(butterKnifeStr);
        butterKnifeIv.setImageDrawable(butterKnifeDrawable);
    }

    private void initResource() {
        butterKnifeStr = getString(R.string.title_btn_butter_knife);
        butterKnifeDrawable = getDrawable(R.mipmap.ic_launcher);
    }
}

2.)使用之后

public class ButterKnifeActivity extends AppCompatActivity {
    private final static String TAG = ButterKnifeActivity.class.getSimpleName();
    private Unbinder unbinder;
    @BindString(R.string.title_btn_butter_knife)
    String butterKnifeStr;
    @BindDrawable(R.mipmap.ic_launcher)
    Drawable butterKnifeDrawable;
    @BindView(R.id.btn_butter_knife)
    Button butterKnifeBtn;
    @BindView(R.id.iv_butter_knife)
    ImageView butterKnifeIv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butter_knife);
        unbinder = ButterKnife.bind(this);
        initViews();
    }

    private void initViews() {
        butterKnifeBtn.setText(butterKnifeStr);
        butterKnifeIv.setImageDrawable(butterKnifeDrawable);
    }

    @OnClick(R.id.btn_butter_knife)
    public void onButterKnifeBtnClick(View view) {
        Log.e(TAG, "onButterKnifeBtnClick");
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        unbinder.unbind();
    }
}

3.)ButterKnife 優(yōu)勢

通過上面使用前后對比來分析下ButterKnife優(yōu)勢

強大的View綁定和Click事件處理功能棍丐,簡化代碼,提升開發(fā)效率
方便的處理Adapter里的ViewHolder綁定問題
運行時不會影響APP效率沧踏,使用配置方便
代碼清晰歌逢,可讀性強
使用前后對比之后有沒有覺得非常的簡單易用。接下來來看下具體怎么使用的翘狱?

ButterKnife如何使用:

1.)在Project的build.gradle中添加如下配置

buildscript {
  repositories {
    mavenCentral()
   }
  dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  }
}

2.)在Module的build.gradle添加如下配置

apply plugin: 'com.neenbedankt.android-apt'

android {
  ...
}

dependencies {
  compile 'com.jakewharton:butterknife:8.1.0'
  apt 'com.jakewharton:butterknife-compiler:8.1.0'
}

3.)注入和重置注入

Activity

class ExampleActivity extends Activity {
  @BindView(R.id.title) TextView title;
  @BindView(R.id.subtitle) TextView subtitle;
  @BindView(R.id.footer) TextView footer;

  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
    // TODO Use fields...
  }
}

Fragment:由于不同的視圖生命周期秘案,所以需要在onCreateView bind,在onDestroyView unbind

public class FancyFragment extends Fragment {
  @BindView(R.id.button1) Button button1;
  @BindView(R.id.button2) Button button2;
  private Unbinder unbinder;

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

  @Override public void onDestroyView() {
    super.onDestroyView();
    unbinder.unbind();
  }
}

ViewHolder


public class MyAdapter extends BaseAdapter {
  @Override public View getView(int position, View view, ViewGroup parent) {
    ViewHolder holder;
    if (view != null) {
      holder = (ViewHolder) view.getTag();
    } else {
      view = inflater.inflate(R.layout.whatever, parent, false);
      holder = new ViewHolder(view);
      view.setTag(holder);
    }

    holder.name.setText("John Doe");
    // etc...

    return view;
  }

  static class ViewHolder {
    @BindView(R.id.title) TextView name;
    @BindView(R.id.job_title) TextView jobTitle;

    public ViewHolder(View view) {
      ButterKnife.bind(this, view);
    }
  }
  

4.)view注入 @BindView潦匈,@BindViews


    @BindView(R.id.btn_butter_knife)
    Button butterKnifeBtn;
    @BindViews({R.id.tv_butter_knife1,R.id.tv_butter_knife2,R.id.tv_butter_knife3})
    List<TextView> textViews;
    

5.)Resource注入

    @BindString(R.string.title_btn_butter_knife)
    String butterKnifeStr;//string注解使用
    @BindDrawable(R.mipmap.ic_launcher)
    Drawable butterKnifeDrawable;//Drawable注解使用
    @BindBitmap(R.mipmap.ic_launcher)
    Bitmap  butterKnifeBitmap;;//Bitmap注解使用
    @BindArray(R.array.day_of_week)
    String weeks[];//數(shù)組
    @BindColor(R.color.colorPrimary)
    int colorPrimary;//color注解使用
    @BindDimen(R.dimen.activity_horizontal_margin)
    Float spacer;

6.)單事件注入

一個控件指定一個事件回調(diào)

    /**
     * 帶參數(shù)
     */
    @OnClick(R.id.btn_butter_knife)
    public void onButterKnifeBtnClick() {
    }

    /**
     * 帶參數(shù)
     */
    @OnClick(R.id.btn_butter_knife)
    public void onButterKnifeBtnClick(View view) {
        Log.e(TAG, "onButterKnifeBtnClick");
    }

    /**
     * 帶參數(shù)
     * @param button
     */
    @OnClick(R.id.btn_butter_knife)
    public void onButterKnifeBtnClick(Button button) {
        Log.e(TAG, "onButterKnifeBtnClick");
    }

也可以多個控件指定一個事件回調(diào)

    /**
     * 兩個不同的button都相應(yīng)onButterKnifeBtnClick事件回調(diào)
     *
     * @param button
     */
    @OnClick({R.id.btn_butter_knife, R.id.btn_butter_knife1})
    public void onButterKnifeBtnClick(Button button) {
        Log.e(TAG, "onButterKnifeBtnClick");
    }

自定義的控件不通過ID也可以綁定到自己的事件

public class FancyButton extends Button {
  @OnClick
  public void onClick() {
    // TODO do something!
  }
}

7.)多事件回調(diào)

有一些View的listener是有多個回調(diào)方法的,比如EditText添加addTextChangedListener

 editText.addTextChangedListener(new TextWatcher() {
            @Override
            public void beforeTextChanged(CharSequence s, int start, int count, int after) {

            }

            @Override
            public void onTextChanged(CharSequence s, int start, int before, int count) {

            }

            @Override
            public void afterTextChanged(Editable s) {

            }
        });

可以使用注解方式改成如下

    @OnTextChanged(value = R.id.nameEditText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)
    void beforeTextChanged(CharSequence s, int start, int count, int after) {

    }
    @OnTextChanged(value = R.id.nameEditText, callback = OnTextChanged.Callback.TEXT_CHANGED)
    void onTextChanged(CharSequence s, int start, int before, int count) {

    }
    @OnTextChanged(value = R.id.nameEditText, callback = OnTextChanged.Callback.AFTER_TEXT_CHANGED)
    void afterTextChanged(Editable s) {

    }

8.)選擇性注入

默認情況下,@Bind 和listener的注入都是必須的,如果target view沒有被發(fā)現(xiàn),則會報錯. 為了抑制這種行為,可以用@Optional注解來標(biāo)記field和方法,讓注入變成選擇性的,如果targetView存在,則注入, 不存在,則什么事情都不做.或者使用 Android's "support-annotations" library.中的@Nullable來修飾

@Nullable @BindView(R.id.might_not_be_there)
TextView mightNotBeThere;

@Optional @OnClick(R.id.maybe_missing) 
void onMaybeMissingClicked() {
  // TODO ...
}

9.)ButterKnife.apply()函數(shù)

可以通過ButterKnifeapply()函數(shù)對view集合元素或者單個view的Action, Setter和Property進行修改

ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);

static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
  @Override public void apply(View view, int index) {
    view.setEnabled(false);
  }
};
static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
  @Override public void set(View view, Boolean value, int index) {
    view.setEnabled(value);
  }
};

ButterKnife.apply(nameViews, View.ALPHA, 0.0f);

10.)ButterKnife.findById()

 ButterKnife 也提供了findById函數(shù)阱高,通過findById()可以獲取Activity、Dialog茬缩、View中的view赤惊,并且是泛型類型不需要強轉(zhuǎn)

View view = LayoutInflater.from(context).inflate(R.layout.thing, null);
TextView firstName = ButterKnife.findById(view, R.id.first_name);
TextView lastName = ButterKnife.findById(view, R.id.last_name);
ImageView photo = ButterKnife.findById(view, R.id.photo);

ButterKnife自動生成插件安裝:

在AndroidStudio->File->Settings->Plugins->搜索Zelezny下載添加就行 ,可以快速生成對應(yīng)組件的實例對象凰锡,不用手動寫未舟。使用時,在要導(dǎo)入注解的Activity 或 Fragment 或 ViewHolder的layout資源代碼上掂为,右鍵——>Generate——Generate ButterKnife Injections裕膀,然后就出現(xiàn)如圖的選擇框。

插件gitHub地址:https://github.com/avast/android-butterknife-zelezny

上面給了一個使用流程圖勇哗,不過流程圖不會針對最新的8.0.1版本的昼扛,但是都是差不多的

流程.gif
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市欲诺,隨后出現(xiàn)的幾起案子抄谐,更是在濱河造成了極大的恐慌,老刑警劉巖瞧栗,帶你破解...
    沈念sama閱讀 219,188評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件斯稳,死亡現(xiàn)場離奇詭異海铆,居然都是意外死亡迹恐,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評論 3 395
  • 文/潘曉璐 我一進店門卧斟,熙熙樓的掌柜王于貴愁眉苦臉地迎上來殴边,“玉大人憎茂,你說我怎么就攤上這事〈赴叮” “怎么了竖幔?”我有些...
    開封第一講書人閱讀 165,562評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長是偷。 經(jīng)常有香客問我拳氢,道長,這世上最難降的妖魔是什么蛋铆? 我笑而不...
    開封第一講書人閱讀 58,893評論 1 295
  • 正文 為了忘掉前任馋评,我火速辦了婚禮,結(jié)果婚禮上刺啦,老公的妹妹穿的比我還像新娘留特。我一直安慰自己,他們只是感情好玛瘸,可當(dāng)我...
    茶點故事閱讀 67,917評論 6 392
  • 文/花漫 我一把揭開白布蜕青。 她就那樣靜靜地躺著,像睡著了一般糊渊。 火紅的嫁衣襯著肌膚如雪右核。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,708評論 1 305
  • 那天渺绒,我揣著相機與錄音蒙兰,去河邊找鬼。 笑死芒篷,一個胖子當(dāng)著我的面吹牛搜变,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播针炉,決...
    沈念sama閱讀 40,430評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼挠他,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了篡帕?” 一聲冷哼從身側(cè)響起殖侵,我...
    開封第一講書人閱讀 39,342評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎镰烧,沒想到半個月后拢军,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,801評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡怔鳖,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,976評論 3 337
  • 正文 我和宋清朗相戀三年茉唉,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,115評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡度陆,死狀恐怖艾凯,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情懂傀,我是刑警寧澤趾诗,帶...
    沈念sama閱讀 35,804評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站蹬蚁,受9級特大地震影響恃泪,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜犀斋,卻給世界環(huán)境...
    茶點故事閱讀 41,458評論 3 331
  • 文/蒙蒙 一静稻、第九天 我趴在偏房一處隱蔽的房頂上張望表伦。 院中可真熱鬧,春花似錦、人聲如沸呢燥。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,008評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽菇民。三九已至,卻和暖如春持钉,著一層夾襖步出監(jiān)牢的瞬間衡招,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,135評論 1 272
  • 我被黑心中介騙來泰國打工每强, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留始腾,地道東北人。 一個月前我還...
    沈念sama閱讀 48,365評論 3 373
  • 正文 我出身青樓空执,卻偏偏與公主長得像浪箭,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子辨绊,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,055評論 2 355

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