詳解ViewBinding用法

更新時(shí)間：2023年03月20日 10:39:53 作者：ximen502_

這篇文章主要介紹了ViewBinding用法,本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

視圖綁定

通過視圖綁定功能，您可以更輕松地編寫可與視圖交互的代碼。在模塊中啟用視圖綁定之后，系統(tǒng)會(huì)為該模塊中的每個(gè) XML 布局文件生成一個(gè)綁定類。綁定類的實(shí)例包含對(duì)在相應(yīng)布局中具有 ID 的所有視圖的直接引用。
在大多數(shù)情況下，視圖綁定會(huì)替代 findViewById。

設(shè)置說明

注意：視圖綁定在 Android Studio 3.6 Canary 11 及更高版本中可用。

視圖綁定功能可按模塊啟用。要在某個(gè)模塊中啟用視圖綁定，請(qǐng)將 viewBinding 元素添加到其 build.gradle 文件中，如下例所示：

android {
    ...
    viewBinding {
        enabled = true
    }
}

然而，在后續(xù)的as版本中這個(gè)引用又變了，不然build可能報(bào)錯(cuò)，需要如下引用才行：

android {
	buildFeatures{
		viewBinding true
	}
}

如果您希望在生成綁定類時(shí)忽略某個(gè)布局文件，請(qǐng)將 tools:viewBindingIgnore=“true” 屬性添加到相應(yīng)布局文件的根視圖中：

<LinearLayout
        ...
        tools:viewBindingIgnore="true" >
    ...
</LinearLayout>

用法

為某個(gè)模塊啟用視圖綁定功能后，系統(tǒng)會(huì)為該模塊中包含的每個(gè) XML 布局文件生成一個(gè)綁定類。每個(gè)綁定類均包含對(duì)根視圖以及具有 ID 的所有視圖的引用。系統(tǒng)會(huì)通過以下方式生成綁定類的名稱：將 XML 文件的名稱轉(zhuǎn)換為駝峰式大小寫，并在末尾添加“Binding”一詞。

例如，假設(shè)某個(gè)布局文件的名稱為 result_profile.xml：

<LinearLayout ... >
        <TextView android:id="@+id/name" />
        <ImageView android:cropToPadding="true" />
        <Button android:id="@+id/button"
            android:background="@drawable/rounded_button" />
    </LinearLayout>

所生成的綁定類的名稱就為 ResultProfileBinding。此類具有兩個(gè)字段：一個(gè)是名為 name 的 TextView，另一個(gè)是名為 button 的 Button。該布局中的 ImageView 沒有 ID，因此綁定類中不存在對(duì)它的引用。

每個(gè)綁定類還包含一個(gè) getRoot() 方法，用于為相應(yīng)布局文件的根視圖提供直接引用。在此示例中，ResultProfileBinding 類中的 getRoot() 方法會(huì)返回 LinearLayout 根視圖。

以下幾個(gè)部分介紹了生成的綁定類在 Activity 和 Fragment 中的使用。

在 Activity 中使用視圖綁定

如需設(shè)置綁定類的實(shí)例以供 Activity 使用，請(qǐng)?jiān)?Activity 的 onCreate() 方法中執(zhí)行以下步驟：

調(diào)用生成的綁定類中包含的靜態(tài) inflate() 方法。此操作會(huì)創(chuàng)建該綁定類的實(shí)例以供 Activity 使用。
通過調(diào)用 getRoot() 方法或使用 Kotlin 屬性語法獲取對(duì)根視圖的引用。
將根視圖傳遞到 setContentView()，使其成為屏幕上的活動(dòng)視圖。

   private lateinit var binding: ResultProfileBinding

   override fun onCreate(savedInstanceState: Bundle) {
       super.onCreate(savedInstanceState)
       binding = ResultProfileBinding.inflate(layoutInflater)
       val view = binding.root
       setContentView(view)
   }

您現(xiàn)在即可使用該綁定類的實(shí)例來引用任何視圖：

    binding.name.text = viewModel.name
    binding.button.setOnClickListener { viewModel.userClicked() }

在 Fragment 中使用視圖綁定

如需設(shè)置綁定類的實(shí)例以供 Fragment 使用，請(qǐng)?jiān)?Fragment 的 onCreateView() 方法中執(zhí)行以下步驟：

調(diào)用生成的綁定類中包含的靜態(tài) inflate() 方法。此操作會(huì)創(chuàng)建該綁定類的實(shí)例以供 Fragment 使用。
通過調(diào)用 getRoot() 方法或使用 Kotlin 屬性語法獲取對(duì)根視圖的引用。
從 onCreateView() 方法返回根視圖，使其成為屏幕上的活動(dòng)視圖。

注意：inflate() 方法會(huì)要求您傳入布局膨脹器。如果布局已膨脹，您可以調(diào)用綁定類的靜態(tài) bind() 方法。如需了解詳情，請(qǐng)查看視圖綁定 GitHub 示例中的例子。

    private var _binding: ResultProfileBinding? = null
    // This property is only valid between onCreateView and
    // onDestroyView.
    private val binding get() = _binding!!

    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        _binding = ResultProfileBinding.inflate(inflater, container, false)
        val view = binding.root
        return view
    }

    override fun onDestroyView() {
        super.onDestroyView()
        _binding = null
    }

您現(xiàn)在即可使用該綁定類的實(shí)例來引用任何視圖：

    binding.name.text = viewModel.name
    binding.button.setOnClickListener { viewModel.userClicked() }

注意：Fragment 的存在時(shí)間比其視圖長。請(qǐng)務(wù)必在 Fragment 的 onDestroyView() 方法中清除對(duì)綁定類實(shí)例的所有引用。

GitHub示例如下代碼所示：

class BindFragment : Fragment(R.layout.fragment_blank) {

    // Scoped to the lifecycle of the fragment's view (between onCreateView and onDestroyView)
    private var fragmentBlankBinding: FragmentBlankBinding? = null

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        val binding = FragmentBlankBinding.bind(view)
        fragmentBlankBinding = binding
        binding.textViewFragment.text = getString(string.hello_from_vb_bindfragment)
    }

    override fun onDestroyView() {
        // Consider not storing the binding instance in a field, if not needed.
        fragmentBlankBinding = null
        super.onDestroyView()
    }
}

與 findViewById 的區(qū)別

與使用 findViewById 相比，視圖綁定具有一些很顯著的優(yōu)點(diǎn)：

Null 安全：由于視圖綁定會(huì)創(chuàng)建對(duì)視圖的直接引用，因此不存在因視圖 ID 無效而引發(fā) Null 指針異常的風(fēng)險(xiǎn)。此外，如果視圖僅出現(xiàn)在布局的某些配置中，則綁定類中包含其引用的字段會(huì)使用 @Nullable 標(biāo)記。
類型安全：每個(gè)綁定類中的字段均具有與它們?cè)?XML 文件中引用的視圖相匹配的類型。這意味著不存在發(fā)生類轉(zhuǎn)換異常的風(fēng)險(xiǎn)。

這些差異意味著布局和代碼之間的不兼容將會(huì)導(dǎo)致構(gòu)建在編譯時(shí)（而非運(yùn)行時(shí)）失敗。