Android使用RecyclerView實現二級列表

hgDendi發表於2017-11-13
AndroidView

ExpanableRecyclerView

demo
demo

github:github.com/hgDendi/Exp…

自定義支援二級選單的RecyclerViewAdapter。

將展開閉合操作封裝在了BaseExpandableRecyclerViewAdapter中，使整個使用方式充滿彈性。

下方有具體使用方法，一般需要override 6個方法：

  • getGroupCount
  • getGroupItem
  • onCreateGroupViewHolder
  • onCreateChildViewHolder
  • onBindGroupViewHolder
  • onBindChildViewHolder

因為onCreateViewHolder和onBindViewHolder本來即是RecyclerViewAdapter需要強制Override的方法，這裡按父子關係拆分成了兩個方法。而getGroupCount和getGroupItem在大概率情況下都是基於List的簡單一行程式碼即可實現，故而使用起來十分簡便。

Gradle

dependencies{
    compile 'com.hgDendi:expandable-recyclerview-adapter:1.0.1'
}複製程式碼

優點

  1. 使用便捷、簡潔明瞭
  2. 最大程度保留RecyclerView的原生機制，滑動到具體條目才進行渲染，不會滑到另一個Group渲染另一個Group下所有子Item
  3. itemView的部分重新整理，可以自定義展開、閉合時的重新整理機制，避免GroupItem在展開閉合時重新整理整個GroupItem（比如只是簡單的箭頭指向改變）
  4. 採用泛型，使用者自定義傳入引數，擴充套件性更高

使用方法

定義父子資料結構

其中GroupBean需要繼承自BaseGroupBean並override三個方法。

  • getChildCount
    • 獲取子節點個數
  • isExpandable
    • 是否為可展開的節點
    • 預設實現可以是判斷子節點是否為0，但是也可以做其他處理
  • getChildAt
    • 根據index獲取對應的子節點資料結構
class SampleGroupBean implements BaseExpandableRecyclerViewAdapter.BaseGroupBean<SampleChildBean> {
    @Override
    public int getChildCount() {
        return mList.size();
    }

    // whether this group is expandable
    @Override
    public boolean isExpandable() {
        return getChildCount() > 0;
    }

      @Override
    public SampleChildBean getChildAt(int index) {
        return mList.size() <= index ? null : mList.get(index);
    }
}

public class SampleChildBean {
}複製程式碼

定義對應的ViewHolder

其中Group對應的ViewHolder要繼承BaseGroupViewHolder並改寫onExpandStatusChanged.

該方法是實現item區域性重新整理的方法，在展開、閉合時會回撥，比如對於大多數情況，開關閉合狀態只需要修改左邊箭頭指向，就無需重新整理itemView的其他部分。

實現原理是使用RecyclerView的payload機制實現區域性監聽重新整理。

static class GroupVH extends BaseExpandableRecyclerViewAdapter.BaseGroupViewHolder {
    GroupVH(View itemView) {
        super(itemView);
    }

    // this method is used for partial update.Which means when expand status changed,only a part of this view need to invalidate
    @Override
    protected void onExpandStatusChanged(RecyclerView.Adapter relatedAdapter, boolean isExpanding) {
      // 1.只更新左側展開、閉合箭頭
      foldIv.setImageResource(isExpanding ? R.drawable.ic_arrow_expanding : R.drawable.ic_arrow_folding);

      // 2.預設重新整理整個Item
      relatedAdapter.notifyItemChanged(getAdapterPosition());
    }
}

static class ChildVH extends RecyclerView.ViewHolder {
    ChildVH(View itemView) {
        super(itemView);
    }
}複製程式碼

使用自定義Adapter繼承基類

// !!注意這裡繼承時候使用的泛型，分別為上面提到的Bean和ViewHolder
public class SampleAdapter extends BaseExpandableRecyclerViewAdapter
<SampleGroupBean, SampleChildBean, SampleAdapter.GroupVH, SampleAdapter.ChildVH>

    @Override
    public int getGroupCount() {
        // 父節點個數
    }

    @Override
    public GroupBean getGroupItem(int groupIndex) {
        // 獲取父節點
    }

    @Override
    public GroupVH onCreateGroupViewHolder(ViewGroup parent, int groupViewType) {
    }

    @Override
    public ChildVH onCreateChildViewHolder(ViewGroup parent, int childViewType) {
    }

    @Override
    public void onBindGroupViewHolder(GroupVH holder, SampleGroupBean sampleGroupBean, boolean isExpand) {
    }

    @Override
    public void onBindChildViewHolder(ChildVH holder, SampleGroupBean sampleGroupBean, SampleChildBean sampleChildBean) {
    }
}複製程式碼

其他用法

增加父子的種類

通過改寫getChildType和getGroupType方法進行控制type，該type會在onCreateGroupViewHolder和onCreateChildViewHolder時回傳。

protected int getGroupType(GroupBean groupBean) {
    return 0;
}

abstract public GroupViewHolder onCreateGroupViewHolder(ViewGroup parent, int groupViewType);

protected int getChildType(GroupBean groupBean, ChildBean childBean) {
    return 0;
}

abstract public ChildViewHolder onCreateChildViewHolder(ViewGroup parent, int childViewType);複製程式碼

增加列表為空時候的EmptyView

adapter.setEmptyViewProducer(new ViewProducer() {
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent) {
        View emptyView = LayoutInflater.from(parent.getContext()).inflate(R.layout.empty, parent, false);
        return new DefaultEmptyViewHolder(emptyView);
    }

    @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder) {
    }
});複製程式碼

增加HeaderView

adapter.setEmptyViewProducer(new ViewProducer() {
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent) {
        View emptyView = LayoutInflater.from(parent.getContext()).inflate(R.layout.header, parent, false);
        return new DefaultEmptyViewHolder(emptyView);
    }

    @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder) {
    }
},false);複製程式碼

監聽事件

可以通過setListener的方式設定監聽事件。

public interface ExpandableRecyclerViewOnClickListener<GroupBean extends BaseGroupBean, ChildBean> {

        /**
         * 長按時的操作
         *
         * @param groupItem
         * @return
         */
        boolean onGroupLongClicked(GroupBean groupItem);

        /**
         * 在可展開group被點選的時候觸發的回撥，返回布林值表示是否攔截該操作
         *
         * @param groupItem
         * @param isExpand
         * @return true 使點選無效。false 正常執行展開、閉合操作。
         */
        boolean onInterceptGroupExpandEvent(GroupBean groupItem, boolean isExpand);

        /**
         * 點選GroupView時的操作(該Group的isExpandable返回false才會觸發這個回撥)
         *
         * @param groupItem
         */
        void onGroupClicked(GroupBean groupItem);

        /**
         * 點選子View時的操作
         *
         * @param groupItem
         * @param childItem
         */
        void onChildClicked(GroupBean groupItem, ChildBean childItem);
    }複製程式碼

實現原理

父子結構劃分

  1. 通過getItemType判斷所處型別，在基類中就先劃分為四種型別的View。
private static final int TYPE_EMPTY = ViewProducer.VIEW_TYPE_EMPTY;
private static final int TYPE_HEADER = ViewProducer.VIEW_TYPE_HEADER;
private static final int TYPE_GROUP = ViewProducer.VIEW_TYPE_EMPTY >> 2;
private static final int TYPE_CHILD = ViewProducer.VIEW_TYPE_EMPTY >> 3;
private static final int TYPE_MASK = TYPE_GROUP | TYPE_CHILD | TYPE_EMPTY | TYPE_HEADER;

// 通過getItemView判斷型別，這裡預設是使用上面定義的MASK，可以過載使Group和Child中再劃分子類，但是不允許和TYPE_MASK衝突，否則會報Exception
@Override
public final int getItemViewType(int position) {
    if (mIsEmpty) {
        return position == 0 && mShowHeaderViewWhenEmpty ? TYPE_HEADER : TYPE_EMPTY;
    }
    if (position == 0 && mHeaderViewProducer != null) {
        return TYPE_HEADER;
    }
    int[] coord = translateToDoubleIndex(position);
    GroupBean groupBean = getGroupItem(coord[0]);
    if (coord[1] < 0) {
        int groupType = getGroupType(groupBean);
        if ((groupType & TYPE_MASK) == 0) {
            return groupType | TYPE_GROUP;
        } else {
            throw new IllegalStateException(
                String.format(Locale.getDefault(), "GroupType [%d] conflits with MASK [%d]", groupType, TYPE_MASK));
        }
    } else {
        int childType = getChildType(groupBean, groupBean.getChildAt(coord[1]));
        if ((childType & TYPE_MASK) == 0) {
            return childType | TYPE_CHILD;
        } else {
            throw new IllegalStateException(
                String.format(Locale.getDefault(), "ChildType [%d] conflits with MASK [%d]", childType, TYPE_MASK));
        }
    }
}複製程式碼
  1. 在onCreateViewHolder和onBindViewHolder中進行型別判斷，呼叫不同的方法，這些方法在子類中進行過載。注意這裡將這三個方法都置為final，防止子類過載，子類只能過載對應不同type的具體方法。
@Override
public final RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
    switch (viewType & TYPE_MASK) {
        case TYPE_EMPTY:
            return mEmptyViewProducer.onCreateViewHolder(parent);
        case TYPE_HEADER:
            return mHeaderViewProducer.onCreateViewHolder(parent);
        case TYPE_CHILD:
            return onCreateChildViewHolder(parent, viewType ^ TYPE_CHILD);
        case TYPE_GROUP:
            return onCreateGroupViewHolder(parent, viewType ^ TYPE_GROUP);
        default:
            throw new IllegalStateException(
                String.format(Locale.getDefault(), "Illegal view type : viewType[%d]", viewType));
    }
}

@Override
public final void onBindViewHolder(final RecyclerView.ViewHolder holder, int position) {
    onBindViewHolder(holder, position, null);
}

@Override
public final void onBindViewHolder(RecyclerView.ViewHolder holder, int position, List<Object> payloads) {
    switch (holder.getItemViewType() & TYPE_MASK) {
        case TYPE_EMPTY:
            mEmptyViewProducer.onBindViewHolder(holder);
            break;
        case TYPE_HEADER:
            mHeaderViewProducer.onBindViewHolder(holder);
            break;
        case TYPE_CHILD:
            final int[] childCoord = translateToDoubleIndex(position);
            GroupBean groupBean = getGroupItem(childCoord[0]);
            bindChildViewHolder((ChildViewHolder) holder, groupBean, groupBean.getChildAt(childCoord[1]), payloads);
            break;
        case TYPE_GROUP:
            bindGroupViewHolder((GroupViewHolder) holder,
                getGroupItem(translateToDoubleIndex(position)[0]), payloads);
            break;
        default:
            throw new IllegalStateException(
                String.format(Locale.getDefault(), "Illegal view type : position [%d] ,itemViewType[%d]", position, holder.getItemViewType()));
    }
}複製程式碼

展開閉合操作

操作

當groupBean的isExpandable返回true的時候，為itemView設定點選事件，進行展開閉合。

展開閉合的具體原理是在Set中記錄展開閉合情況，當發生展開、閉合操作的時候進行更新，並使用notifyItemChange介面進行列表的區域性重新整理。

private Set<GroupBean> mExpandGroupSet;

protected void bindGroupViewHolder(final GroupViewHolder holder, final GroupBean groupBean, List<Object> payload) {
      // ...
    if (!groupBean.isExpandable()) {
      // ...
    } else {
        holder.itemView.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                final boolean isExpand = mExpandGroupSet.contains(groupBean);
                if (mListener == null || !mListener.onInterceptGroupExpandEvent(groupBean, isExpand)) {
                final int adapterPosition = holder.getAdapterPosition();
                holder.onExpandStatusChanged(BaseExpandableRecyclerViewAdapter.this, !isExpand);
                    if (isExpand) {
                        mExpandGroupSet.remove(groupBean);
                        notifyItemRangeRemoved(adapterPosition + 1, groupBean.getChildCount());
                    } else {
                        mExpandGroupSet.add(groupBean);
                        notifyItemRangeInserted(adapterPosition + 1, groupBean.getChildCount());
                    }
                }
            }
        });
    }
      // 子類實現
    onBindGroupViewHolder(holder, groupBean, isGroupExpand(groupBean));
}複製程式碼

區域性重新整理原理

定義了Payload，採用Payload機制進行區域性重新整理。

在notifyItemChange時傳入payload，在onBindViewHolder操作中判斷是否帶有payload，若帶有payload，則執行部分重新整理的操作。

private static final Object EXPAND_PAYLOAD = new Object();

// 區域性重新整理時呼叫的介面(已封裝好，使用者無需呼叫)
notifyItemChanged(position, EXPAND_PAYLOAD);

// 處理payload
protected void bindGroupViewHolder(final GroupViewHolder holder, final GroupBean groupBean, List<Object> payload) {
    if (payload != null && payload.size() != 0) {
        if (payload.contains(EXPAND_PAYLOAD)) {
              // holder方法有抽象方法，在此方法中實現具體的展開、閉合邏輯
            holder.onExpandStatusChanged(BaseExpandableRecyclerViewAdapter.this, isGroupExpand(groupBean));
            if (payload.size() == 1) {
                return;
            }
        }
    onBindGroupViewHolder(holder, groupBean, isGroupExpand(groupBean), payload);
    return;
    }
}複製程式碼

License

MIT

rem.mit-license.org/

相關文章