ddu-ButterKnife 8

前言:
App项目开发大部分时候还是以UI页面为主,这时我们需要调用大量的findViewById以及setOnClickListener等代码,控件的少的时候我们还能接受,控件多起来有时候就会有一种想砸键盘的冲动。所以这个时候我们想着可以借助注解的方式让我们从这种繁重的工作中脱离出来,也让代码变得更加简洁,便于维护,今天主要学习一下只专注View、Resource、Action注解框架BufferKnife 。
BufferKnife 介绍
BufferKnife 是一个专注于Android系统的View、Resource、Action注入框架。
官网:http://jakewharton.github.io/butterknife/
gitHub:https://github.com/JakeWharton/butterknife/
BufferKnife 使用前后对比:
看看没有使用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 优势
通过上面使用前后对比来分析下ButterKnife优势
强大的View绑定和Click事件处理功能,简化代码,提升开发效率
方便的处理Adapter里的ViewHolder绑定问题
运行时不会影响APP效率,使用配置方便
代码清晰,可读性强

使用前后对比之后有没有觉得非常的简单易用。接下来来看下具体怎么使用的?
BufferKnife 如何使用:
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[];//数组 @BindColor(R.color.colorPrimary) int colorPrimary;//color注解使用 @BindDimen(R.dimen.activity_horizontal_margin) Float spacer;

                    6.)单事件注入
                            一个控件指定一个事件回调

                    /带参数 / @OnClick(R.id.btn_butter_knife) public void onButterKnifeBtnClick ()
                    {
                    }/带参数 / @OnClick(R.id.btn_butter_knife) public void onButterKnifeBtnClick
                    (View view){
                        Log.e(TAG, "onButterKnifeBtnClick");
                    } /* 带参数 @param button / @OnClick(R.id.btn_butter_knife) public void onButterKnifeBtnClick(Button button) { Log.e(TAG, "onButterKnifeBtnClick"); }

也可以多个控件指定一个事件回调

/* 两个不同的button都相应onButterKnifeBtnClick事件回调 @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.)多事件回调
有一些View的listener是有多个回调方法的, 比如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没有被发现, 则会报错.为了抑制这种行为, 可以用
@Optional注解来标记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() 函数
可以通过ButterKnifeapply()
函数对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函数,通过findById() 可以获取Activity、Dialog、
View中的view,并且是泛型类型不需要强转
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);

BufferKnife 自动生成插件安装:
在AndroidStudio -> File -> Settings -> Plugins -> 搜索Zelezny下载添加就行,
可以快速生成对应组件的实例对象,不用手动写。使用时,在要导入注解的Activity 或 Fragment 或
ViewHolder的layout资源代码上,右键——>Generate——Generate ButterKnife
Injections,然后就出现如图的选择框。

插件gitHub地址:https://github.com/avast/android-butterknife-zelezny
上面给了一个使用流程图,不过流程图不会针对最新的8 .0 .1 版本的,但是都是差不多

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

推荐阅读更多精彩内容