Kotlin Multiplatform集成Room数据库遇MissingType编译错误求助

问题描述 #

开发Kotlin Multiplatform项目时，集成Room数据库并使用KSP编译，遇到如下错误：

[ksp] [MissingType]: Element 'ProductEntity' references a type that is not present

无法定位错误指向的缺失类型。

相关代码与配置 #

Database类 #

import androidx.room.BuiltInTypeConverters
import androidx.room.ConstructedBy
import androidx.room.Database
import androidx.room.RoomDatabase
import androidx.room.RoomDatabaseConstructor
import androidx.room.TypeConverters
import com.example.shopapp.converter.CategoryObjectConverter
import com.example.shopapp.converter.ListConverter
import com.example.shopapp.data.AppDatabase.Companion.VERSION
import com.example.shopapp.data.local.dao.CartDao
import com.example.shopapp.data.local.dao.ProductsDao
import com.example.shopapp.data.local.entity.CartProductEntity
import com.example.shopapp.data.local.entity.ProductEntity
import com.example.shopapp.getAppDatabase

@TypeConverters(
    CategoryObjectConverter::class,
    ListConverter::class,
    builtInTypeConverters = BuiltInTypeConverters()
)
@ConstructedBy(AppDatabaseProvider::class)
@Database(
    version = VERSION,
    exportSchema = false,
    entities = [
        ProductEntity::class,
        CartProductEntity::class,
    ],
)
abstract class AppDatabase : RoomDatabase() {

    abstract fun getCartDao(): CartDao

    abstract fun getProductsDao(): ProductsDao

    companion object {
        const val VERSION = 1
        const val NAME = "my_room"
    }
}

class AppDatabaseProvider : RoomDatabaseConstructor<AppDatabase> {
    override fun initialize(): AppDatabase = getAppDatabase()
}

Entity类 #

package com.example.shopapp.data.local.entity

import androidx.room.Entity
import androidx.room.PrimaryKey
import androidx.room.TypeConverters
import com.example.shopapp.converter.CategoryObjectConverter
import com.example.shopapp.converter.ListConverter
import kotlinx.serialization.Serializable

@TypeConverters(CategoryObjectConverter::class, ListConverter::class)
@Entity(tableName = "productEntity")
@Serializable
data class ProductEntity(
    @PrimaryKey
    val id: Long,
    val title: String,
    val price: Double,
    val description: String,
    val category: Category,
    val images: List<String>,
)

@Entity(tableName = "cart")
@TypeConverters(CategoryObjectConverter::class, ListConverter::class)
@Serializable
data class CartProductEntity(
    @PrimaryKey
    val id: Long,
    val title: String,
    val price: Double,
    val description: String,
    val category: Category,
    val images: List<String>,
    val quantity: Int
)

data class CartProduct(
    val id: Long,
    val title: String,
    val price: Double,
    val description: String,
    val category: Category,
    val images: List<String>,
    val quantity: Int
)

@Serializable
data class Category(
    val id: Int,
    val name: String,
    val image: String
)

@Serializable
data class Product(
    val id: Long,
    val title: String,
    val price: Double,
    val description: String,
    val category: Category,
    val images: List<String>
)

依赖版本 #

room = "2.7.0-alpha06"
room_compiler = "2.7.0-alpha06"
sqlite = "2.5.0-SNAPSHOT"
ksp = "2.0.0-1.0.21"

Gradle配置 #

plugins {
    alias(libs.plugins.kotlinMultiplatform)
    alias(libs.plugins.androidApplication)
    alias(libs.plugins.buildConfig)
    alias(libs.plugins.kotlinx.serialization)
    alias(libs.plugins.compose.compiler)
    alias(libs.plugins.compose)
    alias(libs.plugins.room)
    alias(libs.plugins.ksp)
    id("com.google.osdetector") version "1.7.3"
}

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

    listOf(
        iosX64(),
        iosArm64(),
        iosSimulatorArm64()
    ).forEach {
        it.binaries.framework {
            baseName = "shared"
            isStatic = true
            linkerOpts.add("-lsqlite3")
        }
    }

    sourceSets {
        androidMain.dependencies {
            implementation(libs.androidx.appcompat)
            implementation(libs.androidx.activity.compose)
            implementation(libs.compose.ui.tooling)
            implementation(libs.ktor.client.okhttp)
            implementation(libs.core)
            implementation(libs.core)
            implementation(libs.custom.ui)
            implementation(libs.koin.android)
            implementation(libs.koin.androidx.compose)
            implementation(libs.androidx.glance.app.widget)
            implementation(libs.androidx.glance.material3)
            implementation(libs.androidx.glance.app.widget)
            implementation(libs.androidx.glance.material3)
        }

        commonMain.dependencies {
            implementation(compose.runtime)
            implementation(compose.material3)
            implementation(libs.screen.size)
            implementation(compose.material)
            implementation(compose.animation)

            implementation(libs.ktor.core)
            implementation(libs.ktor.client.content.negotiation)
            implementation(libs.kotlinx.serialization.json)
            implementation(libs.kotlinx.datetime)
            implementation(libs.ktor.client.logging)
            implementation(libs.io.ktor.ktor.client.serialization)
            api(libs.koin.core)
            implementation(libs.koin.compose.viewmodel)

            implementation(libs.room.runtime)
            implementation(libs.sqlite.bundled)

            implementation(libs.kotlinx.coroutines.core)
            implementation(libs.gson)

            implementation(libs.kamel.image)
            @OptIn(org.jetbrains.compose.ExperimentalComposeLibrary::class)
            implementation(compose.components.resources)
        }

        iosMain.dependencies {
            implementation(libs.ktor.client.darwin)
        }

        commonTest.dependencies {
            implementation(libs.kotlin.test)
        }
    }
}

android {
    namespace = "com.example.shopapp"
    compileSdk = 34

    defaultConfig {
        minSdk = 24
    }
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    buildFeatures {
        compose = true
    }
    composeOptions {
        kotlinCompilerExtensionVersion = "1.5.14"
    }
}

task("testClasses") {}

room {
    schemaDirectory("$projectDir/schemas")
}

dependencies {
    ksp(libs.room.compiler)
}

解决方案 #

1. 检查自定义类型的Room支持 #

ProductEntity中的category字段类型是Category，需确保：

• CategoryObjectConverter正确实现了Category与数据库兼容类型（如String）的双向转换逻辑，且类被正确添加到@TypeConverters注解中。
• Category类在编译时未被混淆，KSP能正常识别该类型。

2. 修正KMP项目的KSP依赖配置 #

仅添加ksp(libs.room.compiler)无法覆盖KMP所有编译单元，需为common元数据及各平台目标分别配置：

dependencies {
    // 处理commonMain元数据
    kspCommonMainMetadata(libs.room.compiler)
    // 处理Android目标
    kspAndroid(libs.room.compiler)
    // 处理iOS各目标
    listOf(iosX64(), iosArm64(), iosSimulatorArm64()).forEach { target ->
        ksp(target, libs.room.compiler)
    }
}

3. 升级依赖版本避免Alpha版Bug #

当前使用的Room是Alpha版本，可能存在KMP与KSP的兼容问题，建议：

• 升级Room到稳定版（如2.6.1）或更新的Alpha版本。
• 确保KSP版本与项目Kotlin版本匹配（KSP 2.0.0-1.0.21对应Kotlin 1.0.21）。

4. 清理缓存后重新构建 #

• 执行命令：./gradlew clean
• 清除IDE缓存（Android Studio：File -> Invalidate Caches... -> Invalidate and Restart）
• 重新构建：./gradlew assemble

验证步骤 #

1. 确认所有实体的自定义类型都有对应TypeConverter，且注解配置正确。
2. 检查KSP依赖已覆盖所有相关编译单元。
3. 升级依赖版本后重新构建项目。

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