如何为ViewPager2中的Fragment设置自定义标签？

Hey there! Let's walk through how to set custom tags for Fragments in both ViewPager and ViewPager2. I know you already have some familiarity with ViewPager, but I'll cover that clearly first before diving into ViewPager2's approach—since that's where you're looking for more clarity.

ViewPager: Setting Custom Fragment Tags #

By default, FragmentPagerAdapter or FragmentStatePagerAdapter generates a default tag for each Fragment using the format android:switcher:[viewPagerId]:[position]. But if you want a custom tag, you can override the instantiateItem method in your Adapter to assign your own tag when the Fragment is added to the FragmentManager.

Here's a practical example using FragmentPagerAdapter:

public class CustomPagerAdapter extends FragmentPagerAdapter {
    private final FragmentManager mFragmentManager;
    // Optional: Map positions to your custom tags
    private final SparseArray<String> mCustomTags = new SparseArray<>();

    public CustomPagerAdapter(FragmentManager fm) {
        super(fm, BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT);
        mFragmentManager = fm;
        // Initialize your custom tags based on your needs
        mCustomTags.put(0, "home_fragment");
        mCustomTags.put(1, "profile_fragment");
        mCustomTags.put(2, "settings_fragment");
    }

    @Override
    public Fragment getItem(int position) {
        // Return the corresponding Fragment instance
        switch (position) {
            case 0: return new HomeFragment();
            case 1: return new ProfileFragment();
            case 2: return new SettingsFragment();
            default: return null;
        }
    }

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

    @Override
    public Object instantiateItem(ViewGroup container, int position) {
        Fragment fragment = (Fragment) super.instantiateItem(container, position);
        String customTag = mCustomTags.get(position);
        // Add the Fragment to the manager with your custom tag if it's not already added
        if (!fragment.isAdded()) {
            FragmentTransaction ft = mFragmentManager.beginTransaction();
            ft.add(fragment, customTag);
            ft.commitNow();
        }
        return fragment;
    }

    // Helper method to retrieve a Fragment by its custom tag
    public Fragment getFragmentByTag(String tag) {
        return mFragmentManager.findFragmentByTag(tag);
    }
}

With this setup, you can later fetch the Fragment directly using your custom tag via getFragmentByTag() or the FragmentManager itself.

ViewPager2: Setting Custom Fragment Tags #

ViewPager2 uses FragmentStateAdapter under the hood, which manages Fragments differently than the old ViewPager adapters. It doesn't expose a direct way to set custom tags like ViewPager does, since it generates its own internal tags for lifecycle and recycling management. But there are two reliable, safe workarounds:

Option 1: Use Fragment Arguments to Store a Custom Identifier #

Instead of relying on the FragmentManager's tag, pass a custom identifier to each Fragment via Bundle arguments. This approach doesn't interfere with ViewPager2's internal logic, making it the most stable choice.

Example:

public class CustomViewPager2Adapter extends FragmentStateAdapter {
    // Optional: Map positions to your custom identifiers
    private final SparseArray<String> mCustomIdentifiers = new SparseArray<>();

    public CustomViewPager2Adapter(@NonNull FragmentActivity fragmentActivity) {
        super(fragmentActivity);
        mCustomIdentifiers.put(0, "home_fragment");
        mCustomIdentifiers.put(1, "profile_fragment");
        mCustomIdentifiers.put(2, "settings_fragment");
    }

    @NonNull
    @Override
    public Fragment createFragment(int position) {
        Fragment fragment;
        switch (position) {
            case 0: fragment = new HomeFragment(); break;
            case 1: fragment = new ProfileFragment(); break;
            case 2: fragment = new SettingsFragment(); break;
            default: fragment = new Fragment(); break;
        }
        // Pass the custom identifier to the Fragment's arguments
        Bundle args = new Bundle();
        args.putString("CUSTOM_ID", mCustomIdentifiers.get(position));
        fragment.setArguments(args);
        return fragment;
    }

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

    // Helper method to find a Fragment by its custom identifier
    public Fragment getFragmentByIdentifier(String identifier) {
        FragmentManager fragmentManager = getFragmentManager();
        for (Fragment fragment : fragmentManager.getFragments()) {
            if (fragment.getArguments() != null && identifier.equals(fragment.getArguments().getString("CUSTOM_ID"))) {
                return fragment;
            }
        }
        return null;
    }
}

Option 2: Maintain a Cache of Fragments #

If you need direct, quick access to Fragment instances, you can maintain a cache (like a SparseArray or HashMap) in your Adapter to store references as Fragments are created. This lets you retrieve Fragments by position or custom tag easily.

public class CustomViewPager2Adapter extends FragmentStateAdapter {
    private final SparseArray<Fragment> mFragmentCache = new SparseArray<>();
    private final SparseArray<String> mCustomTags = new SparseArray<>();

    public CustomViewPager2Adapter(@NonNull FragmentActivity fragmentActivity) {
        super(fragmentActivity);
        mCustomTags.put(0, "home_fragment");
        mCustomTags.put(1, "profile_fragment");
        mCustomTags.put(2, "settings_fragment");
    }

    @NonNull
    @Override
    public Fragment createFragment(int position) {
        Fragment fragment;
        switch (position) {
            case 0: fragment = new HomeFragment(); break;
            case 1: fragment = new ProfileFragment(); break;
            case 2: fragment = new SettingsFragment(); break;
            default: fragment = new Fragment(); break;
        }
        mFragmentCache.put(position, fragment);
        return fragment;
    }

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

    // Helper method to get a Fragment by its custom tag
    public Fragment getFragmentByCustomTag(String tag) {
        for (int i = 0; i < mCustomTags.size(); i++) {
            if (tag.equals(mCustomTags.valueAt(i))) {
                return mFragmentCache.get(mCustomTags.keyAt(i));
            }
        }
        return null;
    }

    // Clean up the cache when the Adapter is detached to avoid memory leaks
    @Override
    public void onDetachedFromRecyclerView(@NonNull RecyclerView recyclerView) {
        super.onDetachedFromRecyclerView(recyclerView);
        mFragmentCache.clear();
    }
}

A quick note: When using a cache, always clear it when the Adapter is detached from the ViewPager2 to prevent memory leaks.

One critical thing to remember: For ViewPager2, never try to override its internal tag generation logic—it's tightly coupled with how ViewPager2 manages Fragment lifecycle and recycling, and modifying it can lead to hard-to-debug crashes or unexpected behavior. The workarounds above are the recommended, safe ways to handle custom identifiers.

内容的提问来源于stack exchange，提问作者Hussein Yaqoobi