SuperAPI AI 工具集

kp-anti-patterns

编程与开发

查看项目

更新于 10-16 17:28

技能介绍

用途

kp-anti-patterns 是一份 Kotlin 语言特有反模式的参考目录,用于代码审查场景。它关注的是语言和协程层面的坏味道,这些坏味道不属于设计模式问题,而是对 Kotlin 特性的误用。

适用场景:

  • 对 Kotlin 代码进行代码审查,尤其是从 Java 转型的开发者所写的代码。
  • 在重构过程中发现坏味道。
  • 帮助团队成员熟悉团队的 Kotlin 约定。
  • 怀疑存在某种特定误用模式(如 !!、lateinit、作用域函数、协程)。

不适用场景:

  • 领域建模坏味道 → 见 ddd-anti-patterns。
  • 设计模式误用 → 见 gof-review 及各模式专项技能。
  • 非 Kotlin 特有的通用代码质量问题(长方法、命名不佳)——由通用代码审查处理,而非本目录。

主要能力(核心内容)

空安全坏味道

  • !! 运算符滥用。因为“我知道它不是 null”而强制解包 Optional<T>。问题在于:静默的 bug 会在生产环境变成 NullPointerException,违背了 Kotlin 的空安全设计。修复:显式处理 null 情况(?.、?:、let),或在上游把类型修正为非空。
  • 对一切声明较晚的字段使用 lateinit var。当字段有合理默认值,或在实际使用前并未真正赋值时,这种做法是错误的。修复:如果有合理默认值,使用可空类型配合 ?.;如果应在首次访问时初始化,使用 lazy { … }。lateinit 用于 DI 生命周期,不用于“我还没决定何时初始化”。
  • 把平台类型当作非空。调用一个返回 String(无注解)的 Java API,假定非空,运行时得到 NPE。修复:除非 Java API 带有 @NonNull 注解,否则假定为可空。

智能转换坏味道

  • 在智能转换即可胜任处使用显式 as 转换。问题在于:as 在类型不匹配时抛异常;而智能转换由编译器跟踪类型,保证正确。修复:调整代码结构,让 is 检查触发编译器智能转换。
  • 因 var 导致智能转换失效。智能转换无法跨越可变边界。var s: String? = …; if (s != null) { val len = s.length } 会失败,因为 s 可能在检查与使用之间变化。修复:在 null 检查后赋值给 val。

作用域函数误用

  • 在需要返回值时使用 apply。apply 返回接收者;let/run 返回 lambda 结果。混用会返回错误的值。
  • 在方法链风格更易读处使用 with(x) { … }。这属于风格选择——选定一种即可。
  • 嵌套不同类型的作​​用域函数。obj.let { … }.also { … }.apply { … } 难以阅读。修复:选定一种风格,为中间结果命名变量。

协程坏味道

  • GlobalScope.launch { … } —— 协程泄漏;生命周期不绑定任何东西。修复:使用合适的作​​用域(viewModelScope、lifecycleScope、管理器持有的作用域)。见 kp-coroutine-scope。
  • 在生产 HTTP 处理器/服务端代码中使用 runBlocking —— 阻塞请求工作线程。修复:一路使用 suspend fun;让框架的协程运行器来编排。
  • 捕获 CancellationException 并吞掉它 —— 破坏取消传播。修复:如果必须捕获,则重新抛出。
  • 在 Dispatchers.Default 上做阻塞 I/O —— 耗尽 CPU 调度器。修复:用 withContext(Dispatchers.IO) { … } 包裹阻塞调用。
  • async { compute() }.await() 立即等待 —— 没有并行收益;直接调用 compute() 即可。见 kp-launch-vs-async。
  • 跨协程共享可变状态而无同步 —— 与其他并发代码相同的竞态条件。修复:使用限制(单一调度器)、Mutex 或 actor 风格隔离。

Java 风格的 Kotlin 坏味道

  • 在 object Foo { } 即可胜任时使用 getInstance() + 私有构造函数的单例。见 gof-singleton、gof-kotlin-idioms。
  • 在 (Input) -> Output 函数类型即可胜任时,使用 interface Strategy { fun execute() } + 具体类。
  • 在仅需基于身份相等性的实体上使用 data class。data class 会比较所有字段。实体应使用重写了 equals 的普通类。
  • 在具名参数 + 默认值即可胜任时使用冗长的伸缩式 Builder。见 gof-builder、gof-kotlin-idioms。

DSL 坏味道

  • 没有 @DslMarker 的 DSL —— 外层作用域泄漏进内层作用域;未限定名被意外解析导致细微 bug。见 kp-type-safe-builders。

使用方式与决策启发式

  • 严重性随影响范围放大:热路径中的 !! 比一次性脚本中的同一个 !! 更严重。
  • 为坏味道命名模式,使修复可被引用(例如“协程:GlobalScope 滥用 —— 见 kp-coroutine-scope”)。
  • 不要字面地 grep !!——它出现在合法场景中(测试夹具,替代方案反而更杂乱)。要看代码的类型。
  • 有些“反模式”在有注释解释原因时是可接受的——只标记,不自动拒绝。

关于“捕捉反模式”的反模式:

  • 把每个 !! 都当作缺陷——有时它正是正确答案(编译器看不到的编译期不变量)。
  • 给坏味道改名而不修复它。
  • 只审查这些坏味道而漏掉更大的设计问题。

参见

  • kp-coroutine-scope、kp-launch-vs-async、kp-dispatchers、kp-structured-concurrency —— 协程坏味道对应这些技能。
  • kp-type-safe-builders —— DSL 坏味道。
  • gof-singleton、gof-kotlin-idioms —— Java 风格的 Kotlin 坏味道。
  • ddd-anti-patterns —— 领域建模坏味道(正交)。

参考

  • 《Kotlin Design Patterns and Best Practices》(Alexey Soshin),第 9 章(Idioms and Anti-Patterns)。
  • Kotlin 语言文档——空安全、智能转换、作用域函数。
  • Kotlin 协程官方指南——常见陷阱。