Android之Databinding學習筆記

Android之DataBinding學習筆記

簡介

Data binding 在2015年7月發布的Android Studio v1.3.0 版本上引入，在2016年4月Android Studio v2.0.0 上正式支持。目前為止，Data Binding 已經支持雙向綁定了。

Databinding 是一個實現數據和UI綁定的框架，是一個實現 MVVM 模式的工具，有了 Data Binding，在Android中也可以很方便的實現MVVM開發模式。

Data Binding 是一個support庫，最低支持到Android 2.1（API Level 7+）。

Data Binding 之前，我們不可避免地要編寫大量的重復的代碼，如 findViewById()、setText()，setVisibility()，setEnabled() 或 setOnClickListener() 等，通過 Data Binding , 我們可以通過聲明式布局以精簡的代碼來綁定應用程序邏輯和布局，這樣就不用編寫大量的重復的代碼了。

studio環境構建

1.在模塊的build.gradle文件中添加dataBinding配置

android {  
    ......  

    dataBinding{
        enabled = true
    }

......
}

注意：如果app依賴了一個使用 Data Binding 的庫，那麼app module 的 build.gradle 也必須配置 Data Binding

Data Binding 布局文件 - (View)

Data binding 的布局文件與傳統布局文件有一點不同。它以一個 layout 標簽作為根節點，裡面是 data 標簽與 view 標簽。view 標簽的內容就是不使用 Data Binding 時的普通布局文件內容。以下是一個例子：

activity_main.xml

在上面的布局中，對於data裡面的variable nama=”entry”表示的是一個變量名entry，type表示你所對應實體的包名路徑，在TextView中，我們采用@{}的語法來引用實體類Entry中的屬性。

數據對象 - (Model)

Entry.java

public class Entry {
    private String text;
    private int color;

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    public int getColor() {
        return color;
    }

    public void setColor(int color) {
        this.color = color;
    }

}

上面就是我們所說的實體類Entry，用於TextView的android:text屬性的表達式@{entry.text}和android:textColor屬性表達式@{entry.color}

綁定數據 - (ViewModel)

在默認情況下，會基於布局文件生成一個繼承於 ViewDataBinding 的 Binding 類，將它轉換成和你的布局命名並在名字後面接上Binding。例如，布局文件叫 activity_main.xml，所以會生成一個 ActivityMainBinding類。這個類包含了布局文件中所有的綁定關系，會根據綁定表達式給布局文件賦值。在 inflate 的時候創建 binding 的方法如下：

MainActivity.java

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMainBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_main);
        Entry entry = new Entry();
        entry.setText("文本數據1");
        entry.setColor(0xff0000ff);
        binding.setEntry(entry);
    }
}

事件處理

類似於 android:onClick 可以指定 Activity 中的函數，Data Binding 也允許處理從視圖中發送的事件。

有兩種實現方式：

方法調用

監聽綁定

二者主要區別在於方法調用在編譯時處理，而監聽綁定於事件發生時處理。

方法調用

相較於 android:onClick ，它的優勢在於表達式會在編譯時處理，如果函數不存在或者函數簽名不對，編譯將會報錯。

以下是個例子：

Entry.java

public class Entry {
    private String text;
    private int color;

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    public int getColor() {
        return color;
    }

    public void setColor(int color) {
        this.color = color;
    }
    //在這個實體中添加一個點擊時間的方法
    public void onClick(View view){
        Toast.makeText(view.getContext(),"已點擊",Toast.LENGTH_SHORT).show();
    }

}

activity_main.xml

通過在上面的TextView中添加一個android:onClick屬性表達式為@{entry.onClick}這樣就能調用點擊事件 了，(注意：對應的方法名和監聽器對象必須對應) 如果該方法不存在，則在編譯的時候就不會通過了。除了上面的表達式可以表示之外，我們還可以使用以下的表達式方式進行設置：

android:onClick="@{entry.onClick}"（不過這種方式已經過時了，因為這樣的表示會和entry.text這樣的屬性引用難以區分）

監聽綁定

監聽綁定在事件發生時調用，可以使用任意表達式

此功能在 Android Gradle Plugin version 2.0 或更新版本上可用.

在方法引用中，方法的參數必須與監聽器對象的參數相匹配。在監聽綁定中，只要返回值與監聽器對象的預期返回值相匹配即可。

Entry.java

public class Entry {
    private String text;
    private int color;

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    public int getColor() {
        return color;
    }

    public void setColor(int color) {
        this.color = color;
    }

    //將點擊監聽事件中添加了一個參數
    public void onClick(View view,String str){
        Toast.makeText(view.getContext(),"已點擊,產生了" + str,Toast.LENGTH_SHORT).show();
    }

}

activity_main.xml

MainAcitivty.java

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityMainBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_main,new MyComponent(this));
        Entry entry = new Entry();
        entry.setText("文本數據1");
        entry.setColor(0xff0000ff);
        //設置測試字符串
        binding.setStr("我是監聽綁定的數據測試");
        binding.setEntry(entry);
    }
}

當一個回調函數在表達式中使用時，數據綁定會自動為事件創建必要的監聽器並注冊監聽。關於android:onClick="@{(v) -> entry.onClick(v,str)}"這裡采用的是java1.8中的lambda表達式的形式，因為這樣我們可以傳遞相應的參數進去。

導入(Imports)

1.data 標簽內可以有多個 import 標簽。你可以在布局文件中像使用 Java 一樣導入引用

activity_main.xml

2.當類名發生沖突時，可以使用 alias

3.導入的類型也可以用於變量的類型引用和表達式中

注意：Android Studio 還沒有對導入提供自動補全的支持。你的應用還是可以被正常編譯，要解決這個問題，你可以在變量定義中使用完整的包名。

4.導入也可以用於在表達式中使用靜態方法

StringUtils.java

public class StringUtils {
    public static String show(String string){
        string = string.toUpperCase();
        return string;
    }
}

activity_main.xml

    
        
        
    
    ......
    

5.java.lang.* 包中的類會被自動導入，可以直接使用，例如， 要定義一個 String 類型的變量

變量 Variables

1.data 標簽中可以有任意數量的 variable 標簽。每個 variable 標簽描述了會在 binding 表達式中使用的屬性。

2.可以在表達式中直接引用帶 id 的 view，引用時采用駝峰命名法。

3.binding 類會生成一個命名為 context 的特殊變量(其實就是 rootView 的 getContext() ) 的返回值)，這個變量可用於表達式中。 如果有名為 context 的變量存在，那麼生成的這個 context 特殊變量將被覆蓋。

StringUtils.java

public class StringUtils {
    public static String show(Context context,String string){
        Toast.makeText(context, string,Toast.LENGTH_SHORT).show();
        string = string.toUpperCase();
        return string;
    }
}

        
        

......

自定義綁定類名

默認情況下，binding 類的名稱取決於布局文件的命名，以大寫字母開頭，移除下劃線，後續字母大寫並追加 “Binding” 結尾。這個類會被放置在 databinding 包中。舉個例子，布局文件 activity_main.xml 會生成 ActivityMainBinding 類。如果 module 包名為 com.example.my.app ，binding 類會被放在 com.example.my.app.databinding 中。

通過修改 data 標簽中的 class 屬性，可以修改 Binding 類的命名與位置。舉個例子：

    ...

以上會在 databinding 包中生成名為 CustomBinding 的 binding 類。如果需要放置在不同的包下，可以在前面加 “.”：

    ...

這樣的話， CustomBinding 會直接生成在 module 包下。如果提供完整的包名，binding 類可以放置在任何包名中：

    ...

Includes

include.xml

需要注意， activity_main.xml 與 include.xml 中都需要聲明 user 變量。

Data binding 不支持直接包含 merge 節點。舉個例子， 以下的代碼不能正常運行 ：

表達式語言

表達式語言與 Java 表達式有很多相似之處。下面是相同之處：

在xml中轉義是不可避免的，如 : 使用“&&”是編譯不通過的，需要使用轉義字符 “&&”

附：常用的轉義字符

不支持的操作符

一些 Java 中的操作符在表達式語法中不能使用。

android:text="@{entry.text ?? `Default Text`}"

android:text="@{entry.text != null ? entry.text : `Default Text`}"

    
    
    
    
    
    
    
    

…
android:text="@{list[index]}"
…
android:text="@{sparse[index]}"
…
android:text="@{map[key]}"

android:text='@{map["text"]}'

android:text="@{map[`text`}"
android:text="@{map["text"]}"

android:text="@{@string/text(entry.text)"

android:text="@{@plurals/sample_plurals(num)}"

android:text="@{@plurals/numbers(num, num)}"

public class Entry extends BaseObservable{
    private String text;
    private int color;

    @Bindable
    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
        notifyPropertyChanged(BR.text);

    }
    @Bindable
    public int getColor() {
        return color;
    }

    public void setColor(int color) {
        this.color = color;
        notifyPropertyChanged(BR.color);
    }

    public void onClick(View view,String str){
        Toast.makeText(view.getContext(),"已點擊,產生了" + str,Toast.LENGTH_SHORT).show();
        setText(str);
        setColor(0xffff0000);
    }

}

public class EntryField{
    public ObservableField mText = new ObservableField<>();
    public ObservableField mColor = new ObservableField<>();

    public EntryField(String text, int color) {
        mText.set(text);
        mColor.set(color);
    }
}

mEntryField.mText.set("text");
mEntryField.mColor.set(0xffff0000);

String text = mEntryField.mText.get();
String color = mEntryField.mColor.get();

ObservableArrayMap mEntry = new ObservableArrayMap<>();
mEntry .put("text", "it_real_man");
mEntry .put("color", 0xffff0000);
binding.setEntry(mEntry);

    
    

…

ObservableArrayList sEntry= new ObservableArrayList<>();
sEntry.add("entryData");
sEntry.add("text");
sEntry.add("color");
binding.setSEntry(sEntry);

    
        

…