Jetpack Navigation Fragmen间数据传递

2021-01-30 本文已影响0人睡姿决定了发型

Jetpack Navigation Fragmen间数据传递

Navigation 是一个框架，用于在 Android 应用中的“目标函数”之间导航，该框架提供一致的 API，无论目标函数是作为 Fragment、Activity 还是其他组件实现。

需要传递数据的几种场景

页面迁移时需要从AFragment 将数据传递到BFragment.
页面回退时需要从BFragment 将数据传递到AFragment.

页面迁移时的数据传递方式

在开发中从AFragment迁移到BFragment时传递数据是非常常见的业务场景。

直接通过Bundl传递数据：

 private void goBFragment() {
        Bundle args = new Bundle();
        args.putString("userName", "张三");
        Navigation.findNavController(getView())
        .navigate(R.id.action_AFragment_to_BFragment, args);
    }

public final class BFragment extends Fragment{
    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        String ueserName = getArguments().getString("userName");
    }
}

上面代码就可实现数据的传递与获取，但此方法需要双方协定好数据的Key 以及数据类型。一方的变更极易引发未知的问题。

官方推荐的safeArgs数据传递方式：

在项目的根build.gradle下添加插件

 dependencies {
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:2.3.2"
    }

然后在Module的build.gradle 中依赖插件

 apply plugin: "androidx.navigation.safeargs"

在navigation.xml 中添声明需要传递的数据

 <fragment
        android:id="@+id/BFragment"
        android:name="org.alee.demo.navigation.back.BFragment"
        android:label="BFragment">
        <argument
            android:name="userName"
            app:argType="string"
            android:defaultValue="张三"
            />
    </fragment>

添加完后rebuild一下工程，safeArgs会自动生成一些代码

在这里插入图片描述

safeArgs会根据nav_graph中的fragment标签生成对应的类，action标签会以“类名+Directions”命名，argument标签会以“类名+Args”命名。

迁移页面并传递数据

 private void goBFragment() {
        Navigation.findNavController(getView())
        .navigate(AFragmentDirections.actionAFragmentToBFragment().setUserName("张三"));
    }

接收数据

public final class BFragment extends Fragment {
    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        String userName = BFragmentArgs.fromBundle(getArguments()).getUserName();
    }
}

无疑使用safeArgs进行Fragment 见数据传递时插件替我们管理了数据的Key与类型，使得更为安全方便。

页面回退时的数据传递方式

在导航业务中，要在算路结果页面（AFragment）跳转到地图拾取页面（BFragment）拾取一个点来作为途径地。此时BFragment 需要将拾取到的兴趣点传递给AFragment，但如果使用NavController.navigate()API 会导致重新创建了一个AFragment 并执行了onCreate()、onCreateView()、onViewCreated()，这是不符合我们需求的。我们希望BFragment仅是将处理后的结果传递给AFragment。

在Fragment和Navigation中有没有像startActivityForResult(Intent intent, int requestCode, @Nullable Bundle options)、setResult(int resultCode, Intent data)这样的接口供我们使用呢？答案是否定的，目前Navigation还不支持popBackStack时将数据回传。但我们可以基于Navigation实现一个类似的接口。

解决方案

public abstract class BaseFragment extends Fragment {
    protected ResultArgs mArgs;

    @Nullable
    @Override
    public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        return inflater.inflate(requireLayoutId(), container, false);
    }


    protected abstract @LayoutRes
    int requireLayoutId();

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        mArgs = new ResultArgs(getArguments());
        onFindView(view);
        onBindListener();
    }

    protected abstract void onFindView(View rootView);

    protected abstract void onBindListener();

    protected void go(@IdRes int destination) {
        go(destination, null);
    }

    protected void go(@IdRes int destination, Bundle bundle) {
        getNavController().navigate(destination, bundle);
    }

    protected void back() {
        getNavController().popBackStack();
    }

    protected <T> void setResult(T data) {
        if (null == mArgs || 0 >= mArgs.getRecipientId()) {
            return;
        }
        getNavController().getBackStackEntry(mArgs.getRecipientId()).getSavedStateHandle().getLiveData(String.valueOf(mArgs.getRequestCode())).postValue(new Pair(mArgs.getRequestCode(), data));
    }

    /**
     * @param destination 要迁移到的页面
     * @param requestCode 与StartActivityForResult 的RequestCode 相同
     * @param <T>         返回数据类型
     * @return {@link LiveData} Pair.first: requestCode; Pair.second: resultData
     */
    protected <T> LiveData<Pair<Integer, T>> startFragmentForResult(@IdRes int destination, int requestCode) {
        return startFragmentForResult(destination, requestCode, null);
    }

    protected <T> LiveData<Pair<Integer, T>> startFragmentForResult(int requestCode, @NonNull NavDirections destination) {
        return startFragmentForResult(destination.getActionId(), requestCode, destination.getArguments());
    }

    protected <T> LiveData<Pair<Integer, T>> startFragmentForResult(@IdRes int destination, int requestCode, @Nullable Bundle bundle) {
        ResultArgs args = new ResultArgs(getNavController().getCurrentDestination().getId(), requestCode).setBusinessArgs(bundle);
        LiveData<Pair<Integer, T>> liveData = getNavController().getCurrentBackStackEntry().getSavedStateHandle().getLiveData(String.valueOf(requestCode));
        getNavController().navigate(destination, args.toBundle());
        return liveData;
    }

    protected void popTo(@IdRes int destination) {
        getNavController().popBackStack(destination, true);
    }

    protected NavController getNavController() {
        return Navigation.findNavController(getView());
    }
}

startFragmentForResult主要依赖于Navigation 提供的SavedStateHandle对象来持有一个LiveData,三个重载函数完美支持了所有跳转方式。返回一个具有生命周期感知能力的LiveData供接收返回的数据,这使得发起跳转的Fragment不会在非活跃状态接收到返回数据，在Fragment 销毁后会自动解除和观察者之间的绑定关系，以防止内存泄漏和过多的内存消耗。

setResult 通过遍历NavController内部管理的回退栈找到要接收数据的Fragment对应的SavedStateHandle以及LiveData 将数据发射出去供订阅者接收。

public class ResultArgs {


    private static final String RECIPIENT_ID = "resultArgsRecipientId";

    private static final String REQUEST_CODE = "ResultArgsRequestCode";

    private static final String BUNDLE = "ResultArgsBundle";


    private final Map<String, Object> mArgsMap = new HashMap<>();

    public ResultArgs(@IdRes int recipientId, int requestCode) {
        mArgsMap.put(RECIPIENT_ID, recipientId);
        mArgsMap.put(REQUEST_CODE, requestCode);
    }

    public ResultArgs(Bundle bundle) {
        if (null == bundle) {
            return;
        }
        setBusinessArgs(bundle);
        mArgsMap.put(RECIPIENT_ID, bundle.getInt(RECIPIENT_ID));
        mArgsMap.put(REQUEST_CODE, bundle.getInt(REQUEST_CODE));
    }

    public Bundle toBundle() {
        Bundle temp = new Bundle();
        if (null != getBusinessArgs()) {
            temp.putAll(getBusinessArgs());
        }
        temp.putInt(RECIPIENT_ID, getRecipientId());
        temp.putInt(REQUEST_CODE, getRequestCode());
        return temp;
    }

    public @IdRes
    int getRecipientId() {
        return (int) mArgsMap.get(RECIPIENT_ID);
    }

    public int getRequestCode() {
        return (int) mArgsMap.get(REQUEST_CODE);
    }

    public ResultArgs setBusinessArgs(Bundle businessArgs) {
        if (null == businessArgs) {
            return this;
        }
        mArgsMap.put(BUNDLE, businessArgs);
        return this;
    }

    public Bundle getBusinessArgs() {
        return (Bundle) mArgsMap.get(BUNDLE);
    }

}

ResultArgs 类似于上文中提到的通过safeArgs生成的Bundle参数管理类

使用方式

public final class AFragment extends BaseFragment {
 private final Observer mViaPoiResultObserver = new Observer<Pair<Integer, Object>>() {
        @Override
        public void onChanged(Pair<Integer, Object> integerObjectPair) {
            Log.i(AFragment.class.getSimpleName(), "RequestCode: [ " + integerObjectPair.first + " ] " + " ResultData: [ " + integerObjectPair.second + " ] ");
        }
    };
    private void goBFragment() {
        startFragmentForResult(R.id.action_AFragment_to_BFragment,2)
        .observe(this, mViaPoiResultObserver);
    }
}

public final class BFragment extends BaseFragment {
  @Override
    protected void onBindListener() {
        mBackBtn.setOnClickListener(view -> {
            setResult("我是返回数据");
            back();
        });
    }
}

假设有业务需求为 A-B-C， C关闭时要返回到A并将数据传递到A：

public final class AFragment extends BaseFragment {
 private final Observer mViaPoiResultObserver = new Observer<Pair<Integer, Object>>() {
        @Override
        public void onChanged(Pair<Integer, Object> integerObjectPair) {
            Log.i(AFragment.class.getSimpleName(), "RequestCode: [ " + integerObjectPair.first + " ] " + " ResultData: [ " + integerObjectPair.second + " ] ");
        }
    };
    private void goBFragment() {
        startFragmentForResult(R.id.action_AFragment_to_BFragment,2).observe(this, mViaPoiResultObserver);
    }
}

public final class BFragment extends BaseFragment {
 private void goCFragment(){
        go(R.id.action_BFragment_to_CFragment,mArgs.toBundle());
    }
}

public final class CFragment extends BaseFragment  {

    @Override
    protected void onBindListener() {
        mCloseBtn.setOnClickListener(view -> {
            setResult("我是返回数据");
            popTo(R.id.BFragment);
        });
    }
}

使用起来也是非常简单的！

Jetpack Navigation Fragmen间数据传递

Jetpack Navigation Fragmen间数据传递

需要传递数据的几种场景

页面迁移时的数据传递方式

页面回退时的数据传递方式

解决方案

使用方式

猜你喜欢

热点阅读