Activity Results API

Activity Results API 中两个重要的组件：ActivityResultContract和ActivityResultLauncher。

ActivityResultContract: 协议，它定义了如何传递数据和如何处理返回的数据。ActivityResultContract是一个抽象类，你需要继承它来创建自己的协议，每个 ActivityResultContract都需要定义输入和输出类，如果您不需要任何输入，可使用 Void（在 Kotlin 中，使用 Void? 或 Unit）作为输入类型。
ActivityResultLauncher: 启动器，调用ActivityResultLauncher的launch方法来启动页面跳转，作用相当于原来的startActivity()
使用 Activity Results API 在Activity之间传递数据

1、定义协议

新建一个Contract类，继承自ActivityResultContract<I,O>，其中，I是输入的类型，O是输出的类型。需要实现2个方法，createIntent和parseResult,输入类型I作为createIntent的参数，输出类型O作为parseResult方法的返回值，在下面的例子中，输入输出类型都是String:

class MyActivityResultContract : ActivityResultContract<String, String>() {
    override fun createIntent(context: Context, input: String): Intent {
        return Intent(context, MainActivity::class.java).apply {
            putExtra("name", input)
        }
    }

    override fun parseResult(resultCode: Int, intent: Intent?): String {
        val data = intent?.getStringExtra("result")
        return if (resultCode == Activity.RESULT_OK && data != null) data else ""
    }
}

2、注册协议，获取启动器-ActivityResultLauncher

注册协议，使用registerForActivityResult方法，该方法由ComponentActivity或者Fragment提供,接受2个参数，第一个参数就是我们定义的Contract协议，第二个参数是一个回调ActivityResultCallback<O>,其中O就是前面Contract的输出类型。代码如下：

private val myActivityLauncher =
    registerForActivityResult(MyActivityResultContract()) { result ->
        println("result=$result")
    }

如上代码，注册了MyActivityResultContract,registerForActivityResult方法的返回值是ActivityResultLauncher, 因此我们定义了一个myActivityLauncher,回调方法中，result就是从上一个界面传回的值。这里我们简单的用println打印

3、调用启动器的launch方法开启界面跳转

myActivityLauncher.launch("Hello World")

4、第二个页面回传的数据

val intent = Intent().apply {
    putExtra("result","Hello，回传的数据！")
}
setResult(Activity.RESULT_OK,intent)
finish()

注：预定义的Contract

大伙都看出来，新的Activity Results API使用起来好像有点麻烦，每次都得定义Contract。Google肯定考虑到了这个问题的，于是，Google 预定义了很多Contract,把你们能想到的使用场景基本上都想到了，它们都定义在类ActivityResultContracts中,有以下这些Contract:

StartActivityForResult() 
RequestMultiplePermissions()
RequestPermission()
TakePicturePreview()
TakePicture()
TakeVideo()
PickContact()
CreateDocument()
OpenDocumentTree()
OpenMultipleDocuments()
OpenDocument()
GetMultipleContents()
GetContent()

下面分别介绍一下这些Contract:

• StartActivityForResult: 通用的Contract,不做任何转换，Intent作为输入，ActivityResult作为输出，这也是最常用的一个协定。
• RequestMultiplePermissions： 用于请求一组权限
• RequestPermission: 用于请求单个权限
• TakePicturePreview: 调用MediaStore.ACTION_IMAGE_CAPTURE拍照，返回值为Bitmap图片
• TakePicture: 调用MediaStore.ACTION_IMAGE_CAPTURE拍照，并将图片保存到给定的Uri地址，返回true表示保存成功。
• TakeVideo: 调用MediaStore.ACTION_VIDEO_CAPTURE 拍摄视频，保存到给定的Uri地址，返回一张缩略图。
• PickContact: 从通讯录APP获取联系人
• GetContent: 提示用选择一条内容，返回一个通过ContentResolver#openInputStream(Uri)访问原生数据的Uri地址（content://形式） 。默认情况下，它增加了Intent#CATEGORY_OPENABLE, 返回可以表示流的内容。
• CreateDocument: 提示用户选择一个文档，返回一个(file:/http:/content)开头的Uri。
• OpenMultipleDocuments: 提示用户选择文档（可以选择多个），分别返回它们的Uri，以List的形式。
• OpenDocumentTree: 提示用户选择一个目录，并返回用户选择的作为一个Uri返回，应用程序可以完全管理返回目录中的文档。

上面这些预定义的Contract中，除了StartActivityForResult和RequestMultiplePermissions之外，基本都是处理的与其他APP交互，返回数据的场景，比如，拍照，选择图片，选择联系人，打开文档等等。使用最多的就是StartActivityForResult和RequestMultiplePermissions了。

示例：
1、注册协议，获取ActivityResultLauncher:

private val myActivityLauncher =
    registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { activityResult ->
        if (activityResult.resultCode == Activity.RESULT_OK) {
            val result = activityResult.data?.getStringExtra("result")
            println("result=$result")
        }
    }

2、构造需要传递的数据，启动页面跳转

val  intent = Intent(this,MainActivity::class.java).apply {
    putExtra("name","Hello World")
}
myActivityLauncher.launch(intent)

在非Activity/Fragment的类中接收Activity的结果

在Activity和Fragment中，我们能直接使用registerForActivityResultAPI，那是因为ComponentActivity和Fragment基类实现了ActivityResultCaller接口,在非Activity/Fragment中，如果我们想要接收Activity回传的数据，可以直接使用 ActivityResultRegistry 来实现。

比如，用一个单独的类来实现协议的注册和启动器的启动：

class MyLifecycleObserver(private val registry : ActivityResultRegistry)
    : DefaultLifecycleObserver {
    lateinit var getContent : ActivityResultLauncher<String>

    override fun onCreate(owner: LifecycleOwner) {
        getContent = registry.register("key", owner, ActivityResultContracts.GetContent()) {
            // Handle the returned Uri
        }
    }

    fun selectImage() {
        getContent("image/*")
    }
}

class MyFragment : Fragment() {
    lateinit var observer : MyLifecycleObserver

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // ...

        observer = MyLifecycleObserver(requireActivity().activityResultRegistry)
        lifecycle.addObserver(observer)
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        val selectButton = view.findViewById<Button>(R.id.select_button)
        selectButton.setOnClickListener {
            // Open the activity to select an image
            observer.selectImage()
        }
    }
}