ViewPager and Fragment State Management: The Right Way to Store Fragment State

How FragmentPagerAdapter Works

When using FragmentPagerAdapter, the system automatically handles Fragment lifecycle management. The FragmentPagerAdapter.getItem(int position) method is only called when a Fragment for that specific position doesn't exist. After configuration changes (such as screen rotation), Android detects that it has already created and saved a Fragment for this position and attempts to reconnect with it using FragmentManager.findFragmentByTag() instead of creating a new instance.

Analysis of Common Error Patterns

Many developers create new Fragment instances every time in Activity.onCreate(Bundle), which is a common mistake. When Fragments are already added to the FragmentManager, the system automatically recreates them during configuration changes, eliminating the need for manual re-addition. This duplicate creation leads to Fragment state confusion and lifecycle callback anomalies.

Standard Fragment Usage Pattern

In standard Fragment usage scenarios, the following pattern is recommended:

protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    
    CustomFragment fragment;
    if (savedInstanceState != null) {
        fragment = (CustomFragment) getSupportFragmentManager().findFragmentByTag("customtag");
    } else {
        fragment = new CustomFragment();
        getSupportFragmentManager().beginTransaction().add(R.id.container, fragment, "customtag").commit(); 
    }
}

Fragment Management in ViewPager

When using FragmentPagerAdapter, Fragment management is delegated to the adapter, and developers don't need to perform the standard steps mentioned above. By default, the adapter only preloads one Fragment in front of and behind the current position (adjustable via ViewPager.setOffscreenPageLimit(int)). Due to this lazy loading mechanism, directly calling Fragment methods outside the adapter may be unreliable since these Fragments might not have been created yet or might have been destroyed.

Effective State Preservation Solutions

Using putFragment and getFragment to save and restore Fragment references is a viable solution, similar to standard Fragment usage patterns. This approach bypasses ViewPager's lazy loading feature but ensures that required Fragments are always available.

Another approach involves overriding the FragmentPageAdapter.instantiateItem(View, int) method and saving the Fragment reference returned from the super call:

@Override
public Object instantiateItem(ViewGroup container, int position) {
    Fragment fragment = (Fragment) super.instantiateItem(container, position);
    // Save fragment reference
    return fragment;
}

Best Practice Recommendations

To ensure reliable Fragment state management, it's recommended to: set offscreenPageLimit sufficiently large to include all Fragments that need persistence; avoid performing critical initialization in Fragment constructors; save essential data in onSaveInstanceState; understand the interaction between Fragment lifecycle and ViewPager scrolling behavior.