用途
该技能用于在 Kotlin 中建模一个封闭的、有限的相关类型集合,通过 sealed class 或 sealed interface 声明封闭变体集,再配合穷尽的 when 表达式,获得编译期校验的模式匹配。当某个变体未被处理时,编译器会拒绝编译。
适用场景包括:建模封闭有限的变体集合,如订单状态、解析器结果、命令类型、AST/表达式节点、网络响应结构;当变体需要携带不同数据时替代枚举(枚举是一组单例,而 sealed 层级是带载荷的变体);以符合 Kotlin 习惯的方式实现 GoF 状态、访问者或命令模式;将旧代码中的"类型码 + switch"模式改写为 sealed + when。
主要能力
核心由两个 Kotlin 语言特性协作完成。
Sealed 类型。sealed class 或 sealed interface 声明一组封闭的直接子类型,子类型需声明在与父类相同的包和相同模块中(多平台项目中有源集约束)。子类型可以是顶层声明,也可以是该包内其他具名类、接口或对象中的嵌套声明。编译器掌握完整集合。示例:
sealed interface Result<out T> {
data class Success<T>(val value: T) : Result<T>
data class Failure(val error: DomainError) : Result<Nothing>
object Pending : Result<Nothing>
}
穷尽 when。当 when 作为表达式使用(其值被赋值或返回)时,编译器要求处理每一个变体,遗漏任何一个都是编译错误。示例:
fun render(r: Result<User>): String = when (r) {
is Result.Success -> "Welcome, ${r.value.name}"
is Result.Failure -> "Error: ${r.error.message}"
Result.Pending -> "Loading…"
}
// Add a new variant and this when stops compiling until you handle it.
编译器的穷尽性检查是该模式的主要价值,它消除了一整类隐藏在 if/else if/else 链和 switch 语句中的"忘记处理某个分支"的缺陷。
关于 sealed class 与 sealed interface 的选择:除非需要在父类中共享状态或公共构造函数,否则优先使用 sealed interface。sealed interface 允许一个变体实现多个 sealed 层级,这对横切状态可能有用。data object(Kotlin 1.9+)是无状态变体的正确选择,能提供合理的 toString/equals 并表达意图;较早的代码使用普通 object。
判断准则
- 封闭变体集 + 变体携带不同数据 → sealed 层级。
- 封闭的纯标签集合、无载荷 → enum class。
- 开放集合(可由使用者扩展) → 开放 interface。
- 想要编译期穷尽性检查:自 Kotlin 1.7 起,表达式形式和语句形式的 when 在 sealed 类型、枚举和 Boolean 上都会被彻底检查。较早的代码库(1.7 之前)仅对表达式形式强制检查,因此旧指南中仍可能出现"把 when 改为表达式"的建议。
反模式
- 在 sealed 类型上的 when 中写 else 分支——会静默吞掉编译器本应标记的新变体。
- 只有一个子类型的 sealed 层级——单一变体没有穷尽性收益,应重新考虑是否需要该层级。
- 下游模块需要添加变体的 sealed 层级——这违背了"封闭",应改为开放。
- 依赖对 sealed 类型的非穷尽 when。自 Kotlin 1.7 起编译器在表达式和语句两种形式下都对 sealed 类型、枚举和 Boolean 强制穷尽性;希望编译器标记新增变体时,应避免 else 分支。
相关技能
- gof-state——sealed + when 是状态模式在 Kotlin 中的惯用实现。
- gof-visitor——在 Kotlin 中 sealed + when 通常替代访问者模式。
- gof-command——sealed interface 命令配合穷尽 when 进行分派。
- gof-kotlin-idioms——逐模式的指导,常会用到 sealed + when。
参考资料
Kotlin Design Patterns and Best Practices(Alexey Soshin),第 5 章(模式匹配)。 Kotlin 语言文档中关于 sealed class / sealed interface 与 when 表达式的部分。