你可能一直在kt文件中写Java代码

2023-06-07  本文已影响0人  BlueSocks

关注 Koltin 的大多数开发中可能都是 Android 开发者吧,大家基本也都是慢慢从 Java 逐步迁移到 Koltin。

得益于 Kotlin 与 Java 之间良好的互通性,有的时候可能我们写代码还是比较随性的,尤其是依旧按照自己过去写 Java 的编程习惯,书写 Kotlin 代码。

但实际上 Kotlin 与 Java 之间编码风格还是有很大的差异的,你的代码可能还是 Java 的咖啡味。

空判断

你大概早就听腻了 Kotlin 的空安全,可是你在代码里是否还在写if (xx != null) 这样满是咖啡味的代码呢?

现在把你的空判断代码都删除掉吧。使用 ?. 安全调用来操作你的对象。

// before
fun authWechat() {
    if (api != null) {
        if (!api.isWXAppInstalled) {
            ToastUtils.showErrorToast("您还未安装微信客户端")
            return
        }
        val req = SendAuth.Req()
        req.scope = "snsapi_userinfo"
        req.state = "none"
        api.sendReq(req)
    }
}

这段代码粗略看没什么问题吧,判断 IWXAPI 实例是否存在,存在的话判断是否安装了微信,未安装就 toast 提示

但是更符合 Kotlin 味道的代码应该是这样的

// after
fun authWechat() {
    api?.takeIf { it.isWXAppInstalled }?.let {
        it.sendReq(
            SendAuth.Req().apply {
                scope = "snsapi_userinfo"
                state = "none"
            }
        )
    } ?: api?.run { ToastUtils.showErrorToast("您还未安装微信客户端") }
}

使用?.安全调用配合 ?: Elvis 表达式,可以覆盖全部的空判断场景,再配合 takeIf 函数,可以让你的代码更加易读(字面意思上的)

上述代码用文字表达其实就是:

可空对象?.takeIf{是否满足条件}?.let{不为空&满足条件时执行的代码块} ?: run { 为空|不满足条件执行的代码块 }

这样是不是更加符合语义呢?

作用域

还是上面的例子,实例化一个req对象

val req = SendAuth.Req()
req.scope = "snsapi_userinfo"
req.state = "none"

更有 Kotlin 味道的代码应该是:

SendAuth.Req().apply {
    scope = "snsapi_userinfo"
    state = "none"
}

使用apply{} 函数可以帮我们轻松的初始化对象,或者配置参数,它更好的组织了代码结构,明确了这个闭包处于某个对象的作用域内,所有的操作都是针对这个对象的。

在 Koltin 的顶层函数中,提供了数个作用域函数,包括上文中的 let 函数,他们大同小异,具体的使用其实更多看编码风格的取舍,例如在我司我们有如下约定:

当出现超过两行的同一对象使用,无论是读、写,我们就应该考虑使用作用域函数,规范组织我们的代码,使之更具有可读性。

这几个函数其实作用效果可以互相转换,故而这只关乎编码风格,而无关对错之分。

?: Elvis 表达式

非空赋值

虽然说在 Kotlin 中可空对象,使用 ?. 可以轻松的安全调用,但是有的时候我们需要一个默认值,这种情况我们就需要用到 ?: Elvis 表达式。

例如:

val name: String = getName() ?: "default"

假如 getName() 返回的是一个 String? 可空对象,当他为空时,通过 ?: Elvis 表达式直接给予一个默认值。

提前返回

当然 ?: Elvis 表达式还有很多其他用途,例如代码块的提前返回

fun View.onClickLike(user: String?, isGroup: Boolean = false) = this.setOnClickListener {
    user?.takeUnless { it.isEmpty() } ?: return@setOnClickListener
    StatisticsUtils.onClickLike(this.context, user, isGroup)
}

这里我们对入参进行了非空判断与字符长度判断,在?: Elvis 表达式后提前 return 避免了后续代码被执行,这很优雅也更符合语义。

这里不是说不能用 if 判断,那样虽然可以实现相同效果,但是额外增加了一层代码块嵌套,看起来不够整洁明了。

这些应用本质上都是利用了 ?: Elvis 表达式的特性,即前者为空时,执行后者。

使用函数对象

很多时候我们的函数会被复用,或者作为参数传递,例如在 Android 一个点击事件的函数可能会被多次复用:

// before
btnA.setOnClickListener { sendEndCommand() }
btnB.setOnClickListener { sendEndCommand() }
btnC.setOnClickListener { sendEndCommand() }

例如这是三个不同帧布局中的三个结束按钮,他们对于的点击事件是同一个,这样写其实也没什么问题,但是他不够 Kotlin 味,我们可以进一步改写

btnA.setOnClickListener(::sendEndCommand)
btnB.setOnClickListener(::sendEndCommand)
btnC.setOnClickListener(::sendEndCommand)

使用 :: 双冒号,将函数作为函数对象直接传递给一个接收函数参数的函数(高阶函数),这对于大量使用高阶函数的链式调用场合更加清晰明了,也更加函数式

ps:这里需要注意函数签名要对应,例如setOnClickListener 的函数签名是View->Unit,故而我们要修改函数与之一致

@JvmOverloads
fun sendEndCommand(@Suppress("UNUSED_PARAMETER") v: View? = null) {

}

使用 KDoc

你还在用 BugKotlinDocument 这样的插件帮你生成函数注释么?你的函数注释看起来是这样的么?

/**
 * 获取全部题目的正确率,x:题目序号,y:正确率数值(float)
 * @param format ((quesNum: Int) -> String)? 格式化X轴label文字
 * @param denominator Int  计算正确率使用的分母
 * @return BarData?
 */

这样的注释看起来没什么问题,也能正确的定位到代码中的参数,但实际上这是 JavaDoc ,并不是 KDoc,KDoc使用的是类似 Markdown 语法,我们可以改写成这样:

/**
 * 获取全部题目的正确率的BarData,其中,x:题目序号,y:正确率数值(float)。
 * [format] 默认值为null,用于格式化X轴label文字,
 * [denominator] 除数,作为计算正确率使用的分母,
 * 返回值是直接可以用在BarChart中的[BarData]。
 */

KDoc 非常强大,你可以使用 ``` 在注释块中写示例代码,或者JSON格式

例如:

/**
 * 使用json填充视图的默认实现,必须遵循下面的数据格式
 * ```json
 *  [
 *      {"index":0,"answer":["对"]},
 *      {"index":1,"answer":["错"]},
 *      {"index":2,"answer":["对"]},
 *  ]
 * ```
 * [result] 必须是一个JSONArray字符串
 */

在AS中他会被折叠成非常美观的注释块:

Json_看图王.png

文章最后我们看一段 ”Java“ 代码与 Kotlin 代码的对比吧:

// before
override fun onResponse(
    call: Call<AvatarPathResult?>,
    response: Response<AvatarPathResult?>
) {
    val avatarPathResult = response.body()
    if (avatarPathResult != null) {
        val status = avatarPathResult.status
        if (status == 200) {
            val data = avatarPathResult.data
            MMKVUtils.saveAvatarPath(data)
        } else {
            MMKVUtils.saveAvatarPath("")
        }
    } else {
        MMKVUtils.saveAvatarPath("")
    }
}

// after
override fun onResponse(
    call: Call<AvatarPathResult?>,
    response: Response<AvatarPathResult?>,
) {
    with(response.body()) {
        MMKVUtils.saveAvatarPath(this?.data?.takeIf { status == 200 } ?: "")
    }
}

上一篇下一篇

猜你喜欢

热点阅读