ViewPager使用记录2——展示动态数据

ViewPager是v4支持库中的一个控件，相信几乎所有接触Android开发的人都对它不陌生。之所以还要在这里翻旧账，是因为我在最近的项目中有多个需求用到了它，觉得自己对它的认识不够深刻。我计划从最简单的使用场景出发，记录我到目前为止所对ViewPager的使用情况以及有关它的一些知识点。

这个系列的代码将存放在Github仓库中，每篇文章对应一个分支。

这是第一篇文章，讲述关于ViewPager展示动态数据的方法与相关知识点。ViewPager展示动态数据的方法有好几种，汇总到一起都离不开PagerAdapter的一个方法getItemPosition。下面讨论一下具体方法。

错误的示例

上一篇文章介绍了如何展示静态数据。代码中的自定义的PagerAdapter中有一个setTexts方法，它的内容是这样的：

public synchronized void setTexts(List<String> texts) {
    this.texts.clear();
    if (texts != null && texts.size() > 0) {
        this.texts.addAll(texts);
    }
    notifyDataSetChanged();
}

它的作用就是清除适配器列表中原有的数据，然后把外部传递进来的数据复制进列表，最后通知适配器更新。

外部数据变更时，直接调用该方法：

adapter.setTexts(randomData());  

看起来好像很合理，毕竟ListView等组件的适配器就是这么用的。

但是如果你真的运行起来就会发现ViewPager的展示的数据并不是如你所愿的更新了。数据变多时，前面的数据不更新；数据变少时，在页面展示最后一项的情况下还可以向左滑动看到部分旧数据；甚至出现白屏的情况。

代码见Github。

那怎么正确更新？

使用ViewPager.setAdapter切换数据源

这是最简单的修改数据的方法，适合在整个数据源都发生变化的场景下使用。

在初始化ViewPager的使用我们使用下面的代码：

adapter = new DynamicDataSetAdapter();
adapter.setTexts(randomData());

viewPager = (ViewPager) findViewById(R.id.vp_viewpager_update);
viewPager.setAdapter(adapter);  

当需要让ViewPager展示的数据改变时，我们可以：

// 可以选择创建新的PagerAdapter对象或使用已有的对象
// adapter = new DynamicDataSetAdapter();
adapter.setTexts(randomData());
viewPager.setAdapter(adapter); 

代码见Github。

为什么使用notifyDatasetChanged无法正确更新数据，而setAdapter可以？这要求我们了解一下ViewPager的更新原理。

ViewPager的更新原理

看ViewPager的源码会发现它拥有两个成员变量，分别是：

PagerAdapter mAdapter;
private PagerObserver mObserver;

PagerObserver是在ViewPager内部定义的私有类，也就是说它默认持有了ViewPager的引用，因此可以调用ViewPager的方法。

private class PagerObserver extends DataSetObserver {
    PagerObserver() {
    }
    @Override
    public void onChanged() {
        dataSetChanged();
    }
    @Override
    public void onInvalidated() {
        dataSetChanged();
    }
}

其实看PagerObserver的名字就知道这是一个观察者。PagerAdapter以PagerObserver为通道告知ViewPager调用dataSetChanged方法更新数据。

看dataSetChanged方法的源码，关键在：

...
for (int i = 0; i < mItems.size(); i++) {
    final ItemInfo ii = mItems.get(i);
    final int newPos = mAdapter.getItemPosition(ii.object);

    if (newPos == PagerAdapter.POSITION_UNCHANGED) {
        continue;
    }

    ...
}
...

我们看到dataSetChanged方法调用了PagerAdapter的getItemPosition方法了。一旦该方法返回了 PagerAdapter.POSITION_UNCHANGED就不刷新这个页面了。

由于我们使用了默认的getItemPosition方法，而默认的getItemPosition方法的实现恰好就返回了这个值：

public int getItemPosition(Object object) {
    return POSITION_UNCHANGED;
}

到这里我们就明白了为什么修改数据后只调用notifyDataSetChanged不会刷新页面了。

接下来看一下setAdapter方法的源码。关键在于该方法的前面几行：

if (mAdapter != null) {
    mAdapter.setViewPagerObserver(null);
    mAdapter.startUpdate(this);
    for (int i = 0; i < mItems.size(); i++) {
        final ItemInfo ii = mItems.get(i);
        mAdapter.destroyItem(this, ii.position, ii.object);
    }
    mAdapter.finishUpdate(this);
    mItems.clear();
    removeNonDecorViews();
    mCurItem = 0;
    scrollTo(0, 0);
}
...

可以看到一旦就的数据适配器不为null，ViewPager就会销毁所有原来与数据相关的ItemInfo，并且逐一调用适配器的destroyItem方法销毁视图。

setAdapter之后的代码就不用看了，跟初始化流程一样生成ItemInfo列表与相关数据。

这就是为什么调用setAdapter可以更新数据的原因。

重写getItemPosition实现更高效的数据更新

既然知道了getItemPosition决定了数据更新的规则，我们只要重写这个方法就可以了。

最暴力的方法当然是直接让这个方法返回POSITION_NONE，在效果上这跟使用setAdapter没什么区别了，只要调用了PagerAdapter的notifyDatasetChanged就会导致销毁原有的数据并重建。

更稳妥一点的方法是配合应用的实际业务数据进行该方法的定制。下面提供一个仅供参考的例子：

private static class DynamicDataSetAdapter extends PagerAdapter {
    private List<String> texts;

    public DynamicDataSetAdapter() {
        texts = new ArrayList<>();
    }

    @Override
    public int getCount() {
        return texts.size();
    }

    @Override
    public boolean isViewFromObject(View view, Object object) {
        return object.equals(view);
    }

    @Override
    public Object instantiateItem(ViewGroup container, int position) {
        String text = texts.get(position);

        TextView textView = new TextView(container.getContext());
        textView.setTag(text);
        textView.setText(text);

        container.addView(textView);
        return textView;
    }

    @Override
    public void destroyItem(ViewGroup container, int position, Object object) {
        container.removeView((View) object);
    }

    @Override
    public int getItemPosition(Object object) {
        View view = (View) object;
        String text = (String) view.getTag();
        if (text == null) {
            return PagerAdapter.POSITION_NONE;
        }

        int index = this.texts.indexOf(text);
        if (index == -1) {
            return PagerAdapter.POSITION_NONE;
        }

        return index;
    }

    public synchronized void setTexts(List<String> texts) {
        this.texts.clear();
        if (texts != null && texts.size() > 0) {
            this.texts.addAll(texts);
        }
        notifyDataSetChanged();
    }
}

代码见Github。

本文来自作者同步博客