KotlinのRoomでデータ取得する方法を完全解説!初心者向け@Queryの使い方
生徒
「Kotlinでアプリのデータベースから情報を取り出すには、どうすればいいんですか?」
先生
「KotlinでAndroidアプリを作るときは、『Room(ルーム)』という仕組みを使ってデータベースとやり取りできます。その中で『@Query(アットクエリ)』という注釈を使うと、データを取り出せますよ。」
生徒
「なんだか難しそうですが、実際にはどんなふうに使うんですか?」
先生
「では、KotlinのRoomでの基本的な@Queryの使い方を、順番にわかりやすく解説していきましょう!」
1. Roomとは?データベースとやり取りする仕組み
Room(ルーム)は、KotlinでAndroidアプリを作るときに使われる「データベース操作の便利セット」です。専門的には「ライブラリ」といって、データを保存したり読み出したりする処理を簡単にしてくれる道具です。
Roomを使えば、複雑なSQL文(エスキューエル:データベースと会話するための文)をほとんど書かずに、データを読み書きできます。
2. @Queryとは?Roomでデータを取り出す魔法のカギ
@Queryは、Roomで使う特別な「注釈(アノテーション)」です。アノテーションとは、Kotlinのコードに「これはこういう意味ですよ」と教えてあげる目印のようなものです。
@Queryを使うことで、SQLの命令を直接書いてデータを取り出せます。例えば、「全てのデータを取得したい」「名前が"太郎"の人だけ取り出したい」など、柔軟に指定できます。
3. KotlinでのRoom + @Query の基本的な使い方
ここでは、名前と年齢を持つ人の情報を保存する簡単な例で、@Queryの基本を学びます。
① データクラス(エンティティ)を定義
まずは、データの形を定義します。
import androidx.room.Entity
import androidx.room.PrimaryKey
@Entity(tableName = "users")
data class User(
@PrimaryKey(autoGenerate = true) val id: Int = 0,
val name: String,
val age: Int
)
② DAOインターフェースで@Queryを書く
DAO(ダオ)とは「データとやり取りする窓口」です。この中で@Queryを使います。
import androidx.room.Dao
import androidx.room.Query
@Dao
interface UserDao {
// 全てのユーザーを取得
@Query("SELECT * FROM users")
fun getAllUsers(): List<User>
// 特定の名前のユーザーを取得
@Query("SELECT * FROM users WHERE name = :userName")
fun getUsersByName(userName: String): List<User>
// 年齢が20歳以上のユーザーだけ取得
@Query("SELECT * FROM users WHERE age >= :minAge")
fun getAdultUsers(minAge: Int): List<User>
}
4. @Queryでよく使う条件と記号の意味
Roomで使うSQL文の中には、条件を指定するための記号が出てきます。初心者が迷いやすいものをいくつか紹介します。
- =(イコール): 値が等しいことを意味します。例:
name = :userName - >=(以上): 数字が指定値以上のとき。例:
age >= 20 - LIKE(ライク): あいまい検索。例:
name LIKE '%郎'(「〜郎」で終わる名前)
5. データ取得結果の例を見てみよう
例えば、次のようなデータが保存されていたとします。
1 | 太郎 | 25
2 | 次郎 | 17
3 | 花子 | 30
このとき、getAdultUsers(20) を呼び出すと、次の2件が取得されます。
1 | 太郎 | 25
3 | 花子 | 30
6. 注意点:SQL文はスペルミスに注意!
@Queryでは、SQL文を自分で書く必要があります。たとえば SELET(×)のように SELECT(○)の綴りを間違えると、アプリが起動しなかったり、ビルドエラーになります。
また、テーブル名やカラム名(列の名前)も、定義とピッタリ同じでないとエラーになります。
7. Kotlin + Room + @Query は覚えておいて損なし!
KotlinでAndroidアプリを作るなら、Roomと@Queryは避けて通れない基本です。最初は難しそうに見えても、少しずつ慣れていけば大丈夫です。
実際のアプリでも、「買い物リスト」「ユーザー情報」「日記の記録」など、どんな場面でもデータ取得は欠かせません。