KSP生成Room内部AutoMigration类致单元测试无法访问的解决方案咨询

问题背景 #

我们近期将Room从KAPT迁移至KSP，开启Kotlin代码生成配置后：

extensions.configure<KspExtension> {
    arg("room.generateKotlin", "true")
}

生成的AutoMigration类会在build/generated/ksp目录下变为internal类，导致现有单元测试因无法访问该实现而失效。目前仅能通过在测试文件顶部添加@file:Suppress("invisible_reference", "invisible_member")临时规避，但这属于不安全的临时方案，相关特性后续可能被废弃。

我们需要解决两个核心问题：

1. 能否在Android库模块中通过Gradle SourceSet解决该问题？
2. 是否可配置Room KSP，将生成的AutoMigration类设为public或添加@VisibleForTesting注解？

附当前使用的约定插件代码：

class AndroidRoomKspConventionPlugin : Plugin<Project> {

    override fun apply(target: Project) {
        with(target) {
            pluginManager.apply("androidx.room")
            pluginManager.apply("com.google.devtools.ksp")

            extensions.configure<KspExtension> {
                arg("room.generateKotlin", "true")
            }

            extensions.configure<RoomExtension> {
                // The schemas directory contains a schema file for each version of the Room database.
                // This is required to enable Room auto migrations.
                schemaDirectory("$projectDir/schemas")
            }

            dependencies {
                add("implementation", libs.findLibrary("ksp-symbol-processing").get())
                add("api", libs.findBundle("room-api").get())
                add(
                    "androidTestImplementation",
                    libs.findLibrary("androidx-room-testing").get()
                )
                add(
                    "testImplementation",
                    libs.findLibrary("androidx-room-testing").get()
                )
                add("ksp", libs.findLibrary("room-compiler").get())
            }
        }
    }
}

使用版本信息：

kotlinVersion = "2.0.20"
roomVersion = "2.6.1"
kspVersion = "2.0.20-1.0.25"

合规解决方案 #

问题1：Gradle SourceSet能否解决？ #

直接通过SourceSet配置无法绕过Kotlin的internal访问权限限制——internal类仅对同一模块内的代码可见，而test/androidTest SourceSet默认属于独立编译单元。

若尝试将主源码目录加入测试SourceSet：

android {
    sourceSets {
        test {
            kotlin.srcDirs += file("src/main/kotlin")
        }
        androidTest {
            kotlin.srcDirs += file("src/main/kotlin")
        }
    }
}

虽然能临时让测试代码访问internal类，但会导致编译冗余，且并非官方推荐方案，仅适合短期过渡。

问题2：能否配置Room KSP修改类可见性？ #

截至Room 2.6.1版本，官方未提供直接配置AutoMigration类可见性的选项，可通过以下两种合规方式解决：

方案1：使用Room官方测试API间接验证迁移

避免直接访问AutoMigration类，改用Room提供的MigrationTestHelper验证自动迁移逻辑，完全符合官方规范：

@RunWith(AndroidJUnit4::class)
class MigrationTest {
    private val TEST_DB = "migration-test"

    @get:Rule
    val helper = MigrationTestHelper(
        InstrumentationRegistry.getInstrumentation(),
        AppDatabase::class.java.canonicalName,
        FrameworkSQLiteOpenHelperFactory()
    )

    @Test
    fun autoMigrationFromVersion1To2() {
        // 创建旧版本数据库
        helper.createDatabase(TEST_DB, 1).apply {
            close()
        }

        // 打开新版本数据库，触发自动迁移并验证
        helper.runMigrationsAndValidate(TEST_DB, 2, true, AppDatabase.AUTO_MIGRATION_1_2)
    }
}

方案2：自定义KSP处理器修改生成代码

编写轻量KSP处理器，监听Room生成的AutoMigration类，在生成代码时将其可见性从internal改为public，或添加@VisibleForTesting注解。需实现KSP的SymbolProcessor，遍历生成的Kotlin文件并修改AST结构。

最优方案推荐 #

优先选择使用Room官方测试API间接验证迁移，既规避了internal访问权限问题，又符合官方测试规范，是长期稳定的解决方案。若必须直接访问AutoMigration类，可关注Room后续版本的更新（可能会提供相关配置），或采用自定义KSP处理器的方式。

内容的提问来源于stack exchange，提问作者Sundara Raghavan