ViewPager2重大更新，支持offscreenPageLimit

時間  2019-11-06
標籤 viewpager2 viewpager 重大 更新 支持 offscreenpagelimit 欄目 Android 简体版
原文   原文鏈接

前言

最近ViewPager2發佈了1.0.0-alpha04版本，新增offscreenPageLimit功能，該功能在ViewPager上並不友好，如今官方將此功能延續下來，這回是騾子是馬呢？趕忙拉出來溜溜；android

閱讀指南:git

  • 內容基於ViewPager21.0.0-alpha04版本講解，因爲正式版還未發佈，若有功能變更有勞看官指出
  • 內容重點：介紹ViewPager2的offscreenPageLimit特性和預加載機制，另外包括Adapter的狀態和Fragment的生命週期等內容

ViewPager頑疾

頑疾是什麼鬼，沒有這麼嚴重吧。ViewPager有兩個毛病：不能關閉預加載和更新Adapter不生效，因此開頭我爲何說offscreenPageLimit在ViewPager上十分不友好；本質上是由於offscreenPageLimit不能設置成0(設置成0就是想象中的關閉預加載)；github

上面是ViewPager默認狀況下的加載示意圖，當切換到當前頁面時，會默認預加載左右兩側的佈局到ViewPager中，儘管兩側的View並不可見的，咱們稱這種狀況叫預加載；因爲ViewPager對offscreenPageLimit設置了限制，頁面的預加載是不可避免；數組

ViewPager緩存

private static final int DEFAULT_OFFSCREEN_PAGES = 1;

public void setOffscreenPageLimit(int limit) {
    if (limit < DEFAULT_OFFSCREEN_PAGES) {//不容許小於1
        Log.w(TAG, "Requested offscreen page limit " + limit + " too small; defaulting to "
                + DEFAULT_OFFSCREEN_PAGES);
        limit = DEFAULT_OFFSCREEN_PAGES;
    }
    if (limit != mOffscreenPageLimit) {
        mOffscreenPageLimit = limit;
        populate();
    }
}
複製代碼

ViewPager強制預加載的邏輯在Fragment配合ViewPager使用時依然存在bash

Fragment懶加載來龍去脈

先說PagerAdapter：app

PagerAdapter經常使用方法以下：ide

  • instantiateItem(ViewGroup container, int position)初始化ItemView，返回須要添加ItemView
  • destroyItem(iewGroup container, int position, Object object)銷燬ItemView，移除指定的ItemView
  • isViewFromObject(View view, Object object)View和Object是否對應
  • setPrimaryItem(ViewGroup container, int position, Object object) 當前頁面的主Item
  • getCount()獲取Item個數

先說setPrimaryItem(ViewGroup container, int position, Object object)，該方法表示當前頁面正在顯示主要Item，何爲主要Item？若是預加載的ItemView已經劃入屏幕，當前的PrimaryItem依然不會改變，除非新的ItemView徹底劃入屏幕，且滑動已經中止纔會判斷；工具

因爲ViewPager不可避免的進行佈局預加載，形成PagerAdapter必須提早調用instantiateItem(ViewGroup container, int position)方法，instantiateItem()是建立ItemView的惟一入口方法，因此PagerAdapter的實現類FragmentPagerAdapter和FragmentStatePagerAdapter必須抓住該方法進行Fragment對象的建立；佈局

碰巧的是，FragmentPagerAdapter和FragmentStatePagerAdapter一股腦的在instantiateItem()中進行建立且進行add或attach操做，並無在setPrimaryItem()方法中對Fragment進行操做；

所以，預加載會致使不可見的Fragment一股腦的調用onCreate、onCreateView、onResume等方法，用戶只能經過Fragment.setUserVisibleHint()方法進行識別；

大多數的懶加載都是對Fragment作手腳，結合生命週期方法和setUserVisibleHint狀態，控制數據延遲加載，而佈局只能提早進入；

ViewPager2基本使用

  • build.gradle引入
implementation 'androidx.viewpager2:viewpager2:1.0.0-alpha04'
複製代碼
  • 佈局文件添加
<androidx.viewpager2.widget.ViewPager2
    android:id="@+id/view_pager"
    android:layout_width="match_parent"
    android:layout_height="0dp"
    android:layout_weight="1" />
複製代碼
  • 設置ViewHolder+Adapter
ViewPager2 viewPager = findViewById(R.id.view_pager2);
viewPager.setAdapter(new RecyclerView.Adapter<ViewHolder>() {
        @Override
        public ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
            View itemView = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_card_layout, parent, false);
            ViewHolder viewHolder = new ViewHolder(itemView);
            return viewHolder;
        }
        @Override
        public void onBindViewHolder(@NonNull ViewHolder holder, int position) {
            holder.labelCenter.setText(String.valueOf(position));
        }
        @Override
        public int getItemCount() {
            return SIZE;
        }
    }));

static class ViewHolder extends RecyclerView.ViewHolder{
    private final TextView labelCenter;
    public ViewHolder(@NonNull View itemView) {
        super(itemView);
        labelCenter = itemView.findViewById(R.id.label_center);
    }
}
複製代碼
  • 設置Fragment+Adapter
viewPager.setAdapter(new FragmentStateAdapter(this) {
        @NonNull
        @Override
        public Fragment getItem(int position) {
            return new VSFragment();
        }

        @Override
        public int getItemCount() {
            return SIZE;
        }
    });
複製代碼

ViewPager2的使用很是簡單，甚至比ViewPager還要簡單，只要熟悉RecyclerView的童鞋確定會寫ViewPager2；

ViewPager2經常使用方法以下:

  • setAdapter() 設置適配器
  • setOrientation() 設置佈局方向
  • setCurrentItem() 設置當前Item下標
  • beginFakeDrag() 開始模擬拖拽
  • fakeDragBy() 模擬拖拽中
  • endFakeDrag() 模擬拖拽結束
  • setUserInputEnabled() 設置是否容許用戶輸入/觸摸
  • setOffscreenPageLimit()設置屏幕外加載頁面數量
  • registerOnPageChangeCallback() 註冊頁面改變回調
  • setPageTransformer() 設置頁面滑動時的變換效果

不少好看好玩的效果，請讀者自行運行官方的DEMO(github.com/googlesampl…)；

重要申明

在上文說ViewPager預加載時，我就在想offscreenPageLimit能不能稱之爲預加載，若是在ViewPager上能夠，那麼在ViewPager2上可能就要混淆了，由於ViewPager2擁有RecyclerView的一整套緩存策略，包括RecyclerView的預加載；爲了不混淆，在下面的文章中我把offscreenPageLimit定義爲離屏加載，預加載只表明RecyclerView的預加載；

ViewPager2離屏加載

在1.0.0-alpha04版本中，ViewPager2提供了離屏加載功能，該功能和ViewPager的預加載存的的意義彷佛是同樣的；

ViewPager2

public static final int OFFSCREEN_PAGE_LIMIT_DEFAULT = 0;

public void setOffscreenPageLimit(int limit) {
    if (limit < 1 && limit != OFFSCREEN_PAGE_LIMIT_DEFAULT) {
        throw new IllegalArgumentException(
                "Offscreen page limit must be OFFSCREEN_PAGE_LIMIT_DEFAULT or a number > 0");
    }
    mOffscreenPageLimit = limit;
    // Trigger layout so prefetch happens through getExtraLayoutSize()
    mRecyclerView.requestLayout();
}
複製代碼

從代碼能夠看出，ViewPager2的離屏加載最小能夠爲0，僅僅從這一步開始，我大膽的猜想ViewPager2支持所謂的懶加載，帶着好奇，看一眼OffscreenPageLimit實現原理;

ViewPager2.LinearLayoutManagerImpl

@Override
protected void calculateExtraLayoutSpace(@NonNull RecyclerView.State state,
        @NonNull int[] extraLayoutSpace) {
    int pageLimit = getOffscreenPageLimit();
    if (pageLimit == OFFSCREEN_PAGE_LIMIT_DEFAULT) {//若是等於默認值(0)，調用基類的方法
        // Only do custom prefetching of offscreen pages if requested
        super.calculateExtraLayoutSpace(state, extraLayoutSpace);
        return;
    }
    //返回offscreenSpace
    final int offscreenSpace = getPageSize() * pageLimit;
    extraLayoutSpace[0] = offscreenSpace;
    extraLayoutSpace[1] = offscreenSpace;
}
複製代碼

OffscreenPageLimit本質上是重寫LinearLayoutManager的calculateExtraLayoutSpace方法，該方法是最新的recyclerView包加入的功能；

calculateExtraLayoutSpace方法定義了佈局額外的空間，何爲佈局額外的空間？默認空間等於RecyclerView的寬高空間，定義這個意在能夠放大可佈局的空間，該方法參數extraLayoutSpace是一個長度爲2的int數組，第一條數據接受左邊/上邊的額外空間，第二條數據接受右邊/下邊的額外空間，故上訴代碼是代表左右/上下各擴大offscreenSpace；

綜上代碼，OffscreenPageLimit其實就是放大了LinearLayoutManager的佈局空間，咱們下面看運行效果；

佈局對比

爲了對比二者加載佈局的效果，我準備了LinearLayout同時展現ViewPager和ViewPager2，設置相同的Item佈局和數據源，而後用Android佈局分析工具抓取二者的佈局結構，代碼比較簡單，就不貼出來了；

默認offscreenPageLimit

從運行結果來看，ViewPager會默認會預佈局兩側各一個佈局，ViewPager2默認不進行預佈局，主要由各自的默認offscreenPageLimit參數決定，ViewPager默認爲1且不容許小於1，ViewPager2默認爲0

設置offscreenPageLimit=2

分析運行結果，在設置相同的offscreenPageLimit時，二者都會預佈局左右(上下)二者的offscreenPageLimit個ItemView；

從對比結果上來看，ViewPager2的offscreenPageLimit和ViewPager運行結果同樣，可是ViewPager2最小offscreenPageLimit能夠設置爲0；

ViewPager2預加載和緩存

ViewPager2預加載即RecyclerView的預加載，代碼在RecyclerView的GapWorker中，這個知識可能有些同窗不是很瞭解，推薦先看這篇博客medium.com/google-deve…；

在ViewPager2上默認開啓預加載，表現形式是在拖動控件或者Fling時，可能會預加載一條數據；下面是預加載的示意圖：

如何關閉預加載？

((RecyclerView)viewPager.getChildAt(0)).getLayoutManager().setItemPrefetchEnabled(false);
複製代碼

預加載的開關在LayoutManager上，只須要獲取LayoutManager並調用setItemPrefetchEnabled()便可控制開關；

ViewPager2默認會緩存2條ItemView，並且在最新的RecyclerView中能夠自定義緩存Item的個數；

RecyclerView

public void setItemViewCacheSize(int size) {
    mRecycler.setViewCacheSize(size);
}
複製代碼

小結: 預加載和緩存在View層面沒有本質的區別，都是已經準備了佈局，可是沒有加載到parent上； 預加載和離屏加載在View層面有本質的區別，離屏加載的View已經添加到parent上；

提早加載對Adapter影響

所謂的提早加載，是指當前position不可見但加載了佈局，包括上面說的預加載和離屏加載，下面先介紹一下Adapter:

ViewPager2的Adapter本質上是RecyclerView.Adapter，下面列舉經常使用方法：

  • onCreateViewHolder(ViewGroup parent, int viewType)建立ViewHolder
  • onBindViewHolder(VH holder, int position)綁定ViewHolder
  • onViewRecycled(VH holder)當View被回收
  • onViewAttachedToWindow(VH holder)當前View加載到窗口
  • onViewDetachedFromWindow(VH holder)當前View從窗口移除
  • getItemCount()//獲取Item個數

下面主要針對ItemView的建立來講，暫不討論回收的狀況；

  • onBindViewHolder 預加載和離屏加載都會調用
  • onViewAttachedToWindow 離屏加載ItemView會調用，可見ItemView會調用
  • onViewDetachedFromWindow 從可見到不可見的ItemView(除離屏中)一定調用

小結: 預加載和緩存在Adapter層面沒有區別，都會調用onBindViewHolder方法； 預加載和離屏加載在Adapter層面有本質的區別，離屏加載的View會調用onViewAttachedToWindow；

ViewPager2對Fragment支持

目前，ViewPager2對Fragment的支持只能使用FragmentStateAdapter，使用起來也是很是簡單：

默認狀況下，ViewPager2是開啓預加載關閉離屏加載的，這種狀況下，切換頁面對Fragment生命周如何？

問題一：關閉預加載對Fragment的影響： 通過驗證，是否開啓預加載，對Fragment的生命週期沒有影響，結果和默認上圖是同樣的；

問題二：開啓離屏加載對Fragment的影響： 設置offscreenPageLimit=1時：

打印結果解讀：

備註：log日誌下標是從2開始的，標註的頁碼是從1開始，請自行矯正；

  • 默認狀況下，ViewPager2會緩存兩條數據，因此滑動到第4頁，第1頁的Fragment纔開始移除，這能夠理解；
  • 設置offscreenPageLimit=1時，ViewPager2在第1頁會加載兩條數據，這能夠理解，會把下一頁View提早加載進來；之後每滑一頁，會加載下一頁數組，直到第5頁，會移除第1頁的Fragment；第6頁會移除第2頁的Fragment

如何理解offscreenPageLimit對Fragment的影響，假設offscreenPageLimit=1，這樣ViewPager2最多能夠承託3個ItemView，再加上2個緩存的ItemView，就是5個，因爲offscreenPageLimit會在ViewPager2兩邊放置一個，因此向前最多承載4個，向後最多能承載1個(預加載對Fragment沒有影響，因此不計算)，這樣很天然就是第5個時候，回收第1個；

FragmentStateAdapter源碼簡單解讀

onCreateViewHolder()方法

public final FragmentViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
    return FragmentViewHolder.create(parent);
}
static FragmentViewHolder create(ViewGroup parent) {
    FrameLayout container = new FrameLayout(parent.getContext());
    container.setLayoutParams(
            new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,
                    ViewGroup.LayoutParams.MATCH_PARENT));
    container.setId(ViewCompat.generateViewId());
    container.setSaveEnabled(false);
    return new FragmentViewHolder(container);
}
複製代碼

onCreateViewHolder()建立一個寬高都MATCH_PARENT的FrameLayout，注意這裏並不像PagerAdapter是Fragment的rootView；

onBindViewHolder()

public final void onBindViewHolder(final @NonNull FragmentViewHolder holder, int position) {
    final long itemId = holder.getItemId();
    final int viewHolderId = holder.getContainer().getId();
    final Long boundItemId = itemForViewHolder(viewHolderId); // item currently bound to the VH
    if (boundItemId != null && boundItemId != itemId) {
        removeFragment(boundItemId);
        mItemIdToViewHolder.remove(boundItemId);
    }
    mItemIdToViewHolder.put(itemId, viewHolderId); // this might overwrite an existing entry
    //保證目標Fragment不爲空，意思是能夠提早建立
    ensureFragment(position);
    /** Special case when {@link RecyclerView} decides to keep the {@link container}
     * attached to the window, but not to the view hierarchy (i.e. parent is null) */
    final FrameLayout container = holder.getContainer();
    //若是ItemView已經在添加到Window中，且parent不等於null，會觸發綁定viewHoder操做；
    if (ViewCompat.isAttachedToWindow(container)) {
        if (container.getParent() != null) {
            throw new IllegalStateException("Design assumption violated.");
        }
        container.addOnLayoutChangeListener(new View.OnLayoutChangeListener() {
            @Override
            public void onLayoutChange(View v, int left, int top, int right, int bottom,
                    int oldLeft, int oldTop, int oldRight, int oldBottom) {
                if (container.getParent() != null) {
                    container.removeOnLayoutChangeListener(this);
                    //將Fragment和ViewHolder綁定
                    placeFragmentInViewHolder(holder);
                }
            }
        });
    }
    //回收垃圾Fragments
    gcFragments();
}
複製代碼
  • onBindViewHolder()首先會獲取當前position對應的Fragment，這意味着預加載的Fragment對象會提早建立；
  • 若是當前的holder.itemView已經添加到屏幕且已經佈局且parent不等於空，就會將Fragment綁定到ViewHodler;
  • 每次調用都會gc一次，主要的避免用戶修改數據源形成垃圾對象；

onViewAttachedToWindow()

public final void onViewAttachedToWindow(@NonNull final FragmentViewHolder holder) {
    placeFragmentInViewHolder(holder);
    gcFragments();
}
複製代碼

onViewAttachedToWindow()方法調用onViewAttachedToWindow將Fragment和hodler綁定；

onViewRecycled()

public final void onViewRecycled(@NonNull FragmentViewHolder holder) {
    final int viewHolderId = holder.getContainer().getId();
    final Long boundItemId = itemForViewHolder(viewHolderId); // item currently bound to the VH
    if (boundItemId != null) {
        removeFragment(boundItemId);
        mItemIdToViewHolder.remove(boundItemId);
    }
}
複製代碼

當onViewRecycled()時纔會觸發Fragment移除;

核心添加操做：

//將Fragment.rootView添加到FrameLayout;
 scheduleViewAttach(fragment, container);//將rootI
 mFragmentManager.beginTransaction().add(fragment, "f" + holder.getItemId()).commitNow();
 
 //主要是監聽onFragmentViewCreated方法，獲取rootView而後添加到container
 private void scheduleViewAttach(final Fragment fragment, final FrameLayout container) {
    // After a config change, Fragments that were in FragmentManager will be recreated. Since
    // ViewHolder container ids are dynamically generated, we opted to manually handle
    // attaching Fragment views to containers. For consistency, we use the same mechanism for
    // all Fragment views.
    mFragmentManager.registerFragmentLifecycleCallbacks(
            new FragmentManager.FragmentLifecycleCallbacks() {
                @Override
                public void onFragmentViewCreated(@NonNull FragmentManager fm,
                        @NonNull Fragment f, @NonNull View v,
                        @Nullable Bundle savedInstanceState) {
                    if (f == fragment) {
                        fm.unregisterFragmentLifecycleCallbacks(this);
                        addViewToContainer(v, container);
                    }
                }
            }, false);
}
複製代碼

更詳細的FragmentStateAdapter源碼解讀盡請期待；

but!!!

Fragment中監聽不到setUserVisibleHint

在設置offscreenPageLimit>0時，Fragment中是監聽不到setUserVisibleHint調用的，我查了源碼沒有調用，並且該方法被標記過期，因此，適用於ViewPager那一套懶加載Fragment在這裏恐怕是不行了；

話又說回來，既然想玩懶加載，爲啥還要設置offscreenPageLimit>0呢，offscreenPageLimit＝0就自帶懶加載效果；

Adapter小結:

  • 目前ViewPager2對Fragment支持只能用FragmentStateAdapter，FragmentStateAdapter在遇到預加載時，只會建立Fragment對象，不會把Fragment真正的加入到佈局中，因此自帶懶加載效果；
  • FragmentStateAdapter不會一直保留Fragment實例，回收的ItemView也會移除Fragment，因此得作好Fragment`重建後恢復數據的準備；
  • FragmentStateAdapter在遇到offscreenPageLimit>0時，處理離屏Fragment和可見Fragment沒有什麼區別，因此沒法經過setUserVisibleHint判斷顯示與否，這一點知得注意；

ViewPager懶加載請注意

新版的Fragment中(Version 1.1.0-alpha07)，該方法setUserVisibleHint已通過時，由FragmentTransactionsetMaxLifecycle替代，新版本的FragmentPagerAdapter能夠設置直接調用生命週期，這表明ViewPager＋Fragment懶加載有更好的解決方案，請注意

最後

ViewPager2更多優勢

因爲本章篇幅有點，沒有對ViewPager2進行的全面介紹，不表明ViewPager就僅此而已，就當前版原本看，ViewPager2的優勢或者特有的功能以下：

  • 支持RecyclerView級別的複用
  • 支持預加載和離屏加載(本章介紹)
  • 支持動態更新Adapter(ViewPager大坑之一)
  • 支持模擬拖拽
  • 支持豎直方向滑動
  • 支持頁面滑動狀態監聽和頁面變換(延續了ViewPager的功能)
  • 只想到這麼多了

總結

這一次ViewPager2更新，官方貌似要發力替換ViewPager了，不管是它高效的複用仍是自帶懶加載，亦或是更新有效的Adapter，都要比ViewPager強大，若是看官老爺們想嘗試升級，在下十分讚揚，但從當前版原本看，請謹慎使用Fragment+offscreenPageLimit>0組合的狀況。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程