SuperAPI AI 工具集

kp-higher-order-functions

编程与开发

查看项目

更新于 10-16 16:28

技能介绍

用途

本技能用于在 Kotlin 中设计接收或返回函数的高阶函数 API。一句话概括:把函数当作一等公民——可以作为参数传入、作为返回值返回、被存储、被组合——并理解 Kotlin 的 inline 机制,使这种用法的开销可以忽略。

何时使用

  • 设计接收函数参数的 API(典型例子:list.map { … }、withResource { … })。
  • 从一个函数返回另一个函数(柯里化、偏应用、函数工厂)。
  • 用 setup/teardown 函数包裹工作,并把工作作为 lambda 传入(use { … }、runBlocking { … })。
  • 任何本来需要只有一个方法的接口的地方——Kotlin 函数类型通常比接口更合适。

何时不使用

  • 函数参数很多且参数名有意义时——普通函数或 data class 比 (A, B, C, D) -> R 更易读。
  • 所谓“函数”携带状态时——那不是函数而是对象,应按对象来设计。
  • 函数必须以阻止内联的方式跨越模块边界暴露时——inline 只对同一编译单元内的调用者有效,因此跨模块 API 可能更适合普通函数。

核心内容

函数类型

(Int) -> String 是一种类型。suspend (User) -> Result<Order> 也是。Item.(Int) -> Item 也是(带接收者的函数类型——类型安全 DSL 构建器的基础)。

传入函数

fun List<Item>.filterPrice(predicate: (BigDecimal) -> Boolean): List<Item> =
    filter { predicate(it.price) }

items.filterPrice { it > 100.toBigDecimal() }

返回函数

fun discountFor(loyalty: LoyaltyLevel): (BigDecimal) -> BigDecimal = when (loyalty) {
    GOLD   -> { price -> price * 0.9.toBigDecimal() }
    SILVER -> { price -> price * 0.95.toBigDecimal() }
    NONE   -> { price -> price }
}

用 inline 提升性能

Kotlin 默认把 lambda 编译为匿名类实例——每次调用都会分配对象。把函数标记为 inline 会在调用点替换其函数体(以及 lambda 的函数体),从而消除该分配。用于非常热的路径,或当 lambda 捕获变量、否则会强制装箱的情况。

inline fun <T> measureTimeMillis(block: () -> T): Pair<T, Long> {
    val start = System.currentTimeMillis()
    val result = block()
    return result to (System.currentTimeMillis() - start)
}

inline 允许 lambda 使用 return(非局部返回——从外层函数返回,而不是从 lambda 返回)。crossinline 禁止非局部返回(当你把 lambda 传到另一个无法安全返回的上下文时)。noinline 让某个特定参数不参与内联。

Reified 类型参数

inline 使 reified 成为可能——因为调用点被内联,类型参数在运行时可知。

inline fun <reified T> Any.asOrNull(): T? = this as? T

决策启发式

  • 优先使用函数类型,而不是只有一个方法的接口(避免仅为包装一个函数而声明接口的样板代码)。
  • 对热路径上的高阶函数、或调用者经常编写 lambda 的高阶函数使用 inline。不要内联大函数——那会膨胀字节码。
  • 带接收者的函数类型是 DSL 构建器的基础——参见 kp-type-safe-builders。

反模式

  • 反射式地内联一切——inline 会膨胀字节码,且只在 lambda 本来会分配对象时才有帮助;对冷路径函数而言只是噪音。
  • 过度使用函数组合(f compose g compose h compose …),而具名函数可读性更好时——组合在一两步时很好,到五步就难以调试。
  • 函数返回函数再返回函数——嵌套三层时类型已不可读。应使用具名类型或重构。

参见

  • gof-strategy——在 Kotlin 中,Strategy 大多时候就是一个函数类型的参数。
  • gof-command——当命令的 execute 没有状态时,函数类型优于 Command 接口。
  • kp-type-safe-builders——带接收者的 lambda 是其基础。

参考资料

  • Kotlin Design Patterns and Best Practices(Alexey Soshin),第 5 章(Introducing Functional Programming)。
  • Kotlin 语言文档中关于函数类型、inline、crossinline、noinline 和 reified 类型参数的部分。