Butter Knife
来源:互联网 发布:笛卡尔心形线 c语言 编辑:程序博客网 时间:2024/05/17 02:07
最明显区别应该是在bind和inject
写在前面:该文档使用7.0版本,8.0版本方法名有所改动,建议看官方文档,整体业务逻辑和原理没什么变动,官网
在Android编程过程中,我们会写大量的布局和点击事件,像初始view、设置view监听这样简单而重复的操作让人觉得麻烦类,所以可以采用注解的方式去实现,而ButterKnife则是注解中相对简单易懂的很不错的开源框架,而网上的文档和例子都过时了,7.0之后的版本改动很大,之前的注解都不能用了,所以借鉴官方文档总结了一下,接下来就介绍一下如何使用。基本参照官方文档,加上自己的心得。
ButterKnife 优势:
1.强大的View绑定和Click事件处理功能,简化代码,提升开发效率
2.方便的处理Adapter里的ViewHolder绑定问题
3.运行时不会影响APP效率,使用配置方便
4.代码清晰,可读性强
使用心得:
1.Activity ButterKnife.bind(this);必须在setContentView();之后,且父类bind绑定后,子类不需要再bind
2.Fragment ButterKnife.bind(this, mRootView);
3.属性布局不能用private or static 修饰,否则会报错
4.setContentView()不能通过注解实现。(其他的有些注解框架可以)
官网http://jakewharton.github.io/butterknife/
使用步骤:
一.导入ButterKnife jar包:
1)如果你是Eclipse,可以去官网下载jar包
2)如果你是AndroidStudio可以直接 File->Project Structure->Dependencies->Library dependency 搜索butterknife即可,第一个就是
3)当然也可以用maven和gradle配置
- MAVEN
- <dependency>
- <groupId>com.jakewharton</groupId>
- <artifactId>butterknife</artifactId>
- <version>(insert latest version)</version>
- </dependency>
- GRADLE
- compile 'com.jakewharton:butterknife:(insert latest version)'
- Be sure to suppress this lint warning in your build.gradle.(关闭)
- lintOptions {
- disable 'InvalidPackage'
- }
注意如果在Library 项目中使用要按如下步骤(github中有具体描述)否则无法找到view:
注:官网和github也有对应的引用步骤。
二.常见使用方法:
1)由于每次都要在Activity中的onCreate绑定Activity,所以个人建议写一个BaseActivity完成绑定,子类继承即可
注:ButterKnife.bind(this);绑定Activity 必须在setContentView之后:
实现如下(FragmentActivity 实现一样):
- public abstract class BaseActivity extends Activity {
- public abstract int getContentViewId();
- @Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(getContentViewId());
- ButterKnife.bind(this);
- initAllMembersView(savedInstanceState);
- }
- protected abstract void initAllMembersView(Bundle savedInstanceState);
- @Override
- protected void onDestroy() {
- super.onDestroy();
- ButterKnife.unbind(this);//解除绑定,官方文档只对fragment做了解绑
- }
- }
2)绑定fragment
- public abstract class BaseFragment extends Fragment {
- public abstract int getContentViewId();
- protected Context context;
- protected View mRootView;
- @Nullable
- @Override
- public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
- mRootView =inflater.inflate(getContentViewId(),container,false);
- ButterKnife.bind(this,mRootView);//绑定framgent
- this.context = getActivity();
- initAllMembersView(savedInstanceState);
- return mRootView;
- }
- protected abstract void initAllMembersView(Bundle savedInstanceState);
- @Override
- public void onDestroyView() {
- super.onDestroyView();
- ButterKnife.unbind(this);//解绑
- }
- }
3)绑定view
- @Bind(R.id.hello_world)
- TextView mHelloWorldTextView;
- @Bind(R.id.app_name)
- TextView mAppNameTextView;//view
- @BindString(R.string.app_name)
- String appName;//sting
- @BindColor(R.color.red)
- int textColor;//颜色
- @BindDrawable(R.mipmap.ic_launcher)
- Drawable drawable;//drawble
- @Bind(R.id.imageview)
- ImageView mImageView;
- @Bind(R.id.checkbox)
- CheckBox mCheckBox;
- @BindDrawable(R.drawable.selector_image)
- Drawable selector;
5)Adapter ViewHolder 绑定
- public class TestAdapter extends BaseAdapter {
- private List<String> list;
- private Context context;
- public TestAdapter(Context context, List<String> list) {
- this.list = list;
- this.context = context;
- }
- @Override
- public int getCount() {
- return list==null ? 0 : list.size();
- }
- @Override
- public Object getItem(int position) {
- return list.get(position);
- }
- @Override
- public long getItemId(int position) {
- return position;
- }
- @Override
- public View getView(int position, View convertView, ViewGroup parent) {
- ViewHolder holder;
- if (convertView == null) {
- convertView = LayoutInflater.from(context).inflate(R.layout.layout_list_item, null);
- holder = new ViewHolder(convertView);
- convertView.setTag(holder);
- } else {
- holder = (ViewHolder) convertView.getTag();
- }
- holder.textview.setText("item=====" + position);
- return convertView;
- }
- static class ViewHolder {
- @Bind(R.id.hello_world)
- TextView textview;
- public ViewHolder(View view) {
- ButterKnife.bind(this, view);
- }
- }
- }
6)点击事件的绑定:不用声明view,不用setOnClickLisener()就可以绑定点击事件
a.直接绑定一个方法
- @OnClick(R.id.submit)
- public void submit(View view) {
- // TODO submit data to server...
- }
b.所有监听方法的参数是可选的
- @OnClick(R.id.submit)
- public void submit() {
- // TODO submit data to server...
- }
c.定义一个特定类型,它将自动被转换
- @OnClick(R.id.submit)
- public void sayHi(Button button) {
- button.setText("Hello!");
- }
d.多个view统一处理同一个点击事件,很方便,避免抽方法重复调用的麻烦
- @OnClick({ R.id.door1, R.id.door2, R.id.door3 })
- public void pickDoor(DoorView door) {
- if (door.hasPrizeBehind()) {
- Toast.makeText(this, "You win!", LENGTH_SHORT).show();
- } else {
- Toast.makeText(this, "Try again", LENGTH_SHORT).show();
- }
- }
e.自定义view可以绑定自己的监听,不指定id
- public class FancyButton extends Button {
- @OnClick
- public void onClick() {
- // TODO do something!
- }
- }
f.给EditText加addTextChangedListener(即添加多回调方法的监听的使用方法),利用指定回调,实现想回调的方法即可,哪个注解不会用点进去看下源码上的注释就会用了
- @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.BEFORE_TEXT_CHANGED)
- void beforeTextChanged(CharSequence s, int start, int count, int after) {
- }
- @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.TEXT_CHANGED)
- void onTextChanged(CharSequence s, int start, int before, int count) {
- }
- @OnTextChanged(value = R.id.mobileEditText, callback = OnTextChanged.Callback.AFTER_TEXT_CHANGED)
- void afterTextChanged(Editable s) {
- }
7)对一组View进行统一操作
a.装入一个list
- @Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })
- List<EditText> nameViews;
b.设置统一处理
- 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);
- }
- };
c.统一操作处理,例如设置是否可点,属性等
- ButterKnife.apply(nameViews, DISABLE);
- ButterKnife.apply(nameViews, ENABLED, false);
- @Nullable @Bind(R.id.might_not_be_there) TextView mightNotBeThere;
- @Nullable @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() {
- // TODO ...
- }
三、代码混淆
- -keep class butterknife.** { *; }
- -dontwarn butterknife.internal.**
- -keep class **$$ViewBinder { *; }
- -keepclasseswithmembernames class * {
- @butterknife.* <fields>;
- }
- -keepclasseswithmembernames class * {
- @butterknife.* <methods>;
- }
四、Zelezny插件的使用
在AndroidStudio->File->Settings->Plugins->搜索Zelezny下载添加就行 ,可以快速生成对应组件的实例对象,不用手动写。使用时,在要导入注解的Activity 或 Fragment 或 ViewHolder的layout资源代码上,右键——>Generate——Generate ButterKnife Injections,然后就出现如图的选择框。(此动态图来自官网)
一些不常用的用法:
Butter Knife
Butter Knife是Jake Wharton创建的一个流行的开源注入库。简单的来说,Butter knife 让你用注解的方式替代findviewbyid和setOnClickListener,这样你就能回到真正有用的代码上去。
compile
'com.jakewharton:butterknife:7.0.1'
Butter Knife 使用的是编译时注解,因此不会在运行时产生任何负担。实际上它是提前生成了需要的代码,而不是使用反射或者在运行时生成代码。所以它不会导致任何性能问题,也不会减慢你的应用。
下面是我很少看到被开发者使用的Butter Knife特性,这些都是非常好的特性,因此我希望你也开始能用到它们!
1. 常用listener的多个view设置方法
- @OnClick({ R.id.button1, R.id.button2, R.id.button2 })
- public void buttonClicks(View view) {
- switch(view.getId()) {
- case R.id.button1:
- Toast.makeText(this, "Button1 clicked!", LENGTH_SHORT).show();
- break;
- case R.id.button1:
- Toast.makeText(this, "Button2 Clicked!", LENGTH_SHORT).show();
- break;
- case R.id.button1:
- Toast.makeText(this, "Button3 clicked!", LENGTH_SHORT).show();
- break;
- }
- }
2. 更多的listener
- @OnLongClick(R.id.hello) boolean sayGetOffMe() {
- Toast.makeText(this, "Let go of me!", LENGTH_SHORT).show();
- return true;
- }
- @OnItemClick(R.id.list_of_things) void onItemClick(int position) {
- Toast.makeText(this, "You clicked: " + adapter.getItem(position), LENGTH_SHORT).show();
- }
- @OnItemSelected({R.id.spinnerCountry})
- void onItemSelected(Spinner spinner, int position) {
- }
- @OnItemSelected(value=R.id.spinnerCountry, callback = OnItemSelected.Callback.NOTHING_SELECTED)
- void onNothingSelected() {
- }
同样的,你还可以为view添加如下listener:
@OnLongClick
@OnPageChange
OnPageChange.Callback
@OnTextChanged
OnTextChanged.Callback
@OnTouch
@OnItemLongClick
@OnCheckedChanged
3.绑定资源
这也是Butter knife提供的优秀功能之一。和使用 @Bind 注解替代findViewById一样,它可以用来绑定colors, dimens, string, drawable等资源。
- class ExampleActivity extends Activity {
- @BindColor(R.color.red) int red;
- @BindString(R.string.activity_title) String activityTitle;
- @BindDimen(R.dimen.btn_horizontal_margin_common) Float btnHorizontalMarginCommon;
- @BindDrawable(R.drawable.ic_instructions) Drawable iconInstructions;
- }
4. 把多个view组织到一个List或者Array中
- Bind({ R.id.first_name, R.id.middle_name, R.id.last_name })
- List<EditText> nameViews;
apply方法允许你一次性在list中的所有view上act
- 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);
- }
- };
5. 设置View的属性
Android属性也可以和apply方法一起使用。
- ButterKnife.apply(nameViews, View.ALPHA, 0.0f);
6. ButterKnife.findById to find views particularly
Butter knife仍然包含了findById方法,用于仍需从一个view ,Activity,或者Dialog上 find 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);
7. @Nullable annotation
如果目标view不能找到,它将抛出异常,暗示那个field在布局中可能不存在。
- @Nullable @Bind(R.id.edUserName)
- EditText edUserName;
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife
- Butter Knife使用教程
- Butter Knife在adapter
- Butter Knife 和 AndroidAnnotations
- Butter Knife 使用方法
- Butter Knife 的使用方法
- Android Butter Knife使用说明
- Butter Knife 使用方法
- Butter Knife 使用说明
- jsf标签详解
- Linux的使用<三> ubuntu16.04LTS安装Wine
- C# string数组转int数组
- BZOJ 1226: [SDOI2009]学校食堂Dining 状压DP
- CF 669E CDQ分治
- Butter Knife
- 关于classpath
- open JDK 和 JDK区别
- 关于extjs的下拉框二级联动
- 九枝兰专访-----深入解读程序化购买以及行业现状(尾篇)
- 开发中常用的一些JS代码片段
- 深入理解Java:注解(Annotation)基本概念
- 物理内存与虚拟内存之间的映射
- 《挑战程序设计竞赛》2.2一直往前!贪心算法