安卓 onActivityResult 废弃，registerForActivityResult 使用详解

文章目录

onActivityResult 存在的问题
registerForActivityResult 有哪些改进
registerForActivityResult 实战
- registerForActivityResult 自定义使用
- registerForActivityResult 开箱即用
- - StartActivityForResult
  - GetContent
后记
- 注意事项
- 附录

安卓的兼容性是出了名的低，原因就在于它经常喜欢出一个版本就换一个 API。终于，连 Activity 之间数据回传的方法 onActivityResult 也废弃了。安卓官方给出的解决方案是使用 registerForActivityResult 来代替 onActivityResult。

registerForActivityResult 的使用流程比原先的 onActivityResult 要复杂很多，但理解了之后，发现这种新的方式确实更优雅。

为了能让读者理解，这里先回顾原来 onActivityResult 的使用方式，然后再来对比讲解 registerForActivityResult。

onActivityResult 存在的问题

为了便于说明，这里假设 活动 A 调用了 活动 B，然后活动 B 生命结束，将结果回传至活动 A。

在这个过程中，A 需要在调用时向 B 传递一个 请求码，这样在 B 返回时就会自动携带那个请求码。同时 B 需要提供一个 返回码，来代表 B 中返回的具体数据 Intent 作一个分类。

活动 A

Intent intent = new Intent(AActivity.this, BActivity.class);
startActivityForResult(intent, requestCode);

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {super.onActivityResult(requestCode, resultCode, data);if (requestCode == SOME_REQUEST_CODE && resultCode == Activity.RESULT_OK) {if (data != null) {String value = data.getStringExtra("key");// 在这里处理传递过来的信息}}
}

活动 B

Intent resultIntent = new Intent();
resultIntent.putExtra("key", value);
setResult(Activity.RESULT_OK, resultIntent);

可以看出，在这个过程中，请求码 才是必要的参数，因为活动 A 有可能在不同情况下启动不同的活动，所以需要标记究竟是哪个活动返回到 A 的。而 返回码 只是一种安卓额外提供的对回传数据的分类，这个参数实际上不是必要的，因为回传数据内部自己就可以自行分类。另外，此值固定设置为 int 类型也非常不合理。

不仅如此，onActivityResult 直接作为 Activity 的重载方法，耦合度过大。onActivityResult 会直接接管所有活动的回传业务，这是非常不合适的。正确的设计方案应该是让每一个返回至活动 A 的活动单独在一个方法中处理回传业务，这样不同的活动之间就可以非侵入解耦，而不是将它们集中在一起统一管理。

可以看出，onActivityResult 的设计其实确实是有很多问题的，只不过这个 API 过于古老，所以广泛用了很久。

registerForActivityResult 有哪些改进

没有任何开发者喜欢官方一出一个新版本，就照官方的指示更换一次 API。这是没有技术含量的事情。如果一个新设计没有重大突破，它也没有替代老古董的必要。registerForActivityResult 相比于 onActivityResult 做了很多设计上的改进。尽管使用流程变得更复杂，但实际上好用很多。

registerForActivityResult 使用了 责任链模式。责任链模式在很多通信框架中都有广泛使用，如 Netty 等。安卓 Activity 的回传过程如果有更复杂的业务需求，其中就涉及对数据的编码与解码。registerForActivityResult 就支持对回传数据的解码及解码之后的业务处理。这一点，它和 onActivityResult 不同，onActivityResult 是把返回码写死为 int 类型，而 registerForActivityResult 虽然也是把返回码写死为 int 类型，但它由于提供了一个 编解码器，因此支持将回传数据转化为任意的类型。

此外，registerForActivityResult 会直接与要启动的 Activity 相绑定，这意味着，对 registerForActivityResult 来说，它不需要提供 请求码 来标记不同的 Activity。因为 registerForActivityResult 并不是 Activtity 重载方法，它支持多实例，因此可以让不同活动的回调代码相互隔离，而不是像 onActivityResult 集中在一起统一管理。

registerForActivityResult 实战

纸上得来终觉浅，没有实战的讲解没有任何意义。这里结合具体代码来详细介绍 registerForActivityResult 的使用。

registerForActivityResult 自定义使用

registerForActivityResult 是 Activtity 的一个方法，它可以生成一个 ActivityResultLauncher<Intent> 对象，该对象的 launch 方法可以启动一次 Activtity 调用流程。该对象可以启动一个 Activtity 并与之绑定，这样，将这个启动的 Activtity 回传时，接收回传数据的代码就无需使用 请求码 了。

可以向 launch 提供一个实参来表示本次 Activtity 调用流程的输入。这个输入可以是任意类型，也可以为 null。
```
// 这里的 this 指向的是一个 Activity
ActivityResultLauncher<Intent> activityLauncher = this.registerForActivityResult(...);
activityLauncher.launch(input);
```
然后，当需要接收处理回传数据时，可以在 registerForActivityResult(...) 中提供回调来处理。

其中，registerForActivityResult 接受两个参数，第一个就是笔者前面提到的 编解码器，第二个就是解码之后的业务处理。

（但是，contract 在英语的意思并不是解码与解码。虽然这里就实际使用来说，意译成 编解码器 会更加望文生义一些，但直译成 协议 可能更符合翻译界的 信达雅 规则。因此，本文后面将使用 协议 一词，但实际上这里的 contract 是一种 编解码器。）
```
@NonNull
@Override
public final <I, O> ActivityResultLauncher<I> registerForActivityResult(@NonNull ActivityResultContract<I, O> contract,@NonNull ActivityResultCallback<O> callback) {return registerForActivityResult(contract, mActivityResultRegistry, callback);
}
```
可以看出，上面的形参 contract 就是 协议，它有两个泛型形参，第一个代表输入，第二个代表输出。输入就是前面向 launch 方法提供的输入。而输出则会向形参 callback 传递。

而形参 callback 就是解码之后的业务处理，它有一个泛型形参，代表从 contract 解码之后的可操作数据。
自定义一个 协议 ActivityResultContract<I, O>，它有两个抽象方法，其中，方法 createIntent 会在启动一个新 Activity 之前被调用，它代表对输入数据的编码。因此，它的返回值被固定为 Intent，代表需要启动的 Activity。

方法 parseResult 则会在启动的那个 Activity 结束，返回到原 Activity 时调用，它代表对输出数据的解码。因此，它也有一个为 Intent 类型的形参。而另一个形参 resultCode，则是启动的那个 Activity 在结束前设置的，这一点与原先使用 onActivityResult 时是一样的。

可以看出，整个过程不需要 请求码，因为 ActivityResultLauncher 已经与启动的 Activity 进行了绑定，所以无需使用 请求码 将不同的 Activity 分开。
```
abstract class ActivityResultContract<I, O> {abstract fun createIntent(context: Context, input: I): Intentabstract fun parseResult(resultCode: Int, intent: Intent?): O// ...省略其它内容...
}
```
下面假设前面向 launch 方法提供的输入为 Integer 类型，而输出设置为 String 类型。这里，先用方法 createIntent 启动了一个新 Activity，然后在方法 parseResult 中对回传数据进行解码处理。
```
import android.content.Context;
import android.content.Intent;import androidx.activity.result.contract.ActivityResultContract;public class ActivityResultHandler extends ActivityResultContract<Integer, String> {@NonNull@Overridepublic Intent createIntent(Context context, Integer input) {// 设置要启动的 ActivityIntent intent = new Intent(context, BActivity.class);intent.putExtra("INPUT_VALUE", input);return intent;}@NonNull@Overridepublic String parseResult(int resultCode, Intent intent) {// 处理回传数据解码业务if (resultCode == RESULT_OK && intent != null) {return intent.getStringExtra("MESSAGE");}return null;}
}
```
自定义解码之后的业务处理。它有一个名称看起来很熟悉的方法 onActivityResult，它的形参正是上面 协议 中输出的内容。
```
public interface ActivityResultCallback<O> {void onActivityResult(@SuppressLint("UnknownNullness") O result);
}
```
这样，被启动的那个 Activity 就可以使用 setResult 传递回传数据了。这个步骤与原先使用 onActivityResult 时是一样的。
```
Intent data = new Intent();
data.putExtra("MESSAGE", "...回传数据...");
setResult(RESULT_OK, data);
finish();
```

上面的代码也可以组合起来成一次函数调用。

this.registerForActivityResult(new ActivityResultContract<Integer, String>() {@NonNull@Overridepublic Intent createIntent(Context context, Integer input) {// 设置要启动的 ActivityIntent intent = new Intent(context, BActivity.class);intent.putExtra("INPUT_VALUE", input);return intent;}@NonNull@Overridepublic String parseResult(int resultCode, Intent intent) {// 处理回传数据解码业务if (resultCode == RESULT_OK && intent != null) {return intent.getStringExtra("MESSAGE");}return null;}},result -> {// 处理回传数据业务}).launch(0); // 传入输入参数 input 值

registerForActivityResult 开箱即用

虽然上面的流程对于笔者这种技术栈较广的老将来说，理解起来不是很有难度，但对有些新手来说，却有点不太友好。为此，安卓官方在 ActivityResultContracts 下提供了一些开箱即用的 协议，它使得 registerForActivityResult 用起来就像原先的 onActivityResult 一样。

StartActivityForResult

StartActivityForResult 是最普通的 协议，它使得 registerForActivityResult 用起来就像原先的 onActivityResult 一样。

ActivityResultLauncher<Intent> activityLauncher = this.registerForActivityResult(new ActivityResultContracts.StartActivityForResult(),result -> {// 处理回传数据业务});
Intent intent = new Intent(AActivity.this, BActivity.class);
activityLauncher.launch(intent);

GetContent

GetContent 可以用于与安卓系统自带应用之间的交互。例如，下面的代码演示了打开系统相册并选择图片的方法。

ActivityResultLauncher<Intent> activityLauncher = this.registerForActivityResult(new ActivityResultContracts.GetContent(),uri -> {// 处理图片回传});
activityLauncher.launch("image/*");

后记

注意事项

当 Activity 返回时，registerForActivityResult 的回调 callback 会先于 Activity 的方法 onResume 被调用。这与原先被废弃的 onActivityResult 是一样的。

registerForActivityResult 需要在生命周期方法 onCreate 及之前调用。也就是说，registerForActivityResult 方法只能在类字段和 onCreate 方法中使用。不能随意调用 registerForActivityResult 来设置 Activity 在返回之后的行为，否则会导致如下报错。

java.lang.IllegalStateException: LifecycleOwner XXX is attempting to register while current state is RESUMED. LifecycleOwners must call register before they are STARTED.at androidx.activity.result.ActivityResultRegistry.register(ActivityResultRegistry.java:123)at androidx.activity.ComponentActivity.registerForActivityResult(ComponentActivity.java:833)at androidx.activity.ComponentActivity.registerForActivityResult(ComponentActivity.java:842)