butterknife簡介及Generate ButterKnife Injections 不出現的問題解決

時間 2019-12-05

標籤 butterknife 簡介 generate injections 出現問題解決简体版

原文原文鏈接

1、概述

butterknife是一款as的功能強大插件。有了它，你幾乎能夠和findViewById說byebye了。javascript

2、使用

github地址：https://github.com/avast/android-butterknife-zeleznyhtml

3、問題解決

Generate ButterKnife Injections 不出現的問題解決

一、下載後重啓須重啓as，方生效java

二、打開Gradle App，添加 compile 'com.jakewharton:butterknife:7.0.1'依賴android

三、請務必將鼠標光標懸停在R.layout.xxx處，點擊右鍵！請詳細參閱https://github.com/avast/android-butterknife-zeleznygit

ButterKnife基本使用

Butter Knife處理字段和方法綁定.

重要更新: 目前(2016.4.29), ButterKnife的最新版本是8.0.1.

Demo項目已更新: https://github.com/mengdd/AndroidButterKnifeSample

如下原文是針對ButterKnife v6.1.0的, v8.0.1主要的不一樣在如下幾個關鍵詞:

@InjectView -> @BindView
@InjectViews -> @BindViews
ButterKnife.inject(this) -> ButterKnife.bind(this)


ButterKnife.reset(this) ->  

private Unbinder unbinder; 
unbinder = ButterKnife.bind(this, view); 
@Override
public void onDestroyView() {
    unbinder.unbind();
    super.onDestroyView();
}

配置:

用gradle配置的時候加入:

compile 'com.jakewharton:butterknife:6.1.0'

注意是加在Module: app的gradle文件中.

加上以後不用運行什麼命令,直接Sync一下就能夠在External Libraries裏面看到butterknife.

功能1: 不再用寫findViewById()啦.

之前的:

mTextView1 = (TextView) findViewById(R.id.butter_text_view_1);

如今能夠這樣實現:

首先在變量聲明的時候加上註解:

@InjectView(R.id.butter_text_view_2)
TextView mTextView2;

若是id找不到,會在編譯的時候報錯.

以後在設置好佈局以後調用ButterKnife.inject():

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.demo_butter_knife);
 
    //using butter knife
    ButterKnife.inject(this);
}

以後View對象就能夠直接使用了.

須要注意的是View變量聲明的時候不能爲 private或者static.

除了Activity以外,你能夠提供其餘的View Root,來獲取對象(執行注入).

還能夠用來簡化Adapter裏面的ViewHolder:

ButterKnife in Fragment

在Fragment中也可使用ButterKnife來獲取View:

public class SimpleFragment extends Fragment {
 
    @InjectView(R.id.fragment_text_view)
    TextView mTextView;
 
    public SimpleFragment() {
    }
 
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_simple, container, false);
        ButterKnife.inject(this, view);
        mTextView.setText("TextView in Fragment are found!");
        return view;
    }
}

ButterKnife in Adapter ViewHolder

Adapter有一種經常使用的優化策略,就是使用ViewHolder來減小findViewById()的重複調用.

之前寫過相關的博文: http://www.cnblogs.com/mengdd/p/3254323.html

用了ButterKnife以後, ViewHolder的使用能夠變成這樣:

 
    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        ViewHolder holder;
        if (convertView == null) {
            convertView = mInflater.inflate(R.layout.person_item_layout, null);
            holder = new ViewHolder(convertView);
            convertView.setTag(holder);
        } else {
            holder = (ViewHolder) convertView.getTag();
        }
        Person person = getItem(position);
        if (null != person) {
            holder.name.setText(person.getName());
            holder.age.setText(String.valueOf(person.getAge()));
            holder.location.setText(person.getLocation());
            holder.work.setText(person.getWork());
        }
 
        return convertView;
    }
 
    static class ViewHolder {
        @InjectView(R.id.person_name)
        TextView name;
        @InjectView(R.id.person_age)
        TextView age;
        @InjectView(R.id.person_location)
        TextView location;
        @InjectView(R.id.person_work)
        TextView work;
 
        public ViewHolder(View view) {
            ButterKnife.inject(this, view);
        }
    }

能夠看到ViewHolder類加了一個帶參數View的構造方法,用註解標記每一個字段,不再須要在 getView()方法裏調用findViewById()方法了.

功能2: 不再用寫setOnClickListener()啦.

好比以前的:

    finishButton.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            finish();
        }
    });

如今能夠寫成:

    @OnClick(R.id.basic_finish_a_button)
    void finishA(View view) {
        finish();
    }

注意這裏方法仍然不能是 private和static, 而且能夠有一個參數View,也可不寫.

全部listener的參數都是optional的,能夠寫,也能夠不寫.

而且寫的時候能夠直接寫一個具體的子類,好比參數View能夠寫成Button,這裏的cast是自動完成的.

注意仍是須要調用一下 ButterKnife.inject(this);

不然事件綁定不成功.

忘記調用ButterKnife.inject(this);對於findView來講會報錯,可是對於綁定事件來講不會報錯,只是沒有事情發生.

除了點擊事件@OnClick,還有ListView的點擊 @OnItemClick, CheckBox的@OnCheckedChanged等等.

能夠一次指定多個id,爲多個View綁定一個事件處理方法,好比:

//you can bind listener to multiple views
@OnClick({R.id.button_enable, R.id.button_disable, R.id.button_alpha_0, R.id.button_alpha_1})
void editViewsClicked() {
    Toast.makeText(this, "You click the Button!", Toast.LENGTH_SHORT).show();
}

功能3: 組建View List: 把多個View放在一塊兒用

能夠同時獲取多個View,放在一個List中:

@InjectViews({R.id.label_first_name, R.id.label_middle_name, R.id.label_last_name})
List<TextView> labelViews;

@InjectViews({R.id.first_name, R.id.middle_name, R.id.last_name})
List<EditText> nameViews;

注意id用逗號分隔,大括號包圍,外面纔是小括號.

apply()方法容許你爲一組對象批量地設置值.

apply()方法共有3種形式:

public static <T extends View> void apply(List<T> list, Action<? super T> action)
public static <T extends View, V> void apply(List<T> list, Setter<? super T, V> setter, V value)
public static <T extends View, V> void apply(List<T> list, Property<? super T, V> setter, V value)

即Action, Setter和Property三種.

其中Action和Setter都是ButterKnife的類,須要繼承,寫本身的子類實現,而後傳入對象.

Setter的第三個參數能夠指定要set到什麼值.

Property是Android中的類: https://developer.android.com/reference/android/util/Property.html

具體的使用能夠參見例子:

https://github.com/mengdd/AndroidButterKnifeSample/blob/master/app/src/main/java/com/example/mengdd/butterknifesample/ViewListActivity.java

其餘實用方法

1.注入重置(Injection Rest):

能夠用 reset()方法將ButterKnife注入的View引用設置爲null.

好比在Fragment的onCreateView()裏調用ButterKnife.inject()方法注入了一些View,在 onDestroyView()裏想把它們置爲null,能夠直接調用ButterKnife.reset(this);方法.

2.選擇性注入(Optional Injection):

默認狀況下,@InjectView和listener的注入都是必須的,若是target view沒有被發現,則會報錯.

爲了抑制這種行爲,能夠用 @Optional註解來標記field和方法,讓注入變成選擇性的,若是targetView存在,則注入, 不存在,則什麼事情都不作.

當佈局被複用時,這個@Optional註解頗有用.

3.多方法的listener(Multi-method Listeners):

有一些View的listener是有多個回調方法的,好比Spinner的onItemSelectedListener:

mSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
    @Override
    public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
    }
 
    @Override
    public void onNothingSelected(AdapterView<?> parent) {
    }
});

方法註解能夠用來綁定到這些方法中的任何一個.

每個註解有一個默認的callback,指定它綁定到什麼方法上;能夠經過callback參數指定爲一個特定的方法.

好比:

沒有指定callback,默認對應onItemSelected()方法:

@OnItemSelected(R.id.my_spinner)
    //default callback : ITEM_SELECTED
void onItemSelected(int position) {
    Toast.makeText(this, "position: " + position, Toast.LENGTH_SHORT).show();
}

指定了callback,對應onNothingSelected()方法:

@OnItemSelected(value = R.id.my_spinner, callback = OnItemSelected.Callback.NOTHING_SELECTED)
void onNothingSelected() {
    Toast.makeText(this, "Nothing", Toast.LENGTH_SHORT).show();
}

注意的是Spinner中只要有數據,默認都會選中第0個數據,因此想進入到onNothingSelected()方法,就須要把Adapter中的數據都清空.

具體完整例子見:

https://github.com/mengdd/AndroidButterKnifeSample/blob/master/app/src/main/java/com/example/mengdd/butterknifesample/SpinnerActivity.java