教你一文搞懂Kotlin中的Jvm注解

JvmOverloads

创建一个kotlin的类

class Student(val name: String, val sex: Int = 1, val age: Int = 18)

可以看出来 这个构造函数的参数是有默认值的，kotlin的特性对吧，我们在使用的时候可以方便的使用，比如：

 val student = Student("wuyue")
 val student2 = Student("wuyue", age = 18)

但是这个特性如果你用java来调用你就是失败的了。

注意看下面的方法调用是报错的，不能调，只能选择3个构造函数的方法。

那我一定要让java也可以调用 怎么办？ 加上注解即可：

class Student @JvmOverloads constructor(val name: String, val sex: Int = 1, val age: Int = 18)

这个对于android程序员来说还是很重要的，比如我们自定义view中 就需要这个注解，否则运行起来 会因为找不到方法而报错的。

所以大家只要谨记一点： 当你的kotlin代码中的某个方法使用了 默认参数值 这个kotlin语言的特性并且这个方法还要给java代码调用的时候那你最好加上JvmOverloads 注解

JvmName

我们给String 增加一个扩展函数 StringsHelper.kt 文件

package com.test
fun String.appendUserName():String{
  return this+"wuyue"
}

在java的世界里 怎么调用他呢？

StringsHelperKt.appendUserName("hello");

很好理解对吧， 但是很多人都习惯于在java的世界中 使用什么xxxUtils 去处理类似的情况。这个时候就要利用到这个JvmName了

@file:JvmName("StringsHelperUtils")
package com.test
fun String.appendUserName():String{
  return this+"wuyue"
}

如此一来 我们在java的世界中 调用他的方法就变成了

StringsHelperUtils.appendUserName("hello");

JvmMultifileClass

关于这个注解 网上的说法是 可以将2个kt文件 里面的代码 合并到一个java的class文件中。

FunA.kt

@file:JvmName("Utils")
@file:JvmMultifileClass

package com.test

fun one(){

}

FunB.kt

@file:JvmName("Utils")
@file:JvmMultifileClass

package com.test

fun two(){

}

这样在java世界中 调用Utils这个类 就有one和two 2个方法了，但是我自己的实验结果 我就算去掉这个JvmMultifileClass 这个注解也一样可以达到效果。似乎这个注解并没有什么用？ 可能是1.3之后的kotlin版本 优化了 JvmName的实现吧。 这里有知道原因的大佬可以指点一下。

JvmField

还是前面这个Student的例子

class Student( val name: String, val sex: Int = 1, val age: Int = 18)

如果在java代码里 你要调用他里面的属性 只能通过get和set 来调用。 但是如果你加上注解

class Student(@JvmField val name: String, val sex: Int = 1, val age: Int = 18)

那他在java的世界中就可以 直接调用了

student.name="hello";

另外还有一个重要的作用是： 在kotlin中， val 并不意味着是常量，只不过val 声明的变量 是没有set方法的，只有get方法。所以给了你一个常量的错觉。 你要真正的 在kotlin中 定义一个常量，只有两种方法：

1. 在top-level或者object中 使用 const val
2. 或者使用 @JvmField val（这种方式定义的就是常量了，讲白了你也无法重写val的get方法了）

JvmStatic

class StaticTest{
  companion object{

    const val field1="111"
    
    val field2="222"
    
    @JvmField val field3="333"

    fun callNonStatic(){

    }
    @JvmStatic
    fun callStatic(){

    }
  }
}

我们看一下 在java代码中 怎么调用他们 就知道这个注解的实际作用了

  StaticTest.callStatic();
    StaticTest.Companion.callNonStatic();
    String t1 = StaticTest.field1;
    String t2=StaticTest.Companion.getField2();
    String t3=StaticTest.field3;

JvmSynthetic

这个注解用的不多，但是kotlin的许多官方库会用到他 讲白了 如果你写的一个函数你只想给kotlin代码调用 而不想给java的代码调用 那你就在你的函数上面加上这个注解即可

例如：

@file:JvmName("StringsHelperUtils")
package com.test
@JvmSynthetic
fun String.appendUserName():String{
  return this+"wuyue"
}

这样你就会发现 这个函数 你用kotlin正常使用 而java代码里StringsHelperUtils 这个类 是没有这个方法的