Android 又雙叒叕更新了: MergeAdapter

MergeAdapter

前幾天更新的 recyclerview-1.2.0-alpha02 中增加了一個新的類 MergeAdapter，這個類可以按照順序把幾個 adapter 合成一個新的 adapter。

一個常見的場景就是 RecycleView 加載更多的實現。

相信很多小夥伴都實現過類似的效果，我們通常會定義多個 ViewType, 在 getItemCount 中返回 item 數據的 size 再加上 2 (header 和 footer)。我們的 adapter 不僅要處理數據相關的邏輯，還要處理 header 和 footer 的邏輯，這樣會導致 adapter 的邏輯變得複雜。

有了 MergeAdapter 之後我們可以把原來的 adapter 分成 HeaderAdapter ItemAdapter 和 FooterAdapter, 使用 MergeAdapter 合成一個之後再給 RecyclerView，這樣每個 Adapter 的分工就比較明確，代碼邏輯更加清晰。

我們看一下具體的實現。

headerAdapter = HeaderAdapter(this)
itemAdapter = ItemAdapter(this)
footerAdapter = FooterAdapter(this)
mergeAdapter = MergeAdapter(headerAdapter, itemAdapter, footerAdapter)

val layoutManager = LinearLayoutManager(this)
binding.recyclerView.layoutManager = layoutManager
binding.recyclerView.adapter = mergeAdapter

我們可以看到使用上跟以前沒有太大差別，無非就是把原來的 adapter 換成 mergeAdapter, mergeAdapter 由多個 adapter 按順序合成。

更新數據的時候我們只需要更新相應的 adapter,比如加載數據之後我們需要更新 ItemAdapter, 如果沒有數據了我們更新 FooterAdapter。

我們在 viewModel 中更新數據，在 activity 中觀察相應數據變化通知對應的 adapter。

MainActivity.kt

viewModel.data.observe(this, Observer {
    itemAdapter.addItem(it)
})
viewModel.hasMoreState.observe(this, Observer {
    footerAdapter.updateFooterState(it)
})

MainViewModel.kt

fun loadMore() {
    viewModelScope.launch {
        var newData = listOf<Int>()
        var newHasMoreState = FooterAdapter.STATE_LOADING
        // 模擬網絡延遲
        withContext(Dispatchers.Default) {
            delay(2000)
            newData = arrayListOf(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
            if (page >= 1) {
                newHasMoreState = FooterAdapter.STATE_COMPLETE
            }
        }
        hasMoreState.value = newHasMoreState
        data.value = newData
        page++
    }
}

這樣整個數據的更新邏輯就比較清晰，每個 adapter 的職責相對明確，不同 adapter 之間互不影響，假如某次改版之後我們不需要header了，只需要去掉 HeaderAdapter 即可，對 ItemAdapter 和 FooterAdapter 完全沒有影響。

原理

那麼問題來了，爲什麼我們更新了 ItemAdapter 列表就會更新呢？

我們知道 recyclerView 真正的 adapter 是 mergeAdapter，只有 mergeAdapter 的更新纔會讓 recycleView 更新，MergeAdapter 是如何實現這些功能的呢？我們來看一下 MergeAdapter 的實現。

public final class MergeAdapter extends Adapter<ViewHolder> {
    static final String TAG = "MergeAdapter";
    /**
     * Bulk of the logic is in the controller to keep this class isolated to the public API.
     */
    private final MergeAdapterController mController;

    // other code
}

我們看到 MergeAdapter 跟別的 Adapter 沒什麼不同，也是繼承者 Adapter，但是裏面有 MergerAdapterController，所有的魔法都在 mController 裏面。

我們以 getItemCount 爲例看一下 mController 有什麼作用。

@Override
public int getItemCount() {
    return mController.getTotalCount();
}

mergeAdapter 的 getItemCount 實際上調用的是 mController的 getTotalCount，我們再進到 getTotalCount 方法裏面看看

public int getTotalCount() {
    // should we cache this as well ?
    int total = 0;
    for (NestedAdapterWrapper wrapper : mWrappers) {
        total += wrapper.getCachedItemCount();
    }
    return total;
}

getTotalCount 方法遍歷 wrapper 把 cachedItemCount 加起來。每個 wrapper 持有 adapter，cachedItemCount 就是 adapter.getItemCount()，所以實際上 getTotalCount 方法就是把所有的 adapter 的 itemCount 加起來。

那麼回到上一個問題，爲什麼 ItemAdapter 的更新會導致 MergeAdapter 的更新。

NestedAdapterWrapper(
        Adapter<ViewHolder> adapter,
        final Callback callback,
        ViewTypeStorage viewTypeStorage,
        StableIdStorage.StableIdLookup stableIdLookup) {
    this.adapter = adapter;
    mCallback = callback;
    mViewTypeLookup = viewTypeStorage.createViewTypeWrapper(this);
    mStableIdLookup = stableIdLookup;
    mCachedItemCount = this.adapter.getItemCount();
    this.adapter.registerAdapterDataObserver(mAdapterObserver);
}

我們看到 NestedAdapterWrapper 的構造方法中會爲 adapter 註冊 observer

private RecyclerView.AdapterDataObserver mAdapterObserver =
new RecyclerView.AdapterDataObserver() {
    @Override
    public void onChanged() {
        mCachedItemCount = adapter.getItemCount();
        mCallback.onChanged(NestedAdapterWrapper.this);
    }
    @Override
    public void onItemRangeChanged(int positionStart, int itemCount) {
        mCallback.onItemRangeChanged(
                NestedAdapterWrapper.this,
                positionStart,
                itemCount,
                null
        );
    }
   // 刪掉類似的代碼
};

我們看到 observer 的相關方法中會調用 mCallback 的方法，mCallback 就是我們在構造方法中傳的 callback 參數。

我們再看一下 MergeAdapterController 中怎麼創建 NestedAdapterWrapper。

NestedAdapterWrapper wrapper = new NestedAdapterWrapper(adapter, this,
            mViewTypeStorage, mStableIdStorage.createStableIdLookup());

MergeAdapter 實現方法

@Override
public void onItemRangeChanged(@NonNullNestedAdapterWrapper nestedAdapterWrapper,
        int positionStart, int itemCount, @Nullable Object payload) {
    final int offset = countItemsBefore(nestedAdapterWrapper);
    mMergeAdapter.notifyItemRangeChanged(
            positionStart + offset,
            itemCount,
            payload
    );
}

所以我們可以看到最後會調用 mergeAdapter 的相應方法實現更新。

總結

MergeAdapter 實際上也是個普通的 Adapter，主要起作用的是 MergeAdapterController。 MergeAdapterController 幫我們實現了不同 adapter 組合之後帶來的繁瑣的計算，讓我們更專注於代碼邏輯。

參考

Merge adapters sequentially with MergeAdapter

代碼

https://github.com/LyCharlie/MergeAdapterTestDemo