91.テーブルの初期化(同期処理)

[versions]
   :
gson = "2.13.2"                     # https://mvnrepository.com/artifact/com.google.code.gson/gson

[libraries]
   :
gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
   :

3行目[versions]

コメント部分のURLを参照して、最新安定バージョンを指定します。

7行目[libraries]

Gsonのライブラリモジュールとバージョンを関連付けします。

   :
dependencies {
   :
  implementation(libs.gson)
   :
}

4行目[dependencies]

Gsonのライブラリを依存ライブラリとして追記します。

   :
  @Insert(onConflict = OnConflictStrategy.REPLACE)
  fun insertAll(routes: List<Route>): List<Long>
   :

2行目～3行目

一括INSERTを追記します。

主キーが重複しているレコードが既に存在している場合は置き換えます。

初期化処理のCoroutine内で使う専用のメソッドですので、suspendを付けません。

   :
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
   :
class HiltApplication: Application() {
   :
  private fun initializeDatabase() {
    runBlocking {
      withContext(Dispatchers.IO) {
        databaseInitializer.initialize()
      }
    }
  }
}

2行目～4行目

同期処理のライブラリをimportします。

9行目

データベースの初期化処理を同期実行にします。

10行目

メインスレッドで重い処理を実行すると「アプリ名」は応答していませんとなるので、別スレッド(I/Oスレッド)で実行させます。

   :
import android.content.Context
import dagger.hilt.android.qualifiers.ApplicationContext
import com.google.gson.Gson
import com.google.gson.reflect.TypeToken
   :
class DatabaseInitializer @Inject constructor(
  private val database: AppDatabase
  private val database: AppDatabase,
  @param:ApplicationContext
  private val context: Context
) {
  private var isInitialized = false
  private val basePackage = "${context.packageName}.core.data"
  private val assetsDir   = "tableInitialData"
   :
  fun initialize(): Boolean {
    return if (isInitialized()) {
      // データベースは既に開いています
      true
    } else {
      // データベースを開きます(存在しない場合は作成されます)
      database.openHelper.writableDatabase.isOpen
      // テーブルを初期化します
      initializeTables()
      isInitialized = true
      true
    }
  }

  /**
   * assets/tableInitialDataディレクトリ内のJSONファイルでテーブルを初期化
   */
  private suspend fun initializeTables() {
    // assetsディレクトリ内のJSON初期化ファイルを取得
    val fileNames = context.assets.list(assetsDir) ?: emptyArray()
    for (fileName in fileNames) {
      if (!fileName.endsWith(".json")) continue
      val entityName = fileName.substringBeforeLast('.')
      loadAndInsert(context, database, entityName, "${assetsDir}/${fileName}")
    }
  }

  /**
   * JSON初期化ファイルの内容でテーブルにレコードを全件INSERT
   */
  private suspend fun loadAndInsert(context: Context, database: RoomDatabase, entityName: String, assetPath: String) {
    val entityClass = Class.forName("${basePackage}.${entityName}")
    val daoClass    = Class.forName("${basePackage}.${entityName}Dao")
    // JSON初期化ファイルから初期化データを取得します
    val json = context.assets.open(assetPath).bufferedReader().use { it.readText() }
    val listType = TypeToken.getParameterized(List::class.java, entityClass).type
    val entities = Gson().fromJson<List<*>>(json, listType)
    // INSERTするテーブルのDAOを取得します
    val daoGetter = "${entityName}Dao"
    val daoInstance = database.javaClass.getMethod(daoGetter).invoke(database)
    // insertAllを呼び出します
    val insertMethod = daoInstance::class.java.getMethod("insertAll", List::class.java)
    insertMethod.invoke(daoInstance, entities)
  }
}

2行目～5行目

必要なimportを追記します。

9行目～11行目

DI(Hilt)の注入にContextを追記します。

初期化用データが格納されているassetsディレクトリの場所を取得するため必要になります。

14行目

エンティティやDAOを定義しているパッケージを設定しています。

15行目

assetsディレクトリ内のJSON初期化ファイルが格納されているディレクトリを設定しています。

24行目～25行目

テーブル初期化処理の呼び出しを追記します。

31行目～42行目

assetsディレクトリ内のJSON初期化ファイルを取得して、テーブル単位に初期化処理を呼び出します。

JSON初期化ファイル名とエンティティ名が同じであることを前提としています。

44行目～60行目

テーブル単位に初期化処理を行います。

DAO名はエンティティ名にDaoを付けることを前提としています。

一括INSERTのメソッド名はInseetAllであり、suspendメソッドではないことを前提としています。