全部配置 / APP-OPTIN

Opt-in

optIn · APP-OPTIN · Gradle DSL · 同源入口 opt-in

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

默认值：未设置。未指定则为空。使用场合：场景可配。场景可配：有明确目标（性能、包体、安全、兼容）时再改。

它是做什么的

用途。启用带 Opt-in 标记的 API（传入要求注解的全限定名列表）。

影响。放开需 Opt-in 的 API；误用可能导致依赖不稳定 API。

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

取值说明

列表

  • Enable API usages that require opt-in with an opt-in requirement marker with the given fully qualified name. Default value: emptyList<String>()

可写。<元素列表> （Gradle 列表属性：org.gradle.api.provider.ListProperty<kotlin.String>）

定义依据：dsl/KotlinCommonCompilerOptions.kt 在仓库中打开

怎么用

  1. 配置入口：build.gradle.kts → kotlin.compilerOptions.optIn
  2. 示例：
// 文件：build.gradle.kts（应用的 Kotlin 模块，例如 composeApp）
kotlin {
  compilerOptions {
    optIn.set(/* value */)
  }
}
  1. 生效：Sync 后执行对应 Kotlin 编译任务。
  2. 验证：编译日志出现 `optIn`。
  3. 回滚：删除对应 compilerOptions 项后 Clean 并重编。
  4. 注意：按 Debug/Release 分流配置，避免公共污染。

同源旧旗标

应用工程只按上方「怎么用」里的 Gradle 示例配置。下面列出编译器还认识的旧名字，避免对着旧文档混用。

优先级：同一 opt-in 能力；工程里优先用 compilerOptions.optIn。

  • 推荐旗标：compilerOptions.optIn（键 optIn） — Gradle DSL（compilerOptions；注解全限定名列表）。
  • 旧旗标（勿用）：-opt-in <fqname>（键 opt-in） — 旧编译器旗标；应用工程用本页推荐的 compilerOptions，不要再写一条 freeCompilerArgs。

默认行为 未设置

不写这个配置时，编译器会怎么处理？

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

未指定则为空。

相关文档

以下摘抄原文中与本配置最相关的段落，便于速读；完整上下文请点原文。 上游与 CPF 分栏对照。

溯源与对照

状态
稳定（正式选项）
版本基线
2.2.21-1.0.0
定义位置类型
Gradle 插件 API（compilerOptions）
源码路径
libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinCommonCompilerOptions.kt 在仓库中打开