MultiItem 用法与详解 - 优雅的实现多类型 RecyclerView Adapter

   <h2>前言</h2>    <p>RecyclerView 是一个大家常用的列表控件，在列表中不免会出现多种类型的布局，这时 adapter 中多种类型的判断就会充满着 switch 的坏味道，可怕的是需求变更，增加或修改新的类型时，所有的改动都在 adapter 中进行，没有一个良好的扩展性。</p>    <p>MutliItem 主要就是解决这些问题，在正常使用中做到了 Adapter 零编码，解放了复杂的 Adapter 类，本库提供了多类型和 ViewHolder 创建绑定的管理器，这样 Adapter 通过依赖倒置与列表中的多类型解耦，还提高了扩展性。在本库中不同实体类可以直接当成数据源绑定到 adapter 中，你不用去担心 item type 的计算，并且对每种类型的 ViewHolder 也做到了隔离。</p>    <p>本库的定位并不是大而全，但是会尽量做到简单易用。</p>    <h2>源码地址</h2>    <p>Github地址： MultiItem ，请大家多多关注，更多更新会首先在GitHub上体现，也会在第一时间在本平台发布</p>    <h2>效果截图</h2>    <p style="text-align:center"><img src="https://simg.open-open.com/show/cafb5478c2b815d9a4e6a993f33237a0.png"></p>    <p style="text-align:center">multi_item</p>    <p style="text-align:center"><img src="https://simg.open-open.com/show/4152f5b31dc1de9e63cc9f6b417668eb.png"></p>    <p style="text-align:center">chat</p>    <h2>下一步要做什么</h2>    <ul>     <li>任务面板 跨 RecyclerView 的 Item 拖动 支持双击缩小后拖动（仿协同办公软件）</li>     <li>增加 header footer line 等一些可复用视图</li>     <li>DataBinding特性支持</li>     <li>录入界面的复用和封装的demo代码（录入业务较多同学可以多多关注）</li>     <li>思考动画分割线等一些功能封装</li>    </ul>    <h2>用法</h2>    <p>添加依赖</p>    <ul>     <li>配置gradle：</li>    </ul>    <p>在 Project root 的 build.gradle 中添加：</p>    <pre>  <code class="language-java">allprojects {      repositories {          ...          maven { url 'https://jitpack.io' }      }  }</code></pre>    <p>在 Module 中添加：</p>    <pre>  <code class="language-java">dependencies {      compile 'com.github.free46000:MultiItem:0.9.1'  }</code></pre>    <ul>     <li>或者你也可以直接克隆源码</li>    </ul>    <p>多种类型列表用法</p>    <p>这里由于单一和多种类型写法上没有差别，所以就不单独贴出单一类型的列表代码了。</p>    <p>注册多种类型 ViewHolderManager ，并为 adapter 设置多种类型数据源:</p>    <pre>  <code class="language-java">//初始化adapter  BaseItemAdapter adapter = new BaseItemAdapter();  //为TextBean数据源注册ViewHolderManager管理类  adapter.register(TextBean.class, new TextViewManager());  //为更多数据源注册ViewHolderManager管理类  adapter.register(ImageTextBean.class, new ImageAndTextManager());  adapter.register(ImageBean.class, new ImageViewManager());    //组装数据源list  List<Object> list = new ArrayList<>();  list.add(new TextBean("AAA"));  list.add(new ImageBean(R.drawable.img1));  list.add(new ImageTextBean(R.drawable.img2, "BBB" + i));    //为adapter注册数据源list  adapter.setDataItems(list);    recyclerView.setAdapter(adapter);</code></pre>    <p>ViewHolder 管理类的子类 TextViewManager 类，其他类相似，下面贴出本类全部代码，是不是非常清晰：</p>    <pre>  <code class="language-java">public class ImageViewManager extends BaseViewHolderManager<ImageBean> {        @Override      public void onBindViewHolder(BaseViewHolder holder, ImageBean data) {          //在指定viewHolder中获取控件为id的view          ImageView imageView = getView(holder, R.id.image);          imageView.setImageResource(data.getImg());      }        @Override      protected int getItemLayoutId() {          //返回item布局文件id          return R.layout.item_image;      }  }</code></pre>    <p>至此本库的多种类型列表用法已经完成，并没有修改或继承 RecyclerView Adapter 类，完全使用默认实现 BaseItemAdapter 即可。</p>    <p>相同数据源对应多个ViewHolder（聊天界面）</p>    <p>这是一种特殊的需求，需要在运行时通过数据源中的某个属性，判断加载的布局，典型的就是聊天功能，相同消息数据对应左右两种气泡视图，在此处贴出注册时的关键代码，其他和多种类型列表类似：</p>    <pre>  <code class="language-java">//初始化adapter  BaseItemAdapter adapter = new BaseItemAdapter();    //为XXBean数据源注册XXManager管理类组合  adapter.register(MessageBean.class, new ViewHolderManagerGroup<MessageBean>(new SendMessageManager(), new ReceiveMessageManager()) {      @Override      public int getViewHolderManagerIndex(MessageBean itemData) {          //根据message判断是否本人发送并返回对应ViewHolderManager的index值          return itemData.getSender().equals(uid) ? 0 : 1;      }  });    recyclerView.setAdapter(adapter);</code></pre>    <p>设置点击监听</p>    <p>点击监听：</p>    <pre>  <code class="language-java">adapter.setOnItemClickListener(new OnItemClickListener() {      @Override      public void onItemClick(BaseViewHolder viewHolder) {          //通过viewHolder获取需要的数据          toastUser(String.format("你点击了第%s位置的数据：%s", viewHolder.getItemPosition()          , viewHolder.getItemData()));      }  });</code></pre>    <p>长按监听：</p>    <pre>  <code class="language-java">adapter.setOnItemLongClickListener(new OnItemLongClickListener() {      @Override      public void onItemLongClick(BaseViewHolder viewHolder) {          //通过viewHolder获取需要的数据          toastUser(String.format("你长按了第%s位置的数据：%s", viewHolder.getItemPosition()                  , viewHolder.getItemData()));      }  });</code></pre>    <h2>详解</h2>    <p>主要流程</p>    <ul>     <li>为指定的数据源注册 ViewHolderManager 提供视图创建绑定等工作</li>     <li>在列表创建的过程中通过数据源在 ItemTypeManager 找到对应的 ViewHolderManager</li>     <li>按照需要创建与刷新视图并对视图做一些通用处理</li>    </ul>    <p>ViewHolder管理</p>    <p>ViewHolder管理源码类为 ViewHolderManager ，使用者会首先注册数据源和本实例的对应关系，由类型管理类提供统一管理。</p>    <ul>     <li>提供了参数类，会在 adapter 调用本类方法的时候传入并做出通用处理</li>     <li>本类的设计使用泛型，是为了在后续回调方法中有更直观的类型体现，这也是强类型和泛型带来的好处，给人在编写代码的时候带来确定感</li>     <li>本类为抽象类需要重写 ViewHolder 的创建与绑定方法，为了方便后续使用，写了一个简单的 BaseViewHolderManager 实现类，请读者根据业务自行决定是否需要使用更灵活的基类，这里贴出需要复写的两个方法，延续了 Adapter 中的命名规则，在使用中减少一些认知成本：</li>    </ul>    <pre>  <code class="language-java">/**   * 创建ViewHolder   * {@link android.support.v7.widget.RecyclerView.Adapter#onCreateViewHolder}   */  @NonNull  public abstract V onCreateViewHolder(@NonNull ViewGroup parent);    /**   * 为ViewHolder绑定数据   * {@link android.support.v7.widget.RecyclerView.Adapter#onBindViewHolder}   *   * @param t 数据源   */  public abstract void onBindViewHolder(@NonNull V holder, @NonNull T t);</code></pre>    <p>ViewHolder管理组合(相同数据源对应多个ViewHolderManager)</p>    <p>组合管理源码类为 ViewHolderManagerGroup ，本实例需要一个 ViewHolderManager 集合，并增加通过数据源指定哪个 ViewHolderManager 的方法，使用者同样会注册数据源和本实例的对应关系，由类型管理类对本类中的 ViewHolderManager 集合进行统一注册管理。下面贴出关键代码：</p>    <pre>  <code class="language-java">private ViewHolderManager[] viewHolderManagers;    /**   * @param viewHolderManagers 相同数据源对应的所有ViewHolderManager   */  public ViewHolderManagerGroup(ViewHolderManager... viewHolderManagers) {      if (viewHolderManagers == null || viewHolderManagers.length == 0) {          throw new IllegalArgumentException("viewHolderManagers can not be null");      }      this.viewHolderManagers = viewHolderManagers;  }    /**   * 根据item数据源中的属性判断应该返回的对应viewHolderManagers的index值   *   * @param itemData item数据源   * @return index值应该是在viewHolderManagers数组有效范围内   */  public abstract int getViewHolderManagerIndex(T itemData);</code></pre>    <p>类型管理</p>    <p>类型管理源码类为 ItemTypeManager ，通过数据源 className List 和 viewHolderManager List 两组集合对类型进行管理，并对 Adapter 提供注册和对应关系查找等方法的支持，这里并没有把这个地方设计灵活，如果有一些变化还是希望可以在 ViewHolderManager 做出适配。</p>    <ul>     <li>数据源一对一 viewHolderManager 时比较简单，关键代码：</li>    </ul>    <pre>  <code class="language-java">/**   * 通过数据源`className List`和`viewHolderManager List`两组集合对类型进行管理   *   * @param cls     数据源class   * @param manager ViewHolderManager   * @see com.freelib.multiitem.adapter.BaseItemAdapter#register(Class, ViewHolderManager)   */  public void register(Class<?> cls, ViewHolderManager manager) {      register(getClassName(cls), manager);  }</code></pre>    <ul>     <li>数据源一对多 viewHolderManager 时，关键代码：</li>    </ul>    <pre>  <code class="language-java">/**   * 通过group获取一组ViewHolderManager循环注册，并生成不同的className作为标识<br>   * 其他类似{@link #register(Class, ViewHolderManager)}   *   * @param cls   数据源class   * @param group 多个ViewHolderManager的组合   * @see com.freelib.multiitem.adapter.BaseItemAdapter#register(Class, ViewHolderManagerGroup)   */  public void register(Class<?> cls, ViewHolderManagerGroup group) {      ViewHolderManager[] managers = group.getViewHolderManagers();      for (int i = 0, length = managers.length; i < length; i++) {          register(getClassNameFromGroup(cls, group, managers[i]), managers[i]);      }      itemClassNameGroupMap.put(getClassName(cls), group);  }</code></pre>    <p>希望大家会喜欢，多多留言交流</p>    <p> </p>    <p>来自：https://juejin.im/post/58d1d9d0128fe1006ca69b45</p>    <p> </p>