JetPack知识点实战系列十四:View Binding替代ButterKnife和Kotlin synthetics

解决findViewById的忧伤

在早期的Android开发中,我们都是通过一系列的findViewById去找到XML Layout文件中的View。当XML文件中View特别多的情况下,这样的写法非常的繁琐。

主要有如下几种方式可以解决这个问题:

  1. ButterKnife:使用这个库,我们可以通过注解的方式非常方便进行View的绑定和处理Click事件。
  2. Kotlin Android Extensions sythentics:它是一个Kotlin插件,使用它可以非常方便的在Activities, Fragments, 和自定义的Views 中无缝的绑定View。此外绑定View有缓存,多次获取的速度更快。可以参阅 Kotlin Android Extensions: Say goodbye to findViewById
  3. View Binding:它具有Kotlin Android Extensions sythentics的一些优点,此外它还有两大优势:
  • 类型安全(Type-safe):Layout中id对应的View和代码中View属性的类型是一致的。
  • 空安全(Null-safe):如果Layout中的View在某个配置情况下是不存在的,那代码中View属性的就会加上@Nullable

对比一下:

三者对比

View Binding的使用

启动View Binding

可以在build.gradle中启动View Binding,不同的版本的Android Studio的配置有差异。

  • Android Studio 3.6
android {
    viewBinding {
        enabled = true
    }
}
  • Android Studio 4.0
android {
    buildFeatures {
        viewBinding = true
    }
}
View Binding在Activity中的使用

我们的MainActivity.kt使用activity_main.xml作为布局文件。View Binding会生成一个小的类ActivityMainBinding的类,这个类有属性对应布局文件的ID

Binding类的名字是:xml文件名以下划线为分割转成驼峰命名法+Binding组合而成

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    ... 
    
    <androidx.appcompat.widget.Toolbar
        android:id="@+id/toolbar"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:background="?attr/colorPrimary"
        android:minHeight="?attr/actionBarSize"
        android:theme="?attr/actionBarTheme"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:contentInsetStart="16dp"
        app:contentInsetEnd="16dp"
        app:contentInsetStartWithNavigation="0dp"
        />

</androidx.constraintlayout.widget.ConstraintLayout>
class MainActivity : AppCompatActivity() {
    // 1 
    lateinit var binding: ActivityMainBinding

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // 2
        binding = ActivityMainBinding.inflate(LayoutInflater.from(this))
        setContentView(binding.root)
        // 3
        setSupportActionBar(binding.toolbar)
        ...
    }
    
}

代码解释如下:

  1. View Binding会根据Activity的布局文件activity_main.xml生成ActivityMainBinding,我们这里定义一个类型为ActivityMainBinding的属性binding
  2. 使用inflate方法生成ActivityMainBinding对象,binding.root就是布局文件的根View,然后将其设置给Activity
  3. 直接使用binding.toolbar就能取到对应的idtoolbarToolBar对象。
View Binding在Fragment中的使用

Fragment中的使用方式类似,区别是Fragment在onCreateView函数中将binding.root做为返回值返回。

下例中我们Fragment的布局文件是fragment_discovery_main.xml

class DiscoveryMainFragment : Fragment() {
    // 1 binding属性定义
    lateinit var binding: FragmentDiscoveryMainBinding

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        // 2 binding属性通过inflate初始化
        binding = FragmentDiscoveryMainBinding.inflate(LayoutInflater.from(requireContext()), container, false)
        return binding.root
    }


    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        ... 
        // 3. 通过 binding属性获取其中的View
        binding.refreshlayout.setColorSchemeResources(R.color.colorAccent)
        binding.refreshlayout.setOnRefreshListener {
            viewModel.fetchData()
        }
        ...
    }

}
View Binding在Adapter中的使用

主要的步骤有两步:

  1. 在Adapter的onCreateViewHolder方法中生成binding对象,然后将这个对象传给ViewHolder的构造函数。
  2. ViewHolder对象持有这个binding属性,然后就可以获取到对应的View
class SearchResultAdapter(private val context: Context) : RecyclerView.Adapter<SearchResultAdapter.ViewHolder>() {
    
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder {
        // 1.实例化LayoutItemSearchResultBinding对象传给ViewHolder
        val binding = LayoutItemSearchResultBinding.inflate(LayoutInflater.from(context), null, false)
        // 2. 将这个binding对象传给**ViewHolder**的构造函数
        return ViewHolder(binding)
    }

    inner class ViewHolder(private val binding: LayoutItemSearchResultBinding): BaseViewHolder(binding.root) {

        init {
            // 3. 获取view
            binding.root.setOnClickListener(this)
        }

        fun bindItem(item: SearchSuggestResponse.SearchSuggest) {
            // 3. 获取view
            binding.keywordTv.text = item.keyword
            binding.searchIv.visible()
        }

    }

从Kotlin synthetics迁移到View Binding

更新 Gradle 文件
  • 添加启动View Binding的配置
android {
    ...
    buildFeatures {
        viewBinding true
    }
}
  • 删除Kotlin synthetics的配置
<!--删除-->
apply plugin: `kotlin-android-extensions`

如果使用了Kotlin的Parcelize特性,删除会受到影响,需要添加一个插件

apply plugin: 'kotlin-parcelize'

classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.20"

更新 Activity, Fragment,和Adapter文件
  • 删掉所有的kotlin.android.synthetic引用
  • Kotlin synthetics的写法替换成View Binding的写法。

总结

View Binding只能进行View的绑定,如果需要数据View双向绑定就需要引入Data Binding这一技术了。下一节我们将来介绍下Data Binding的使用。

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

推荐阅读更多精彩内容