阿里巴巴开源项目Virtuallayout的使用总结

VirtualLayout是什么

VirtualLayout是一个针对RecyclerView的LayoutManager扩展, 主要提供一整套布局方案和布局间的组件复用的问题。

VirtualLayout设计思路

通过定制化的LayoutManager，接管整个RecyclerView的布局逻辑；LayoutManager管理了一系列LayoutHelper，LayoutHelper负责具体布局逻辑实现的地方；每一个LayoutHelper负责页面某一个范围内的组件布局；不同的LayoutHelper可以做不同的布局逻辑，因此可以在一个RecyclerView页面里提供异构的布局结构，这就能比系统自带的LinearLayoutManager、GridLayoutManager等提供更加丰富的能力。同时支持扩展LayoutHelper来提供更多的布局能力。

主要功能

• 默认通用布局实现，解耦所有的View和布局之间的关系: Linear, Grid, 吸顶, 浮动, 固定位置等。

* LinearLayoutHelper: 线性布局
* GridLayoutHelper: Grid布局， 支持横向的colspan
* FixLayoutHelper: 固定布局，始终在屏幕固定位置显示
* ScrollFixLayoutHelper: 固定布局，但之后当页面滑动到该图片区域才显示, 可以用来做返回顶部或其他书签等
* FloatLayoutHelper: 浮动布局，可以固定显示在屏幕上，但用户可以拖拽其位置
* ColumnLayoutHelper: 栏格布局，都布局在一排，可以配置不同列之间的宽度比值
* SingleLayoutHelper: 通栏布局，只会显示一个组件View
* OnePlusNLayoutHelper: 一拖N布局，可以配置1-5个子元素
* StickyLayoutHelper: stikcy布局， 可以配置吸顶或者吸底
* StaggeredGridLayoutHelper: 瀑布流布局，可配置间隔高度/宽度

• 上述默认实现里可以大致分为两类：一是非fix类型布局，像线性、Grid、栏格等，它们的特点是布局在整个页面流里，随页面滚动而滚动；另一类就是fix类型的布局，它们的子节点往往不随页面滚动而滚动。
• 所有除布局外的组件复用，VirtualLayout将用来管理大的模块布局组合，扩展了RecyclerView，使得同一RecyclerView内的组件可以复用，减少View的创建和销毁过程。

如何使用VirtualLayout

1.依赖

(版本号请参考使用 release文档 中的最新版本号)

compile ('com.alibaba.android:vlayout:1.2.8@aar') {
    transitive = true
}

2.初始化LayoutManager

VirtualLayoutManager virtualLayoutManager = new VirtualLayoutManager(this);
recyclerView.setLayoutManager(virtualLayoutManager);

3.设置回收复用池的大小

RecyclerView.RecycledViewPool recycledViewPool = new RecyclerView.RecycledViewPool();
recyclerView.setRecycledViewPool(recycledViewPool);
recycledViewPool.setMaxRecycledViews(0, 10);

4.使用adapter加载数据

• 一种方法是使用一个代理适配器DelegateAdapter,delegateAdapter接收一个集合作为参数,这个集合中的元素是一种特殊的adapter,特殊性在于它持有一个LayoutHelper的成员变量,其它和默认adapter几乎一样

//创建delegateAdapter对象
DelegateAdapter delegateAdapter = new DelegateAdapter(virtualLayoutManager, true);

//给recyclerview设置adapter
recyclerView.setAdapter(delegateAdapter);

//创建adapter的集合
List adapters = new ArrayList<>();

//添加一个吸顶效果的adapter,作为第一组的标题(第二,第三组同理,不再赘述)
adapters.add(new HeadLineAdapter(this, new StickyLayoutHelper(), "这是第一组"));
//添加一个线性的adapter,作为第一组的内容
adapters.add(new MyAdapter(this, new LinearLayoutHelper(), 30, 0));

adapters.add(new HeadLineAdapter(this, new StickyLayoutHelper(), "这是第二组"));       
adapters.add(new MyAdapter(this, new LinearLayoutHelper(), 30, 30));
adapters.add(new HeadLineAdapter(this, new StickyLayoutHelper(), "这是第三组"));        
adapters.add(new MyAdapter(this, new LinearLayoutHelper(), 30, 60));

//将这个集合添加到delegateAdater中  
delegateAdapter.setAdapters(adapters);

• 第二种方式是当业务有自定义的复杂需求的时候, 可以继承自VirtualLayoutAdapter, 实现自己的Adapter

    private Context context;

    public CustomAdapter(@NonNull VirtualLayoutManager layoutManager, Context context) {
        super(layoutManager);
        this.context = context;
    }

    @NonNull
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        View inflate = LayoutInflater.from(context).inflate(R.layout.item, parent, false);
        RecyclerView.ViewHolder viewHolder = new MainActivity.MyViewHolder(inflate);
        return viewHolder;
    }

    @Override
    public void onBindViewHolder(@NonNull RecyclerView.ViewHolder holder, int position) {
        MainActivity.MyViewHolder myViewHolder = (MainActivity.MyViewHolder) holder;
        myViewHolder.textView.setText(String.valueOf(position));
    }

    @Override
    public int getItemCount() {
        List helpers = getLayoutHelpers();
        if (helpers == null) {
            return 0;
        }
        int count = 0;
        for (int i = 0, size = helpers.size(); i < size; i++) {
            count += helpers.get(i).getItemCount();
        }
        return count;
    }

    VirtualLayoutManager layoutManager = new VirtualLayoutManager(this);
    CustomAdapter customAdapter = new CustomAdapter(layoutManager, this);

    List helpers = new LinkedList<>();
    GridLayoutHelper helper1 = new GridLayoutHelper(3);
    helper1.setItemCount(25);

    GridLayoutHelper helper2 = new GridLayoutHelper(5);
    helper2.setItemCount(25);

    helpers.add(helper1);
    helpers.add(helper2);

    customAdapter.setLayoutHelpers(helpers);

    rv.setLayoutManager(layoutManager);

    rv.setAdapter(customAdapter);