2019年7月3日水曜日

BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT 編 : ViewPager + FragmentPagerAdapter での onResume() の挙動

ViewPager + FragmentPagerAdapter での setVisibleUserHint の挙動」の BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT 編です。


FragmentPagerAdapter の getItem() で返す Fragment に次のようにログを入れました。 class SimpleFragment : Fragment() { override fun onStart() { super.onStart() println("$position : onStart") } override fun onResume() { super.onResume() println("$position : onResume") } override fun onPause() { super.onPause() println("$position : onPause") } override fun onStop() { super.onStop() println("$position : onStop") } }

1. レイアウトより前のタイミング(例えば onCreate())で adapter をセットしている場合 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) viewPager.adapter = MyPager(supportFragmentManager, FragmentPagerAdapter.BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT) } } この場合、ログは次のようになります。 System.out: 0 : onStart System.out: 1 : onStart System.out: 0 : onResume つまり
  • 1. position 0 の Fragment の onStart()
  • 2. position 1 の Fragment の onStart()
  • 3. position 0 の Fragment の onResume()
という流れです。



2. レイアウトより前のタイミング(例えば onCreate())で adapter をセットし、currentItem を変更している場合

onCreate() で ViewPager に adapter をセットした後 currentItem を 1 にしてみます。 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) viewPager.adapter = MyPager(supportFragmentManager, FragmentPagerAdapter.BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT) viewPager.currentItem = 1 } } この場合のログはこうなります。 System.out: 1 : onStart System.out: 0 : onStart System.out: 2 : onStart System.out: 1 : onResume つまり
  • 1. position 1 の Fragment の onStart()
  • 2. position 0 の Fragment の onStart()
  • 3. position 2 の Fragment の onStart()
  • 4. position 1 の Fragment の onResume()
という流れです。



3. レイアウトより後のタイミングで adapter をセットしている場合 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) Handler().postDelayed( { viewPager.adapter = MyPager(supportFragmentManager, FragmentPagerAdapter.BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT) }, 1000 ) } } onCreate() から1秒後に adapter をセットしてみます。この場合ログは次のようになります。 System.out: 0 : onStart System.out: 1 : onStart System.out: 0 : onResume 「1. レイアウトより前のタイミング(例えば onCreate())で adapter をセットしている場合」と同じですね。
  • 1. position 0 の Fragment の onStart()
  • 2. position 1 の Fragment の onStart()
  • 3. position 0 の Fragment の onResume()
という流れです。



4. レイアウトより後のタイミングで adapter をセットし、currentItem を変更している場合

onCreate() から1秒後に adapter をセットし、currentItem を 1 にしてみます。 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) Handler().postDelayed( { viewPager.adapter = MyPager(supportFragmentManager, FragmentPagerAdapter.BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT) viewPager.currentItem = 1 }, 1000 ) } } この場合ログは次のようになります。 System.out: 0 : onStart System.out: 1 : onStart System.out: 0 : onResume System.out: 2 : onStart System.out: 0 : onPause System.out: 1 : onResume 「2. レイアウトより前のタイミング(例えば onCreate())で adapter をセットし、currentItem を変更している場合」と同じになりません!

まず「3. レイアウトより後のタイミングで adapter をセットしている場合」と同じことが起こります。

つまり
  • 1. position 0 の Fragment の onStart()
  • 2. position 1 の Fragment の onStart()
  • 3. position 0 の Fragment の onResume()
という流れが最初にあります。

その後
  • 4. position 2 の Fragment の onStart()
  • 5. position 0 の Fragment の onPause()
  • 6. position 1 の Fragment の onResume()
という流れになります。

adapter をセットしたタイミングで 1 〜 3 までの流れが起こり、currentItem を 1 にしたタイミングで 4 〜 6 の流れが起こります。

このように、レイアウトよりも後のタイミングで adapter をセットすると、その時点で position 0 の Fragment を PrimaryItem として onResume() まで呼ばれてしまいます。

そのため、レイアウトよりも後のタイミングで adapter をセットして currentItem を 0 以外に変更する場合、「Fragment がユーザーに表示されたタイミングで xx したい」処理のトリガーとして onResume() を使うには注意が必要です。

adapter がセットされている間の onResume() に反応してしまうと、その後 currentItem が変更されて実際にはユーザーにはほぼ見えない Fragment でも処理が走ってしまうため、adapter がセットされている間だけフラグを立てておいて onResume() で反応しないような工夫が必要になります。


androidx.fragment:fragment:1.1.0-alpha07 で userVisibleHint は deprecated になりました

ViewPager + FragmentPagerAdapter での setVisibleUserHint の挙動」の冒頭で軽く言及しましたが、androidx.fragment:fragment:1.1.0-alpha07 で FragmentPagerAdapter および FragmentStatePagerAdapter に変更が入っています。

1.1.0-alpha08 でも変更が入っており、以下の挙動は 1.1.0-rc01 で確認しています。


今まで FragmentPagerAdapter および FragmentStatePagerAdapter のコンストラクタでは FragmentManager だけを渡していましたが、1.1.0-alpha07 からはフラグ(int)も渡すように変わりました。

ここで指定できるフラグとして以下の2つが用意されています。
  • BEHAVIOR_SET_USER_VISIBLE_HINT
  • BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT
今までの FragmentManager だけを渡すコンストラクタは deprecated になり、内部ではフラグとして BEHAVIOR_SET_USER_VISIBLE_HINT が指定されます。 public abstract class FragmentPagerAdapter extends PagerAdapter { ... @Deprecated public FragmentPagerAdapter(@NonNull FragmentManager fm) { this(fm, BEHAVIOR_SET_USER_VISIBLE_HINT); } ... } つまり BEHAVIOR_SET_USER_VISIBLE_HINT を指定すると、1.1.0-alpha06 までと同じ挙動になるということです。

ただし、この BEHAVIOR_SET_USER_VISIBLE_HINT 自体も deprecated です。 public abstract class FragmentPagerAdapter extends PagerAdapter { ... @Deprecated public static final int BEHAVIOR_SET_USER_VISIBLE_HINT = 0; public static final int BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT = 1; ... } さらに Fragment の setUserVisibleHint(), getUserVisibleHint() も deprecated になりました。


では新しい BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT を指定するとどうなるのか、挙動を確認してみましょう。

FragmentPagerAdapter の getItem() で返す Fragment に次のようにログを入れました。 class SimpleFragment : Fragment() { override fun setUserVisibleHint(isVisibleToUser: Boolean) { super.setUserVisibleHint(isVisibleToUser) println("$position : setUserVisibleHint : $isVisibleToUser") } override fun onStart() { super.onStart() println("$position : onStart") } override fun onResume() { super.onResume() println("$position : onResume") } override fun onPause() { super.onPause() println("$position : onPause") } override fun onStop() { super.onStop() println("$position : onStop") } } class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) viewPager.adapter = MyPager(supportFragmentManager, FragmentPagerAdapter.BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT) } } この場合、ログは次のようになります。 System.out: 0 : onStart System.out: 1 : onStart System.out: 0 : onResume setUserVisibleHint() は呼ばれません。

position 0 と 1 の Fragment の onStart() が呼ばれ、その後 position 0 の Fragment だけ onResume() が呼ばれます。


この状態(position 0 が表示されいる状態)で右にスワイプして position 1 を表示すると、次のようなログが出ます。 System.out: 2 : onStart System.out: 0 : onPause System.out: 1 : onResume position 2 の Fragment が生成されて onStart() が呼ばれ、その後 position 0 の Fragment の onPause() が呼ばれて、position 1 の Fragment の onResume() が呼ばれます。


この状態(position 1 が表示されいる状態)で左にスワイプして再度 position 0 を表示すると、次のようなログが出ます。 System.out: 2 : onStop System.out: 1 : onPause System.out: 0 : onResume position 2 の Fragment が detach されるので onStop() が呼ばれています。
その後 position 1 の Fragment の onPause() が呼ばれて、position 0 の Fragment の onResume() が呼ばれます。


つまり、BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT を指定すると、PrimaryItem の Fragment だけが Lifecycle.State.RESUMED に達し、その他の Fragment は Lifecycle.State.STARTED で止まるという挙動になります。

onResume() が呼ばれるのは PrimaryItem の Fragment だけなので、「Fragment がユーザーに表示されたタイミングで xx したい」という場合に onResume() をトリガーとすることができるようになりました。



ViewPager + FragmentPagerAdapter での setVisibleUserHint の挙動

以下は androidx.fragment:fragment:1.0.0 での挙動です。1.1.0-alpha07 で別の挙動にするためのオプションが追加されています。



ViewPager + FragmentPagerAdapter の構成はよく使うと思います。

FragmentPagerAdapter では、ViewPager のページが切り替わる処理の中で、
以前の PrimaryItem の Fragment に対して setUserVisibleHint(false) を呼び、
新しい PrimaryItem の Fragment に対して setUserVisibleHint(true) を呼んでいます。


挙動を確認するために、FragmentPagerAdapter の getItem() で返す Fragment に次のようにログを入れました。 class SimpleFragment : Fragment() { ... override fun setUserVisibleHint(isVisibleToUser: Boolean) { println("$position : setUserVisibleHint : before super : to = $isVisibleToUser, current = $userVisibleHint") super.setUserVisibleHint(isVisibleToUser) println("$position : setUserVisibleHint : after super : to = $isVisibleToUser, current = $userVisibleHint") } override fun onStart() { super.onStart() println("$position : onStart : $userVisibleHint") } }

1. レイアウトより前のタイミング(例えば onCreate())で adapter をセットしている場合 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) viewPager.adapter = MyPager(supportFragmentManager) } } この場合、ログは次のようになります。 System.out: 0 : setUserVisibleHint : before super : to = false, current = true System.out: 0 : setUserVisibleHint : after super : to = false, current = false System.out: 1 : setUserVisibleHint : before super : to = false, current = true System.out: 1 : setUserVisibleHint : after super : to = false, current = false System.out: 0 : setUserVisibleHint : before super : to = true, current = false System.out: 0 : setUserVisibleHint : after super : to = true, current = true System.out: 0 : onStart : true System.out: 1 : onStart : false まず position 0 と 1 の Fragment の setUserVisibleHint が false にセットされます。

super.setUserVisibleHint() が呼ばれる前の時点で取得した userVisibleHint が true ですね。 実は Fragment の mUserVisibleHint はデフォルトが true です。 package androidx.fragment.app; ... public class Fragment implements ComponentCallbacks, OnCreateContextMenuListener, LifecycleOwner, ViewModelStoreOwner { ... // Hint provided by the app that this fragment is currently visible to the user. boolean mUserVisibleHint = true; ... }
次に position 0 の Fragment の setUserVisibleHint が true にセットされます。

その後、Fragment の onStart() が呼ばれます。

つまり
  • 1. position 0 の Fragment の setUserVisibleHint() : true → false
  • 2. position 1 の Fragment の setUserVisibleHint() : true → false
  • 3. position 0 の Fragment の setUserVisibleHint() : false → true
  • 4. position 0 の Fragment の onStart() : setUserVisibleHint は true
  • 5. position 1 の Fragment の onStart() : setUserVisibleHint は false
という流れです。



2. レイアウトより前のタイミング(例えば onCreate())で adapter をセットし、currentItem を変更している場合

onCreate() で ViewPager に adapter をセットした後 currentItem を 1 にしてみます。 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) viewPager.adapter = MyPager(supportFragmentManager) viewPager.currentItem = 1 } } この場合のログはこうなります。 System.out: 1 : setUserVisibleHint : before super : to = false, current = true System.out: 1 : setUserVisibleHint : after super : to = false, current = false System.out: 0 : setUserVisibleHint : before super : to = false, current = true System.out: 0 : setUserVisibleHint : after super : to = false, current = false System.out: 2 : setUserVisibleHint : before super : to = false, current = true System.out: 2 : setUserVisibleHint : after super : to = false, current = false System.out: 1 : setUserVisibleHint : before super : to = true, current = false System.out: 1 : setUserVisibleHint : after super : to = true, current = true System.out: 1 : onStart : true System.out: 0 : onStart : false System.out: 2 : onStart : false まず position 1, 0, 2 の Fragment の setUserVisibleHint が false にセットされ、
次に position 1 の Fragment の setUserVisibleHint が true にセットされ、
その後、Fragment の onStart() が呼ばれます。

つまり
  • 1. position 1 の Fragment の setUserVisibleHint() : true → false
  • 2. position 0 の Fragment の setUserVisibleHint() : true → false
  • 3. position 2 の Fragment の setUserVisibleHint() : true → false
  • 4. position 1 の Fragment の setUserVisibleHint() : false → true
  • 5. position 1 の Fragment の onStart() : setUserVisibleHint は true
  • 6. position 0 の Fragment の onStart() : setUserVisibleHint は false
  • 7. position 2 の Fragment の onStart() : setUserVisibleHint は false
という流れです。



3. レイアウトより後のタイミングで adapter をセットしている場合 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) Handler().postDelayed( { viewPager.adapter = MyPager(supportFragmentManager) }, 1000 ) } } onCreate() から1秒後に adapter をセットしてみます。この場合ログは次のようになります。 System.out: 0 : setUserVisibleHint : before super : to = false, current = true System.out: 0 : setUserVisibleHint : after super : to = false, current = false System.out: 1 : setUserVisibleHint : before super : to = false, current = true System.out: 1 : setUserVisibleHint : after super : to = false, current = false System.out: 0 : setUserVisibleHint : before super : to = true, current = false System.out: 0 : setUserVisibleHint : after super : to = true, current = true System.out: 0 : onStart : true System.out: 1 : onStart : false 「1. レイアウトより前のタイミング(例えば onCreate())で adapter をセットしている場合」と同じですね。
  • 1. position 0 の Fragment の setUserVisibleHint() : true → false
  • 2. position 1 の Fragment の setUserVisibleHint() : true → false
  • 3. position 0 の Fragment の setUserVisibleHint() : false → true
  • 4. position 0 の Fragment の onStart() : setUserVisibleHint は true
  • 5. position 1 の Fragment の onStart() : setUserVisibleHint は false
という流れです。



4. レイアウトより後のタイミングで adapter をセットし、currentItem を変更している場合

onCreate() から1秒後に adapter をセットし、currentItem を 1 にしてみます。 class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) Handler().postDelayed( { viewPager.adapter = MyPager(supportFragmentManager) viewPager.currentItem = 1 }, 1000 ) } } この場合ログは次のようになります。 System.out: 0 : setUserVisibleHint : before super : to = false, current = true System.out: 0 : setUserVisibleHint : after super : to = false, current = false System.out: 1 : setUserVisibleHint : before super : to = false, current = true System.out: 1 : setUserVisibleHint : after super : to = false, current = false System.out: 0 : setUserVisibleHint : before super : to = true, current = false System.out: 0 : setUserVisibleHint : after super : to = true, current = true System.out: 0 : onStart : true System.out: 1 : onStart : false System.out: 2 : setUserVisibleHint : before super : to = false, current = true System.out: 2 : setUserVisibleHint : after super : to = false, current = false System.out: 0 : setUserVisibleHint : before super : to = false, current = true System.out: 0 : setUserVisibleHint : after super : to = false, current = false System.out: 1 : setUserVisibleHint : before super : to = true, current = false System.out: 1 : setUserVisibleHint : after super : to = true, current = true System.out: 2 : onStart : false 「2. レイアウトより前のタイミング(例えば onCreate())で adapter をセットし、currentItem を変更している場合」と同じになりません!

まず「3. レイアウトより後のタイミングで adapter をセットしている場合」と同じことが起こります。

つまり
  • 1. position 0 の Fragment の setUserVisibleHint() : true → false
  • 2. position 1 の Fragment の setUserVisibleHint() : true → false
  • 3. position 0 の Fragment の setUserVisibleHint() : false → true
  • 4. position 0 の Fragment の onStart() : setUserVisibleHint は true
  • 5. position 1 の Fragment の onStart() : setUserVisibleHint は false
という流れが最初にあります。

その後
  • 6. position 2 の Fragment の setUserVisibleHint() : true → false
  • 7. position 0 の Fragment の setUserVisibleHint() : true → false
  • 8. position 1 の Fragment の setUserVisibleHint() : false → true
  • 9. position 2 の Fragment の onStart() : setUserVisibleHint は false
という流れになります。 adapter をセットしたタイミングで 1 〜 5 までの流れが起こり、currentItem を 1 にしたタイミングで 6 〜 9 の流れが起こります。

しかも position 1 が表示されているのに、onStart() 時の setUserVisibleHint 値を見ると position 0 が表示されているかのようです。


このように、レイアウトよりも後のタイミングで adapter をセットすると、その時点で position 0 の Fragment を PrimaryItem として onStart() まで呼ばれてしまいます。
そのため、レイアウトよりも後のタイミングで adapter をセットし、currentItem を 0 以外に変更する場合は setUserVisibleHint() や onStart() が呼ばれるタイミングに注意が必要です。