Data Binding 详解(七)-在 Kotlin 中的使用

知是行之始,行是知之成。
文章配套的 Demohttps://github.com/muyi-yang/DataBindingDemo
Demo 支持 Java 和 Kotlin 双语言,master 分支为 Java 语言代码,kotlin 分支为 Kotlin 语言代码。

在 Google 官方宣布 Android 支持 Kotlin 语言后,Kotlin 瞬间席卷了整个 Android 圈,各种文章书籍,学习小组应时而生。时至今日已有很大一部分先行者已经使用 Kotlin 开发自家的商业项目,在此期间我也是 Kotlin 的学习者之一,且在公司多个商业项目中使用 Kotlin 语言(100%)编写。这篇作为 DataBinding 的结尾篇,我将讲解如何在 Kotlin 项目中使用 DataBinding。如果你还不了解 Kotlin,你可以查看 Kotlin 官网,也可以学习 Google 官方的 Kotlin 示例

以下操作是在 Android Studio 3.3.1 下完成的,Android Studio 是从 3.0 版本开始默认支持 Kotlin 开发,如果你是 Android Studio 3.0 以下版本,需要安装 Kotlin 插件才能正常使用。

新建 Kotlin 项目

在 Android Studio 3.0 及以上可以直接创建一个 Kotlin 项目,在项目创建界面新增了一个 Language 选项,你可以选择 Java 或者 Kotlin 语言进行项目创建,如下图:
image.png

在项目创建好后你可以看到熟悉的 MainActivity 已不再是 .java 后缀了,它是 .kt 后缀,项目已经完全是 Kotlin 语法了,如下图:
image.png

项目中的 Gradle 配置也有了新的变化,项目根目录下的 build.gradle 中增加了 Kotlin 插件,如下:
buildscript {
    ext.kotlin_version = '1.3.41'
    ...
    dependencies {
        ...
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}

以及 module 下 build.gradle 中增加了新的依赖:

...
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
...
dependencies {
    ...
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
}

这样的项目就可以使用 Kotlin 语言开发了,当然这个项目依然支持 Java 语言,你完全可以在此项目中使用 Java 和 Kotlin 进行混合开发,因为 Kotlin 语言可以无缝的支持 Java 开发。你也可以查看 Kotlin 官方文章《Android 与 Kotlin 入门》来了解如何和使用 Kotlin。

已有项目开启 Kotlin 配置

如果你想在已有的老项目中使用 Kotlin,你只需要将上面讲的 Gradle 配置加上即可。加上后编译通过就可以创建 Kotlin 文件了,比如:
image.png

对于老的 Java 文件 Android studio 也提供了一键转换成 Kotlin 代码的工具,使用方法是选中你想转的 Java 文件,点击 Code > Convert Java File to Kotlin File,就这么简单,一键转换成了 Kotlin 代码。但是这个可不是万能的,毕竟它只是一个工具,在少许情况下转换出来的代码会出现编译不过的情况,这时就需要你手动修改代码,解决语法问题。所以对 Kotlin 语法不熟悉的同学,不推荐进行强转,也没这个必要,因为 Kotlin 和 Java 完全可以互调。

为了讲明 DataBinding 的用法,Demo 初期都是使用 Java 语言编写的,这样可以让读者专注于 DataBinding 本身,而不用担心 Kotlin 语言的干扰。但本节就是讲解 Kotlin 的用法,所以我在配套的 Demo 项目中创建了一个 kotlin 分支,此篇的示例可以切换到 kotlin 分支查看。

DataBinding 在 Kotlin 中的配置

想在 Kotlin 项目中使用 DataBinding 你必须在 module 下的 build.gradle 中配置如下信息:

...
apply plugin: 'kotlin-kapt'
...
dependencies {
    ...
    kapt "androidx.databinding:databinding-compiler:3.3.1"
}

apply plugin: 'kotlin-kapt'是为项目添加 kapt 依赖,kapt 即 Kotlin annotation processing tool(Kotlin 注解处理工具)缩写。在 Kotlin 中通过 kapt 编译器插件支持注解处理器,比如在 Kotlin 项目中使用像 Dagger 或者 DataBinding 这样大量使用了注解的库。
kapt "androidx.databinding:databinding-compiler:3.3.1"是添加 DataBinding 的编译插件,通过它可以识别 DataBinding 中的各种注解。

DataBinding 的编译插件必须和 Android studio 版本对应,否则会编译报错,我这里是使用的 Android studio 3.3.1,所以 DataBinding 插件也是 3.3.1 版本。DataBinding 插件从 3.3.x 开始是 androidx 版本,在 3.3.x 之前是这样写:kapt "com.android.databinding:compiler:3.2.1"

DataBinding 在 Kotlin 中的适配器

在使用 DataBinding 的过程中,我们会写很多@BindingAdapter,这些适配器方法必须是静态的,但在 Kotlin 当中如何声明静态方法呢?使用@JvmStatic注解来解决这类问题,以下为 Java 和 Kotlin 的代码对比:

    //java 代码
    @BindingAdapter(value = {"app:image", "app:placeholder", "app:error"}, requireAll = false)
    public static void loadImage(ImageView view, String url, Drawable placeholder, Drawable error) {
        if (TextUtils.isEmpty(url)) {
            view.setImageDrawable(placeholder);
        } else {
            RequestOptions options = new RequestOptions().placeholder(placeholder).error(error);
            Glide.with(view).load(url).apply(options).into(view);
        }
    }
    //kotlin 代码
    @BindingAdapter(value = ["app:image", "app:placeholder", "app:error"], requireAll = false)
    @JvmStatic
    fun loadImage(view: ImageView, url: String, placeholder: Drawable, error: Drawable) {
        if (TextUtils.isEmpty(url)) {
            view.setImageDrawable(placeholder)
        } else {
            val options = RequestOptions().placeholder(placeholder).error(error)
            Glide.with(view).load(url).apply(options).into(view)
        }
    }

静态字段也是一样需要加上@JvmStatic注解,否则编译会提示找不到对应字段。

object View {
    @JvmStatic
    var isShow = false
}

至此 Demo 已经可以正常运行了,DataBinding 的讲解也将告一段落。在此期间因为各种缘由断了3个月左右,但庆幸终于得空把设想的内容基本写完。如果你是全系列看完,至此应该可以正常的使用 DataBinding 库了,后续可能还会写一些特别篇,内容可能是 DataBinding 和 Architecture Components 联合使用,或者是一些心得,以及使用规范等。

如果你觉得文章有帮助到你,记得点个喜欢以表支持,同时欢迎你的指正和建议。十分感谢!