DataBinding入门（一）基于MVVM+DataBinding+OkHttp的股票查询demo

观摩了Google官方的DataBinding项目architecture-samples，实践出真知，用一个例子来阐述DataBinding最简单的用法。

Github地址，欢迎star：https://github.com/LittleFogCat/DataBindingDemo

功能：输入股票代码，查询当前价格和涨幅。

demo

MVVM+DataBinding+OkHttp，使用的腾讯股票接口http://qt.gtimg.cn/q=sh600519

1. 新建模块simpledatabindingkt

2. 在module的build.gradle中启用databinding并添加Java8支持

如果不添加Java8支持，会出现莫名其妙的错误。

android {
    ...

    buildFeatures {
        dataBinding = true
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

3. 创建StockViewModel类和StockRepository类

首先明确业务逻辑：我们需要通过网络获取到某只股票当前的行情，并把它显示到View中。

StockRepository用于调用网络api获取数据。

class StockRepository {
    companion object {
        const val URL_PREFIX = "http://qt.gtimg.cn/q="
    }

    fun getStockInfo(code: String, callback: Callback) {
        val realUrl = URL_PREFIX + code
        HttpUtil.httpGet(realUrl, callback)
    }

}

StockViewModel处理业务逻辑。这里定义了两个被观察者Observable：用于观察请求到的股票信息的stockInfoObservable和用于观察加载状态的refreshingObservable。

class StockViewModel() {
    companion object {
        const val TAG = "StockViewModel"
    }

    private val repository = StockRepository()

    val stockInfoObservable = ObservableField<StockInfo>()
    val refreshingObservable = ObservableBoolean(false)
    
    fun queryStock(code: String) {
        refreshingObservable.set(true) // 设置刷新状态
        // 发起请求
        repository.getStockInfo(realCode, object : Callback {
            override fun onResponse(call: Call, response: Response) {
                // 前略 val stockInfo = ....
                // 根据api返回结果设置股票信息，并更新刷新状态
                stockInfoObservable.set(stockInfo)
                refreshingObservable.set(false)
            }
        })
    }

}

这是一个典型的观察者模式；在第5节中View和ViewModel绑定之后，布局中的内容就会因为Observable的更新而更新了。

跟MVP架构相比，MVVM更加激进和简洁：它去掉了许多复杂的接口，ViewModel也不像Presenter一样持有View的实例——而是使用观察者模式进行数据的更新。这样的好处是，ViewModel再也不用感知View的存在，只需要关心自己的业务逻辑，而不用关心View的具体实现或者手动去更新状态。从某种意义上来讲，MVVM可以看成MVP的进一步解耦，因为在MVP中，Presenter需要持有View的引用，并且更新它的状态。

4. 修改主布局activity_main.xml文件

将原始xml布局用<layout>标签包裹起来，然后在其中加入一个<data>标签，这个xml文件就被识别为DataBinding布局文件。然后build一下，就可以自动生成binding类了。
<data>中的<variable>标签表示可以在xml中使用的变量，这里定义了一个StockViewModel类型的变量viewmodel，这个xml就可以访问viewmodel的成员了。这个viewmodel变量是在哪里初始化的呢？这在5中会说明。

简化后布局如下：

<layout xmlns:tool="http://schemas.android.com/tools">

    <data>

        <import type="android.view.View" />

        <variable
            name="viewmodel"
            type="top.littlefogcat.simpledatabindingkt.StockViewModel" />

    </data>

    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">

        <LinearLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content">

            <EditText
                android:id="@+id/input"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"/>

            <Button
                android:id="@+id/btnGo"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="查询" />
        </LinearLayout>

        <TextView
            android:id="@+id/result"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:text='@{viewmodel.refreshingObservable?"加载中...":(viewmodel.stockInfoObservable.name+"（"+viewmodel.stockInfoObservable.code+"）\n当前价："+viewmodel.stockInfoObservable.price+"\n涨幅："+viewmodel.stockInfoObservable.increase+"%")}' />

    </LinearLayout>
</layout>

xml

build完之后，在build目录下面应该就可以看到自动生成的binding文件了。

注意到，在xml中的查询结果TextView中：

        <TextView
            android:id="@+id/result"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:text='@{viewmodel.refreshingObservable?"加载中...":(viewmodel.stockInfoObservable.name+"（"+viewmodel.stockInfoObservable.code+"）\n当前价："+viewmodel.stockInfoObservable.price+"\n涨幅："+viewmodel.stockInfoObservable.increase+"%")}' />

其中的android:text='@{viewmodel.refreshingObservable?...}'这个里面用@{}包裹起来的部分便是data-binding表达式，其中可以调用<data>标签中定义的viewmodel对象的成员。它可以是一个变量，或者是一个三元表达式，与Java语法相同。

可以看到，这个表达式特别冗长，作为优化方案，可以使用BinderAdapter来处理。Android Developer - 提供自定义逻辑
另外，如果不能够直接进行参数赋值，而有其他无法在xml中完成的逻辑，也可以使用BinderAdapter来处理。

5. 绑定View和ViewModel

将MainActivity做如下修改：

    private lateinit var mViewModel: StockViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val binding = DataBindingUtil.setContentView<ActivityMainBinding>(
            this, R.layout.activity_main
        )
        mViewModel = StockViewModel()
        binding.viewmodel = mViewModel // 正是在这里绑定的

        btnGo.setOnClickListener {
            val code = input.text
            mViewModel.queryStock(code.toString())
            if (result.visibility != VISIBLE) {
                result.visibility = VISIBLE
            }
        }
    }

这里和普通的Activity不同，没有调用setContentView，而是使用DataBindingUtil.setContentView来绑定布局。DataBindingUtil.setContentView会返回一个Binding对象，也就是4中自动build出来的那个。
而4中xml布局的viewmodel变量，正是这句：binding.viewmodel = mViewModel赋值的。

至此，我们将View和ViewModel进行了绑定。再补充一些细节，这个demo就完成了。

遇到的问题

报错：Invalid byte 3 of 3-byte UTF-8 sequence.

小结

使用DataBinding的基本流程：

在build.gradle中开启data-binding；
修改xml布局文件，将根布局替换为<layout>，并在其中添加<data>标签；
build一下，这时候IDE就自动生成Binding文件了。

2020年9月7日更新：
新版本的Android Studio只要布局文件修改成了data-binding格式，就自动生成Binding文件，不需要再build了。