基於BaseRecyclerViewAdapterHelper封裝的多條目Adapter，方便快捷，便於維護

chaychan發表於2018-03-22
ViewAPT封裝

  專案地址： github.com/chaychan/Mu…

  效果圖，我之前做過的精仿今日頭條,新聞列表中有好幾種佈局：

home.jpg

Apk下載地址

[點選下載體驗]

專案介紹

  MultipleItemRvAdapter是在BaseRecyclerViewAdapterHelper的基礎上對BaseQuickAdapter進行封裝，在包含BaseRecyclerViewAdapterHelper所有功能的基礎上，對其中的多條目佈局處理邏輯進行了封裝，將adapter中每種子條目單獨出對應的ItemProvider，這樣方便相應條目做相關的業務邏輯。

BaseRecyclerViewAdapterHelper

基於BaseRecyclerViewAdapterHelper封裝的多條目Adapter，方便快捷，便於維護

  BaseRecyclerViewAdapterHelper是一個封裝好的萬能RecyclerView的介面卡，可以方便快捷地完成adapter的編寫，包含一種或多種子條目的處理且擁有許多強大的功能，比如上拉載入更多、支援新增動畫、可以新增子條目的點選、長按事件、新增頭部和底部等，現擁有12.6K多的star數，受到不少Android開發者的青睞，我在專案的開發中也使用BaseRecyclerViewAdapterHelper，是一名忠實的粉絲。

BaseRecyclerViewAdapterHelper 多條目佈局的不足之處

  BaseRecyclerViewAdapterHelper中對多條目佈局的邏輯都放在convert()方法中，通過判斷對應的itemViewTyper來進行相應子條目的處理，當條目特別多以及擁有複雜業務邏輯的情況，convert()中的處理將會特別多，不便於往後專案的維護，比如IM裡面的訊息列表，有文字、圖片、語音、位置、紅包、轉賬等，有很多種不同佈局，對應的邏輯也比較多，在只使用BaseRecyclerViewAdapterHelper的情況下，對應訊息列表的adapter程式碼就已經破一千行，全部條目的邏輯都在一個adapter種，覺得不是特別合理，如下是訊息列表的adapter:

public class MessageListAdapter extends BaseQuickAdapter<Message,BaseViewHolder>{

public static final int TYPE_TEXT = 0;
public static final int TYPE_IMG = 1;

public MessageListAdapter(int layoutResId, @Nullable List<Message> data) {
        super(layoutResId, data);

        setMultiTypeDelegate(new MultiTypeDelegate<Message>() {
            @Override
            protected int getItemType(Message message) {
                if (message instanceof TextMessage){
                    return TYPE_TEXT;
                }else if (message instanceof ImageMessage){
                    return TYPE_IMG;
                }
                // else if(){
                //     //還有其他訊息型別，比如語音、位置、紅包、轉賬等
                // }

                return 0;
            }
        });

        getMultiTypeDelegate()
                .registerItemType(TYPE_TEXT, R.layout.item_text_message)
                .registerItemType(TYPE_IMG, R.layout.item_image_message);
				//還有其他訊息型別，比如語音、位置、紅包、轉賬等
    }

    @Override
    protected void convert(BaseViewHolder helper, Message item) {
        int viewType = helper.getItemViewType();
        switch (viewType){
            case TYPE_TEXT:
                //文字訊息的業務邏輯

                break;
            case TYPE_IMG:
                //圖片訊息的業務邏輯

                break;
             // case 語音、位置、紅包、轉賬等
            // break;
        }
    }
}
複製程式碼

  當子條目有許多種的時候，convert()中的邏輯將會很多，不便於專案的維護，故而封裝了MultipleItemRvAdapter，將每個條目的邏輯處理都交給建立的ItemProvider來處理，這樣可以在對應條目的ItemProvider寫相應的邏輯，方便維護。

如何使用MultipleItemRvAdapter

一、建立對應條目的ItemProvider，繼承BaseItemProvider，註解ItemProviderTag中填寫對應的viewType的值（建議在對應的adapter中定義常量，每種條目的viewType必須唯一）, layout指定對應條目的佈局id。

比如文字訊息條目的provider：

/**
 * @author ChayChan
 * @description 文字訊息條目的provider
 * @date 2018/3/21  14:43
 */
@ItemProviderTag(
    viewType = MessageListAdapter.TYPE_TEXT,
    layout = R.layout.item_text_message
)
public class TextMessageItemProvider extends BaseItemProvider<TextMessage> {

    @Override
    public void convert(BaseViewHolder helper, TextMessage data, int position) {
        //處理相關業務邏輯
        helper.setText(R.id.tv_text, data.text);
    }

    @Override
    public void onClick(BaseViewHolder helper, TextMessage data, int position) {
		//單擊事件
        Toast.makeText(mContext, "Click: " + data.text, Toast.LENGTH_SHORT).show();
    }

    @Override
    public boolean onLongClick(BaseViewHolder helper, TextMessage data, int position) {
		//長按事件
        Toast.makeText(mContext, "longClick: " + data.text, Toast.LENGTH_SHORT).show();
        return true;
    }
}
複製程式碼

圖片訊息條目的provider：

/**
 * @author ChayChan
 * @description 圖片訊息條目的provider
 * @date 2018/3/21  14:43
 */
@ItemProviderTag(
        viewType = MessageListAdapter.TYPE_IMG,
        layout = R.layout.item_image_message
)
public class ImageMessageItemProvider extends BaseItemProvider<ImageMessage> {

    @Override
    public void convert(BaseViewHolder helper, ImageMessage data, int position) {
        //處理相關業務邏輯
        ImageView iv = helper.getView(R.id.iv_img);
        Glide.with(mContext).load(data.imgUrl).into(iv);
    }

    @Override
    public void onClick(BaseViewHolder helper, ImageMessage data, int position) {
        //單擊事件
        Toast.makeText(mContext, "Click: " + data.imgUrl, Toast.LENGTH_SHORT).show();
    }

    @Override
    public boolean onLongClick(BaseViewHolder helper, ImageMessage data, int position) {
        //長按事件
        Toast.makeText(mContext, "longClick: " + data.imgUrl, Toast.LENGTH_SHORT).show();
        return true;
    }
}
複製程式碼

ItemProvider的convert()方法中用於處理相應的業務邏輯，onClick()中用於處理條目的單擊事件，onLongClick()中用於處於條目的長按事件；儘管單擊和長按事件adapter中可以通過ssetOnItemClick(）和setOnItemLongClick()來處理，但是這裡還是有將這兩個事件交於itemProvider,開發者可以根據具體需要選擇使用其中一種方式。

二、建立對應的adapter，繼承MultiItemRvAdapter，如MessageListAdapter:

/**
 * @author ChayChan
 * @description: 訊息列表的adapter
 * @date 2018/3/21  14:40
 */

public class MessageListAdapter extends MultipleItemRvAdapter<Message> {

    public static final int TYPE_TEXT = 0;
    public static final int TYPE_IMG = 1;

    public MessageListAdapter(@Nullable List<Message> data) {
        super(data);

  		//建構函式若有傳參可以在呼叫finishInitialize()之前進行賦值，賦值給全域性變數
        //這樣getViewType()和registerItemProvider()方法中可以獲取到傳過來的值
        //getViewType()中可能因為某些業務邏輯，需要將某個值傳遞過來進行判斷，返回對應的viewType
        //registerItemProvider()中可以將值傳遞給ItemProvider
        
		finishInitialize();//呼叫該方法告知MultipleItemRvAdapter1️已初始化完建構函式引數的傳遞
    }

    @Override
    protected int getViewType(Message message) {
		//返回對應的viewType
        if (message instanceof TextMessage) {
            return TYPE_TEXT;
        } else if (message instanceof ImageMessage) {
            return TYPE_IMG;
        }
        return 0;
    }


    @Override
    public void registerItemProvider() {
		//註冊相關的條目provider
        mProviderDelegate.registerProvider(new TextMessageItemProvider()); //註冊文字訊息條目的itemProvider
        mProviderDelegate.registerProvider(new ImageMessageItemProvider());//註冊圖片訊息條目的itemProvider
    }

}
複製程式碼

  adapter中需要實現getViewType()和registerItemProvider()兩個方法。getViewType()通過判斷相關邏輯返回不同的viewType,registerItemProvider()用於註冊自己所定義的所有子條目的ItemProvider。

三、為RecyclerView設定相應的adapter:

	mRvMessages = findViewById(R.id.rv_message);

    mRvMessages.setHasFixedSize(true);
    mRvMessages.setLayoutManager(new LinearLayoutManager(this));

    String imgUrl1 = "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1521627479112&di=7b109af49f8c1c193c3173306cf58680&imgtype=0&src=http%3A%2F%2Fimg.xgo-img.com.cn%2Fpics%2F1538%2F1537620.jpg";
    String imgUrl2 = "https://timgsa.baidu.com/timg?image&quality=80&size=b10000_10000&sec=1521617426&di=d6537bb0ef71984e4a1d14e4b18ba169&src=http://img1d.xgo-img.com.cn/pics/789/788784.jpg";

    mMessages.add(new TextMessage("你好呀，哈哈哈哈，嗚啦啦啦啦"));
    mMessages.add(new ImageMessage(imgUrl1));
    mMessages.add(new TextMessage("嗯嗯，今天天氣真不錯！"));
    mMessages.add(new ImageMessage(imgUrl2));

    mRvMessages.setAdapter(new MessageListAdapter(mMessages));
複製程式碼

效果圖：

基於BaseRecyclerViewAdapterHelper封裝的多條目Adapter，方便快捷，便於維護

  由於該庫中包含BaseRecyclerViewAdapterHelper庫，所以BaseRecyclerViewAdapterHelper擁有的它也具有。

匯入方式

在專案根目錄下的build.gradle中的allprojects{}中，新增jitpack倉庫地址，如下：

allprojects {
    repositories {
        jcenter()
        maven { url 'https://jitpack.io' }//新增jitpack倉庫地址
    }
}
複製程式碼

開啟app的module中的build.gradle，在dependencies{}中，新增依賴，如下：

dependencies {
        compile 'com.github.chaychan:MultipleItemRvAdapter:1.0.2' //建議使用最新版本
}
複製程式碼

最新發布的版本可以檢視

github.com/chaychan/Mu…

支援和鼓勵

  如果覺得對你有幫助，請幫忙star一下，讓更多人可以看到，謝謝！這樣我會更加有動力去完善好這個專案；

相關文章