您的位置：首页 > 职场人生

ButterKnife Android程序员的一大利器

2016-07-12 20:36 363 查看
注：最近才看到的这个类库，来自于jakewharton大神的力作，安卓里面的视图注入库
另小弟水平有限，翻译的不好，还请多多指正
首先是地址（托管在github上）：http://jakewharton.github.io/butterknife/
进去后首先看到的是关于用法的讲解，翻译部分正式开始（通俗且精简化，建议对照着看）！

简介：

程序员都是懒惰的，不想写一大堆像下面这样的代码

view
sourceprint?

01.
class
ExampleActivity
extends
Activity
{


02.
TextView
title;


03.
TextView
subtitle;


04.
TextView
footer;


05.


06.
@Override
public
void
onCreate(Bundle
savedInstanceState) {


07.
super
.onCreate(savedInstanceState);


08.
setContentView(R.layout.simple_activity);


09.
title
= (TextView) findViewById(R.id.title);


10.
subtitle
= (TextView) findViewById(R.id.subtitle);


11.
footer
= (TextView) findViewById(R.id.footer);


12.


13.
//
TODO Use views...


14.
}


15.
}


这样很不好，因此我们就找到了一个方法，使用魔法一般的注解，来浓缩代码，就像下面这样

view
sourceprint?

01.
class
ExampleActivity
extends
Activity
{


02.
@Magic
(R.id.title)
TextView title;


03.
@Magic
(R.id.subtitle)
TextView subtitle;


04.
@Magic
(R.id.footer)
TextView footer;


05.


06.
@Override
public
void
onCreate(Bundle
savedInstanceState) {


07.
super
.onCreate(savedInstanceState);


08.
setContentView(R.layout.simple_activity);


09.
//
TODO Use "injected" views...


10.
}


11.
}


然而，这样虽然看起来很酷，很Magic，不过还是会带来严重的运行时的问题

于是，我们就利用javac 编译器中一大利器来生成前面例子中的findViewById的引用，并且继续保持代码的精简 ，继续看下面的代码

view
sourceprint?

01.
class
ExampleActivity
extends
Activity
{


02.
@InjectView
(R.id.title)
TextView title;


03.
@InjectView
(R.id.subtitle)
TextView subtitle;


04.
@InjectView
(R.id.footer)
TextView footer;


05.


06.
@Override
public
void
onCreate(Bundle
savedInstanceState) {


07.
super
.onCreate(savedInstanceState);


08.
setContentView(R.layout.simple_activity);


09.
ButterKnife.inject(
this
);


10.
//
TODO Use "injected" views...


11.
}


12.
}


在原本Magic的地方使用inject 方法来替代，下面是该方法的一段代表（This method delegates to generated code 不明），可以看并debug

view
sourceprint?

1.
public
void
inject(ExampleActivity
activity) {


2.
activity.subtitle
= (android.widget.TextView) activity.findViewById(
2130968578
);


3.
activity.footer
= (android.widget.TextView) activity.findViewById(
2130968579
);


4.
activity.title
= (android.widget.TextView) activity.findViewById(
2130968577
);


5.
}


（这段可以忽略吗？貌似翻译不对，看不太懂）有些人称这个为视图注入，并加到了传统的依赖注入框架中，也许在术语上有错误，不过或许有一点作用.......

NON-ACTIVITY INJECTION

我们可以对任意的View对象使用注入，当然了，需要提供view root的对象

view
sourceprint?

01.
public
class
FancyFragment
extends
Fragment
{


02.
@InjectView
(R.id.button1)
Button button1;


03.
@InjectView
(R.id.button2)
Button button2;


04.


05.
@Override
View
onCreateView(LayoutInflater inflater,ViewGroup container,Bundle savedInstanceState) {


06.
View
view = inflater.inflate(R.layout.fancy_fragment,container,
false
);


07.
ButterKnife.inject(
this
,
view);


08.
//
TODO Use "injected" views...


09.
return
view;


10.
}


11.
}


另外一个用处是简化list adapter中的View Holder模式，这个例子可以在提供的sample中看到

view
sourceprint?

01.
public
class
MyAdapter
extends
BaseAdapter
{


02.
@Override
public
View
getView(
int
position,
View view,ViewGroup parent) {


03.
ViewHolder
holder;


04.
if
(view
!=
null
)
{


05.
holder
= (ViewHolder) view.getTag();


06.
}
else
{


07.
view
= inflater.inflate(R.layout.whatever,parent,
false
);


08.
holder
=
new
ViewHolder(view);


09.
view.setTag(holder);


10.
}


11.


12.
holder.name.setText(
"John
Doe"
);


13.
//
etc...


14.


15.
return
convertView;


16.
}


17.


18.
static
class
ViewHolder
{


19.
@InjectView
(R.id.title)
TextView name;


20.
@InjectView
(R.id.job_title)
TextView jobTitle;


21.


22.
public
ViewHolder(View
view) {


23.
ButterKnife.inject(
this
,
view);


24.
}


25.
}


26.
}


其他的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 也可以被注入

view
sourceprint?

1.
@OnClick
(R.id.submit)


2.
public
void
submit()
{


3.
//
TODO submit data to server...


4.
}


也可以加一个view对象，特定的类型会被自动转换

view
sourceprint?

1.
@OnClick
(R.id.submit)


2.
public
void
sayHi(Button
button) {


3.
button.setText(
"Hello!"
);


4.
}


一次指定多个id，同时加事件

view
sourceprint?

1.
@OnClick
({
R.id.door1,R.id.door2,R.id.door3 })


2.
public
void
pickDoor(DoorView
door) {


3.
if
(door.hasPrizeBehind())
{


4.
Toast.makeText(
this
,
"You
win!"
,
LENGTH_SHORT).show();


5.
}
else
{


6.
Toast.makeText(
this
,
"Try
again"
,
LENGTH_SHORT).show();


7.
}


8.
}


INJECTION RESET

Fragments 有比Avtivity更多的生命周期 ，如果需要在onCreateView中注入一个fragment，在onDestroyView中销毁它

Butter Knife 有一个reset 方法自动实现它



view
sourceprint?

01.
public
class
FancyFragment
extends
Fragment
{


02.
@InjectView
(R.id.button1)
Button button1;


03.
@InjectView
(R.id.button2)
Button button2;


04.


05.
@Override
View
onCreateView(LayoutInflater inflater,ViewGroup container,Bundle savedInstanceState) {


06.
View
view = inflater.inflate(R.layout.fancy_fragment,container,
false
);


07.
ButterKnife.inject(
this
,
view);


08.
//
TODO Use "injected" views...


09.
return
view;


10.
}


11.


12.
@Override
void
onDestroyView()
{


13.
super
.onDestroyView();


14.
ButterKnife.reset(
this
);


15.
}


16.
}


OPTIONAL INJECTIONS

默认情况下 @InjectView和@OnClick都是必须加上的，如果当前对象不存在，就会抛出一个异常

为了压制这个异常，可以在变量或者方法上加入一下注解

view
sourceprint?

1.
@Optional
@InjectView
(R.id.might_not_be_there)
TextView mightNotBeThere;


2.


3.
@Optional
@OnClick
(R.id.maybe_missing)
void
onMaybeMissingClicked()
{


4.
//
TODO ...


5.
}


BONUS

这段看不太懂，大意估计是除了以上注入方法之外还有一种，类型会自动转换，需要静态导入ButterKnife.findById

view
sourceprint?

1.
View
view = LayoutInflater.from(context).inflate(R.layout.thing,
null
);


2.
TextView
firstName = ButterKnife.findById(view,R.id.first_name);


3.
TextView
lastName = ButterKnife.findById(view,R.id.last_name);


4.
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开发的童鞋，请自觉加上如下依赖

view
sourceprint?

1.
<dependency>


2.
<groupId>com.jakewharton</groupId>


3.
<artifactId>butterknife</artifactId>


4.
<version>
4.0
.
1
</version>


5.
</dependency>


IDE的配置



IntelliJ IDEA — 如果你是用外部工具管理工程 (如 Maven pom.xml) 应该能正常工作,不然就看看这个 http://jakewharton.github.io/butterknife/ide-idea.html
Eclipse — http://jakewharton.github.io/butterknife/ide-eclipse.html

PROGUARD

使用注入会导致ProGuard 认为变量未被使用，因此，需要在ProGuard 中加入如下字段

view
sourceprint?

1.
-dontwarn
butterknife.internal.**


2.
-keep
class
**$$ViewInjector
{ *; }


3.
-keepnames
class
*
{
@butterknife
.InjectView
*;}


Having Happy Coding!

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息
标签： 
相关文章推荐
新的分享
章节导航