Kotlin 中 `@JvmField` 注解的使用

一、先明确 @JvmField 的核心作用

@JvmField 是 Kotlin 提供的JVM 互操作性注解 ,它的核心功能是:让 Kotlin 中声明的 val(只读属性)或 var(可变属性),在编译为 Java 字节码时,直接生成一个 公共(public)的成员字段(Field),而不是默认生成「私有字段 + getter 方法(val 对应)/ getter+setter 方法(var 对应)」的封装形式

简单说,它会「跳过 Kotlin 属性的默认封装」,直接暴露原始的 Java 公共字段。

二、对比:有无 @JvmField 的编译差异

1. 不加 @JvmField(Kotlin 默认行为)

如果你写:

kotlin 复制代码
class ApiManager {
    // 无 @JvmField 注解
    val api = RetrofitCreate.create(ApiService::class.java)
}

编译为 Java 后,会生成私有字段 + 公共 getter 方法

java 复制代码
public class ApiManager {
    // 私有字段,外部无法直接访问
    private final ApiService api;

    public ApiManager() {
        this.api = RetrofitCreate.create(ApiService.class);
    }

    // 公共 getter 方法,外部通过 getApi() 获取值
    public ApiService getApi() {
        return this.api;
    }
}

此时在 Java 中访问,必须通过 apiManager.getApi(),无法直接 apiManager.api

2. 加 @JvmField(你的代码写法)

你的代码:

kotlin 复制代码
class ApiManager {
    @JvmField
    val api = RetrofitCreate.create(ApiService::class.java)
}

编译为 Java 后,会生成公共成员字段,无 getter 方法:

java 复制代码
public class ApiManager {
    // 公共字段,外部可直接访问(无 getter 方法)
    public final ApiService api;

    public ApiManager() {
        this.api = RetrofitCreate.create(ApiService.class);
    }
}

此时在 Java 中可直接通过 apiManager.api 访问该属性,无需调用 getter 方法。

三、@JvmField 的使用约束

  1. 仅适用于 val/var 属性:不能用于函数、参数等其他元素。
  2. 不能与 lateinit 以外的属性委托/特殊修饰符共存
    • 支持:@JvmField lateinit var api: ApiService(延迟初始化属性可搭配)
    • 不支持:@JvmField val api by lazy { ... }(属性委托无法搭配,因为委托依赖 Kotlin 内部封装逻辑)
  3. val 修饰的 @JvmField 字段,编译后为 final(只读) :和你的代码一致,Java 中无法修改该字段的值;若用 var 修饰,则编译后为非 final(可修改)。
  4. 通常用于类成员属性 :可用于顶层属性(文件级属性),编译后会成为对应文件名的 Kt 类的公共静态字段。

四、使用 @JvmField 的核心场景

你的代码使用 @JvmField,大概率是为了Kotlin 与 Java 的互操作性 ------当你的 Kotlin 代码需要被 Java 代码调用时,通过 @JvmField 可以让 Java 侧像访问普通 Java 公共字段一样,直接访问 Kotlin 属性,简化代码写法(无需频繁调用 getXxx() 方法)。

除此之外,在一些需要反射访问字段、或与老的 Java 框架(依赖公共字段注入)集成时,@JvmField 也必不可少(因为反射获取 getter 方法和直接获取字段的逻辑不同,框架若要求直接访问字段,则必须用 @JvmField)。

总结

  1. @JvmField 核心:让 Kotlin 属性编译为 Java 公共字段,跳过默认的「私有字段 + getter/setter」封装。
  2. 你的代码效果:api 会成为公共只读(final)字段,Java 可直接 对象.api 访问。
  3. 关键差异:有无 @JvmField 决定了 Java 侧是「调用 getter」还是「直接访问字段」。
  4. 使用约束:不支持属性委托(如 lazy),仅适用于 val/varval 对应 Java final 字段。
相关推荐
Pcr_C2 小时前
Qt事件循环深度解析与实战指南
开发语言·c++·qt·开源
大大祥2 小时前
一个kotlin实现的视频播放器
android·开发语言·kotlin·音视频
唐古乌梁海2 小时前
【pytest】pytest详解-入门到精通
开发语言·python·pytest
爱上妖精的尾巴2 小时前
7-1 WPS JS宏 Object对象创建的几种方法
开发语言·前端·javascript
ZePingPingZe2 小时前
静态代理、JDK和Cglib动态代理、回调
java·开发语言
2501_921649492 小时前
iTick 全球外汇、股票、期货、基金实时行情 API 接口文档详解
开发语言·python·websocket·金融·restful
卸载引擎2 小时前
vue3+vite如何兼容低版本浏览器的白屏问题(安卓7/ios11)
android·javascript
你怎么知道我是队长2 小时前
python---进程
开发语言·chrome·python
C++ 老炮儿的技术栈2 小时前
时序数据库 相对于关系型数据库,有什么区别
c语言·开发语言·c++·机器人·时序数据库·visual studio