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

時間  2021-08-14
標籤 java android 面試 微信 markdown app 框架 ide gradle 欄目 Java 简体版
原文   原文鏈接

背景

在Android應用程序開發中，啓動一個Activity不必定是單項操做，從啓動的Activity獲取數據是常見的場景，最傳統的方式是經過Intent攜帶數據，而後使用startActivityForResult方法來啓動下一個Activity，而後經過onActivityResult來接收返回的結果，代碼以下：java

  1. 調用startActivityForResult方法啓動
startActivityForResult(intent,1)
複製代碼
  1. 實現onActivityResult方法
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        if(resultCode == 1 && resultCode == Activity.RESULT_OK){
            // 處理第二個頁面帶回的數據
        }
}
複製代碼

以上方式，onActivityResult就能獲取從上一個界面返回的數據，這種方式很是有用，不只能同一個應用中，也能夠從其餘應用中獲取數據，好比咱們常見的，調用系統相機、相冊獲取照片，獲取系統通信錄等。android

但也有一些問題...面試

隨着應用的擴展，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,用與判斷是哪一個請求的回調結果。markdown

onActivityResult 現狀？

Google 可能也意識到onActivityResult的這些問題，在androidx.activity:activity:1.2.0-alpha02 和androidx.fragment:fragment:1.3.0-alpha02 中，已經廢棄了startActivityForResult和onActivityResult方法。app

/** * {@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獲取數據的方式。ide

Activity Results API 到底怎麼用？相比onActivityResult有哪些優點？接下來，將一一爲你解答。gradle

在介紹如何使用以前，先爲你們介紹Activity Results API 中兩個重要的組件：ActivityResultContract和ActivityResultLauncher。ui

  • 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>，其中，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,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>,其中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返回的數據

看一下效果:

這就完了嗎？

你可能會有疑問，雖然確實減小了代碼耦合，可是使用並不簡單啊。

確實，但這並無完！！！

預約義的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中，咱們能直接使用registerForActivityResultAPI ，那是由於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返回的數據。

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

文章首發於公衆號：「 技術最TOP 」，天天都有乾貨文章持續更新，能夠微信搜索「 技術最TOP 」第一時間閱讀，回覆【思惟導圖】【面試】【簡歷】有我準備一些Android進階路線、面試指導和簡歷模板送給你

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程