如何写出Java-Friendly的kotlin代码

本文用实例讲解了各个kotlin用于编译出bytecode的注解的用法。希望大家通过这code出完美兼容java的kotlin代码,让java和kotlin想看两不厌。

先来个方法总览:

  • @JvmStatic 告诉jvm生成静态方法和成员
  • @JvmOverloads 生成Java重载方法,应用于kotlin方法有默认值生成对于的java方法
  • @JvmName 改变getter和setter中的方法名
  • @JvmField 直接暴露类中的属性和
  • @Throws 声明这个方法要检查Exception
@JvmStatic的使用示例
//kotlin
object Repository {
    ...
    private val _users = mutableListOf<User>()
    val users: List<User>
        get() = _users
}

在java代码里使用就报错"Non-static cannot be accessed from a static context."

//java
List<User> users = Repository.getUsers();

问题出在kotlin生成了一个静态类在我们设计的类的内部,没有暴露出类里面的方法和属性。如果上面用Repository.INSTANCE.getUsers()应该就可以了。不过官方推荐是用@JvmStatic注释,下面这样上面就可以运行了。

//kotlin
object Repository {
    ...
    private val _users = mutableListOf<User>()
    @JvmStatic
    val users: List<User>
        get() = _users
}
@JvmOverloads的使用示例
//kotlin
data class User(
    val id: Int,
    val username: String,
    val displayName: String = username.toTitleCase(),
    val groups: List<String> = listOf("guest")
)

这个类我们在kotlin里用的很普遍,但是我们在java代码里实例化这个类不小心就会报错了。比如下面这样:

//java
User user = new User(1001,"mical","M");

上面使用会报没有这个方法。这是由于kotlin里有默认参数,而java里是没有的,这里需要用@JvmOverloads来完善。

//kotlin
//需要注意的是,类的构造方法需要加constructor来标识,然后前面加@JvmOverloads注释。
data class User @JvmOverloads constructor(
    val id: Int,
    val username: String,
    val displayName: String = username.toTitleCase(),
    val groups: List<String> = listOf("guest")
)
@JvmField的使用示例

对于上面的User类中,在java代码中可以同getter和setter来访问和设置id等属性,但是可以通过@JvmField来改变这个行为。也就是可以直接通过user.username来访问和设置username这个属性

//kotlin
data class User @JvmOverloads constructor(
   @JvmField val id: Int,
   @JvmField val username: String,
   @JvmField val displayName: String = username.toTitleCase(),
   @JvmField val groups: List<String> = listOf("guest")
)

所以你可以看出@JvmField可以修改kotlin代码编译后生成的bytecode的这属性的名字。还有个更常用的地方是项目中的常量值。

//kotlin
object Repository {
    val BACKUP_PATH = "/backup/user.repo"
    
//java
Repository.BACKUP_PATH //报错这是private变量无法访问

如果你在java里访问这个属性就会发现无法访问,因为被当成了private变量。

//kotlin
object Repository {
    @JvmField
    val BACKUP_PATH = "/backup/user.repo"

然后就可以通过Repository.BACKUP_PATH访问了这个全局变量了。当然,这只是个作用演示,实际这里应该用const

object Repository {
   const val BACKUP_PATH = "/backup/user.repo"
@JvmName的使用示例

case0

考虑一种情况,工具类是我们常用的,在kotlin里我们普遍利用拓展函数来实现,由于java里没有这种特性,所以kotlin把他们编译成静态方法。

//kotlin
//fileName="StringUtil"
fun isEmpty(target: String?): Boolean = 
    target == null || target.length == 0

这种情况下你要访问到这个方法就需要使用

StringUtilKt.isEmpty();

这时候用注解@JvmName就可以方便的解决这个问题

//在package上面加入注解,用你想要的类的名字
@file:JvmName("StringUtil")
package 包名

case1

上面的User类的kotlin代码里加入方法

//in User.kotlin
data class User @JvmOverloads constructor(
   @JvmField val id: Int,
   @JvmField val username: String,
   @JvmField val displayName: String = username.toTitleCase(),
   @JvmField val groups: List<String> = listOf("guest")
) {
   val hasSystemAccess
       get() = "sys" in groups
}

这个时候如果在java代码里通过user.hasSystemAccess()也会报没有这个方法的错误。我们也需要通过@JvmName来解决这个问题。

//kotlin
val hasSystemAccess
   @JvmName("hasSystemAccess")
   get() = "sys" in groups
@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阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容