RecyclerView中DataBinding的使用

为什么要使用DataBinding

在不支援DataBinding之前，数据和UI间的更新需要依靠findViewById(), setText(), setVisibility(), setEnabled()等，稍微复杂的UI会充斥大量的毫无营养的代码；

通过DataBinding，可以使用声明式布局以及精简的代码来绑定应用程序逻辑和布局。
DataBinding基础

1. 让Module支援DataBinding

在Module的build.gradle中支援DataBinding

android {  
    dataBinding {
        enabled true    
    }
}

2. layout修改

支援了DataBinding以后，layout文件就不再是单纯的UI元素展示，还需要定义UI元素用到的变量，所以根节点也需要改变，不再是一个ViewGroup，而是layout，并且新增了一个data节点

<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
    </data>
    <!-- 原来的根节点 -->
    <LinearLayout>
    ...
    </LinearLayout>
<layout>

3. 实现数据对象

public class Fruit {
    private String name;
    private int imageId;
    
    public Fruit( String name, int imageId ) {
        this.name = name;
        this.imageId = imageId;
    }
    
    public String getName() {
        return name;
    }
    
    public int getImageId() {
        return imageId;
    }
}

4. 在layout中使用数据对象

<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <variable name="fruit" type="com.zenstudio.UISamples.Fruit"
    </data>
    <!-- 原来的根节点 -->
    <LinearLayout>
        <TextView
             android:text="@{fruit.name}"
         </TextView>
    </LinearLayout>
<layout>

5. 绑定数据

在enable了DataBinding以后，com.android.databinding会根据layout文件的名称产生一个继承自ViewDataBinding的类，名字规则是

fruit_item.xml --> FruitItemBinding

在MainActivity的onCreate中，产生出对应的binding对象，并把数据对象与binding对象绑定起来

@Override
protected void onCreate( Bundle savedInstanceState ) {
    super.onCreate( savedInstanceState );
    
    FruitItemBinding binding = DataBindingUtil.setContentView( this, R.layout.fruit_item );
    Fruit fruit = new Fruit( "Apple", R.drawable.apple_pic );
    binding.setFruit( fruit );
}

RecyclerView中的DataBinding

有了上面的基础以后，在RecyclerView中使用DataBinding稍有变化，我们在ViewHolder中进行binding对象的产生，以及数据对象的绑定

public class FruitRvAdapter extends RecyclerView.Adapter<FruitRvAdapter.ViewHolder> {
    private List<Fruit> mFruitList;
    
    public FruitRvAdapter(List<Fruit> mFruitList) {
        this.mFruitList = mFruitList;
    }

    @Override
    public ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from( parent.getContext()).inflate( R.layout.fruit_item, parent, false);
        final ViewHolder holder = new ViewHolder( view );
        return holder;
    }
    
    @Override
    public void onBindViewHolder(ViewHolder holder, int position) {
        Fruit fruit = mFruitList.get( position );
        holder.bind( fruit );
    }
    
    @Override
    public int getItemCount() {
        return mFruitList.size();
    }
    
    @BindingAdapter({"android:src"})
    public static void setImageResource( ImageView imageView, int resource ) {
        imageView.setImageResource( resource );
    }
    
    static class ViewHolder extends RecyclerView.ViewHolder {
        private FruitItemBinding mBinding;

        public ViewHolder(View itemView) {
            super(itemView);

            mBinding = DataBindingUtil.bind( itemView);
        }

        public void bind(@NonNull Fruit fruit ) {
            mBinding.setFruit( fruit );
        }
    }
}

上面的code对照没有DataBinding的RecyclerView的使用方式就可以清楚的看懂，其中需要重点强调的是

@BindingAdapter({"android:src"})
public static void setImageResource( ImageView imageView, int resource ) {
    imageView.setImageResource( resource );
}

这一段代码，为了说明这段代码的用途，我们先从没有DataBinding的情况下如何使用ImageId来更新ImageView的显示:

imageView.setImageResource( R.darwable.apple_pic );

而在使用DataBinding时，为了在xml中，android:src是不能以imageId作为参数的，为了可以支援:

<ImageView
    android:src="@{fruit.imageId}"
</ImageView>

我们就需要上面的BindingAdapter, 上面的BindingAdapter为android:src新增了multiple methods,有了这个API以后，我们就可以让android:src可以支援int类型的image id了。
动态更新UI

上面的Fruit class只是一个简单的POJO， 这样实现的DataBinding是无法做到UI的动态更新的( 当fruit的name或者imageId变化时，UI显示不会更新)，为了在data变化时，UI会动态更新，我们需要引入新的机制。

实现动态更新的方法比较多，比较简单且易扩展的方法如下：

public class Fruit extends BaseObservable {
    private String name;
    private int imageId;
    
    @Bindable
    public String getName() {
        return name;
    }
    
    @Bindable
    public int getImageId() {
        return imageId;
    }
    
    public void setName( String name ) {
        this.name = name;
        notifyPropertyChanged( BR.name );
    }
    
    public void setImageId( int imageId ) {
        this.imageId = imageId;
        notifyPropertyChanged( BR.imageId );
    }
}

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