【ButterKnife】 安卓程序猿的一大利器
注:近期才看到的这个类库,来自于jakewharton大神的力作,安卓里面的视图注入库
另小弟水平有限,翻译的不好,还请多多指正
首先是地址(托管在github上):http://jakewharton.github.io/butterknife/
进去后首先看到的是关于使用方法的解说,翻译部分正式開始(通俗且精简化,建议对比着看)!
简单介绍:
程序猿都是懒惰的,不想写一大堆像以下这种代码
class ExampleActivity extends Activity { TextView title; TextView subtitle; TextView footer; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.simple_activity); title = (TextView) findViewById(R.id.title); subtitle = (TextView) findViewById(R.id.subtitle); footer = (TextView) findViewById(R.id.footer); // TODO Use views... } }
这样非常不好,因此我们就找到了一个方法,使用魔法一般的注解,来浓缩代码,就像以下这样
class ExampleActivity extends Activity { @Magic(R.id.title) TextView title; @Magic(R.id.subtitle) TextView subtitle; @Magic(R.id.footer) TextView footer; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.simple_activity); // TODO Use "injected" views... } }
然而,这样尽管看起来非常酷,非常Magic,只是还是会带来严重的执行时的问题
于是,我们就利用javac 编译器中一大利器来生成前面样例中的findViewById
的引用,
而且继续保持代码的精简
,继续看以下的代码
class ExampleActivity extends Activity { @InjectView(R.id.title) TextView title; @InjectView(R.id.subtitle) TextView subtitle; @InjectView(R.id.footer) TextView footer; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.simple_activity); ButterKnife.inject(this); // TODO Use "injected" views... } }
在原本Magic的地方使用inject
方法来替代,以下是该方法的一段代表(This
method delegates to generated code 不明),能够看并debug
public void inject(ExampleActivity activity) { activity.subtitle = (android.widget.TextView) activity.findViewById(2130968578); activity.footer = (android.widget.TextView) activity.findViewById(2130968579); activity.title = (android.widget.TextView) activity.findViewById(2130968577); }
(这段能够忽略吗?貌似翻译不正确,看不太懂)有些人称这个为视图注入,并加到了传统的依赖注入框架中,也许在术语上有错误,只是也许有一点作用.......
NON-ACTIVITY INJECTION
我们能够对随意的View对象使用注入,当然了,须要提供view root的对象
public class FancyFragment extends Fragment { @InjectView(R.id.button1) Button button1; @InjectView(R.id.button2) Button button2; @Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { View view = inflater.inflate(R.layout.fancy_fragment, container, false); ButterKnife.inject(this, view); // TODO Use "injected" views... return view; } }
另外一个用处是简化list adapter中的View Holder模式,这个样例能够在提供的sample中看到
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 convertView; } static class ViewHolder { @InjectView(R.id.title) TextView name; @InjectView(R.id.job_title) TextView jobTitle; public ViewHolder(View view) { ButterKnife.inject(this, view); } } }
其它的API(这段真心建议看一下原版)
-当使用activity作为view root节点时,你假设使用的是像MVC设计模式,你能够将控制器注入,使用它的acitvity并通过
ButterKnife.inject(this,
activity)
方法
-将一个子View对象字段注入,使用
ButterKnife.inject(this)(在前面样例的
onCreate方法中就是,不懂的能够參考这个),假设你在一个layout的构造方法中使用<merge>标签而且,inflate了一个自己定义View,马上调用这种方法。或者,假设是从xml中inflate自己定义view,
能够使用这种方法---onLayoutInflated()
CLICK LISTENER INJECTION
Click listener 也能够被注入
@OnClick(R.id.submit) public void submit() { // TODO submit data to server... }
也能够加一个view对象,特定的类型会被自己主动转换
@OnClick(R.id.submit) public void sayHi(Button button) { button.setText("Hello!"); }
一次指定多个id,同一时候加事件
@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(); } }
INJECTION RESET
Fragments 有比Avtivity很多其它的生命周期 ,假设须要在onCreateView中注入一个fragment,在onDestroyView中销毁它
Butter Knife 有一个reset
方法自己主动实现它
public class FancyFragment extends Fragment {
@InjectView(R.id.button1) Button button1;
@InjectView(R.id.button2) Button button2;
@Override View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
View view = inflater.inflate(R.layout.fancy_fragment, container, false);
ButterKnife.inject(this, view);
// TODO Use "injected" views...
return view;
}
@Override void onDestroyView() {
super.onDestroyView();
ButterKnife.reset(this);
}
}
OPTIONAL INJECTIONS
默认情况下
@InjectView
和@OnClick
都是必须加上的,假设当前对象不存在,就会抛出一个异常
为了压制这个异常,能够在变量或者方法上增加一下注解
@Optional @InjectView(R.id.might_not_be_there) TextView mightNotBeThere; @Optional @OnClick(R.id.maybe_missing) void onMaybeMissingClicked() { // TODO ... }
BONUS
这段看不太懂,大意预计是除了以上注入方法之外另一种,类型会自己主动转换,须要静态导入ButterKnife.findById
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);
Download:当前版本号 4.0.1
详细:http://github.com/JakeWharton/butterknife
jar包:http://repo1.maven.org/maven2/com/jakewharton/butterknife/4.0.1/butterknife-4.0.1.jar
Maven配置:假设你是用maven开发的童鞋,请自觉加上例如以下依赖
<dependency> <groupId>com.jakewharton</groupId> <artifactId>butterknife</artifactId> <version>4.0.1</version> </dependency>
IDE的配置
- IntelliJ IDEA — 假设你是用外部工具管理project (如 Maven pom.xml)
应该能正常工作, 不然就看看这个 http://jakewharton.github.io/butterknife/ide-idea.html
- Eclipse — http://jakewharton.github.io/butterknife/ide-eclipse.html
PROGUARD
使用注入会导致ProGuard 觉得变量未被使用,因此,须要在ProGuard 中增加例如以下字段
-dontwarn butterknife.internal.**
-keep class **$$ViewInjector { *; }
-keepnames class * { @butterknife.InjectView *;}
Having Happy Coding!
PROGUARD
使用注入会导致ProGuard 觉得变量未被使用,因此,须要在ProGuard 中增加例如以下字段
-dontwarn butterknife.internal.** -keep class **$$ViewInjector { *; } -keepnames class * { @butterknife.InjectView *;}
Having Happy Coding!