MVVM架构之自动增删改的极简RecycleView的实现

本文首发于微信公众号——世界上有意思的事，搬运转载请注明出处，否则将追究版权责任。微信号：a1018998632，交流qq群：859640274

介绍图

先上个源代码的链接：https://github.com/whenSunSet/MVVMRecycleView

RecycleView是Google替代ListView的一种方案，其有着很高的解耦度，让许多开发者抛弃了以往的ListView，那么RecycleView在MVVM架构下又该怎么实现呢？如何实现单条item刷新以及增减Item的自动刷新呢？今天我就要给大家带来一种方便的高解耦度的解决方案。

1.了解几个工具类

我们先来看几个我制作的工具类，这几个工具类可以一直复用。为啥要介绍他们呢，当然是为了让大家更好的了解内部的机制，在出现坑的时候不至于找不到解决方案，哈哈（当然我使用了这么久还没发现有坑）！

• 1.LayoutManager，这个类是用来提供布局的类型的，大家看看就明白了！

public class LayoutManager {

protected LayoutManager() {
}

public interface LayoutManagerFactory {
    RecyclerView.LayoutManager create(RecyclerView recyclerView);
}

public static LayoutManagerFactory linear() {
    return new LayoutManagerFactory() {
        @Override
        public RecyclerView.LayoutManager create(RecyclerView recyclerView) {
            return new LinearLayoutManager(recyclerView.getContext());
        }
    };
}

public static LayoutManagerFactory linear(@Orientation final int orientation, final boolean reverseLayout) {
    return new LayoutManagerFactory() {
        @Override
        public RecyclerView.LayoutManager create(RecyclerView recyclerView) {
            return new LinearLayoutManager(recyclerView.getContext(), orientation, reverseLayout);
        }
    };
}

public static LayoutManagerFactory grid(final int spanCount) {
    return new LayoutManagerFactory() {
        @Override
        public RecyclerView.LayoutManager create(RecyclerView recyclerView) {
            return new GridLayoutManager(recyclerView.getContext(), spanCount);
        }
    };
}

public static LayoutManagerFactory grid(final int spanCount, @Orientation final int orientation, final boolean reverseLayout) {
    return new LayoutManagerFactory() {
        @Override
        public RecyclerView.LayoutManager create(RecyclerView recyclerView) {
            return new GridLayoutManager(recyclerView.getContext(), spanCount, orientation, reverseLayout);
        }
    };
}

public static LayoutManagerFactory staggeredGrid(final int spanCount, @Orientation final int orientation) {
    return new LayoutManagerFactory() {
        @Override
        public RecyclerView.LayoutManager create(RecyclerView recyclerView) {
            return new StaggeredGridLayoutManager(spanCount, orientation);
        }
    };
}

@IntDef({LinearLayoutManager.HORIZONTAL, LinearLayoutManager.VERTICAL})
@Retention(RetentionPolicy.SOURCE)
public @interface Orientation {
}

}

• 2.ItemViewArg:这个类用于提供每个item界面的xml的id和BR中绑定实例的id

    public class ItemViewArg {
        public static  ItemViewArg of(ItemView itemView) {
            return new ItemViewArg<>(itemView);
        }
  
        public static  ItemViewArg of(ItemViewSelector selector) {
            return new ItemViewArg<>(selector);
        }
  
        private final ItemView itemView;
        private final ItemViewSelector selector;
  
        private ItemViewArg(ItemView itemView) {
            this.itemView = itemView;
            this.selector = new ItemViewSelector() {
                @Override
                public void select(ItemView itemView, int position, T item) {
  
                }
  
                @Override
                public int viewTypeCount() {
                    return 1;
                }
            };
        }
    
        private ItemViewArg(ItemViewSelector selector) {
            this.itemView = new ItemView();
            this.selector = selector;
        }
    
        public void select(int position, T item) {
            selector.select(itemView, position, item);
        }
    
        public int bindingVariable() {
            return itemView.bindingVariable();
        }
    
        public int layoutRes() {
            return itemView.layoutRes();
        }
    
        public int viewTypeCount() {
            return selector.viewTypeCount();
        }
    
        @Override
        public boolean equals(Object o) {
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;
    
            ItemViewArg that = (ItemViewArg) o;
    
            if (!itemView.equals(that.itemView)) return false;
            return selector == that.selector;
        }
  
        @Override
        public int hashCode() {
            int result = itemView.hashCode();
            result = 31 * result + selector.hashCode();
            return result;
        }
    
        public interface ItemViewSelector {
    
            void select(ItemView itemView, int position, T item);
    
    
            int viewTypeCount();
        }
    
        public static class ItemView {
    
            public static final int BINDING_VARIABLE_NONE = 0;
    
            private int bindingVariable;
            @LayoutRes
            private int layoutRes;
    
    
                public static ItemView of(int bindingVariable, @LayoutRes int layoutRes) {
                return new ItemView().setBindingVariable(bindingVariable).setLayoutRes(layoutRes);
            }
  
            public ItemView set(int bindingVariable, @LayoutRes int layoutRes) {
                this.bindingVariable = bindingVariable;
                this.layoutRes = layoutRes;
                return this;
            }
    
  
            public ItemView setBindingVariable(int bindingVariable) {
                this.bindingVariable = bindingVariable;
                return this;
            }
  
            public ItemView setLayoutRes(@LayoutRes int layoutRes) {
                this.layoutRes = layoutRes;
                return this;
            }
    
            public int bindingVariable() {
                return bindingVariable;
            }
    
            @LayoutRes
            public int layoutRes() {
                return layoutRes;
            }
    
            @Override
            public boolean equals(Object o) {
                if (this == o) return true;
                if (o == null || getClass() != o.getClass()) return false;
  
                ItemView itemView = (ItemView) o;
    
                if (bindingVariable != itemView.bindingVariable) return false;
                return layoutRes == itemView.layoutRes;
            }
  
            @Override
            public int hashCode() {
                int result = bindingVariable;
                result = 31 * result + layoutRes;
                return result;
            }
        }
  
    }
  

这个类中有一个内部累和一个内部接口，接下来我将来介绍这个类。

- 1.先来看看内部类ItemView：该类有两个int字段，bindingVariable储存实例在BR中生成的id，layoutRes储存所需xml文件的id。其他的几个方法都是为这两个字段服务的，比较简单，大家看看应该就了解了。
- 2.再来看看内部接口ItemViewSelector：我们前面的内部类，只能提供一个布局给item，如果我的item有许多个布局怎么办的，这个接口就是用来解决这个问题。
    - 1.select(ItemView itemView, int position, T item)：这个方法是开发者自己实现的，item这个字段是咱么列表Item的ViewModel，里面储存着到底当前列表item的布局type。所以我们只要用判断item中布局的种类，然后调用itemView的of或者set方法，就能对列表item的布局进行选择。**其实总的说就是根据字段item中的参数来构造出不同的ItemView**
    - 2.viewTypeCount()：这个方法很简单，就是返回一下列表item所有布局的种类。
- 3.最后看看ItemViewArg：该类中储存着ItemView和ItemViewSelector的实体，我们在开发的时候只要传入一个实例另一个会自动生成。
    - 这其中最重要的一个方法就是select(int position, T item)，大家先记着这个方法，在后面我们整个流程串起来了之后，会讲到这个方法。        

• 3.BindingAdapters：用过databinding的人都知道，如果我想定义一个xml中能使用的字段，就得构造一个方法，这个类就是RecycleView在xml中字段设置的构造字段的方法。

    public class BindingAdapters {
        @SuppressWarnings("unchecked")
            @BindingAdapter(value = {"itemView", "items",  "itemIds","itemAnimator","itemDecor"}, requireAll = false)
        public static  void setAdapter(final RecyclerView recyclerView, ItemViewArg arg, final List items, BindingRecyclerViewAdapter.ItemIds itemIds,RecyclerView.ItemAnimator animator,RecyclerView.ItemDecoration decor) {
            if (arg == null) {
                throw new IllegalArgumentException("itemView must not be null");
            }
            BindingRecyclerViewAdapter adapter = new BindingRecyclerViewAdapter<>(arg);
            if (items!=null)adapter.setItems(items);
            if (itemIds!=null)adapter.setItemIds(itemIds);
            if (animator!=null)recyclerView.setItemAnimator(animator);
            if (decor!=null)recyclerView.addItemDecoration(decor);
            recyclerView.setAdapter(adapter);
  
        }
  
        @BindingAdapter("layoutManager")
        public static void setLayoutManager(RecyclerView recyclerView, LayoutManager.LayoutManagerFactory layoutManagerFactory) {
            recyclerView.setLayoutManager(layoutManagerFactory.create(recyclerView));
        }
  
        @BindingConversion
        public static ItemViewArg toItemViewArg(ItemViewArg.ItemView itemView) {
            return ItemViewArg.of(itemView);
        }
  
        @BindingConversion
        public static ItemViewArg toItemViewArg(ItemViewArg.ItemViewSelector selector) {
            return ItemViewArg.of(selector);
        }
  
    } 
  

让我来解释一下这几个方法：
- 1.setAdapter()：这一个方法中arg是在xml中必须设置的字段，其他都是可选字段，
- 1.arg我们在前面介绍过是为item提供界面id的实例。
- 2.items是为列表提供数据的实例。
- 3.animator是为item的增加删除提供动画的实例。
- 4.decor是为列表提供分割线的实例。
- 5.当然大家还可以为RecycleView设置更多的初始化的实例。
- 2.setLayoutManager()：我们前面提供了LayoutManager这个类来生成各种列表排布情况，这方法xml中的字段的构造字段函数。
- 3.两个toItemViewArg()是转换器，能够将ItemView和ItemViewSelector<>转换成ItemViewArg()，这样在xml中itemView字段中也可以填写ItemView和ItemViewSelector<>类型的实例了。

• 4.BindingRecyclerViewAdapter：这个类就是我们平时写RecycleView时要写的adapter，有了这个类之后，大家基本上不用碰adapter了，所有逻辑都能在item的ViewModel中进行。我们就来好好看看这个类。

public class BindingRecyclerViewAdapter extends RecyclerView.Adapter {

private static final Object DATA_INVALIDATION = new Object();

@NonNull
private final ItemViewArg itemViewArg;//item界面的layout，通过databing设置
private final WeakReferenceOnListChangedCallback callback = new WeakReferenceOnListChangedCallback<>(this);//数据list变化的时候的回调，设置在数据list中，如果list是ObservableList
private List items;//数据的list
private LayoutInflater inflater;//初始化item 界面；
// Currently attached recyclerview, we don't have to listen to notifications if null.
@Nullable
private RecyclerView recyclerView;

public BindingRecyclerViewAdapter(@NonNull ItemViewArg arg) {
    this.itemViewArg = arg;
}

@Override
public final RecyclerView.ViewHolder onCreateViewHolder(ViewGroup viewGroup, int layoutId) {
    if (inflater == null) {
        inflater = LayoutInflater.from(viewGroup.getContext());
    }
    ViewDataBinding binding = DataBindingUtil.inflate(inflater, layoutId, viewGroup, false);
    final RecyclerView.ViewHolder holder=new BindingViewHolder(binding);
    binding.addOnRebindCallback(new OnRebindCallback() {
        @Override
        public boolean onPreBind(ViewDataBinding binding) {
            return recyclerView != null && recyclerView.isComputingLayout();
        }

        @Override
        public void onCanceled(ViewDataBinding binding) {
            if (recyclerView == null || recyclerView.isComputingLayout()) {
                return;
            }
            int position = holder.getAdapterPosition();
            if (position != RecyclerView.NO_POSITION) {
                notifyItemChanged(position, DATA_INVALIDATION);
            }
        }
    });
    return holder;
}

@Override
public final void onBindViewHolder(RecyclerView.ViewHolder viewHolder, int position) {
    T item = items.get(position);
    ViewDataBinding binding = DataBindingUtil.getBinding(viewHolder.itemView);
    if (itemViewArg.bindingVariable() != ItemViewArg.ItemView.BINDING_VARIABLE_NONE) {
        boolean result = binding.setVariable(itemViewArg.bindingVariable(), item);
        if (!result) {
            Utils.throwMissingVariable(binding, itemViewArg.bindingVariable(), itemViewArg.layoutRes());
        }
        binding.executePendingBindings();
    }
}

@Override
public void onBindViewHolder(RecyclerView.ViewHolder holder, int position, List