Android Databinding数据绑定框架

绝地灬酷狼 2022-06-17 14:20 181阅读 0赞

本文转载自：[精通 Android Data Binding][Android Data Binding]

官方虽然已经给出了教程 - Data Binding Guide （中文版 - Data Binding（数据绑定）用户指南） ，但是实践之后发现槽点实在太多，于是就有了这个教程，针对每个知识点给出更详实的例子同时也总结了遇到的一些坑，希望对你有所帮助：）

Data Binding 解决了 Android UI 编程的一个痛点，官方原生支持 MVVM 模型可以让我们在不改变既有代码框架的前提下，非常容易地使用这些新特性。

Data Binding 框架如果能够推广开来，也许 RoboGuice、ButterKnife 这样的依赖注入框架会慢慢失去市场，因为在 Java 代码中直接使用 View 变量的情况会越来越少。

## **准备** ##

新建一个 Project，确保 Android 的 Gradle 插件版本不低于 1.5.0-alpha1：

classpath 'com.android.tools.build:gradle:1.5.0'

然后修改对应模块（Module）的 build.gradle：

dataBinding {
        enabled true
    }

## **基础** ##

### **布局文件** ###

使用 Data Binding 之后，xml 的布局文件就不再用于单纯地展示 UI 元素，还需要定义 UI 元素用到的变量。所以，它的根节点不再是一个 ViewGroup，而是变成了 layout，并且新增了一个节点 data。

要实现 MVVM 的 ViewModel 就需要把数据（Model）与 UI（View） 进行绑定，data 节点的作用就像一个桥梁，搭建了 View 和 Model 之间的通路。

我们先在 xml 布局文件的 data 节点中声明一个 variable，这个变量会为 UI 元素提供数据（例如 TextView 的 android:text），然后在 Java 代码中把『后台』数据与这个 variable 进行绑定。

下面我们使用 Data Binding 创建一个展示用户信息的表格。

### **数据对象** ###

添加一个 POJO 类 - User，非常简单，两个属性以及他们的 getter 和 setter。

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 firstName;
        }
    
        public String getLastName() {
            return lastName;
        }
    }

稍后，我们会新建一个 User 类型的变量，然后把它跟布局文件中声明的变量进行绑定。

### **定义 Variable** ###

回到布局文件，在 data 节点中声明一个 User 类型的变量 user。

其中 type 属性就是我们在 Java 文件中定义的 User 类。  
当然，data 节点也支持 import，所以上面的代码可以换一种形式来写。

然后我们刚才在 build.gradle 中添加的那个插件 - com.android.databinding 会根据 xml 文件的名称 Generate 一个继承自 ViewDataBinding 的类。 当然，IDE 中看不到这个文件，需要手动去 build 目录下找。  
例如，这里 xml 的文件名叫 activity\_basic.xml，那么生成的类就是 ActivityBasicBinding。

注意  
java.lang.\* 包中的类会被自动导入，可以直接使用，例如要定义一个 String 类型的变量：

### **绑定 Variable** ###

修改 BasicActivity 的 onCreate 方法，用 DatabindingUtil.setContentView() 来替换掉 setContentView()，然后创建一个 user 对象，通过 binding.setUser(user) 与 variable 进行绑定。

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ActivityBasicBinding binding = DataBindingUtil.setContentView(
                this, R.layout.activity_basic);
        User user = new User("fei", "Liang");
        binding.setUser(user);
    }

除了使用框架自动生成的 ActivityBasicBinding，我们也可以通过如下方式自定义类名。

注意

ActivityBasicBinding 类是自动生成的，所有的 set 方法也是根据 variable 名称生成的。例如，我们定义了两个变量。

那么就会生成对应的两个 set 方法。

setFirstName(String firstName);
    setLastName(String lastName);

### **使用 Variable** ###

数据与 Variable 绑定之后，xml 的 UI 元素就可以直接使用了。

至此，一个简单的数据绑定就完成了，可参考完整代码.

## **高级用法** ##

### **使用类方法** ###

首先定义一个静态方法

public class MyStringUtils {
        
        public static String capitalize(final String word) {
            if (word.length() > 1) {
                return String.valueOf(word.charAt(0)).toUpperCase() + word.substring(1);
            }
            return word;
        }
    }

然后在 xml 的 data 节点中导入：

使用方法与 Java 语法一样：

### **类型别名** ###

如果我们在 data 节点了导入了两个同名的类怎么办？

这样一来出现了两个 User 类，那 user 变量要用哪一个呢？不用担心，import 还有一个 alias 属性。

### **Null Coalescing 运算符** ###

android:text="@{user.displayName ?? user.lastName}"

就等价于

android:text="@{user.displayName != null ? user.displayName : user.lastName}"

### **属性值** ###

通过 @\{\} 可以直接把 Java 中定义的属性值赋值给 xml 属性。

使用资源数据  
这个例子，官方教程有错误，可以参考Android Data Binder 的一个bug，完整代码在此

### **Observable Binding** ###

本来这一节的标题应该叫双向绑定，但是很遗憾，现在的 Data Binding 暂时支持单向绑定，还没有达到 Angular.js 的威力。

要实现 Observable Binding，首先得有一个 implement 了接口 android.databinding.Observable 的类，为了方便，Android 原生提供了已经封装好的一个类 - BaseObservable，并且实现了监听器的注册机制。

我们可以直接继承 BaseObservable。

public class ObservableUser extends BaseObservable {
        
        private String firstName;
        private String lastName;
    
        @Bindable
        public String getFirstName() {
            return firstName;
        }
    
        @Bindable
        public String getLastName() {
            return lastName;
        }
    
        public void setFirstName(String firstName) {
            this.firstName = firstName;
            notifyPropertyChanged(BR.firstName);
        }
    
        public void setLastName(String lastName) {
            this.lastName = lastName;
            notifyPropertyChanged(BR.lastName);
        }
    }

BR 是编译阶段生成的一个类，功能与 R.java 类似，用 @Bindable 标记过 getter 方法会在 BR 中生成一个 entry。

通过代码可以看出，当数据发生变化时还是需要手动发出通知。 通过调用 notifyPropertyChanged(BR.firstName) 可以通知系统 BR.firstName 这个 entry 的数据已经发生变化，需要更新 UI。

除此之外，还有一种更细粒度的绑定方式，可以具体到成员变量，这种方式无需继承 BaseObservable，一个简单的 POJO 就可以实现。

public class PlainUser {
        
        public final ObservableField<String> firstName = new ObservableField<>();
        public final ObservableField<String> lastName = new ObservableField<>();
        public final ObservableInt age = new ObservableInt();
    }

系统为我们提供了所有的 primitive type 所对应的 Observable类，例如 ObservableInt、ObservableFloat、ObservableBoolean 等等，还有一个 ObservableField 对应着 reference type。

剩下的数据绑定与前面介绍的方式一样，具体可参考ObservableActivity。

### **带 ID 的 View** ###

Data Binding 有效降低了代码的冗余性，甚至完全没有必要再去获取一个 View 实例，但是情况不是绝对的，万一我们真的就需要了呢？不用担心，只要给 View 定义一个 ID，Data Binding 就会为我们生成一个对应的 final 变量。

上面代码中定义了一个 ID 为 firstName\* 的 TextView，那么它对应的变量就是

public final TextView firstName;

具体代码可参考 ViewWithIDsActivity.java

### **ViewStubs** ###

xml 中的 ViewStub 经过 binding 之后会转换成 ViewStubProxy, 具体代码可参考 ViewStubActivity.java

简单用代码说明一下，xml 文件与之前的代码一样，根节点改为 layout，在 LinearLayout 中添加一个 ViewStub，添加 ID。

在 Java 代码中获取 binding 实例，为 ViewStubProy 注册 ViewStub.OnInflateListener 事件：

binding = DataBindingUtil.setContentView(this, R.layout.activity_view_stub);
    binding.viewStub.setOnInflateListener(new ViewStub.OnInflateListener() {
        @Override
        public void onInflate(ViewStub stub, View inflated) {
            ViewStubBinding binding = DataBindingUtil.bind(inflated);
            User user = new User("fee", "lang");
            binding.setUser(user);
        }
    });

### **Dynamic Variables** ###

完整代码可以参考 dynamic

以 RecyclerView 为例，Adapter 的 DataBinding 需要动态生成，因此我们可以在 onCreateViewHolder 的时候创建这个 DataBinding，然后在 onBindViewHolder 中获取这个 DataBinding。

public static class BindingHolder extends RecyclerView.ViewHolder {
        
        private ViewDataBinding binding;
    
        public BindingHolder(View itemView) {
            super(itemView);
        }
    
        public ViewDataBinding getBinding() {
            return binding;
        }
    
        public void setBinding(ViewDataBinding binding) {
            this.binding = binding;
        }
    }
    
    @Override
    public BindingHolder onCreateViewHolder(ViewGroup viewGroup, int i) {
        ViewDataBinding binding = DataBindingUtil.inflate(
                LayoutInflater.from(viewGroup.getContext()),
                R.layout.list_item,
                viewGroup,
                false);
        BindingHolder holder = new BindingHolder(binding.getRoot());
        holder.setBinding(binding);
        return holder;
    }
    
    @Override
    public void onBindViewHolder(BindingHolder holder, int position) {
        User user = users.get(position);
        holder.getBinding().setVariable(BR.user, user);
        holder.getBinding().executePendingBindings();
    }

注意此处 DataBindingUtil 的用法：

ViewDataBinding binding = DataBindingUtil.inflate(
        LayoutInflater.from(viewGroup.getContext()),
        R.layout.list_item,
        viewGroup,
        false);

还有另外一种比较简洁的方式，直接在构造 Holder 时把 View 与自动生成的 XXXBinding 进行绑定。

public class UserAdapter extends RecyclerView.Adapter<UserAdapter.UserHolder> {
        
        private static final int USER_COUNT = 10;
    
        @NonNull
        private List<User> mUsers;
    
        public UserAdapter() {
            mUsers = new ArrayList<>(10);
            for (int i = 0; i < USER_COUNT; i ++) {
                User user = new User(RandomNames.nextFirstName(), RandomNames.nextLastName());
                mUsers.add(user);
            }
        }
    
        public static class UserHolder extends RecyclerView.ViewHolder {
        
            private UserItemBinding mBinding;
    
            public UserHolder(View itemView) {
                super(itemView);
                mBinding = DataBindingUtil.bind(itemView);
            }
    
            public void bind(@NonNull User user) {
                mBinding.setUser(user);
            }
        }
    
        @Override
        public UserHolder onCreateViewHolder(ViewGroup viewGroup, int i) {
            View itemView = LayoutInflater.from(viewGroup.getContext())
                    .inflate(R.layout.user_item, viewGroup, false);
            return new UserHolder(itemView);
        }
    
        @Override
        public void onBindViewHolder(UserHolder holder, int position) {
            holder.bind(mUsers.get(position));
        }
    
        @Override
        public int getItemCount() {
            return mUsers.size();
        }
    }

注意此处 DataBindingUtil 的用法：

ViewDataBinding binding = DataBindingUtil.inflate(
        LayoutInflater.from(viewGroup.getContext()),
        R.layout.list_item,
        viewGroup,
        false);

还有另外一种比较简洁的方式，直接在构造 Holder 时把 View 与自动生成的 XXXBinding 进行绑定。

### **Attribute setters** ###

有了 Data Binding，即使属性没有在 declare-styleable 中定义，我们也可以通过 xml 进行赋值操作。 为了演示这个功能，我自定义了一个 View - NameCard，属性资源 R.styleable.NameCard 中只定义了一个 age 属性，其中 firstName 和 lastName 只有对应的两个 setter 方法。

只要有 setter 方法就可以像下面代码一样赋值：

<com.liangfeizc.databindingsamples.attributesetters.UserView
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:paddingLeft="@dimen/largePadding"
        app:onClickListener="@{activity.clickListener}"
        app:firstName="@{@string/firstName}"
        app:lastName="@{@string/lastName}"
        app:age="27" />

onClickListener 也是同样道理，只不过我们是在 Activity 中定义了一个 Listener。

### **转换器 (Converters)** ###

> **非常重要**  
> 使用 Converter 一定要保证它不会影响到其他的属性，例如这个 @BindingConversion- convertColorToString 就会影响到android:visibility, 因为他们都是都符合从 int 到 int 的转换。

在 xml 中为属性赋值时，如果变量的类型与属性不一致，通过 DataBinding 可以进行转换。

例如，下面代码中如果要为属性 android:background 赋值一个 int 型的 color 变量：

@BindingConversion
    public static ColorDrawable convertColorToDrawable(int color) {
        return new ColorDrawable(color);
    }

[Android Data Binding]: https://github.com/LyndonChin/MasteringAndroidDataBinding