Android registerForActivityResult 详解

文章目录一、背景二、基本用法示例启动 Activity 并获取回传数据示例申请单个权限三、核心概念执行流程四、注册时机五、常用 Contract5.1 StartActivityForResult5.2 RequestPermission / RequestMultiplePermissions5.3 GetContent / GetMultipleContents5.4 TakePicture / CaptureVideo5.4 CreateDocument / OpenDocument5.5 内置 Contract 汇总六、自定义 Contract示例封装 Activity 跳转示例多选图片七、新旧对比一、背景在 Android 开发中从当前 Activity 发起一个操作并在完成后获取返回结果是常见的需求典型场景包括跳转到另一个 Activity等它关闭后获取回传数据向用户申请运行时权限从相册或文件管理器中选择文件调用系统相机拍照在 AndroidX Activity 1.2.0 之前这些场景依赖多套不同的 APIActivity 跳转用startActivityForResult/onActivityResult权限申请用requestPermissions/onRequestPermissionsResult。这些 API 存在一些共性问题代码分散发起请求和接收结果的逻辑分布在不同的方法中不利于阅读和维护。requestCode 管理繁琐需要手动维护整型常量多模块协作时容易产生冲突。回调膨胀所有返回结果汇聚到同一个回调方法中业务扩展后分支逻辑不断膨胀。API 风格不统一Activity 跳转和权限申请使用完全不同的回调机制。AndroidX 引入了registerForActivityResult来解决这些问题将所有发起—返回模式统一为一套声明式 API。二、基本用法registerForActivityResult的调用形式为ActivityResultLauncherIlauncherregisterForActivityResult(ActivityResultContractI,Ocontract,ActivityResultCallbackOcallback);// 触发操作launcher.launch(input);与旧 API 最直观的区别是不再需要requestCode也不再需要重写任何回调方法。发起和接收结果在同一个代码块中完成声明。示例启动 Activity 并获取回传数据ActivityResultLauncherIntentlauncherregisterForActivityResult(newActivityResultContracts.StartActivityForResult(),result-{if(result.getResultCode()RESULT_OKresult.getData()!null){Stringvalueresult.getData().getStringExtra(key);}});launcher.launch(newIntent(this,SecondActivity.class));示例申请单个权限ActivityResultLauncherStringlauncherregisterForActivityResult(newActivityResultContracts.RequestPermission(),granted-{if(granted){// 授权成功}else{// 授权被拒绝}});launcher.launch(Manifest.permission.CAMERA);可以看到Activity 跳转和权限申请现在使用完全相同的 API 风格代码结构一致。三、核心概念registerForActivityResult围绕三个核心概念构建概念类型职责ContractActivityResultContractI, O定义操作的类型输入 I 是什么输出 O 是什么以及如何生成启动 Intent、如何解析返回结果CallbackActivityResultCallbackO结果返回后的处理逻辑参数 O 的类型由 Contract 决定LauncherActivityResultLauncherI通过registerForActivityResult获得的启动器调用launch(I)触发操作执行流程launch(输入 I) ↓ Contract.createIntent(Context, I) → 生成 Intent → 打开目标组件 ↓ 目标组件关闭 ↓ Contract.parseResult(int, Intent) → 将返回数据解析为类型 O ↓ Callback.onActivityResult(O) → 执行业务逻辑四、注册时机registerForActivityResult必须在 Activity 生命周期进入STARTED状态之前调用。官方推荐在onCreate中进行注册。// 正确OverrideprotectedvoidonCreate(BundlesavedInstanceState){super.onCreate(savedInstanceState);launcherregisterForActivityResult(...);}// 错误privatevoidonButtonClick(){launcherregisterForActivityResult(...);// 此时生命周期已过 STARTED}原因当 Activity 因系统内存回收被销毁后重建时只会重新执行onCreate。如果在onCreate中注册重建时会自动重新注册之前在途的请求结果也不会丢失。若在事件回调中注册重建后注册缺失结果将无法兑现。五、常用 ContractAndroidX 内置了多种 Contract覆盖常见场景。5.1 StartActivityForResult启动一个 Activity 并接收返回结果。最常用的 Contract。ActivityResultLauncherIntentlauncherregisterForActivityResult(newActivityResultContracts.StartActivityForResult(),result-{if(result.getResultCode()RESULT_OKresult.getData()!null){Stringdataresult.getData().getStringExtra(extra_key);}});输入Intent输出ActivityResult封装了resultCode和data5.2 RequestPermission / RequestMultiplePermissions申请单个或多个运行时权限。// 单个权限ActivityResultLauncherStringsinglePermissionLauncherregisterForActivityResult(newActivityResultContracts.RequestPermission(),granted-{/* granted 为 Boolean */});// 多个权限ActivityResultLauncherString[]multiPermissionLauncherregisterForActivityResult(newActivityResultContracts.RequestMultiplePermissions(),result-{/* result 为 MapString, Boolean */});RequestPermission输入String权限名输出Boolean。RequestMultiplePermissions输入String[]权限名数组输出MapString, Boolean。5.3 GetContent / GetMultipleContents从系统文件选择器中选择文件。// 单选ActivityResultLauncherStringlauncherregisterForActivityResult(newActivityResultContracts.GetContent(),uri-{/* uri 为 Uri? */});launcher.launch(image/*);// MIME 类型launcher.launch(video/*);launcher.launch(*/*);// 任意文件// 多选ActivityResultLauncherStringmultiLauncherregisterForActivityResult(newActivityResultContracts.GetMultipleContents(),uris-{/* uris 为 ListUri */});5.4 TakePicture / CaptureVideo调用系统相机拍照或录像。// 拍照ActivityResultLauncherUritakePictureLauncherregisterForActivityResult(newActivityResultContracts.TakePicture(),success-{/* success 为 Boolean */});// 录像ActivityResultLauncherUricaptureVideoLauncherregisterForActivityResult(newActivityResultContracts.CaptureVideo(),success-{/* success 为 Boolean */});// 需要先准备输出文件的 UriUrioutputUri/* 由 FileProvider 生成 */;takePictureLauncher.launch(outputUri);5.4 CreateDocument / OpenDocument创建或打开文档。// 创建新文件ActivityResultLauncherStringcreateLauncherregisterForActivityResult(newActivityResultContracts.CreateDocument(text/plain),uri-{/* uri 为 Uri? */});createLauncher.launch(文件名.txt);// 打开已有文件ActivityResultLauncherString[]openLauncherregisterForActivityResult(newActivityResultContracts.OpenDocument(),uri-{/* uri 为 Uri? */});openLauncher.launch(newString[]{image/*,application/pdf});5.5 内置 Contract 汇总Contract输入输出用途RequestPermissionStringBoolean单个权限申请RequestMultiplePermissionsString[]MapString, Boolean多个权限申请StartActivityForResultIntentActivityResult通用 Activity 启动StartIntentSenderForResultIntentSenderRequestActivityResult启动 IntentSenderGetContentStringMIMEUri?选择单个文件GetMultipleContentsStringMIMEListUri选择多个文件TakePictureUriBoolean拍照并保存TakePicturePreview无Bitmap?拍照获取缩略图CaptureVideoUriBoolean录像并保存CreateDocumentStringMIMEUri?创建文件OpenDocumentString[]MIMEUri?打开文件OpenDocumentTreeUri?Uri?选择目录PickContact无Uri?选择联系人六、自定义 Contract当内置 Contract 无法满足需求时可以通过继承ActivityResultContractI, O实现自定义 Contract。需要覆写两个方法方法调用时机作用createIntent(Context, I)launch()调用时根据输入 I 生成启动目标组件的 IntentparseResult(int, Intent)目标组件关闭时将 resultCode 和 Intent 解析为输出 O示例封装 Activity 跳转将启动某个 Activity 并传递字符串的逻辑封装为 Contract调用方无需直接构造 IntentclassOpenTargetActivityContractextendsActivityResultContractString,ActivityResult{privatefinalClass?extendsActivitytargetClass;publicOpenTargetActivityContract(Class?extendsActivitytargetClass){this.targetClasstargetClass;}NonNullOverridepublicIntentcreateIntent(NonNullContextcontext,Stringinput){IntentintentnewIntent(context,targetClass);intent.putExtra(payload,input);returnintent;}NonNullOverridepublicActivityResultparseResult(intresultCode,NullableIntentdata){returnnewActivityResult(resultCode,data);}}// 使用ActivityResultLauncherStringlauncherregisterForActivityResult(newOpenTargetActivityContract(TargetActivity.class),result-{if(result.getResultCode()RESULT_OKresult.getData()!null){Stringbackresult.getData().getStringExtra(result);}});launcher.launch(要传递的内容);示例多选图片系统默认的GetMultipleContents已支持多选这里通过自定义 Contract 来演示实现思路classPickMultipleImagesContractextendsActivityResultContractVoid,ListUri{NonNullOverridepublicIntentcreateIntent(NonNullContextcontext,Voidinput){IntentintentnewIntent(Intent.ACTION_PICK);intent.setType(image/*);intent.putExtra(Intent.EXTRA_ALLOW_MULTIPLE,true);returnintent;}NonNullOverridepublicListUriparseResult(intresultCode,NullableIntentdata){if(resultCodeRESULT_OKdata!null){ListUriurisnewArrayList();ClipDataclipDatadata.getClipData();if(clipData!null){for(inti0;iclipData.getItemCount();i){uris.add(clipData.getItemAt(i).getUri());}}elseif(data.getData()!null){uris.add(data.getData());}returnuris;}returnCollections.emptyList();}}七、新旧对比对比维度旧 APIregisterForActivityResultActivity 回传startActivityForResultonActivityResultStartActivityForResultContract权限申请requestPermissionsonRequestPermissionsResultRequestPermissionContract文件选择手动构造 Intent onActivityResultGetContent/OpenDocumentContract代码组织发起和回调分离在两个方法在同一位置声明requestCode手动管理整型常量无类型安全回调参数无编译期约束泛型保证类型匹配可扩展性需覆写 Activity/Fragment 回调方法实现自定义 Contract