首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >写出让java相看两不厌的kotlin代码-@JvmField和@JvmStatic的方法论

写出让java相看两不厌的kotlin代码-@JvmField和@JvmStatic的方法论

作者头像
1025645
发布2019-10-16 12:00:29
1.2K0
发布2019-10-16 12:00:29
举报
文章被收录于专栏:Android开发小工Android开发小工

本文用实例讲解了各个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...
}
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2019.10.15 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • @JvmStatic的使用示例
  • @JvmOverloads的使用示例
  • @JvmField的使用示例
  • @JvmName的使用示例
  • @Throws的使用示例
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档