@JvmOverloads 是 Kotlin 中的一个注解，用于生成重载方法，以便于与 Java 代码的互操作性。当你在 Kotlin 函数中使用了默认参数值时，@JvmOverloads 注解可以帮助你为该函数生成多个 Java 兼容的重载版本，这样在 Java 代码中调用会更加方便。

示例

下面是一个简单的例子，展示了 @JvmOverloads 的用法：

class Example {
    @JvmOverloads
    fun greet(name: String = "World", greeting: String = "Hello") {
        println("$greeting, $name!")
    }
}

在这个例子中，greet 函数有两个带有默认值的参数。当你使用 @JvmOverloads 时，Kotlin 编译器会为 Java 生成以下重载方法：

1. greet(String name)
2. greet()
3. greet(String name, String greeting)

Java 中的用法

在 Java 中，你可以这样调用 greet 函数：

Example example = new Example();
example.greet(); // 调用 greet()，使用默认值
example.greet("Alice"); // 调用 greet(String name)，传入 "Alice"
example.greet("Bob", "Hi"); // 调用 greet(String name, String greeting)，传入 "Bob" 和 "Hi"

使用场景

• 当你希望为 Java 客户端提供更灵活的 API，同时又想利用 Kotlin 的默认参数值时，可以使用 @JvmOverloads。
• 在参数较多的函数中使用时要谨慎，因为这可能会生成大量的重载方法，从而使 Java API 变得复杂。

限制

• @JvmOverloads 只能应用于带有默认参数值的函数。
• 不能用于扩展函数或标记为 vararg 的函数。

使用 @JvmOverloads 可以显著提高 Kotlin 代码在 Java 中的可用性，因此它是 Kotlin 开发者在维护 Java 互操作性时的一个重要工具。

参考地址

豆包AI