全部配置 / KN-XEXPLICIT-API

Xexplicit-api

Xexplicit-api · KN-XEXPLICIT-API · 编译器参数(Native)

重要:中 · 场景相关 默认:未设置(不传则空) 场合:场景可配 来源:上游原样

默认值:未设置。未指定时由消费侧决定;未核对前不写死取值。使用场合:场景可配。场景可配:有明确目标(性能、包体、安全、兼容)时再改。

它是做什么的

用途。强制the compiler to report errors on all public AP…

影响。实验/高级编译开关;默认保持关闭,改前需可复现、可回滚。

适用场景。场景可配。有明确需求再改,无需求时保持发行版默认更稳妥。改前核对目标限制与联动项,改后做冒烟。

取值说明

枚举

  • 参数描述:Force the compiler to report errors on all public API declarations without an explicit visibility or a return type. Use the 'warning' level to issue warnings instead of errors.
可写取值含义使用场景
strict显式 API 模式:strict库作者要求公开 API 必须显式可见性时
warning显式 API 模式:warning希望提示但不硬失败时
disable关闭显式 API 检查应用模块或不需要显式 API 门禁时

含义/场景依据:ExplicitApiMode.modeName=strict; ExplicitApiMode.modeName=warning; ExplicitApiMode.modeName=disable

定义依据:description/CommonCompilerArguments.kt 在仓库中打开types/ExplicitApiMode.kt 在仓库中打开

怎么用

  1. 配置入口:build.gradle.kts → ohosArm64.binaries.all { freeCompilerArgs += "-Xexplicit-api" }
  2. 示例
// 文件:build.gradle.kts(应用的 Kotlin 模块,例如 composeApp)
kotlin {
  ohosArm64 {  // 按实际 native target 调整
    binaries.all {
      freeCompilerArgs += "-Xexplicit-api"
    }
  }
}
  1. 生效:Sync 后执行该目标的 compile/link。
  2. 验证:编译日志出现 `-Xexplicit-api`。
  3. 回滚:从 binaries.all 的 freeCompilerArgs 中删除该项后 Clean 并重编。
  4. 注意:实验项无稳定兼容保证;改前留可回滚配置。

默认行为 未设置

不写这个配置时,编译器会怎么处理?

此选项默认未设置(空列表 / 空映射 / null)。不设置时由其他逻辑决定行为或直接跳过。

未指定时由消费侧决定;未核对前不写死取值。

溯源与对照

状态
实验(-X,兼容性不保证)
版本基线
2.2.21-1.0.0
定义位置类型
编译器参数定义(arguments DSL)
源码路径
compiler/arguments/src/org/jetbrains/kotlin/arguments/description/CommonCompilerArguments.kt 在仓库中打开