kotlin之 @JvmOverloads 的作用
@JvmOverloads 介绍
@Target([AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR]) annotation class JvmOverloads
Instructs the Kotlin compiler to generate overloads for this function that substitute default parameter values.
If a method has N parameters and M of which have default values, M overloads are generated: the first one takes N-1 parameters (all but the last one that takes a default value), the second takes N-2 parameters, and so on.
官网链接
以上就是kotlin官方对于kotlin @JvmOverloads 作用的解释。
中文翻译如下：
指示Kotlin编译器为该函数生成替代默认参数值的重载。
如果一个方法有N个参数，其中M个参数有默认值，那么就会生成M个重载。:第一个方法有N-1个参数，第二个方法有N-2个参数，依此类推(除了最后一个方法都有默认值)。
加与不加@JvmOverloads对比
来段代码对比下吧。
定义一个printPersonInfo方法，打印人物信息，我们可以看到有两个参数是有默认值的。
不加@JvmOverloads
首先让我们看看不加@JvmOverloads 的情况
fun printPersonInfo(age:Int=0,name:String,sex:String="男"){
println("姓名:$name 年龄:$age 性别:$sex")
}
fun main() {
printPersonInfo(name = "chl")
}
其对应的反编译Java代码如下
public static final void overloadTest(int age, @NotNull String name, @NotNull String sex) {
Intrinsics.checkParameterIsNotNull(name, "name");
Intrinsics.checkParameterIsNotNull(sex, "sex");
String var3 = "姓名:" + name + " 年龄:" + age + " 性别:" + sex;
boolean var4 = false;
System.out.println(var3);
}
// $FF: synthetic method
public static void overloadTest$default(int var0, String var1, String var2, int var3, Object var4) {
if ((var3 & 1) != 0) {
var0 = 0;
}
if ((var3 & 4) != 0) {
var2 = "男";
}
overloadTest(var0, var1, var2);
}
public static final void main() {
overloadTest$default(0, "chl", (String)null, 5, (Object)null);
}
我们可以看到其对应的Java代码是通过生成了一个 overloadTest$default方法，这个方法成为了外部调用的方法，在这个方法里面，进行了数据默认值的处理，然后再调用 overloadTest方法。
加@JvmOverloads
接下来我们再来看下加上@JvmOverloads注解的函数。
@JvmOverloads fun printPersonInfo(age:Int=0,name:String,sex:String="男"){
println("姓名:$name 年龄:$age 性别:$sex")
}
对应Java代码
@JvmOverloads
public static final void printPersonInfo(int age, @NotNull String name, @NotNull String sex) {
Intrinsics.checkParameterIsNotNull(name, "name");
Intrinsics.checkParameterIsNotNull(sex, "sex");
String var3 = "姓名:" + name + " 年龄:" + age + " 性别:" + sex;
boolean var4 = false;
System.out.println(var3);
}
// $FF: synthetic method
public static void printPersonInfo$default(int var0, String var1, String var2, int var3, Object var4) {
if ((var3 & 1) != 0) {
var0 = 0;
}
if ((var3 & 4) != 0) {
var2 = "男";
}
printPersonInfo(var0, var1, var2);
}
@JvmOverloads
public static final void printPersonInfo(int age, @NotNull String name) {
printPersonInfo$default(age, name, (String)null, 4, (Object)null);
}
@JvmOverloads
public static final void printPersonInfo(@NotNull String name) {
printPersonInfo$default(0, name, (String)null, 5, (Object)null);
}
public static final void main() {
printPersonInfo$default(0, "chl", (String)null, 5, (Object)null);
}
从以上代码可以看到，@JvmOverloads 注解的函数，对应的Java文件生成了一个所有参数都有的方法外，还生成了2个重载方法，第一个2个参数，第二个 1个参数。而所有的逻辑都在那个有所有参数的方法中，其他的方法通过调用printPersonInfo$default来访问该方法。
为什么用@JvmOverloads
通过以上代码我们明白了 @JvmOverloads的作用，但是我们在使用kotlin编写代码时候。似乎@JvmOverloads对我们的编码毫无影响，我们为什么要加上它呢？这其实主要是为了在java中调用kotlin代码的时候能够使用，如果不加 @JvmOverloads ， 当我们想要在Java中调用kotlin的方法时，是必须输入所有参数的值得，kotlin中默认参数我们无法使用。而当加上 @JvmOverloads ，kotlin编译器生成的字节码中有对应的重载方法，我们就可以通过Java的重载方式来使用kotlin的代码了，不必要输入所有的参数。
@JvmOverloads 使用范围
kotlin中 构造函数、顶级函数、类中方法，静态方法（@Jvmstatic修饰） 均可以采用@JvmOverloads生成对应重载方法。
在主构造函数使用重载函数，效果如下
kotlin代码
class People @JvmOverloads constructor(age:Int=0,name:String,sex:String="男"){
}
java代码
public final class People {
@JvmOverloads
public People(int age, @NotNull String name, @NotNull String sex) {
Intrinsics.checkParameterIsNotNull(name, "name");
Intrinsics.checkParameterIsNotNull(sex, "sex");
super();
}
// $FF: synthetic method
public People(int var1, String var2, String var3, int var4, DefaultConstructorMarker var5) {
if ((var4 & 1) != 0) {
var1 = 0;
}
if ((var4 & 4) != 0) {
var3 = "男";
}
this(var1, var2, var3);
}
@JvmOverloads
public People(int age, @NotNull String name) {
this(age, name, (String)null, 4, (DefaultConstructorMarker)null);
}
@JvmOverloads
public People(@NotNull String name) {
this(0, name, (String)null, 5, (DefaultConstructorMarker)null);
}
}
小结
本文主要讲述了@JvmOverloads 关键字的作用，其对应java代码中效果，以及为什么使用@JvmOverloads关键字，如有问题，还请批评指正！
原创声明
作者：陈浩亮
链接：
- 掘金 kotlin之 @JvmOverloads 的作用