用途:当 ./gradlew apiCheck 失败、出现二进制兼容性错误或未预期的 public API 差异时,用于诊断并修复。
主要能力:先用 ./gradlew apiCheck --info 查看错误,确认被改动的 API(类、函数、属性)、是否为有意变更、以及受影响的模块。随后按情形处理:API 文件不存在时执行 ./gradlew :module:apiDump 生成文件,并在 api/ 目录中确认已生成;若模块为空,可注释掉该模块或添加占位符。API 为有意变更时,阅读源码确认后更新 api/ 目录文件,使其反映改动。API 为意外变更时,读取源码并用编辑方式还原改动,再次运行检查。
必要用法:诊断命令 ./gradlew apiCheck --info;生成 API 文件命令形如 ./gradlew :extension:extension-navigation:apiDump 与 ./gradlew :extension:extension-navigation3:apiDump;验证命令 ./gradlew apiCheck,需退出码为 0。
适用场景:Kotlin Multiplatform 项目中通过 apiCheck 保证二进制兼容性,api/ 目录保存各平台(Android、JVM、Native 等)的 API 声明。
限制:API 文件建议由 apiDump 任务自动生成,不推荐手动编辑;具体项目模块路径、平台支持与额外配置以实际项目为准,资料未提供。