PageAdapter,FragmentPagerAdapter与FragmentStatePagerAdapter

╰+哭是因爲堅強的太久メ 2022-08-19 15:08 147阅读 0赞

在一个 Android 应用中，我使用 [FragmentPagerAdapter][] 来处理多 Fragment 页面的横向滑动。不过我碰到了一个问题，即当 Fragment 对应的数据集发生改变时，我希望能够通过调用 mAdapter.notifyDataSetChanged() 来触发 Fragment 页面使用新的数据调整或重新生成其内容，可是当我调用 notifyDataSetChanged() 后，发现什么都没发生。  
  
搜索之后发现不止我一个人碰到这个问题，大家给出的解决办法五花八门，有些确实解决了问题，但是我总感觉问题没搞清楚。于是我决定搞明白这个问题到底是怎么回事，以及正确的用法到底如何。要搞明白这个问题，仅仅阅读文档并不足够，还需要阅读相关几个类的相关方法的实现，搞懂其设计意图。下面就是通过阅读源代码搞明白的内容。  
  
  
**【ViewPager】**  
  
[ViewPager][] 如其名所述，是负责翻页的一个 View。准确说是一个 [ViewGroup][]，包含多个 View 页，在手指横向滑动屏幕时，其负责对 View 进行切换。为了生成这些 View 页，需要提供一个 [PagerAdapter][] 来进行和数据绑定以及生成最终的 View 页。

*  [**setAdapter()**][setAdapter]
    
     *  ViewPager 通过 setAdapter() 来建立与 PagerAdapter 的联系。这个联系是双向的，一方面，ViewPager 会拥有 [PagerAdapter 对象][PagerAdapter 1]，从而可以在需要时调用 PagerAdapter 的方法；另一方面，ViewPager 会在 setAdapter() 中[调用 PagerAdapter 的 registerDataSetObserver() 方法][PagerAdapter _ registerDataSetObserver_]，注册一个[自己生成的 PagerObserver 对象][PagerObserver]，从而在 PagerAdapter 有所需要时（如 [notifyDataSetChanged()][notifyDataSetChanged]或 notifyDataSetInvalidated() 时），可以调用 Observer 的 onChanged() 或 onInvalidated() 方法，从而实现 PagerAdapter 向 ViewPager 方向发送信息。
 *  [**dataSetChanged()**][dataSetChanged]
    
     *  在 [PagerObserver][PagerObserver 1].onChanged()，以及 PagerObserver.onInvalide() 中被调用。因此当 PagerAdapter.notifyDataSetChanged() 被触发时，ViewPager.dataSetChanged() 也可以被触发。该函数将[使用 getItemPosition() 的返回值来进行判断][getItemPosition_]，如果为 POSITION\_UNCHANGED，则什么都不做；如果为 POSITION\_NONE，则调用 PagerAdapter.destroyItem() 来去掉该对象，并设置为需要刷新 ([needPopulate = true][needPopulate _ true]) 以便[触发][Link 1]PagerAdapter.instantiateItem() 来生成新的对象。

**【PagerAdapter】**

[PageAdapter][PagerAdapter] 是 ViewPager 的支持者，ViewPager 将调用它来取得所需显示的页，而 PageAdapter 也会在数据变化时，通知 ViewPager。这个类也是 [FragmentPagerAdapter][FragmentPagerAdapter 1] 以及  [FragmentStatePagerAdapter][] 的基类。如果继承自该类，至少需要实现 instantiateItem(), destroyItem(), getCount() 以及 isViewFromObject()。

*  [**getItemPosition()**][getItemPosition]
    
     *  该函数用以返回给定对象的位置，给定对象是由 instantiateItem() 的返回值。
     *  在 ViewPager.dataSetChanged() 中将对该函数的返回值进行判断，以决定是否最终触发 PagerAdapter.instantiateItem() 函数。
     *  在 PagerAdapter 中的实现是直接传回 [POSITION\_UNCHANGED][POSITION_UNCHANGED]。如果该函数不被重载，则会一直返回 POSITION\_UNCHANGED，从而导致 ViewPager.dataSetChanged() 被调用时，认为不必触发 PagerAdapter.instantiateItem()。很多人因为没有重载该函数，而导致调用  
        PagerAdapter.notifyDataSetChanged() 后，什么都没有发生。
 *  [**instantiateItem()**][instantiateItem]
    
     *  在每次 ViewPager 需要一个用以显示的 Object 的时候，该函数都会被 ViewPager.[addNewItem()][Link 1] 调用。
 *  **[notifyDataSetChanged()][notifyDataSetChanged]**
    
     *  在数据集发生变化的时候，一般 Activity 会调用 PagerAdapter.notifyDataSetChanged()，以通知 PagerAdapter，而 PagerAdapter 则会通知在自己这里[注册过][Link 2]的所有 [DataSetObserver][]。其中之一就是在 ViewPager.setAdapter() 中注册过的 PageObserver。PageObserver 则进而调用 ViewPager.dataSetChanged()，从而导致 ViewPager 开始触发更新其内含 View 的操作。

**【FragmentPagerAdapter】**  
  
[FragmentPagerAdapter][FragmentPagerAdapter 1] 继承自 PagerAdapter。相比通用的 PagerAdapter，该类更专注于每一页均为 Fragment 的情况。如文档所述，**该类内的每一个生成的 Fragment 都将保存在内存之中**，因此适用于那些相对静态的页，数量也比较少的那种；如果需要处理有很多页，并且数据动态性较大、占用内存较多的情况，应该使用[FragmentStatePagerAdapter][FragmentStatePagerAdapter 1]。FragmentPagerAdapter 重载实现了几个必须的函数，因此来自 PagerAdapter 的函数，我们只需要实现 getCount()，即可。且，由于 FragmentPagerAdapter.instantiateItem() 的实现中，调用了一个新增的虚函数 getItem()，因此，我们还至少需要实现一个 getItem()。因此，总体上来说，相对于继承自 PagerAdapter，更方便一些。

*  [**getItem()**][getItem]
    
     *  该类中新增的一个虚函数。函数的目的为生成**新的** Fragment 对象。重载该函数时需要注意这一点。在需要时，该函数将被 instantiateItem() 所调用。
     *  如果需要向 Fragment 对象传递相对**静态的数据**时，我们一般通过 Fragment.setArguments() 来进行，这部分代码应当放到 getItem()。它们只会在新生成 Fragment 对象时执行一遍。
     *  如果需要在生成 Fragment 对象后，将**数据集里面一些动态的数据**传递给该 Fragment，那么，这部分代码不适合放到 getItem() 中。因为当数据集发生变化时，往往对应的 Fragment 已经生成，如果传递数据部分代码放到了 getItem() 中，这部分代码将不会被调用。这也是为什么很多人发现调用 PagerAdapter.notifyDataSetChanged() 后，getItem() 没有被调用的一个原因。
 *  **[instantiateItem()][instantiateItem 1]**
    
     *  函数中[判断一下][Link 3]要生成的 Fragment 是否已经生成过了，如果生成过了，就使用旧的，[旧的将被 Fragment.attach()][Fragment.attach]；如果没有，[就调用 getItem() 生成一个新的][getItem_]，[新的对象将被 FragmentTransation.add()][FragmentTransation.add]。
     *  FragmentPagerAdapter 会将所有生成的 Fragment 对象通过 FragmentManager 保存起来备用，以后需要该 Fragment 时，都会从 FragmentManager 读取，**而不会再次调用 getItem() 方法**。
     *  如果需要在生成 Fragment 对象后，将数据集中的一些数据传递给该 Fragment，这部分代码应该放到这个函数的重载里。在我们继承的子类中，重载该函数，并调用 FragmentPagerAdapter.instantiateItem() 取得该函数返回 Fragment 对象，然后，我们该 Fragment 对象中对应的方法，将数据传递过去，然后返回该对象。
     *  否则，如果将这部分传递数据的代码放到 getItem()中，在 PagerAdapter.notifyDataSetChanged() 后，这部分数据设置代码将不会被调用。
 *  [**destroyItem()**][destroyItem]
    
     *  该函数被调用后，会对 Fragment 进行 [FragmentTransaction.detach()][FragmentTransaction.detach]。这里不是 remove()，只是 detach()，因此 Fragment 还在 FragmentManager 管理中，Fragment 所占用的资源不会被释放。

**【FragmentStatePagerAdapter】**  
  
  
[FragmentStatePagerAdapter][FragmentStatePagerAdapter 1] 和前面的 FragmentPagerAdapter 一样，是继承子 PagerAdapter。但是，和 FragmentPagerAdapter 不一样的是，正如其类名中的 'State' 所表明的含义一样，该 PagerAdapter 的实现将只保留当前页面，当页面离开视线后，就会被消除，释放其资源；而在页面需要显示时，生成新的页面(就像 ListView 的实现一样)。这么实现的好处就是当拥有大量的页面时，不必在内存中占用大量的内存。

*  [**getItem()**][getItem 1]
    
     *  一个该类中新增的虚函数。
     *  函数的目的为生成**新的** Fragment 对象。
     *  Fragment.setArguments() 这种只会在新建 Fragment 时执行一次的参数传递代码，可以放在这里。
     *  由于 FragmentStatePagerAdapter.instantiateItem() 在大多数情况下，都将调用 getItem() 来生成新的对象，因此如果在该函数中放置与数据集相关的 setter 代码，基本上都可以在 instantiateItem() 被调用时执行，但这和设计意图不符。毕竟还有[部分可能][Link 4]是不会调用 getItem() 的。因此这部分代码应该放到 instantiateItem() 中。
 *  [**instantiateItem()**][instantiateItem 2]
    
     *  除非碰到 FragmentManager 刚好从 SavedState 中恢复了对应的 Fragment 的情况外，该函数将会调用 getItem() 函数，生成新的 Fragment 对象。新的对象将被 FragmentTransaction.add()。
     *  FragmentStatePagerAdapter 就是通过这种方式，每次都创建一个新的 Fragment，而在不用后就立刻释放其资源，来达到节省内存占用的目的的。
 *  [**destroyItem()**][destroyItem 1]
    
     *  将 Fragment 移除，即调用 [FragmentTransaction.remove()][FragmentTransaction.remove]，并释放其资源。

**讨论**  
  
之前看到一些解决办法，有的认为这是一个 [bug][]，应该被修复；有的[建议][Link 5]不用 FragmentPagerAdapter，而改用 FragmentStatePagerAdapter，并且重载 getItemPosition() 并返回 POSITION\_NONE，以触发销毁对象以及重建对象。从上面的分析中看，后者给出的建议确实可以达到调用 notifyDataSetChanged() 后，Fragment 被以新的参数重新建立的效果。  
  
但是问题在于，如果我们只能这么解决这个问题，岂不是 FragmentPagerAdapter 就用不上了？最关键的是，二者对应的情况不同。对于页面相对较少的情况，我仍旧希望能够将生成的 Fragment 保存在内存中，在需要显示的时候直接调用，而不要产生生成、销毁对象的额外的开销，这样效率更高。这种情况下，选择 FragmentPagerAdapter 是更适合，不加考虑的选择 FragmentStatePagerAdapter 是不合适的。我们不能够因噎废食。  
  
因此，对于 FragmentPagerAdapter 的解决方案就是，分别重载 getItem() 以及 instantiateItem() 对象。getItem() 只用于生成新的与数据无关的 Fragment；而 instantiateItem() 函数则先调用父类中的 instantiateItem() 取得所对应的 Fragment 对象，然后，根据对应的数据，调用该对象对应的方法进行数据设置。  
  
当然，不要忘记重载 getItemPosition() 函数，返回 POSITION\_NONE，这个两个类的解决方案都需要的。二者不同之处在于，FragmentStatePagerAdapter 在会在因 POSITION\_NONE 触发调用的 destroyItem() 中真正的释放资源，重新建立一个新的 Fragment；而 FragmentPagerAdapter 仅仅会在 destroyItem() 中 detach 这个 Fragment，在 instantiateItem() 时会使用旧的 Fragment，并触发 attach，因此没有释放资源及重建的过程。  
  
这样，当 notifyDataSetChanged() 被调用后，会最终触发 instantiateItem()，而不管 getItem() 是否被调用，我们都在重载的 instantiateItem() 函数中已经将所需要的数据传递给了相应的 Fragment。在 Fragment 接下来的 onCreateView(), onStart() 以及 onResume() 的事件中，它可以正确的读取新的数据，Fragment 被成功复用了。  
  
这里需要注意一个问题，在 Fragment 没有被添加到 FragmentManager 之前，我们可以通过 Fragment.setArguments() 来设置参数，并在 Fragment 中，使用 getArguments() 来取得参数。这是常用的参数传递方式。但是这种方式对于我们说的情况不适用。因为这种数据传递方式只可能用一次，在 Fragment 被添加到 FragmentManager 后，一旦被使用，我们再次调用 setArguments() 将会导致 **java.lang.IllegalStateException: Fragment already active** 异常。因此，我们这里的参数传递方式选择是，在继承的 Fragment 子类中，新增几个 setter，然后通过这些 setter 将数据传递过去。反向也是类似。相关信息可以参考 \[5\]。哦，这些 setter 中要注意不要操作那些 View，这些 View 只有在 onCreateView() 事件后才可以操作。  
  
  
针对 FragmentPagerAdapter 的解决办法如下列代码所示：  
  
  
\[mw\_shl\_code=java,true\]@Override  
public Fragment getItem(int position) \{  
     MyFragment f = new MyFragment();  
     return f;  
\}  
  
@Override  
public Object instantiateItem(ViewGroup container, int position) \{  
     MyFragment f = (MyFragment) super.instantiateItem(container, position);  
     String title = mList.get(position);  
     f.setTitle(title);  
     return f;  
\}  
  
@Override  
public int getItemPosition(Object object) \{  
     return PagerAdapter.POSITION\_NONE;  
\}\[/mw\_shl\_code\]

[FragmentPagerAdapter]: http://developer.android.com/reference/android/support/v4/app/FragmentPagerAdapter.html
[ViewPager]: http://developer.android.com/reference/android/support/v4/view/ViewPager.html
[ViewGroup]: http://developer.android.com/reference/android/view/ViewGroup.html
[PagerAdapter]: http://developer.android.com/reference/android/support/v4/view/PagerAdapter.html
[setAdapter]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#ViewPager.setAdapter%28android.support.v4.view.PagerAdapter%29
[PagerAdapter 1]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#125
[PagerAdapter _ registerDataSetObserver_]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#370
[PagerObserver]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#368
[notifyDataSetChanged]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/PagerAdapter.java#PagerAdapter.notifyDataSetChanged%28%29
[dataSetChanged]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#ViewPager.dataSetChanged%28%29
[PagerObserver 1]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#ViewPager.PagerObserver
[getItemPosition_]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#714
[needPopulate _ true]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#728
[Link 1]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/ViewPager.java#ViewPager.addNewItem%28int%2Cint%29
[FragmentPagerAdapter 1]: http://developer.android.com/reference/android/support/v13/app/FragmentPagerAdapter.html
[FragmentStatePagerAdapter]: http://developer.android.com/reference/android/support/v13/app/FragmentStatePagerAdapter.html
[getItemPosition]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/PagerAdapter.java#PagerAdapter.getItemPosition%28java.lang.Object%29
[POSITION_UNCHANGED]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/PagerAdapter.java#PagerAdapter.0POSITION_UNCHANGED
[instantiateItem]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/PagerAdapter.java#PagerAdapter.instantiateItem%28android.view.ViewGroup%2Cint%29
[Link 2]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/view/PagerAdapter.java#PagerAdapter.registerDataSetObserver%28android.database.DataSetObserver%29
[DataSetObserver]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/database/DataSetObserver.java#DataSetObserver
[FragmentStatePagerAdapter 1]: http://developer.android.com/reference/android/support/v4/app/FragmentStatePagerAdapter.html
[getItem]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#FragmentPagerAdapter.getItem%28int%29
[instantiateItem 1]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#FragmentPagerAdapter.instantiateItem%28android.view.ViewGroup%2Cint%29
[Link 3]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#90
[Fragment.attach]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#95
[getItem_]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#97
[FragmentTransation.add]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#99
[destroyItem]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentPagerAdapter.java#FragmentPagerAdapter.destroyItem%28android.view.ViewGroup%2Cint%2Cjava.lang.Object%29
[FragmentTransaction.detach]: http://developer.android.com/reference/android/support/v4/app/FragmentTransaction.html#detach%28android.support.v4.app.Fragment%29
[getItem 1]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentStatePagerAdapter.java#FragmentStatePagerAdapter.getItem%28int%29
[Link 4]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentStatePagerAdapter.java#94
[instantiateItem 2]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentStatePagerAdapter.java#FragmentStatePagerAdapter.instantiateItem%28android.view.ViewGroup%2Cint%29
[destroyItem 1]: http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.1.1_r1/android/support/v4/app/FragmentStatePagerAdapter.java#FragmentStatePagerAdapter.destroyItem%28android.view.ViewGroup%2Cint%2Cjava.lang.Object%29
[FragmentTransaction.remove]: http://developer.android.com/reference/android/support/v4/app/FragmentTransaction.html#remove%28android.support.v4.app.Fragment%29
[bug]: http://code.google.com/p/android/issues/detail?id=19001
[Link 5]: http://stackoverflow.com/questions/10849552/android-viewpager-cant-update-dynamically