簡述
Android databind技術實現了view -- model之間的綁定,在寫Android界面的時候,可以省去大量的findviewbyid( )
、setOnClickListener( )
、textview.setText( )
等膠水代碼。該技術的某些高級特性還可以快速的實現添加view屬性。
Android databind技術采用 mvvm設計模式,該設計模式主要分為三個部分:model 、view 、viewmodel。其中view 為用戶定義的layout布局, model 為用戶定義的數據結構, viewmodel則是Android databing 根據layout生成的binding 類。
使用databind需要使用Gradle 的 Android Plugin 1.5 以上的版本。然后在app 模塊的gradle文件中進行聲明:
android {
....
dataBinding {
enabled = true
}
}
一個簡單的例子###
- 首先,需要在layout.xml文件中聲明使用databind
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
<variable
name="user"
type="com.example.User"/>
</data>
<LinearLayout
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="@{user.firstName}"/>
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="@{user.lastName}"/>
</LinearLayout>
</layout>
layout中的內容需要在最外層添加 <layout> </layout>
。
然后要聲明 <data>
內容,其中<variable>
對應的是使用的mvvm中的model,即用戶定義的數據結構。其中 name 聲明變量名,type聲明變量類型。
最后在view的參數中使用android:text="@{user.lastName}"
進行賦值。
- User類中的用于賦值的變量必須有對應的getter函數
public class User {
private final String firstName;
private final String lastName;
public User(String firstName, String lastName) {
this.firstName = firstName;
this.lastName = lastName;
}
public String getFirstName() {
return this.firstName;
}
public String getLastName() {
return this.lastName;
}
}
- Android 的databind 工具會根據layout文件生成對應的binding 類 ,如mainacitivyt.xml 會生成
MainActivityBinding
.所有生成的banding類全部繼承于android.databinding.ViewDataBinding
。
需要在加載layout的時候使用bingding類進行綁定,綁定方法有很多,例如
MainActivityBinding binding = DataBindingUtil.setContentView(this, R.layout.main_activity);
MainActivityBinding binding = MainActivityBinding.*inflate*(getLayoutInflater());
view綁定后,需要在合適的時候對model進行綁定,
User user = new User("Test", "User");
binding.setUser(user);
真正的數據綁定
上面的例子可以在binding.setUser(user);
的時候,將user的數據寫到對應 view上。但是,當你在后面的代碼中改user里的變量時,view 上的內容并不會進行相應的變化。如果想要user變化時,view上的內容“實時”更新,則需要以下幾種方法:
- 繼承BaseObservable
private static class User extends BaseObservable {
private String firstName;
private String lastName;
@Bindable
public String getFirstName() {
return this.firstName;
}
@Bindable
public String getLastName() {
return this.lastName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
notifyPropertyChanged(BR.firstName);
}
public void setLastName(String lastName) {
this.lastName = lastName;
notifyPropertyChanged(BR.lastName);
}
}
使用@Bindable
對getter
方法進行注解,并且在setter
方法的時候,顯性調用 notifyPropertyChanged
方法,其中BR.xxx
變量為Android databind 工具生成。
- ObservableFields
上述方式比較麻煩,Android databind 提供了ObservableField<T>
類。以及一些基礎類型的包裝類,ObservableBoolean, ObservableByte, ObservableChar, ObservableShort, ObservableInt, ObservableLong, ObservableFloat, ObservableDouble, ObservableParcelable
用法如下:
public final ObservableField<String> firstName = new ObservableField<>();
public final ObservableInt age = new ObservableInt();
user.firstName.set("Google");
int age = user.age.get();
Observable 定義的變量,必須使用 getter 和 setter進行取值賦值操作。
還可以定義Observable集合,ObservableArrayMap
。
Android databind 常見用法
databing最簡單的用法就是上面例子中直接對view的屬性進行賦值(前提是該屬性有對應setter函數),下面介紹幾種稍微復雜的用法。
-
表達式賦值
Android databind 支持大部分java語法(不支持 new),在對view的屬性賦值時,可以直接使用表達式,例如:
<TextView android:text="@{user.age < 18 ? @string/redacted : user.name}"/>
<TextView android:text="@{String.valueOf(index + 1)}" />
-
事件監聽
為View設置onClick ,如下
android:onClick="@{(view) -> presenter.onSaveClick()}"
需要在對應的Presenter類中有對應的函數,
public class Presenter {
public void onSaveClick(View view){
}
}
-
類型轉換
對view賦值時有些類型需要轉換,例如:
<View
android:background="@{isError ? @color/red : @color/white}"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
color 為int值 ,view.setBackground 需要的是drawable參數,這個時候,需要定義類型轉換,
@BindingConversion
public static ColorDrawable convertColorToDrawable(int color) {
return new ColorDrawable(color);
}
該方法可以定義在任何地方。
-
適配器
開發中一個比較常見的場景就是使用ImageLoader進行加載圖片,在任何地方添加適配器代碼:
@BindingAdapter("android:src")
public static void setImageUrl(ImageView view, String url) {
Picasso.with(view.getContext()).load(url).into(view);
}
這個時候可以使用下面代碼進行數據綁定:
<ImageView …
android:src="@{data.url}" />
當進行bind的時候,會自動調用適配器定義的函數。適配器也可以用來添加view的屬性。比如我想在Textview
中綁定long
型的時間戳,并且按照一個格式顯示。
<TextView ···
app:date="@{appData.create_time}"
app:format='@{"yyyy年MM月dd日"}'
/>
@android.databinding.BindingAdapter(value = {"app:date", "app:format"}, requireAll = false)
public static void bindFormat(TextView view, String date, String format) {
if (date == null) {
return;
}
SimpleDateFormat formatter;
if (format != null) {
formatter = new SimpleDateFormat(format);
} else {
formatter = new SimpleDateFormat("yyyy-MM-dd");
}
Long timeStamp = Long.parseLong(date);
view.setText(formatter.format(new Date(timeStamp)));}
其中 requireAll = false
表示當參數不全時,也會調用適配器函數,補全的參數會傳入空值,所以要自己判斷。
-
findView
某些時候我們還是需要引用到布局中的view,但是不需要使用findview···
,databinding會根據布局中的view的ID,以及屬性賦值自動生成布局中需要用的view引用。其中 binding.getRoot()
返回綁定的View
。
總結
- databind 可以減少編寫各種膠水代碼,同時也在開發中引入MVVM設計模式。也可以為MVP 、MVC等其他的設計模式提供支持。
- Android databind是在編譯階段進行代碼生成,所以并不影響運行效率。
- 當前版本的databind的支持還是有些欠佳的,比如在布局文件中,使用
app:xxx
進行賦值的時候,是不能自動補全的。在比如說賦值drawable資源的時候,是不能使用 @mipmap 路徑的。