Jetpack Activity Result API 优雅的实现页面传值

官方文档

1. 老的实现方式

日常开发中,实现页面传值,通常通过startActivityForResult和onActivityResult配合,通过判断requestCode处理不同的业务场景

startActivityForResult(intent, requestCode)
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        if(resultCode == Activity.RESULT_OK && requestCode == 100) {
           // 处理页面返回的参数
        }
}

2. 新Activity Result API

private val startForResult =
        registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result: ActivityResult ->
            if (result.resultCode == Activity.RESULT_OK) {
                //页面返回值
                val data = result.data
            }
        }
// 打开页面
startForResult.launch(Intent(this, ActivityB::class.java))

上面的实现是不是简单明了,直接注册回调实现业务逻辑,有多个传值的业务就定义多个回调协定(ActivityResultContract),可以很好的单独处理,不用在onActivityResult里面通过requestCode判断,非常方便的实现业务解耦。

3.如何使用

3.1 添加依赖,Activity Result API是在Androidx Activity和Fragment中引入的

最新版本

    implementation "androidx.activity:activity-ktx:1.2.2"
    implementation "androidx.fragment:fragment-ktx:1.3.2"
3.2 注册协定,获取ActivityResultLauncher
private val selectData =
        registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
            if (result.resultCode == Activity.RESULT_OK) {
                val data = result.data
            }
        }
3.3 构造Intent传递参数,启动页面
 btnA.setOnClickListener {
       val intent = Intent(this, ActivityB::class.java)
       selectData.launch(intent)
 }

4. 其它的协定

上面使用的ActivityResultContracts.StartActivityForResult是一个通用的协定,可以原封不动的通过Intent启动页面,ActivityResult接收返回值,系统还定义了好多通用的协定方便使用,下面一一简单介绍

  • StartActivityForResult 这是一个通用协定,它可接受任何 Intent 作为输入内容并返回 ActivityResult,让您能够在回调中提取 resultCodeIntent
  • RequestMultiplePermissions 用于请求一组权限
  • RequestPermission 用于请求一个权限
  • TakePicturePreview 调用MediaStore.ACTION_IMAGE_CAPTURE拍照,返回 Bitmap,可以继承它重写createIntent方法传递额外的参数
  • TakePicture 调用MediaStore.ACTION_IMAGE_CAPTURE拍照,返回Uri
  • TakeVideo 调用MediaStore.ACTION_VIDEO_CAPTURE 拍摄视频,返回Uri
  • PickContact 从通讯录APP获取联系人
  • GetContent 通过Intent.ACTION_GET_CONTENT选择一条内容,默认添加了Intent.CATEGORY_OPENABLE接收流内容,返回Uri
  • GetMultipleContents 同上,选择多条内容,需要api 18以上
  • OpenDocument 选择一个文档
  • OpenMultipleDocuments 选择一个、多个文档
  • OpenDocumentTree 打开文档树选择文档
  • CreateDocument 提示用户选择一个路径,创建新文档
    大部分系统间的交互都已经定义好了,我们可以直接使用,比如GetContent,如下:
private val getContent = registerForActivityResult(ActivityResultContracts.GetContent()) { uri ->
       // Handle the Intent
   }
// 选择图片
getContent.launch("image/*")
// 选择视频
getContent.launch("video/*")

4.自定义协定

除了上面的预定义协定,我们还可以根据实际的业务定义自己的协定,当然实现也很简单,只需要继承ActivityResultContract<I, O>抽象类即可,ActivityResultContract类有两个抽象方法,
//创建Intent,在Activity#startActivityForResult中使用I input是定义的范型
public abstract Intent createIntent(Context context, I input)
//解析Activity#onActivityResult中的返回结果,返回范型O
public abstract O parseResult(int resultCode, Intent intent)
下面实现一个例子

// 定义协定
class MyActivityResultContract : ActivityResultContract<Int, String>() {
   override fun createIntent(context: Context, input: Int?): Intent {
       return Intent(context, ActivityB::class.java).apply {
           putExtra("projectId", input)
       }
   }

   override fun parseResult(resultCode: Int, intent: Intent?): String? {
       if (intent == null || !intent.hasExtra("projectName")) {
           return null
       }
       return intent.getStringExtra("projectName").orEmpty()
   }
}

//注册协定
private val getProject = registerForActivityResult(MyActivityResultContract()) {
      //it 是返回值
}
//启动页面
getProject.launch(23)

5.非Activity、Fragment页面接收协定结果

一般的onActivityResult只能在Activity类处理返回结果,处理业务逻辑,增加了代码的耦合性,同时有很多场景希望在自己的类里面接收结果,处理逻辑,比如在Adapter里面响应点击事件,处理返回结果,下面介绍如何在业务类实现打开新页面,处理返回结果。
页面的启动管理是通过ActivityResultRegistry实现的,Activity里面已经定义好了ActivityResultRegistry方便我们使用,在自己的类里面只需要传递过来就可以处理跳转逻辑了。

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

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

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

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

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

       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()
       }
   }
}

使用 ActivityResultRegistry API 时,强烈建议您使用可接受 LifecycleOwner 作为参数的 API,因为 LifecycleOwner 会在 Lifecycle 被销毁时自动移除已注册的启动器。不过,如果 LifecycleOwner 不存在,每个 ActivityResultLauncher 类都允许您手动调用 unregister() 作为替代。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容