Kotlin + Room：添加库时遭遇注解处理错误，寻求解决方案

Hey there, let's work through this Room annotation processing bug together—this is a super common snag when setting up Room, so we’ve got plenty of actionable fixes to try:

• Ensure all Room dependency versions match exactly
  Mismatched versions between Room components are the #1 cause of this error. Double-check that room-runtime, room-compiler, room-ktx, etc., all use the same version number. For example:

  // Correct: Uniform version across all Room dependencies
  implementation "androidx.room:room-runtime:2.5.0"
  kapt "androidx.room:room-compiler:2.5.0"
  implementation "androidx.room:room-ktx:2.5.0"
  
  // Wrong: Mismatched versions will break annotation processing
  implementation "androidx.room:room-runtime:2.5.0"
  kapt "androidx.room:room-compiler:2.4.3"
  

• Explicitly enable annotation processing (Gradle 7.0+)
  Newer Gradle versions sometimes require you to turn on kapt explicitly in your module-level build.gradle/build.gradle.kts:
  For Groovy:

  android {
      ...
      buildFeatures {
          kapt true
          // Add dataBinding/viewBinding if you use them
      }
  }
  

  For Kotlin DSL:

  android {
      ...
      buildFeatures {
          kapt = true
      }
  }
  

• Clean and rebuild your project (and nuke old artifacts)
  Stale build files often cause hidden conflicts. Try these steps in order:

  1. Click Build > Clean Project in Android Studio
  2. Then run Build > Rebuild Project
  3. If that fails, delete the .gradle and build folders in your project root and module directories, then sync your project again

• Audit your Room classes for code mistakes
  The KaptError might be masking a bug in your entities, DAOs, or database class. Double-check:

  • All entities have a valid @PrimaryKey annotation
  • DAO methods use correct annotations (e.g., @Query with valid SQL syntax, @Insert with proper parameters)
  • Your @Database class extends RoomDatabase and includes all entities in its entities array
  • No typos in annotation names or query strings

• Update Kotlin and Gradle plugin versions
  Outdated Kotlin or Android Gradle plugin versions can clash with Room. Make sure you’re using compatible versions:

  • Check for the latest Kotlin version in your project-level build.gradle
  • Match the Android Gradle plugin version to Kotlin’s compatibility (you can find this info in Android Studio’s SDK Manager)

• Switch to KSP instead of kapt (optional but recommended)
  KSP (Kotlin Symbol Processing) is a faster, more reliable alternative to kapt for Room. To switch:

  1. Add the KSP plugin to your project-level build.gradle:

     plugins {
         id 'com.android.application' version '7.4.2' apply false
         id 'org.jetbrains.kotlin.android' version '1.8.20' apply false
         id 'com.google.devtools.ksp' version '1.8.20-1.0.11' apply false
     }
     

  2. Replace kapt with ksp in your module-level build.gradle:

     plugins {
         ...
         id 'com.google.devtools.ksp'
     }
     
     dependencies {
         implementation "androidx.room:room-runtime:2.5.0"
         ksp "androidx.room:room-compiler:2.5.0" // Swap kapt for ksp here
         implementation "androidx.room:room-ktx:2.5.0"
     }
     

If none of these fix the issue, run this command in your terminal to get detailed error logs that pinpoint exactly which class is causing the failure:

./gradlew kaptDebugKotlin

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