Room使ってデータレイヤーを実装してみた

はじめに

こんにちは！とりかつです。
前回に引き続き冷蔵庫管理アプリ「RefMA」 の改修に関する記事です。
今日はRoomを使ったデータレイヤー（緑色の部分）の実装をしていきます。

設計

思ったより記事のボリュームがやばくなりそうなので何回かに分けていこうと思います。
今回紹介する内容は

• Roomについて
  • Entity(テーブルっぽいもの)の作成
  • Dao(Data Access Object)の作成
  • RoomDatabaseを使って実装
• Repositoryの実装
  • そもそもリポジトリってなんだ？
  • Repositoryの実装

です。どれも自分なりに理解したものなので間違ってたらすみませんm( )m
LiveDataの実装はまた次回しようと思いますのでよろしくお願いします。 あと言い忘れてましたがKoitlinで開発していきます。

Roomについて

AndroidDevelopersみると

Room永続化ライブラリは、SQLiteののパワーをフルに活用しながら、より堅牢なデータベース・アクセスを可能にするためのSQLiteの上に抽象化レイヤーを提供します。

ってありました。とりあえず便利だからつかっとけばOKって認識でいいと思います。あとRoomはLiveData使えるらしいので使わない手はないですね！

Roomのアーキテクチャです。RoomDatabaseを介してDaoを取得、DaoからEntityを取得、更新するって感じですね。

Roomの実装は大きく分けて以下の工程に分かれます。

• build.gradleに依存関係の設定
• Entity(テーブルっぽいもの)の作成
• Dao(Data Access Object)の作成
• RoomDatabaseを使って実装

では早速実装していきましょう！

build.gradleに依存関係の設定

build.gradleに依存関係を設定していきましょう

apply plugin: 'kotlin-kapt'

dependencies{
    def roomVersion = '2.2.1'
    implementation "android.arch.persistence.room:runtime:$roomVersion"
    kapt "android.arch.persistence.room:compiler:$roomVersion"
    androidTestImplementation "android.arch.persistence.room:testing:$roomVersion"
}

Roomの最新バージョンは公式に載ってるので確認しましょう。

Entity(テーブルっぽいもの)の作成

Entityはプロパティしか持たないのでdataクラスで宣言するといいと思います。以下のコードスニペットはEntityの実装例です。

@Entity
data class Hoge (
    @PrimaryKey
    var id: Int,

    var name: String
)

めっちゃシンプルですね。

• クラスの先頭に@Entityを宣言します
• 主キーにするものは@PrimaryKeyを変数の前に宣言します。

これだけです。

Dao(Data Access Object)の作成

Daoはinterfaceで宣言します。以下は実装例です。

@Dao
interface HogeDao {
    @Query( "select * from hoges")
    suspend fun getAllHoges() : List<hoge>

    @Query("select * from hoges where id = :id")
    suspend fun getHoge(id: Int) : Hoge

    @Insert
    suspend fun insert(hoge: Hoge)

    @Update
    suspend fun update(hoge: Hoge)

    @Delete
    suspend fun delete(hoge: Hoge)
}

実装の手順は@Daoを先頭に宣言してあとは必要なメソッドを書いてくだけです。メソッドの先頭には以下のアノテーションをつけなければならないです。

• クエリ：@Query( / SQL文 / )
• 挿入：@Insert
• 更新：@Update
• 削除：@Delete

@Queryでメソッドの引数（fun getHoge(id: Int)）を使いたい時は、SQL文でid = :idみたいに: を変数の前につけてあげればOKです。
＠DeleteではHogeクラスを渡しているだけで特にSQL書いたりしてないですが、どうやらデフォルトで主キーで判別してくれるらしいです。
@Insertとかの設定？でコンフリクトのハンドリングできるらしいですがまたいつかまとめようと思います。

RoomDatabaseを使って実装

いよいよRoom実装も終わりが見えてきました。Databaseの実装は以下のコード通りやれば良さそうです。

@Database(entities = [HogeDao::class], version = 1)
abstract class MyDatabase: RoomDatabase() {

    abstract fun hogeDao(): HogeDao

    companion object{
        @Volatile
        private var instance: MyDatabase? = null
        private const val databaseName = "hoge.db"

        fun getInstance(context: Context): MyDatabase =
            instance ?: synchronized(this) {
                Room.databaseBuilder(context,
                    MyDatabase::class.java, databaseName)
                    .build()
            }
    }
}

Roomでは抽象クラスでデータベースクラスを定義しておけばBuilderが勝手にクラスを作成してくれるらしいです。さすがBuilder...
実装手順としては

• クラスをabstractで宣言する
• クラスの先頭に@Database(entities = [さっき作ったDao::class], version = 1)って宣言する（ここで宣言するversionはマイグレーションとかで使うらしいです）
• クラス内にさっき作ったDaoを戻り値とする抽象メソッドを定義
• companion objectを宣言してその中でインスタンスを生成する処理を書く

って感じです。どうやらインスタンスの生成はsynchronizedを宣言しておくといいらしいです。

とりあえずこれでRoomの実装は終わりました！

findAll()を呼び出したかったら以下のようにすれば呼び出せます！

MyDatabase.getInstance(context).hogeDao().findAll()

Repositoryの実装

　最後にRepositoryの実装を紹介します。まだ理解が完全ではないので間違ってたらすみません。

そもそもリポジトリってなんだ？

Qiitaの記事によると

Repositoryパターンとは永続化を隠蔽するためのデザインパターンで、DAO(DataAccessObject)パターンに似ていますが、より高い抽象度でエンティティの操作から現実の永続化ストレージを完全に隠蔽します 例えばDBコネクションやストレージのパス等はReposiotoryのインターフェースからは隠蔽され、Repositoryのユーザは永続化ストレージが何であるか(例えばMySQLやRedis等)を意識することなく保存や検索の操作を行うことができるようになります。

引用：やはりお前たちのRepositoryは間違っている

とありました。
　おそらく生のSQL文書いたりデータベースにアクセスするためのインスタンスを取得したり...とかの処理を隠蔽してfindAll()するだけで全件取得できちゃうぜみたいな設計のことだと思います。
　今回の改修では関心の分離が大きなテーマの一つだったので使わない手はないですね！

Repositoryの実装

　データベースアクセスは先に紹介したように

MyDatabase.getInstance(context).hogeDao().findAll()

こうすればいいわけですがこれってなんだか毎回書いてたらデータベースアクセスとビジネスロジックが混在してコードがぐちゃぐちゃになりそうですよね。ってことなのでデータベースアクセスの処理をRepositoryに書いて責務を分離しようと思います。

class HogeRepository(val context: Context) {
    private val hogeDao: HogeDao by lazy { MyDatabase.getInstance(context).hogeDao() }

    fun getAll(): List<Hoge> {
        MyDatabase.getInstance(context).hogeDao().findAll()
   
    ......
    }
}

こんな感じにしてみました！これならデータベースアクセスとビジネスロジックが綺麗に分けられてて良さそうですね！ 　Daoを取得する際にby lazy { ・・・ }ってしましたが、これは使うときになったら取得する方がなんとなく良さそう()って理由と出来るだけnullableな変数を宣言したくない理由からこうしました。lateinitも使えそうですがこっちの方がコードがスッキリしますよね。

おわりに

　今回はRoomの使い方とRepositoryの実装をざっくりまとめてみました。次回は実際に自分が実装している中で詰まったこととか、これ便利だなって感じたものを紹介したいと思います。

参考文献とか

• やはりお前たちのRepositoryは間違っている
• JetPack HandBook
• Android Deveropers -Room