KSP2+Room多平台构建抛出NPE及实现类找不到问题求助

问题分析 #

你遇到的两个问题本质是同一原因：KSP2生成的Room实现类没有被正确关联到对应平台的编译流程，错误的任务依赖触发了构建时NPE，移除依赖后又导致生成代码未被纳入编译，最终运行时找不到AppDatabase_Impl。

解决方案 #

1. 修正依赖与插件配置 #

确保项目根build.gradle.kts和shared模块的配置符合KMP+Room+KSP2的标准：

根项目build.gradle.kts

plugins {
    id("com.android.application") version "8.2.2" apply false
    id("org.jetbrains.kotlin.android") version "1.9.20" apply false
    id("com.google.devtools.ksp") version "1.9.20-1.0.14" apply false
    id("org.jetbrains.kotlin.multiplatform") version "1.9.20" apply false
}

shared模块build.gradle.kts

plugins {
    kotlin("multiplatform")
    id("com.google.devtools.ksp")
    id("com.android.library")
}

kotlin {
    androidTarget {
        compilations.all {
            kotlinOptions.jvmTarget = "1.8"
        }
    }

    // 按需添加你的iOS目标
    listOf(iosX64(), iosArm64(), iosSimulatorArm64()).forEach {
        it.binaries.framework {
            baseName = "shared"
            isStatic = true
        }
    }

    sourceSets {
        val commonMain by getting {
            dependencies {
                implementation("androidx.room:room-ktx:2.6.1")
                implementation("androidx.room:room-runtime:2.6.1")
                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
            }
        }

        val androidMain by getting {
            dependencies {
                // 仅在Android平台通过KSP引入Room编译器
                ksp("androidx.room:room-compiler:2.6.1")
            }
        }

        // 其他平台sourceSet配置按需补充
        val iosMain by creating {
            dependsOn(commonMain)
            iosX64Main.dependsOn(this)
            iosArm64Main.dependsOn(this)
            iosSimulatorArm64Main.dependsOn(this)
        }
    }
}

android {
    namespace = "com.your.package.shared"
    compileSdk = 34
    defaultConfig.minSdk = 24
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
}

2. 修复任务依赖（关键） #

之前的configureEach全局任务依赖是错误的——Common模块没有配置Room编译器，自然不存在对应的KSP任务，强行让所有Kotlin编译任务依赖KSP任务会触发kspCommonMainKotlinMetadata的NPE。

正确做法：仅给Android平台的编译任务添加KSP依赖，或者直接依赖KSP插件的自动关联（推荐）：

// 手动关联Android编译任务与KSP任务（如果自动关联失效时用）
tasks.named("compileDebugKotlinAndroid") {
    dependsOn(tasks.named("kspDebugKotlinAndroid"))
}
tasks.named("compileReleaseKotlinAndroid") {
    dependsOn(tasks.named("kspReleaseKotlinAndroid"))
}

注意：KSP2在Android平台默认会自动将生成代码加入编译路径，多数情况下不需要手动配置依赖。

3. 检查Room数据库类声明 #

确保Common模块的数据库类符合Room要求：

import androidx.room.Database
import androidx.room.RoomDatabase

@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

Android平台的数据库初始化代码要正确引用这个类：

import androidx.room.Room
import android.content.Context

fun provideAppDatabase(context: Context): AppDatabase {
    return Room.databaseBuilder(context, AppDatabase::class.java, "app-db").build()
}

4. 清理缓存重建项目 #

执行以下命令彻底清理并重新构建：

./gradlew clean
./gradlew assembleDebug

原因说明 #

• 构建NPE：全局configureEach让无KSP任务的Common元数据编译任务强行依赖KSP任务，导致空指针。
• 运行时找不到Impl类：移除错误依赖后，Android编译任务未关联KSP生成的代码，导致AppDatabase_Impl未被打包进APK。

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