详解Kotlin中的Jvm注解

@JvmStatic 告诉jvm生成静态方法和成员
@JvmOverloads 生成Java重载方法,应用于kotlin方法有默认值生成对于的java方法
@JvmName 改变getter和setter中的方法名
@JvmField 直接暴露类中的属性和
@Throws 声明这个方法要检查Exception

1.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 注解

2.JvmName

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

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

在kotlin里 怎么调用他呢?

StringsHelperKt.appendUserName("hello");

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

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

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

StringsHelperUtils.appendUserName("hello");
3.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的实现吧。 这里有知道原因的大佬可以指点一下。

4.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方法了)

5.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;
6.JvmSynthetic

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

例如:

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

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

7.@Throws

java需要在每行代码生成的地方都检查异常,要吗处理掉,要吗网上抛,直到最顶上被顶级异常捕获掉,最差的情况就是没有捕获这个异常,直至程序异常崩溃掉。
而在kotlin上,是不需要每步检查异常的。这就导致了kotlin写的代码在java中调用不管有没有抛出异常都不需要声明或者捕获异常。这样肯定是有问题的。为处理这个问题就有了@Throws的用武之地。

//kotlin
@JvmStatic
fun saveAs(path: String?) {
   val outputFile = File(path)
   if (!outputFile.canWrite()) {
       throw FileNotFoundException("Could not write to file: $path")
   }
   // Write data...
}

//java
public static void backupUsers() {
        try {
            if (!Repository.saveAs(Repository.BACKUP_PATH)) {
                // TODO: Report error backing up user database.
            }
        } catch (IOException e) {
            // Log exception.
        }
    }

强行在java中声明异常会报错,所以需要加注解处理

@JvmStatic
@Throws(IOException::class)
fun saveAs(path: String?) {
   val outputFile = File(path)
   if (!outputFile.canWrite()) {
       throw FileNotFoundException("Could not write to file: $path")
   }
   // Write data...
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容