MultiType 源码分析

MultiType 源码分析

---

前言

空闲时间不学习点什么真的是心慌慌的。这次就来分析分析 MultiType 这个三方库。挺不错的一个东西，也是我在好几个项目里用到的三方库。希望这个文章能够帮助到其他人吧，虽然希望渺茫~

---

MultiType 简介

MultiType 是对 RecyclerView 的 Adapter 的一个扩展，它把 面向 Adapter 编程变成了面向 ViewBinder 编程。之前的对于不同类型的 item 的处理，需要自己在 Adapter 中去手动区分手动处理，这样写出来的 Adapter 代码逻辑复杂不好维护，所有的 item 类型的处理都是在一块的；而 MultiType 对每种类型的 item，都有一个单独的 ViewBinder 去处理各自 item 的 ui 和代码逻辑，MultiType 通过继承并重写 RecyclerView 的 Adapter，把原本 Adapter 里边的对 item 的 ui 和 逻辑的处理，传递到了相应的 ViewBinder 中去处理，这样就把不同类型 item 的逻辑都单独封装在了 ViewBinder 里边。

这样处理的好处也是很明显的，它把不同类型的 item 都模块化了，便于不同类型 item 的修改替换组合。

---

MultiType 简单使用

1. 在 gradle 文件里引用

   implementation 'me.drakeet.multitype:multitype:3.5.0'

2. 创建一个数据模型

   public class TextItem {
   
       public final @NonNull String text;
   
       public TextItem(@NonNull String text) {
           this.text = text;
       }
   }
   
   

3. 创建一个类(ViewBinder)继承自 ItemViewBinder

   
   public class TextItemViewBinder extends ItemViewBinder {
   
       static class TextHolder extends RecyclerView.ViewHolder {
       
           private @NonNull final TextView text;
   
           TextHolder(@NonNull View itemView) {
               super(itemView);
               this.text = (TextView) itemView.findViewById(R.id.text);
           }
       }
   
       @NonNull @Override
       protected TextHolder onCreateViewHolder(@NonNull LayoutInflater inflater, @NonNull ViewGroup parent) {
           View root = inflater.inflate(R.layout.item_text, parent, false);
           return new TextHolder(root);
       }
   
       @Override
       protected void onBindViewHolder(@NonNull TextHolder holder, @NonNull TextItem textItem) {
           holder.text.setText("hello: " + textItem.text);
           Log.d("demo", "position: " + getPosition(holder));
           Log.d("demo", "adapter: " + getAdapter());
       }
   }
   
   

4. 创建 MultiTypeAdapter 并注册 ViewBinder

   
   public class SampleActivity extends AppCompatActivity {
   
       private MultiTypeAdapter adapter;
       private Items items;
   
       @Override 
       protected void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           setContentView(R.layout.activity_main);
           RecyclerView recyclerView = (RecyclerView) findViewById(R.id.list);
   
           adapter = new MultiTypeAdapter();
           adapter.register(TextItem.class, new TextItemViewBinder());
           adapter.register(ImageItem.class, new ImageItemViewBinder());
           adapter.register(RichItem.class, new RichItemViewBinder());
           recyclerView.setAdapter(adapter);
   
           TextItem textItem = new TextItem("world");
           ImageItem imageItem = new ImageItem(R.mipmap.ic_launcher);
           RichItem richItem = new RichItem("小艾大人赛高", R.mipmap.avatar);
   
           items = new Items();
           for (int i = 0; i < 20; i++) {
               items.add(textItem);
               items.add(imageItem);
               items.add(richItem);
           }
           adapter.setItems(items);
           adapter.notifyDataSetChanged();
       }
   }
   
   

---

MultiType 源码分析

MultiType 的工作流程分析（一对一）

我们一般情况下对 RecyclerView 的 item 的处理都是在 Adapter 里边处理的，但是 MultiType 却是在 ViewBinder 里边处理的，它是怎么把逻辑转换到 Viewbinder 里的？看了上边的简单使用的介绍，它实例化了 MultiTypeAdapter 这个适配器并且设置给了 RecyclerView，这个操作是常规操作，但是 item 逻辑就是到 ViewBinder 里边去了；再看这个 adapter，它提供了注册 ViewBinder 的方法，看上去这个 MultiTypeAdapter 好像并不简单，那就从它开始突破吧。。

看它的构造方法：

    public class MultiTypeAdapter extends RecyclerView.Adapter {

          private static final String TAG = "MultiTypeAdapter";
        
          private @NonNull List items;
          private @NonNull TypePool typePool;
        
        
          /**
           * Constructs a MultiTypeAdapter with an empty items list.
           */
          public MultiTypeAdapter() {
            this(Collections.emptyList());
          }
        
        
          /**
           * Constructs a MultiTypeAdapter with a items list.
           *
           * @param items the items list
           */
          public MultiTypeAdapter(@NonNull List items) {
            this(items, new MultiTypePool());
          }
        
        
          /**
           * Constructs a MultiTypeAdapter with a items list and an initial capacity of TypePool.
           *
           * @param items the items list
           * @param initialCapacity the initial capacity of TypePool
           */
          public MultiTypeAdapter(@NonNull List items, int initialCapacity) {
            this(items, new MultiTypePool(initialCapacity));
          }
        
        
          /**
           * Constructs a MultiTypeAdapter with a items list and a TypePool.
           *
           * @param items the items list
           * @param pool the type pool
           */
          public MultiTypeAdapter(@NonNull List items, @NonNull TypePool pool) {
            checkNotNull(items);
            checkNotNull(pool);
            this.items = items;
            this.typePool = pool;
          }
          ...
    }

可以看到，这几个构造方法最终都会调用 MultiTypeAdapter(@NonNull List items, @NonNull TypePool pool) 这个构造方法。这里以调用无参构造方法为例，当最终调用到此构造方法的时候，先判断参数合法性，然后 保存 数据集合 items 和 MultiTypePool 的实例

接下来再来看一下 MultiTypeAdapter#register(@NonNull Class clazz, @NonNull ItemViewBinder binder) 方法：

  public  void register(@NonNull Class clazz, @NonNull ItemViewBinder binder) {
    checkNotNull(clazz);
    checkNotNull(binder);
    checkAndRemoveAllTypesIfNeeded(clazz);
    register(clazz, binder, new DefaultLinker());
  }


   void register(
      @NonNull Class clazz,
      @NonNull ItemViewBinder binder,
      @NonNull Linker linker) {
    typePool.register(clazz, binder, linker);
    binder.adapter = this;
  }

这个方法里，主要是调用 MultiTypePool 的 register 方法去注册 viewBinder，并且把 adapter 保存到 ViewBinder 里。

这里还有个需要注意的地方，checkAndRemoveAllTypesIfNeeded(clazz); 这个方法，会调用 MultiTypePool 的 unregister 方法，如果取消注册成功了，说明之前的实体类已经绑定过 ViewBinder 了，如果再注册这个实体类的话，之前的绑定会被删除，然后绑定新的 ViewBinder。

这里先简单介绍一下 MultiTypePool，他是一个类型池，里边维护了三个数组，分别保存数据模型的类型、与数据模型绑定的 Viewbinder、链接前边两者的一个数据类型对象。ViewBinder 的注册和取消注册其实就是对 MultiTypePool 里这三个数组的添加删除操作。

我们都知道，对一个常规的 RecyclerView 的 Adapter 的处理流程：实现 onCreateViewHolder、onBindViewHolder、getItemViewType、getItemCount。接下来看看 MultiTypeAdapter 是怎么处理这几个方法的：

  
  @Override
  public final int getItemViewType(int position) {
    Object item = items.get(position);
    return indexInTypesOf(position, item);
  }
  
  int indexInTypesOf(int position, @NonNull Object item) throws BinderNotFoundException {
    int index = typePool.firstIndexOf(item.getClass());
    if (index != -1) {
      @SuppressWarnings("unchecked")
      Linker