startActivityForResult被弃用后，如何优雅的启动Activity? （建议收藏）
共 10379字，需浏览 21分钟
· 2022-04-16
大家好，我是刘望舒，腾讯最具价值专家，著有三本业内知名畅销书，连续五年蝉联电子工业出版社年度优秀作者，百度百科收录的资深技术专家。
前华为面试官、独角兽公司技术总监。
BAT 即可。Activity Result API已经出来有一段时间了，但是还是有很多朋友对这个API感到使用不便或疑惑，今天尽量用一篇简短的文章简述下registerForActivityResult的使用方法。
1.如何解决 startActivityForResult 被弃用？
可以明显的看到，在androidx.activity1.2.0-alpha04时开始，Android中这位你调用过无数次的startActivityForResult和onActivityResult，已经被官方标记为弃用了，继而推出了名为Activity Result API的组件。
弃用原因也许是onActivityResult里需要处理的各种判断、嵌套，也许是既要处理requestCode也要处理resultCode这种高耦合难以维护的Id判断模式。但其原因已不重要了，因为既然Android里已提供了更好的方案并把startActivityForResult标记为了弃用，那么我们就应该开始了解一下位于 ComponentActivity 或 Fragment 中的registerForActivityResult了。
这里先做一个简单的对比，来了解下registerForActivityResult的简单及清爽。
// startActivityForResult
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
startActivityForResult(Intent(this, SecondActivity::class.java), REQUEST_CODE)
}
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
when (requestCode) {
REQUEST_CODE -> {
val code = resultCode
val data = data
}
}
}
companion object {
private const val REQUEST_CODE = 1024
}
// registerForActivityResult
private lateinit var resultLauncher: ActivityResultLauncher
private val launcherCallback = ActivityResultCallback { result ->
val code = result.resultCode
val data = result.data
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
resultLauncher = registerForActivityResult(
ActivityResultContracts.StartActivityForResult(),
launcherCallback)
resultLauncher.launch(Intent(this,SecondActivity::class.java))
}
代码一看完，是不是第一感觉不对啊，怎么感觉比之前还复杂了，其实这里是为了让你更直观的了解到这个registerForActivityResult到底是什么东西，所以对载体、定义协定、回调3个类分别定义写出来。其实大部分情况我们像以下代码其实这么写就可以了。
private val launcherActivity = registerForActivityResult(
ActivityResultContracts.StartActivityForResult()) {
val code = it.resultCode
val data = it.data
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
launcherActivity.launch(Intent(this, SecondActivity::class.java))
}
是不是瞬间清爽了许多，但是…你还是觉得比使用startActivityForResult更复杂？其实不然，因为上面代码的需求是一个单一的回调，所以看着似乎startActivityForResult更便于维护和使用。但倘若编写一个稍复杂的页面，需要同时请求相册、需要在其它Activity选择数据并回调、需要判断权限等等时，继续使用startActivityForResult，会导致onActivityResult里掺杂各种嵌套及判断，导致代码难以维护。而使用registerForActivityResult()可以多次调用以注册多个 ActivityResultLauncher 实例，用来处理不同的Activity结果，让代码更便于维护。
优势了解到了，但既然需要使用新的功能，那么我们就必须要先了解一下，刚说到的ActivityResultLauncher、ActivityResultContract、ActivityResultCallback到底是些什么东西？
ActivityResultLauncher 从字面意思其实就能很好理解，可以理解它就是一个Activity的启动器，它的作用就是承载启动对象与返回对象，通过registerForActivityResult返回该对象，这时并不会立即启动另一个Activity。
ActivityResultContract 是用来协定所需的输入类型以及结果的输出类型，Android默认提供了一些常用的定义，例如上面所使用到到ActivityResultContracts.StartActivityForResult()。当然这里你也可以通过继承ActivityResultContract实现自己的定义。
ActivityResultCallback 通过名字就可以了解到这是启动Activity并返回到当前Activity时的结果回调。
对于这3个类，其实只需重点了解ActivityResultContract，就能很轻松的理解并使用好Activity Result API了。
同时，引用一个官方文档的警告 ↓
注意：虽然在 fragment 或 activity 创建完毕之前可安全地调用 registerForActivityResult()，但在 fragment 或 activity 的 Lifecycle 变为 CREATED 状态之前，您无法启动 ActivityResultLauncher。
2.ActivityResultContract 该如何使用？
刚才的例子中，其实已经简单的使用到Android提供的一个默认协定ActivityResultContracts.StartActivityForResult()来启动了一个Activity并获得想要的返回值。除了StartActivityForResult()，Android还提供了以下的默认协定以便于开发者的使用。
以上全部ActivityResultContracts可在GitHub查看完整示例源码。
https://github.com/TxcA/ManageStartActivity/blob/master/app/src/main/java/com/itxca/sample/msa/ActivityResultContractsActivity.kt
OK，到此是不是慢慢开始感觉到Activity Result API的便捷了。
虽然Android提供的默认协定ActivityResultContracts已经很丰富了，但是为了自己应用内Activity类型安全的传递或是解耦，有时我们需要自己创建一个ActivityResultContract。其实查看ActivityResultContracts任意一个类的源码，发现自己实现ActivityResultContract并不复杂，只需继承ActivityResultContract，即可实现类型安全的Activity启动与数据返回。
class ContractActivity : AppCompatActivity() {
......
/**
* 继承[ActivityResultContract]
*
* 泛型第一个参数为传入到 [ContractActivity] 的参数
* 第二个参数为 [ContractActivity] 返回给启动Activity的返回值
*/
class Contract : ActivityResultContract<String, String>() {
/**
* 创建启动Intent
* @param context [Context]
* @param input 当前类的第一个泛型参, 这里自己实现传递过程
*/
override fun createIntent(context: Context, input: String): Intent =
Intent(context, ContractActivity::class.java).apply {
putExtra(EXTRA_NAME, "$input - ${System.currentTimeMillis()}")
}
/**
* 解析结果
* @param resultCode [Activity.setResult] 的 resultCode
* @param intent [Activity.setResult] 的 intent
* 其实这里类似 [Activity.onActivityResult] 处理过程，只是由于返回是明确的，所以少了requestCode
*/
override fun parseResult(resultCode: Int, intent: Intent?): String {
return if (resultCode == Activity.RESULT_OK && intent != null) {
"${intent.getStringExtra(EXTRA_RESULT)} - ${System.currentTimeMillis()}"
} else {
"error"
}
}
companion object {
/** EXTRA */
const val EXTRA_NAME = "extra_name"
const val EXTRA_RESULT = "extra_result"
}
}
}
定义好一个Contract后，在使用Activity Result API启动ContractActivity时，只需调用：
val launcherContractActivity = registerForActivityResult(ContractActivity.Contract()) { result: String -> }
launcherContractActivity.launch("hi, Activity Result API!")
怎么样，是不是瞬间觉得特别方便？而且这种方式让启动Activity解耦得很彻底，启动方能明确的知道该传什么值给被启动的Activity，也能明确的知道被启动Activity会返回什么数据。
以上全部ActivityResultContracts可在GitHub查看完整示例源码。
https://github.com/TxcA/ManageStartActivity/blob/master/app/src/main/java/com/itxca/sample/msa/ActivityResultContractsActivity.kt
3.但是…我就想简单的使用startActivityForResult怎么办?
虽然Activity Result API非常强大与便捷，但在国内各厂商深度定制系统的情况下，权限申请操作一般我们还是会使用到第三方框架，拍照、视频录制大部分情况使用系统界面操作肯定也不适用。所以Activity Result API里，我的刚需似乎只是一个startActivityForResult那么简单, 那有更便捷的方法吗？
首先，尝试一个直接在按钮点击时创建一个ActivityResultLauncher并启动。
viewBinding.btnStartActivityForResult.setOnClickListener {
registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result->
val code = result.resultCode
val data = result.data
}.launch(Intent(this@ActivityResultContractsActivity, SecondActivity::class.java))
}
看着似乎很方便，又不需要提前注册，即用即回调。但是很不幸，这样使用你会收获一个IllegalStateException，异常里也说得很明白LifecycleOwner xxx is attempting to register while current state is RESUMED. LifecycleOwners must call register before they are STARTED.，必须在STARTED前调用registerForActivityResult。
看来我们必须每次都必须通过registerForActivityResult预定一个ActivityResultLauncher，在需要的时候再去launch，这…似乎还是比较麻烦。那么来看看一个ManageStartActivity小框架吧。
ManageStartActivity - Github 一个基于Activity Result API搭建的纯粹启动Activity的小框架。
https://github.com/TxcA/ManageStartActivity
何为纯粹？就是只负责启动Acitivity，权限、拍照、录像等等虽然Activity Result API都支持，但是该框架都不去实现这些功能。原因一，刚也描述过，这些预定的Contract可能在国内大环境下兼容不一定好，或者UI及功能上过于简单不能满足实际功能需求。原因二，是若想自己调用，使用其实也很简单，只需调用Android提供的这些默认协定即可。所以ManageStartActivity只是纯粹的为了减轻使用Activity Result API启动Activity时过于繁琐的那些步骤。
只需两步，轻松实现startActivityForResult。
1、ComponentActivity、Fragment 实现 IMangeStartActivity接口，并委托给MangeStartActivity处理。
2、onCreate时调用initManageStartActivity()即可。
abstract class BaseActivity : AppCompatActivity(), IMsa by msa() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
initManageStartActivity()
}
}
推荐在BaseActivity、BaseFragment里实现 IMangeStartActivity接口, 这样就能愉快的在任意继承Base的页面中使用startActivityForResult了。
// 注意实现 `IMsa by msa()`
class SampleActivity : AppCompatActivity(), IMsa by msa() {
override fun onCreate(savedInstanceState: Bundle?) {
// 推荐在super.onCreate 前初始化 `initMangeStartActivity`
// 这样就能防止还未初始化`ActivityResultLauncher`就调用`launch`导致`UninitializedPropertyAccessException`异常
initManageStartActivity()
super.onCreate(savedInstanceState)
}
/**
* 直接启动Activity
* 3 种方式
*/
fun startActivity() {
// Android习惯模式，传入KClass即可
startActivity(MainActivity::class) {
putExtra("key", "value")
}
// KClass扩展方法模式
MainActivity::class.start {
putExtra("key", "value")
}
// Intent扩展方法模式
Intent(this, MainActivity::class.java).apply {
putExtra("key", "value")
}.start()
}
/**
* 启动Activity并需要回调结果
* 4 种方法
*/
fun startActivityForResult() {
// Android习惯模式，传入KClass即可
startActivityForResult(MainActivity::class, {
putExtra("key", "value")
}) { code: Int, data: Intent? ->
// code = resultCode
}
// KClass扩展方法模式
MainActivity::class.startForResult({
putExtra("key", "value")
}) {code: Int, data: Intent? ->
// code = resultCode
}
// Android习惯模式，传入Intent即可
startActivityForResult(Intent(this, MainActivity::class.java).apply {
putExtra("key", "value")
}){ code: Int, data: Intent? ->
// code = resultCode
}
// Intent扩展方法模式
Intent(this, MainActivity::class.java).apply {
putExtra("key", "value")
}.startForResult { code: Int, data: Intent? ->
// code = resultCode
}
}
/**
* Kotlin协程挂起函数
* 4 种方式
*/
fun startActivityForResultCoroutine() {
lifecycleScope.launch {
// Android习惯模式，传入KClass即可
val (code1: Int, data1: Intent?) = startActivityForResultSync(MainActivity::class) {
putExtra("key", "value")
}
// KClass扩展方法模式
val (code2: Int, data2: Intent?) = MainActivity::class.startForResultSync {
putExtra("key", "value")
}
// Android习惯模式，传入Intent即可
val (code3: Int, data3: Intent?) = startActivityForResultSync(Intent(this@SampleActivity, MainActivity::class.java).apply {
putExtra("key", "value")
})
// Intent扩展方法模式
val (code4: Int, data4: Intent?) = Intent(this@SampleActivity, MainActivity::class.java).apply {
putExtra("key", "value")
}.startForResultSync()
}
}
}
对的，要的就是这种纯粹的startActivityForResult的感觉。
总结
Activity Result API和更优雅的使用startActivityForResult现在想必你都已经会使用了，是不是比你想象的更简单？
如果有需要，我会再写一篇使用较少的在单独的类中接收 Activity 结果和Activity Result API的源码解析。技术有限，若文中有错误遗漏之处，尽情谅解，也欢迎指正共同进步。
• 耗时2年，Android进阶三部曲第三部《Android进阶指北》出版！
为了防止失联，欢迎关注我的小号
微信改了推送机制，真爱请星标本公号👇