Google 会使用 AI 技术将内容翻译成您偏好的语言。AI 翻译可能包含错误。

从 ViewPager 迁移到 ViewPager2

ViewPager2 是 ViewPager 库的改进版本，提供了增强型功能，还解决了使用 ViewPager 时常见的问题。如果您的应用已使用 ViewPager，请阅读本页面，详细了解如何迁移到 ViewPager2。

如果您想在应用中使用 ViewPager2，但目前未使用 ViewPager，请参阅使用 ViewPager2 在 fragment 之间滑动和使用 ViewPager2 创建包含标签页的滑动视图，了解详情。

迁移到 ViewPager2 的优势

迁移的主要原因是 ViewPager2 正在获得积极的开发支持，而 ViewPager 没有。不过，ViewPager2 还具有其他一些特定优势。

垂直方向支持

除了传统的水平分页之外，ViewPager2 还支持垂直分页。您可以通过设置 ViewPager2 元素的 android:orientation 属性来为其启用垂直分页：

<androidx.viewpager2.widget.ViewPager2
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:orientation="vertical" />

您还可以使用 setOrientation() 方法以编程方式设置此属性。

从右到左支持

ViewPager2 支持从右到左 (RTL) 分页。系统会根据语言区域在适当情况下自动启用 RTL 分页，但您也可以通过设置 ViewPager2 元素的 android:layoutDirection 属性来手动启用 RTL 分页：

<androidx.viewpager2.widget.ViewPager2
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:layoutDirection="rtl" />

您还可以使用 setLayoutDirection() 方法以编程方式设置此属性。

可修改的 Fragment 集合

ViewPager2 支持对可修改的 fragment 集合进行分页，并在底层集合发生更改时调用 notifyDatasetChanged() 来更新界面。

这意味着，您的应用可以在运行时动态修改 fragment 集合，并且 ViewPager2 将正确显示修改后的集合。

DiffUtil

ViewPager2 基于 RecyclerView 构建，这意味着它可以访问 DiffUtil 实用程序类。这会带来多项好处，但最值得注意的是，这意味着 ViewPager2 对象会原生利用 RecyclerView 类中的数据集更改动画。

将您的应用迁移到 ViewPager2

请按照以下步骤将应用中的 ViewPager 对象更新为 ViewPager2：

更新 XML 布局文件

首先，将 XML 布局文件中的 ViewPager 元素替换为 ViewPager2 元素：

<!-- A ViewPager element -->
<android.support.v4.view.ViewPager
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

<!-- A ViewPager2 element -->
<androidx.viewpager2.widget.ViewPager2
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

更新适配器类

使用 ViewPager 时，您必须扩展向对象提供新页面的适配器类。根据应用场景，ViewPager 使用了三个不同的抽象类。ViewPager2 只使用两个抽象类。

对于要转换为 ViewPager2 对象的每个 ViewPager 对象，请更新适配器类，以扩展相应的抽象类，如下所示：

如果 ViewPager 使用 PagerAdapter 翻阅视图，请将 RecyclerView.Adapter 与 ViewPager2 搭配使用。
如果 ViewPager 使用 FragmentPagerAdapter 对少量固定数量的 fragment 进行分页，请将 FragmentStateAdapter 与 ViewPager2 搭配使用。
如果 ViewPager 使用 FragmentStatePagerAdapter 对大量或未知数量的 fragment 进行分页，请将 FragmentStateAdapter 与 ViewPager2 搭配使用。

构造函数参数

继承自 FragmentPagerAdapter 或 FragmentStatePagerAdapter 的基于 fragment 的适配器类始终接受单个 FragmentManager 对象作为构造函数参数。为 ViewPager2 适配器类扩展 FragmentStateAdapter 时，您可以改为使用以下构造函数参数：

ViewPager2 对象所在的 FragmentActivity 对象或 Fragment 对象。在大多数情况下，这个选择更好。
FragmentManager 对象和 Lifecycle 对象。

直接继承自 RecyclerView.Adapter 的基于视图的适配器类不需要构造函数参数。

替换方法

您的适配器类还需要为 ViewPager2 替换与 ViewPager 不同的方法：

替换 getItemCount()，而不是 getCount()。除了名称之外，此方法没有变化。
在基于 fragment 的适配器类中，替换 createFragment()，而不是 getItem()。确保每次调用函数时，新的 createFragment() 方法始终提供新的 fragment 实例，而不是重复使用实例。

摘要

总之，如需转换 ViewPager 适配器类以与 ViewPager2 搭配使用，您必须进行以下更改：

将父类更改为 RecyclerView.Adapter（用于对视图进行分页）或 FragmentStateAdapter（用于对 fragment 进行分页）。
更改基于 Fragment 的适配器类中的构造函数参数。
替换 getItemCount()，而不是 getCount()。
在基于 fragment 的适配器类中替换 createFragment()，而不是 getItem()。

Kotlin

// A simple ViewPager adapter class for paging through fragments
class ScreenSlidePagerAdapter(fm: FragmentManager) : FragmentStatePagerAdapter(fm) {
    override fun getCount(): Int = NUM_PAGES

    override fun getItem(position: Int): Fragment = ScreenSlidePageFragment()
}

// An equivalent ViewPager2 adapter class
class ScreenSlidePagerAdapter(fa: FragmentActivity) : FragmentStateAdapter(fa) {
    override fun getItemCount(): Int = NUM_PAGES

    override fun createFragment(position: Int): Fragment = ScreenSlidePageFragment()
}

Java

// A simple ViewPager adapter class for paging through fragments
public class ScreenSlidePagerAdapter extends FragmentStatePagerAdapter {
    public ScreenSlidePagerAdapter(FragmentManager fm) {
        super(fm);
    }

    @Override
    public Fragment getItem(int position) {
        return new ScreenSlidePageFragment();
    }

    @Override
    public int getCount() {
        return NUM_PAGES;
    }
}

// An equivalent ViewPager2 adapter class
private class ScreenSlidePagerAdapter extends FragmentStateAdapter {
    public ScreenSlidePagerAdapter(FragmentActivity fa) {
        super(fa);
    }

    @Override
    public Fragment createFragment(int position) {
        return new ScreenSlidePageFragment();
    }

    @Override
    public int getItemCount() {
        return NUM_PAGES;
    }
}

重构 TabLayout 接口

ViewPager2 引入了对 TabLayout 集成的更改。如果您目前使用 ViewPager 和 TabLayout 对象来显示水平标签页以进行导航，则需要重构 TabLayout 对象，以便与 ViewPager2 集成。

TabLayout 已与 ViewPager2 分离，现在作为 Material 组件的一部分提供。这意味着，如需使用它，您需要将适当的依赖项添加到 build.gradle 文件中：

Groovy

implementation "com.google.android.material:material:1.1.0-beta01"

Kotlin

implementation("com.google.android.material:material:1.1.0-beta01")

您还需要更改 TabLayout 元素在 XML 布局文件的层次结构中的位置。使用 ViewPager 时，TabLayout 元素声明为 ViewPager 元素的子元素；但使用 ViewPager2 时，TabLayout 元素直接在 ViewPager2 元素上方声明，位于同一级别：

<!-- A ViewPager element with a TabLayout -->
<androidx.viewpager.widget.ViewPager
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/pager"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.google.android.material.tabs.TabLayout
        android:id="@+id/tab_layout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

</androidx.viewpager.widget.ViewPager>

<!-- A ViewPager2 element with a TabLayout -->
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical">

    <com.google.android.material.tabs.TabLayout
        android:id="@+id/tab_layout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

    <androidx.viewpager2.widget.ViewPager2
        android:id="@+id/pager"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="1" />

</LinearLayout>

最后，您必须更新将 TabLayout 对象附加到 ViewPager 对象的代码。虽然 TabLayout 使用自己的 setupWithViewPager() 方法与 ViewPager 集成，但它需要 TabLayoutMediator 实例才能与 ViewPager2 集成。

TabLayoutMediator 对象还会处理为 TabLayout 对象生成网页标题的任务，这意味着适配器类不需要替换 getPageTitle()：

Kotlin

// Integrating TabLayout with ViewPager
class CollectionDemoFragment : Fragment() {
    ...
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        val tabLayout = view.findViewById(R.id.tab_layout)
        tabLayout.setupWithViewPager(viewPager)
    }
    ...
}

class DemoCollectionPagerAdapter(fm: FragmentManager) : FragmentStatePagerAdapter(fm) {

    override fun getCount(): Int  = 4

    override fun getPageTitle(position: Int): CharSequence {
        return "OBJECT ${(position + 1)}"
    }
    ...
}

// Integrating TabLayout with ViewPager2
class CollectionDemoFragment : Fragment() {
    ...
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        val tabLayout = view.findViewById(R.id.tab_layout)
        TabLayoutMediator(tabLayout, viewPager) { tab, position ->
            tab.text = "OBJECT ${(position + 1)}"
        }.attach()
    }
    ...
}

Java

// Integrating TabLayout with ViewPager
public class CollectionDemoFragment extends Fragment {
    ...
    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        TabLayout tabLayout = view.findViewById(R.id.tab_layout);
        tabLayout.setupWithViewPager(viewPager);
    }
    ...
}

public class DemoCollectionPagerAdapter extends FragmentStatePagerAdapter {
    ...
    @Override
    public int getCount() {
        return 4;
    }

    @Override
    public CharSequence getPageTitle(int position) {
        return "OBJECT " + (position + 1);
    }
    ...
}

// Integrating TabLayout with ViewPager2
public class CollectionDemoFragment : Fragment() {
    ...
    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        TabLayout tabLayout = view.findViewById(R.id.tab_layout);
        new TabLayoutMediator(tabLayout, viewPager,
                (tab, position) -> tab.setText("OBJECT " + (position + 1))
        ).attach();
    }
    ...
}

支持嵌套的可滚动元素

如果滚动视图的方向与其包含的 ViewPager2 对象相同，则 ViewPager2 本身不支持嵌套滚动视图。例如，对于垂直方向的 ViewPager2 对象内的垂直滚动视图，滚动将不起作用。

如需在具有相同方向的 ViewPager2 对象内支持滚动视图，您必须在预期滚动嵌套元素时对 ViewPager2 对象调用 requestDisallowInterceptTouchEvent()。ViewPager2 嵌套滚动示例演示了如何使用多功能自定义封装容器布局解决此问题。

其他资源

如需详细了解 ViewPager2，请参阅下面列出的其他资源。

视频

新篇章：迁移到 ViewPager2（2019 年 Android 开发者峰会）

从 ViewPager 迁移到 ViewPager2 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

迁移到 ViewPager2 的优势

垂直方向支持

从右到左支持

可修改的 Fragment 集合

DiffUtil

将您的应用迁移到 ViewPager2

更新 XML 布局文件

更新适配器类

构造函数参数

替换方法

摘要

Kotlin

Java

重构 TabLayout 接口

Groovy

Kotlin

Kotlin

Java

支持嵌套的可滚动元素

其他资源

视频

从 ViewPager 迁移到 ViewPager2