Kotlin 中的工具类 | Baeldung中文网

1. 引言

工具类（Util Classes）通常是指包含静态方法和常量的类，它们在应用程序中封装核心功能，起到复用作用。工具类不应被实例化，其主要职责是提供一组可复用的功能。

在本文中，我们将学习 Kotlin 中的工具类，包括其作用、使用方式、代码示例、单元测试以及实际应用场景。

2. 为什么工具类重要？

工具类在软件开发中扮演着关键角色：

✅ 遵循单一职责原则（Single Responsibility Principle）：每个工具类专注于一组特定的功能，使代码结构更清晰，便于维护。
✅ 无需实例化：工具类通常由静态方法和常量组成，避免不必要的对象创建，提升性能。
✅ 解耦功能：将通用功能集中管理，有助于实现关注点分离，保持代码模块化。

通过合理使用工具类，可以提升代码的可读性、可维护性，同时减少重复代码。

3. 创建工具类

在 Kotlin 中，使用 object 关键字可以创建单例对象，非常适合用于定义工具类。我们应使用 object 而不是 class 来声明工具类。

下面是一个简单的数学工具类示例，用于计算一个整数的平方：

object MathUtils {
    fun square(number: Int): Int {
        return number * number
    }
}

我们可以直接调用该工具类中的方法，无需实例化：

@Test
fun `Should Calculate Square`() {
    assertEquals(25, MathUtils.square(5))
    assertEquals(36, MathUtils.square(6))
}

3.1. 包含扩展函数的工具类

Kotlin 支持扩展函数（Extension Functions），这使得我们可以在不修改类源码的情况下为其添加新功能。工具类中经常使用扩展函数来增强已有类的功能。

例如，我们为 String 类添加一个判断是否为回文字符串的扩展函数：

object ExtensionUtil {
    fun String.isPalindrome(): Boolean {
        val cleanString = this.replace("\\s".toRegex(), "").toLowerCase()
        return cleanString == cleanString.reversed()
    }
}

对应的测试用例如下：

@Test
fun `Should Check If Palindrome`() {
    assertTrue("radar".isPalindrome())
    assertTrue("A man a plan a canal Panama".isPalindrome())
}

扩展函数的调用方式与普通方法略有不同，必须通过对应类型的实例来调用。

✅ 扩展函数的好处：

遵循 DRY 原则，避免重复逻辑。
提升代码可读性和可维护性。
工具类中统一管理扩展函数，有助于逻辑分组和复用。

⚠️ 注意：虽然扩展函数看起来像类的一部分，但它们实际上是静态函数，不能访问类的私有成员。

4. Java 互操作性与 @JvmStatic

在 Kotlin 与 Java 混合项目中，如果我们希望从 Java 中调用 Kotlin 工具类的方法，需要使用 @JvmStatic 注解。

例如：

object Utils {
    @JvmStatic
    fun foo(): Boolean {
        return false
    }
}

如果不加 @JvmStatic，Java 调用方式如下：

Utils.INSTANCE.foo();

而加上 @JvmStatic 后，调用方式更接近 Java 的静态方法：

Utils.foo();

✅ @JvmStatic 的作用：

生成 Java 字节码中的静态方法。
提升 Kotlin 工具类在 Java 中的调用体验，使其行为更接近 Java 原生静态方法。

因此，在需要被 Java 调用的 Kotlin 工具类中，建议为方法加上 @JvmStatic 注解。

5. 总结

Kotlin 中的工具类是组织可复用功能的重要手段，具有以下优势：

✅ 代码结构清晰，易于维护。
✅ 支持扩展函数，增强已有类的功能。
✅ 提供 Java 互操作性支持（通过 @JvmStatic）。
✅ 避免重复逻辑，提升开发效率。

合理使用工具类，可以显著提升代码质量与开发体验。

完整示例代码可在 GitHub 上找到。

Persistence

REST