【Kotlin学習帳】Room+KSPの導入

前置き

1. ロジック部分はChatGPTから引用しています
2. プロジェクト作成時は「No Activity」を選択しています
3. Activity起動時にInsertするだけの限りなく最低限な内容です

※特に2に関しては「Empty View Activity」などを選択すると下記のコードは直で動かないと思われるので注意してください
（最初に生成されるActivityがComponentActivityならOK？とにかく最初の選択によって最初の依存関係などが変わってくるので自分はそれでハマりました）

最終的に動いたコード

gradleに関しては計8行追加しました。
追加部分はコメントを付けています。

build.gradle(Project)

plugins {
    alias(libs.plugins.android.application) apply false
    alias(libs.plugins.jetbrains.kotlin.android) apply false
    id("org.jetbrains.kotlin.jvm") version "2.0.20-Beta2" apply false //追加
}

build.gradle(Module)

plugins {
    alias(libs.plugins.android.application)
    alias(libs.plugins.jetbrains.kotlin.android)
    id("com.google.devtools.ksp") version "2.0.0-1.0.23" //追加
    id("org.jetbrains.kotlin.plugin.compose") version "2.0.20-Beta2" //追加
}

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

    defaultConfig {
        applicationId = "com.example.roomsample"
        minSdk = 29
        targetSdk = 34
        versionCode = 1
        versionName = "1.0"

        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
        vectorDrawables {
            useSupportLibrary = true
        }
    }

    buildTypes {
        release {
            isMinifyEnabled = false
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),
                "proguard-rules.pro"
            )
        }
    }
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8"
    }
    buildFeatures {
        compose = true
    }
    composeOptions {
        kotlinCompilerExtensionVersion = "1.5.1"
    }
    packaging {
        resources {
            excludes += "/META-INF/{AL2.0,LGPL2.1}"
        }
    }
}

dependencies {
    implementation(libs.androidx.core.ktx)
    implementation(libs.androidx.lifecycle.runtime.ktx)
    implementation(libs.androidx.activity.compose)
    implementation(platform(libs.androidx.compose.bom))
    implementation(libs.androidx.ui)
    implementation(libs.androidx.ui.graphics)
    implementation(libs.androidx.ui.tooling.preview)
    implementation(libs.androidx.material3)
    testImplementation(libs.junit)
    androidTestImplementation(libs.androidx.junit)
    androidTestImplementation(libs.androidx.espresso.core)
    androidTestImplementation(platform(libs.androidx.compose.bom))
    androidTestImplementation(libs.androidx.ui.test.junit4)
    debugImplementation(libs.androidx.ui.tooling)
    debugImplementation(libs.androidx.ui.test.manifest)
    //以下追加
    val room_version = "2.6.1"
    implementation("androidx.room:room-runtime:$room_version")
    implementation("androidx.room:room-ktx:$room_version")
    annotationProcessor("androidx.room:room-compiler:$room_version")
    ksp("androidx.room:room-compiler:$room_version")
}

User.kt

import androidx.room.Entity
import androidx.room.PrimaryKey

@Entity(tableName = "users")
data class User(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val name: String,
    val age: Int
)

UserDao.kt

import androidx.room.Dao
import androidx.room.Insert
import androidx.room.Query

@Dao
interface UserDao {
    @Insert
    suspend fun insert(user: User)

    @Query("SELECT * FROM users")
    suspend fun getAllUsers(): List<User>
}

AppDatabase.kt

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

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

DatabaseProvider.kt

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

object DatabaseProvider {
    private var instance: AppDatabase? = null

    fun getInstance(context: Context): AppDatabase {
        if (instance == null) {
            synchronized(AppDatabase::class) {
                instance = Room.databaseBuilder(
                    context.applicationContext,
                    AppDatabase::class.java, "app_database"
                ).build()
            }
        }
        return instance!!
    }
}

MainActivity.kt

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.tooling.preview.Preview
import androidx.lifecycle.lifecycleScope
import com.example.roomsample.ui.theme.RoomSampleTheme
import kotlinx.coroutines.launch

class MainActivity : ComponentActivity() {
    private lateinit var database: AppDatabase
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        database = DatabaseProvider.getInstance(this)
        lifecycleScope.launch {
            val userDao = database.userDao()
            val user = User(id = 0, name = "John Doe", age = 25)
            userDao.insert(user)
        }
    }
}

実行後、App InspectionでDBの中身を確認

2回起動したので同じ内容が2行挿入されていますが、無事に動いていることが確認できました。

補足

ChatGPTには下記のように教えてもらいましたがこれは実施しないでも動きました。
プロジェクトのルートディレクトリにgradle.propertiesファイルを作成し、以下の行を追加します。 ksp.incremental=true

それをやるとどのような効果があるか聞いたところ
インクリメンタルビルドでは、プロジェクト全体を再コンパイルするのではなく、変更が加えられた部分だけを再ビルドします。そのため、ビルド時間が大幅に短縮されます。
とのことでしたので、一応gradle.propertiesに追記しておきました。