再見！onActivityResult！你好，Activity Results API！

背景

在Android應用程式開發中，啟動一個Activity不一定是單項操作，從啟動的Activity擷取資料是常見的場景，最傳統的方式是通過Intent攜帶資料，然後使用startActivityForResult方法來啟動下一個Activity，然後通過onActivityResult來接收傳回的結果，代碼如下：調用startActivityForResult方法啟動 startActivityForResult(intent,1)實作onActivityResult方法override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { super.onActivityResult(requestCode, resultCode, data) if(resultCode == 1 && resultCode == Activity.RESULT_OK){ // 處理第二個頁面帶回的資料 }}以上方式，onActivityResult就能擷取從上一個界面傳回的資料，這種方式非常有用，不僅能同一個應用中，也可以從其他應用中擷取資料，比如我們常見的，調用系統相機、相冊擷取照片，擷取系統通訊錄等。但也有一些問題...随着應用的擴充，onActivityResult回調方法各種嵌套、耦合嚴重、難以維護。最常見的場景就是調用系統相機相冊擷取照片了。代碼可能像是如下這樣：class MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) } override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { if (resultCode == Activity.RESULT_OK) { when (requestCode) { REQUEST_PERMISSION -> { // 處理權限 } REQUEST_CAMERA -> { // 相機擷取圖檔結果 } REQUEST_ALBUM -> { // 相冊擷取圖檔結果 } REQUEST_CROP -> { // 系統裁剪 } } } super.onActivityResult(requestCode, resultCode, data) } companion object { const val REQUEST_PERMISSION = 1001 const val REQUEST_CAMERA = 1002 const val REQUEST_ALBUM = 1003 const val REQUEST_CROP = 1004 }}各種處理結果都耦合在onActivityResult回調裡，并且還得定義一堆額外的常量REQUEST_CODE,用與判斷是哪個請求的回調結果。

onActivityResult 現狀？

Google 可能也意識到

onActivityResult

的這些問題，在

androidx.activity:activity:1.2.0-alpha02

和

androidx.fragment:fragment:1.3.0-alpha02

中，已經廢棄了

startActivityForResult

和

onActivityResult

方法。

/**
    * {@inheritDoc}
    *
    * @deprecated use
    * {@link #registerForActivityResult(ActivityResultContract, ActivityResultCallback)}
    * passing in a {@link StartActivityForResult} object for the {@link ActivityResultContract}.
    */
   @Override
   @Deprecated
   public void startActivityForResult(@SuppressLint("UnknownNullness") Intent intent,
           int requestCode) {
       super.startActivityForResult(intent, requestCode);
   }

/**
    * {@inheritDoc}
    *
    * @deprecated use
    * {@link #registerForActivityResult(ActivityResultContract, ActivityResultCallback)}
    * with the appropriate {@link ActivityResultContract} and handling the result in the
    * {@link ActivityResultCallback#onActivityResult(Object) callback}.
    */
   @CallSuper
   @Override
   @Deprecated
   protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data){
       if (!mActivityResultRegistry.dispatchResult(requestCode, resultCode, data)) {
           super.onActivityResult(requestCode, resultCode, data);
       }
   }

可以看到，這兩個方法都被标記為了

Deprecated

，那這兩個方法不推薦使用了，Google推薦使用什麼方式從Activity中更好的擷取傳回結果呢？答案就是

Activity Results API

Activity Results API

Activity Results API 是 Google官方推薦的Activity、Fragment擷取傳回結果的方式。

Activity Results API 到底怎麼用？相比

onActivityResult

有哪些優勢？接下來，将一一為你解答。

在介紹如何使用之前，先為大家介紹Activity Results API 中兩個重要的元件：

ActivityResultContract

和

ActivityResultLauncher

。

ActivityResultContract : 協定，它定義了如何傳遞資料和如何處理傳回的資料。 ActivityResultContract 是一個抽象類，你需要繼承它來建立自己的協定，每個 ActivityResultContract 都需要定義輸入和輸出類，如果您不需要任何輸入，可使用 Void（在 Kotlin 中，使用 Void? 或 Unit）作為輸入類型。
ActivityResultLauncher : 啟動器，調用 ActivityResultLauncher 的 launch 方法來啟動頁面跳轉，作用相當于原來的 startActivity()

使用 Activity Results API 擷取Activity傳回的結果

`1.` 首先，在app下的 `build.gradle` 中加入依賴:

implementation 'androidx.activity:activity:1.2.0-beta01'
implementation 'androidx.fragment:fragment:1.3.0-beta01'

`2.` 定義協定

建立一個Contract類，繼承自

ActivityResultContract<I,O>

，其中，

是輸入的類型，

是輸出的類型。需要實作2個方法，

createIntent

和

parseResult

,輸入類型

作為

createIntent

的參數，輸出類型

作為

parseResult

方法的傳回值，在下面的例子中，輸入輸出類型都是String:

class MyActivityResultContract: ActivityResultContract<String,String>(){
        override fun createIntent(context: Context, input: String?): Intent {
            return Intent(context,SecondActivity::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 null
        }

    }

如上代碼，我們在

createIntent

方法中建立了Intent，并且攜帶了參數

name

,在

parseResult

方法中，擷取了傳回的資料

result

。

`3.` 注冊協定，擷取啟動器-ActivityResultLauncher

注冊協定，使用

registerForActivityResult

方法，該方法由

ComponentActivity

或者

Fragment

提供,接受2個參數，第一個參數就是我們定義的Contract協定，第二個參數是一個回調

ActivityResultCallback<O>

,其中

就是前面Contract的輸出類型。代碼如下：

private val myActivityLauncher = registerForActivityResult(MyActivityResultContract()){result ->
   Toast.makeText(applicationContext,result,Toast.LENGTH_SHORT).show()
   textView.text = "回傳資料：$result"
}

如上代碼，注冊了

MyActivityResultContract

registerForActivityResult

方法的傳回值是

ActivityResultLauncher

, 是以我們定義了一個

myActivityLauncher

,回調方法中，

result

就是從上一個界面傳回的值。這裡我們簡單的用Toast顯示。

`4.` 最後，調用啟動器的launch方法開啟界面跳轉

MainActivity

中添加一個Button,點選Button時，調用

launch

方法跳轉：

button.setOnClickListener {
      // 開啟頁面跳轉
      myActivityLauncher.launch("Hello,技術最TOP")
 }

SecondActivity

的代碼很簡單：

class SecondActivity : AppCompatActivity(){

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.second_layout)

        val name = intent.getStringExtra("name")
        textView3.text = "接收到的資料為：$name"

        button2.setOnClickListener {
            val intent = Intent().apply {
                putExtra("result","Hello，依然範特西稀，我是回傳的資料！")
            }
            setResult(Activity.RESULT_OK,intent)
            finish()
        }
    }
}

以上3步，就實作了使用新的

Activity Results API

來完成Activity之間的資料傳遞，并擷取Activity傳回的資料

看一下效果:

再見！onActivityResult！你好，Activity Results API！

這就完了嗎？

你可能會有疑問，雖然确實減少了代碼耦合，但是使用并不簡單啊。

确實，但這并沒有完！！！

預定義的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

了。

有了這些預定義的Contract, Activity之間傳遞資料就簡單多了，比如，前面的例子，可以簡化成這樣：

1. 注冊協定，擷取

ActivityResultLauncher

private val myActivityLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()){ activityResult ->  
        if(activityResult.resultCode == Activity.RESULT_OK){
            val result = activityResult.data?.getStringExtra("result")
            Toast.makeText(applicationContext,result,Toast.LENGTH_SHORT).show()
            textView.text = "回傳資料：$result"
        }
    }

2. 構造需要傳遞的資料，啟動頁面跳轉

button.setOnClickListener {
        val  intent = Intent(this,SecondActivity::class.java).apply {
             putExtra("name","Hello,技術最TOP")
        }
        myActivityLauncher.launch(intent)
}

OK，就是這麼簡單！！！

在比如，我們的權限，申請，請看代碼：

request_permission.setOnClickListener {
    requestPermission.launch(permission.BLUETOOTH)
}

request_multiple_permission.setOnClickListener {
    requestMultiplePermissions.launch(
        arrayOf(
            permission.BLUETOOTH,
            permission.NFC,
            permission.ACCESS_FINE_LOCATION
        )
    )
}

// 請求單個權限
private val requestPermission =
    registerForActivityResult(ActivityResultContracts.RequestPermission()) { isGranted ->
        // Do something if permission granted
        if (isGranted) toast("Permission is granted")
        else toast("Permission is denied")
    }

// 請求一組權限
private val requestMultiplePermissions =
    registerForActivityResult(ActivityResultContracts.RequestMultiplePermissions()) { permissions : Map<String, Boolean> ->
        // Do something if some permissions granted or denied
        permissions.entries.forEach {
            // Do checking here
        }                                                                             
}

有了這個，我們就可以抛棄所有的第三方權限請求架構，隻需要将這兩個Contract放到BaseActivity中，或者抽取到一個單獨的類中，就能随時随地申請權限。是不是很友善！！！

在非Activity/Fragment的類中接收Activity的結果

在Activity和Fragment中，我們能直接使用

registerForActivityResult

API ，那是因為

ConponentActivity

和

Fragment

基類實作了

ActivityResultCaller

接口,在非Activity/Fragment中，如果我們想要接收Activity回傳的資料，可以直接使用

ActivityResultRegistry

來實作。

比如，用一個單獨的類來實作協定的注冊和啟動器的啟動：

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

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

        fun selectImage() {
            getContent("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()
            }
        }
    }

示例中，我們在

MyLifecycleObserver

中實作協定注冊和啟動器啟動，為什麼要實作

LifecycleObserver

呢？因為，使用生命周期元件，

LifecycleOwner

會在

Lifecycle

被銷毀時自動移除已注冊的啟動器。不過，如果 LifecycleOwner 不存在，則每個

ActivityResultLauncher

類都允許您手動調用

unregister()

作為替代。但在使用ActivityResultRegistry時，Google官方強烈建議我們使用可接受

LifecycleOwner

作為參數的 API。

Activity和Fragment中為什麼不需要手動調用

unregister()

呢？,因為

ComponentActivity

和Fragment已經實作了

LifecycleObserver

。

ComponentActivity

源碼在這裡：

Fragment中源碼在這裡：

總結

新的Activity Result API提供了一種執行許多常見任務的簡便方法，比如我們調用第三方APP 擷取資料，請求權限、拍照、選圖檔、擷取聯系人等等。除此之外，降低了代碼的耦合，減少了樣闆代碼（比如，定義requestCode常量）。另外，

startActivityForResult

和

onActivityResult

已經被廢棄，官方也是強烈建議使用這種方式來進行資料傳遞并擷取Activity傳回的資料。

還沒用起來的，趕快使用起來，賊香！！！祝大家編碼愉快！！！

再見！onActivityResult！你好，Activity Results API！

onActivityResult 現狀？

Activity Results API

使用 Activity Results API 擷取Activity傳回的結果

`1.` 首先，在app下的 `build.gradle` 中加入依賴:

`2.` 定義協定

`3.` 注冊協定，擷取啟動器-ActivityResultLauncher

`4.` 最後，調用啟動器的launch方法開啟界面跳轉

預定義的Contract

在非Activity/Fragment的類中接收Activity的結果

總結

繼續閱讀

Android MVP架構MVCMVP

mvp初探

Android常用工具類簡介目錄

android常用工具類轉載自：http://www.trinea.cn/android/android-common-utils/Android常用工具類

Android常用工具類ToastUtilsSizeUtilsLogUtilsRetrofitManagerAnimUtil

磁盤結構及在Linux中的命名

Android Studio 0.8.0解決 Failure [INSTALL_FAILED_OLDER_SDK] 問題

Android – ListView 中添加按鈕，動态删除添加ItemView的操作

Kotlin的ListView與RecyclerView的簡單應用

關于公司的那些坑：Android Studio篇

android SQLite事務和kotlin協程

無法正常編譯錯誤Compilation failed to complete

關于Gradle配置的小結

詳解STM32單片機的堆棧

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Android APK檔案反編譯Android APK檔案反編譯

再見！onActivityResult！你好，Activity Results API！

onActivityResult 現狀？

Activity Results API

使用 Activity Results API 擷取Activity傳回的結果

​ ​1.​ ​​ 首先，在app下的​ ​build.gradle​ ​中加入依賴:

​ ​2.​ ​ 定義協定

​ ​3.​ ​ 注冊協定，擷取啟動器-ActivityResultLauncher

​ ​4.​ ​ 最後，調用啟動器的launch方法開啟界面跳轉

預定義的Contract

在非Activity/Fragment的類中接收Activity的結果

總結

繼續閱讀

`1.` 首先，在app下的 `build.gradle` 中加入依賴:

`2.` 定義協定

`3.` 注冊協定，擷取啟動器-ActivityResultLauncher

`4.` 最後，調用啟動器的launch方法開啟界面跳轉