Android 通过RecyclerView Adapter设置空布局

在Android开发中,列表无数据时,一般会显示一个空布局。普遍的做法是把列表布局(如:RecyclerView)和空布局都写在布局文件(xml)里,通过对列表和空布局的隐藏/显示来切换需要显示的控件。如果大家有很多页面都需要显示这种空布局,就需要每个页面都要写重复的代码。这种方法不仅耦合度高,而且实现和维护麻烦。网上也有把空布局封装成公共组件,通过给空布局组件设置需要替换的目标控件,把目标控件(如:RecyclerView)替换掉的做法。这两种做法其实都是通过切换显示不同的控件来实现功能的,而且都需要大家自己去操作列表和空布局之间的切换。那么有没有不需要切换控件,就可以让大家的列表在无数据时自动显示一个空布局的方法呢。答案肯定是有的,今天我就给大家先容一种通过给RecyclerView设置空布局item实现空布局显示的方法。

显示列表一般是使用RecyclerView,RecyclerView的显示内容是由Adapter提供和管理的。Adapter知道RecyclerView是否有数据,如果没有数据时,由Adapter提供一个空布局给RecyclerView显示,这样RecyclerView的空布局功能能就实现了。因为RecyclerView支撑多种ViewType的item,所以大家可以把空布局作为一个ViewType,。当无数据时,getItemCount返回1,让RecyclerView显示一个item,这个item就是大家要显示的空布局。item的ViewType为TYPE_EMPTY(可随便定义,只要不跟普通的item冲突即可),item的宽高为match_parent,这样空布局就可以铺面RecyclerView。

public class EmptyAdapter extends RecyclerView.Adapter<EmptyAdapter.ViewHolder> {

    // 普通的item ViewType
    private static final int TYPE_ITEM = 1;
    // 空布局的ViewType
    private static final int TYPE_EMPTY = 2;

    private Context mContext;

    // 数据
    private List<String> mList;

    // 是否显示空布局,默认不显示
    private boolean showEmptyView = false;

    public EmptyAdapter(Context context) {
        mContext = context;
    }

    @NonNull
    @Override
    public ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        if (viewType == TYPE_EMPTY) {
            // 创建空布局item
            return new ViewHolder(getEmptyView(parent));
        } else {
            // 创建普通的item
            View view = LayoutInflater.from(mContext).inflate(R.layout.adapter_item, parent, false);
            return new ViewHolder(view);
        }
    }

    /**
     * 获取空布局
     */
    private View getEmptyView(ViewGroup parent) {
        View view = LayoutInflater.from(mContext).inflate(R.layout.adapter_empty_view, parent, false);
        Button btnLoadData = view.findViewById(R.id.btn_load_data);
        btnLoadData.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                setList(initData());
            }
        });
        return view;
    }

    @Override
    public void onBindViewHolder(@NonNull ViewHolder holder, int position) {
        // 如果是空布局item,不需要绑定数据
        if (!isEmptyPosition(position)) {
            holder.tvItem.setText(mList.get(position));
        }
    }

    @Override
    public int getItemCount() {
        // 判断数据是否空,如果没有数据,并且需要显示空布局,就返回1。
        int count = mList != null ? mList.size() : 0;
        if (count > 0) {
            return count;
        } else if (showEmptyView) {
            // 显示空布局
            return 1;
        } else {
            return 0;
        }
    }

    @Override
    public int getItemViewType(int position) {
        if (isEmptyPosition(position)) {
            // 空布局
            return TYPE_EMPTY;
        } else {
            return TYPE_ITEM;
        }
    }

    public void setList(List<String> list) {
        mList = list;
        notifyDataSetChanged();
    }

    /**
     * 判断是否是空布局
     */
    public boolean isEmptyPosition(int position) {
        int count = mList != null ? mList.size() : 0;
        return position == 0 && showEmptyView && count == 0;
    }

    /**
     * 设置空布局显示。默认不显示
     */
    public void showEmptyView(boolean isShow) {
        if (isShow != showEmptyView) {
            showEmptyView = isShow;
            notifyDataSetChanged();
        }
    }

    public boolean isShowEmptyView() {
        return showEmptyView;
    }

    static class ViewHolder extends RecyclerView.ViewHolder {

        TextView tvItem;

        public ViewHolder(@NonNull View itemView) {
            super(itemView);

            tvItem = itemView.findViewById(R.id.tv_item);
        }
    }

}

由于列表中的空布局最多只会有一个,所以它不需要在onBindViewHolder中重新绑定数据。大家在创建空布局的时候就可以直接给它设置需要显示的内容和设置点击事件。

在上面的例子中,我通过getEmptyView方法提供空布局对象。这样做是为了让空布局和adapter解耦,不过在这个例子中没有明显的体现出来。试想,如果大家通过一个方法或者接口提供需要的空布局,那么大家就可以让具体的adapter子类(或者使用者)试下这个方法(实现接口),由子类或者外部提供具体的空布局,让空布局可自定义,而且不会影响adapter的基本功能。比如大家项目中一般都会封装一个BaseAdapter类,或者使用第三方开源的BaseAdapter,项目中的adapter都继承自BaseAdapter。大家可以把空布局的功能集成在BaseAdapter,并且提供默认的通用空布局。然后子类可通过重写方法提供自己的空布局,这样就让空布局可自定义了。把空布局功能集成到adapter后,直接使用这个adapter,在没有数据时就会显示空布局了,而且无需大家手动地调用空布局的显示或者隐藏。

mAdapter = new EmptyAdapter(this);
// 显示空布局
mAdapter.showEmptyView(true);
rvList.setLayoutManager(new LinearLayoutManager(this));
rvList.setAdapter(mAdapter);

如果是使用GridLayoutManager,为了能让空布局铺面RecyclerView,需要setSpanSizeLookup。

    final GridLayoutManager layoutManager = new GridLayoutManager(this, 2);
    layoutManager.setSpanSizeLookup(new GridLayoutManager.SpanSizeLookup() {
        @Override
        public int getSpanSize(int position) {
            // 如果是空布局,让它占满一行
            if (mAdapter.isEmptyPosition(position)) {
                return layoutManager.getSpanCount();
            }
            return 1;
        }
    });
    rvList.setLayoutManager(layoutManager);

到这里,空布局的实现就完成了。有兴趣的朋友可以体验一下我在GitHub提供的例子:EmptyAdapter。

之所以考虑把空布局功能集成到adapter中,是因为我之前在GitHub开源了一个可分组的RecyclerView Adapter:GroupedRecyclerViewAdapter。后面收到不少反馈,希翼GroupedRecyclerViewAdapter能提供空布局的设置,所以我就想出了这种实现方式,并且给GroupedRecyclerViewAdapter集成了这个功能。今天写这篇文章,是希翼能把这种实现方法分享给大家。虽然大家现在是给RecyclerView 的Adapter实现空布局,但是这种思路同样适用于ListView等列表控件。