Randall | 三、Databinding and MVVM

一、Databinding框架有什么实质性的作用？

1.让开发者尽可能地不再用findViewById

原先创建一个layout布局文件后，在Activity中要用findViewById方法去获取实例，一旦布局文件变得复杂，需要付出的代价（性能及维护）将难以想象。而现在只需要打开布局绑定这个开关，然后对原先的布局文件做一点点改动，再到Activity中得到自动生成的XXbinding实例，通过这个实例，就能很轻松拿到所有带id的View的实例。

下面是一个简单的例子：

• 打开布局绑定开关（记得Sync Now）

打开布局绑定开关.png

• 重构已有的布局文件

<layout>
    <data>
    </data>
    <LinearLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center_horizontal"
        android:orientation="vertical"
        android:paddingBottom="@dimen/activity_vertical_margin"
        android:paddingLeft="@dimen/activity_horizontal_margin"
        android:paddingRight="@dimen/activity_horizontal_margin"
        android:paddingTop="@dimen/activity_vertical_margin"
        tools:context="cn.mrzhqiang.randall.ui.LoginActivity">
        
        <!-- 省略部分无关布局 -->

    </LinearLayout>
</layout>

不要纠结data元素里面为什么没有任何子元素，这里暂时不做深入探讨，请无视它。

• 建立Activity与layout的关联，得到相关binding实例

拿到binding实例.png

使用DataBindingUtil类中的setContentView静态方法，替换Activity中的setContentView方法。

第一个参数需要传入当前Activity实例，第二个参数与原先保持一致。

这样替换之后，框架会自动为开发者创建布局文件名称对应的类，并返回这个类的实例。

比如当前布局文件是activity_login，则会创建ActivityLoginBinding类，而binding实例在生成时，就已经一次性寻找到所有带id的View的实例，花费的代价相对findViewById可以忽略不计。

2.配合MVVM模式，不需要initView，onCreate方法不再臃肿

简单来说，MVVM就是把ui、data、control等模块分得更具体一些。

M=Model，V=View，VM=ViewModel。

M是逻辑相关的集合体，不与UI产生关联，是单纯操作数据、返回结果的“过程”或“函数”。

V是视图相关的集合体，是UI级别的模块，它可以是布局文件也可以是Activity等组件。

VM通常没有具体的指代。可以自定义XxxViewModel，比如ToolbarViewModel；如果View层不是很复杂的话，比如在Fragment中，可以把整个Fragment作为ViewModel；以此类推，Activity、Dialog、ViewHolder等也可以是ViewModel。

通常而言，ViewModel是连接View与Model的桥梁，相当于MVP中的P。

因此通常情况下，需要创建自定义的ViewModel。

或许解释起来还不是很明白，但只要记住：M数据、V展示、VM连接，这种简单的对应关系就行。

现在，来重构一下LoginActivity，变为MVVM模式看看：

（当然，为了不使复杂化，将使用LoginActivity作为ViewModel）

// 这里省略了大部分代码，是为了更直观一些
public class LoginActivity extends AppCompatActivity {
    // ViewModel
    public final ObservableBoolean showProgress = new ObservableBoolean(false);
    public final ObservableBoolean showLoginForm = new ObservableBoolean(true);
    public final ObservableField<String> email = new ObservableField<>();
    public final ObservableField<String> emailError = new ObservableField<>();
    public final ObservableField<String> password = new ObservableField<>();
    public final ObservableField<String> passwordError = new ObservableField<>();

    @BindingAdapter("bindVisibility")
    public static void setVisibilityAndAnimate(final View view, final boolean show) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB_MR2) {
            int shortAnimTime = view.getResources().getInteger(android.R.integer.config_shortAnimTime);

            view.setVisibility(show ? View.VISIBLE : View.GONE);
            view.animate().setDuration(shortAnimTime).alpha(
                    show ? 1 : 0).setListener(new AnimatorListenerAdapter() {
                @Override
                public void onAnimationEnd(Animator animation) {
                    view.setVisibility(show ? View.VISIBLE : View.GONE);
                }
            });
        } else {
            // The ViewPropertyAnimator APIs are not available, so simply show
            // and hide the relevant UI components.
            view.setVisibility(show ? View.VISIBLE : View.GONE);
        }
    }

    @BindingAdapter("bindError")
    public static void setErrorAndRequestFocus(final TextView view, final String error) {
        view.setError(error);
        if (error != null) {
            view.requestFocus();
        }
    }

    public TextView.OnEditorActionListener getPasswordEditorAction() {
        return new TextView.OnEditorActionListener() {
            @Override public boolean onEditorAction(TextView v, int actionId, KeyEvent event) {
                if (actionId == R.id.login || actionId == EditorInfo.IME_NULL) {
                    attemptLogin();
                    return true;
                }
                return false;
            }
        };
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityLoginBinding binding = DataBindingUtil
                .setContentView(this, R.layout.activity_login);
        // setLogin是R.layout.activity_login文件中的data元素建立了variable子元素
        // 根据variable元素的name属性的值，ActivityLoginBinding自动生成的方法
        binding.setLogin(this);
    }

    public void attemptLogin() {
        // Reset errors.
        emailError.set(null);
        passwordError.set(null);

        // Check for a valid password, if the user entered one.
        if (!TextUtils.isEmpty(password.get()) && !isPasswordValid(password.get())) {
            passwordError.set(getString(R.string.error_invalid_password));
            return;
        }

        // Check for a valid email address.
        if (TextUtils.isEmpty(email.get())) {
            emailError.set(getString(R.string.error_field_required));
            return;
        }

        if (!isEmailValid(email.get())) {
            emailError.set(getString(R.string.error_invalid_email));
            return;
        }

        // Show a progress spinner, and kick off a background task to
        // perform the user login attempt.
        showProgress(true);

        // do something
        // ...
    }

    private boolean isEmailValid(String email) {
        //TODO: Replace this with your own logic
        return email.contains("@");
    }

    private boolean isPasswordValid(String password) {
        //TODO: Replace this with your own logic
        return password.length() > 4;
    }

    private void showProgress(boolean show) {
        showProgress.set(show);
        showLoginForm.set(!show);
    }
}

简单将LoginActivity中引用的View实例消除，只保留mEmailView，这还是由于AutoCompleteTextView的Adapter太简陋，而使得继续重构没有必要性。

假若后面逻辑变得复杂，则可以建立联系人数据库中Email信息的自动完成表单EmailViewModel，并且建立针对数据库查询的EmailModel，通过EmailModel返回【过滤后的按中文拼音排序】的邮箱地址数据，让EmailViewModel建立联系，最终显示在mEmailView的自动完成表单中。

来看看布局文件的变化：

<layout>
    <data>
        <variable name="login" type="cn.mrzhqiang.randall.ui.LoginActivity"/>
    </data>
    <LinearLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:app="http://schemas.android.com/apk/res-auto"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center_horizontal"
        android:orientation="vertical"
        android:paddingBottom="@dimen/activity_vertical_margin"
        android:paddingLeft="@dimen/activity_horizontal_margin"
        android:paddingRight="@dimen/activity_horizontal_margin"
        android:paddingTop="@dimen/activity_vertical_margin"
        tools:context="cn.mrzhqiang.randall.ui.LoginActivity">

        <!-- Login progress -->
        <ProgressBar
            app:bindVisibility="@{login.showProgress}"/>

        <ScrollView
            app:bindVisibility="@{login.showLoginForm}">

            <LinearLayout>

                <android.support.design.widget.TextInputLayout>

                    <AutoCompleteTextView
                        android:text="@={login.email}"
                        app:bindError="@{login.emailError}"/>

                </android.support.design.widget.TextInputLayout>

                <android.support.design.widget.TextInputLayout>

                    <!--suppress AndroidUnknownAttribute -->
                    <EditText
                        app:bindError="@{login.passwordError}"
                        android:text="@={login.password}"
                        android:onEditorAction="@{login.passwordEditorAction}"/>

                </android.support.design.widget.TextInputLayout>

                <Button
                    android:onClick="@{(v) -> login.attemptLogin()}"/>

            </LinearLayout>
        </ScrollView>
    </LinearLayout>
</layout>

为免除长篇大论，只列出改动的部分，具体可以到这里查看改动。

3.Databinding的使用总结

Databinding很聪明地处理了大部分系统View的绑定方法，之所以不是全部，是因为并没有包括兼容库在内。

以下是官方针对系统View的绑定适配方法的类包：

官方定义的bindingadapter类.png

有了BindingAdapter，自定义一个针对兼容库的方法绑定类，是十分之简单而又轻松的。

先来看看TextViewBandingAdapter类：

@BindingMethods({
        @BindingMethod(type = TextView.class, attribute = "android:autoLink", method = "setAutoLinkMask"),
        @BindingMethod(type = TextView.class, attribute = "android:drawablePadding", method = "setCompoundDrawablePadding"),
        @BindingMethod(type = TextView.class, attribute = "android:editorExtras", method = "setInputExtras"),
        @BindingMethod(type = TextView.class, attribute = "android:inputType", method = "setRawInputType"),
        @BindingMethod(type = TextView.class, attribute = "android:scrollHorizontally", method = "setHorizontallyScrolling"),
        @BindingMethod(type = TextView.class, attribute = "android:textAllCaps", method = "setAllCaps"),
        @BindingMethod(type = TextView.class, attribute = "android:textColorHighlight", method = "setHighlightColor"),
        @BindingMethod(type = TextView.class, attribute = "android:textColorHint", method = "setHintTextColor"),
        @BindingMethod(type = TextView.class, attribute = "android:textColorLink", method = "setLinkTextColor"),
        @BindingMethod(type = TextView.class, attribute = "android:onEditorAction", method = "setOnEditorActionListener"),
})
public class TextViewBindingAdapter {

    private static final String TAG = "TextViewBindingAdapters";
    public static final int INTEGER = 0x01;
    public static final int SIGNED = 0x03;
    public static final int DECIMAL = 0x05;

    @BindingAdapter("android:text")
    public static void setText(TextView view, CharSequence text) {
        final CharSequence oldText = view.getText();
        if (text == oldText || (text == null && oldText.length() == 0)) {
            return;
        }
        if (text instanceof Spanned) {
            if (text.equals(oldText)) {
                return; // No change in the spans, so don't set anything.
            }
        } else if (!haveContentsChanged(text, oldText)) {
            return; // No content changes, so don't set anything.
        }
        view.setText(text);
    }

    // 省略代码，节省篇幅
    // ...
}

看到@BindingAdapter("android:text")是不是觉得很熟悉？没错，就是重构后的LoginActivity中，对于切换布局和显示输入错误提示的封装，将重复代码变为静态的公开方法，用注解绑定到对应的布局文件，使得开发复杂度降低，更专注于逻辑的实现，而不是代码的copy。

这里不分析Databinding框架的原理，也不是一个真正的入门教程，仅仅是展示了它的简单用法。所以，想要入门的话，请先关注官方文档，以及其他博客对于框架的分析。当然，也可以直接照着代码走一遍，你很有可能是无师自通的那种天才。

二、MVVM到底在搞些什么？

其实所有的模式，都是为了方便开发者。

从开发到测试到维护，这一系列过程必须是轻松愉快的，否则带来的不只是折磨，更容易陷入魔障。

MVP将页面逻辑分离出来，使得多个页面可以共享同一套逻辑；MVVM实际上更强大，它可以使应用像组装电脑一样，随心所欲地拼装出不同需求的页面和功能。

为了达到这个目标，首先要对应用进行分析，或者是，要对开发进行剖析：

• 假若需要自定义标题，最好建立一个ToolbarViewModel，它可以是Activity级别ViewModel的public final
• 假若基于Fragment切换页面，或是RecyclerView的ViewHolder，则可以直接建立对应的layout.fragment_xx、layout.item_xx，将Fragment和ViewHolder作为ViewModel
• 假若Activity十分复杂，则可以分解为多个ViewModel，每个ViewModel负责单一职责的部分，比如，主页包含地图、搜索栏、账户操作栏，则可以将地图页面设为MapViewModel，将搜索栏设为SearchViewModel，将账户操作栏设为AccountViewModel，以此类推

根据不同的需求，建立不同的MVVM，坚持模块化、插件化，减少重复代码，降低维护难度，测试更容易，扩展更方便。

基于此，Randall将逐步探索MVVM的可能性，尽量避免说教式体验。