Kotlin 中的日志记录：惯用方法及方法比较

为什么 Kotlin 中的日志记录是个痛点（以及如何解决）

如果你曾经用 Java 写过代码，你一定熟悉这个仪式：在每个类的开头写上 private static final Logger logger = LoggerFactory.getLogger(MyClass.class);。枯燥、千篇一律，但确实有效。迁移到 Kotlin 后，你自然希望找到更优雅的方式——而有趣的事情就此开始。

在 Stack Overflow 上，关于 "Kotlin 中日志记录的惯用方法" 的问题获得了数千次浏览和数十次讨论。事实证明，即使在现代 Kotlin 中，也没有一个统一的“正确”日志记录方式。在本文中，我们将分析三种主要方法，比较它们的性能和可读性，并选出那个适用于 90% 项目的 Kotlin 中日志记录的惯用方法。

问题：Kotlin 中的 Logger 并不简单

Kotlin 是一种崇尚简洁的语言。但 SLF4J（Java/Kotlin 世界中最流行的日志记录库）要求为每个日志记录器显式指定类。在 Java 中，这可以通过 Lombok 或 IDE 模板解决。在 Kotlin 中，则需要借助语言本身的特性。

我们面临几个任务：

• 不重复类名（复制粘贴时容易出错）
• 不牺牲性能（日志记录是频繁操作）
• 保持代码的可读性和简洁性
• 支持日志记录器的 延迟初始化

让我们看看 Kotlin 社区提供了哪些解决方案。

方法 1：“粗暴型”——Companion Object

最直接的方法是在类的 companion object 中声明日志记录器。

class UserService {    companion object {        private val logger = LoggerFactory.getLogger(UserService::class.java)    }

    fun createUser(name: String) {        logger.info("Creating user: $name")    }}

优点：

• 简单易懂
• 无需额外依赖

缺点：

• 手动指定类——容易出错
• 大量样板代码
• 不适用于接口和抽象类

这种方法是所有其他方法的基础。它有效，但这并不是 Kotlin 中日志记录的惯用方法——样板代码太多了。

方法 2：扩展函数——Kotlin 风格

Kotlin 允许通过扩展函数来扩展类。为什么不创建一个能为任何类返回日志记录器的函数呢？

inline fun <reified T : Any> T.logger(): Logger {    return LoggerFactory.getLogger(T::class.java)}

class OrderService {    private val logger = logger()

    fun processOrder(id: String) {        logger.debug("Processing order: $id")    }}

这里我们使用了内联函数中的 reified 类型参数。这允许在运行时获取类而无需反射。

优点：

• 简洁：private val logger = logger()
• 安全：自动获取类
• 内联函数不会创建多余对象

缺点：

• 日志记录器在对象创建时立即初始化，而非延迟
• 不适用于顶层函数（类外部）

这已经更接近惯用解决方案了。但还可以做得更好。

方法 3：委托属性——Kotlin 的优雅

Kotlin 支持 委托属性。我们可以创建一个自定义委托，用于延迟初始化日志记录器并缓存它。

class LoggerDelegate<in T : Any> : ReadOnlyProperty<T, Logger> {    private var logger: Logger? = null

    override fun getValue(thisRef: T, property: KPropert