Android Roomで動的クエリを扱う【株式会社ライトコード】

Roomで動的クエリを使いたい時だってある

（株）ライトコードでモバイルアプリケーションメインで色々開発している笹川（ささがわ）です！

Androidアプリ開発でRoomを使っていると、@Queryアノテーションで静的なSQLを定義する場面が多いですよね。

ほとんどのケースではこれで十分なのですが、アプリの機能が複雑になってくると、次のような要望が出てくることがあります。

ユーザーの入力に応じて検索条件を柔軟に変えたい
特定の条件を満たすデータだけを動的に絞り込みたい
LIKEやGLOBなど、より高度な文字列検索をカスタマイズしたい

このような場合、事前に定義された @Queryだけでは対応が難しいことがあります。

そこで今回は、Kotlinのコード内でSQL構文を動的に構築し、Roomで実行するための方法について、具体的な手順とともに解説していきます。

なぜ動的なSQLクエリが必要になるのか

Roomの @Queryアノテーションは非常に便利ですが、SQL文自体は固定です。

例えば、ユーザーが入力したキーワードの数や種類によって WHERE句の条件を増やしたり、並び順を動的に変更したりするようなケースでは、静的な@Queryだけでは対応しきれません。

私自身も、検索機能の実装で「複数のキーワードでAND検索したい」「特定の状態のデータをフィルタリングしたい」といった要件に直面しました。

最初は複数の@Queryを用意する方法を考えましたが、条件の組み合わせが増えるほど@Daoインターフェースが肥大化してしまい、管理が難しくなるという課題がありました。

この経験から、KotlinコードでSQLを組み立てて動的に実行するというアプローチの重要性を痛感しました。

これにより、複雑な検索条件にも柔軟に対応でき、コードの重複を減らすことにも繋がります。

Roomで動的クエリを扱う主役：@RawQueryアノテーション

Roomで動的にSQLクエリを実行するために使うのが、@RawQueryアノテーションです。これは、任意のSQLクエリ文字列を受け取って実行できる、強力な機能です。

RawQueryの使い方

まず、@Daoインターフェースに@RawQueryを付与したメソッドを定義します。このメソッドは、引数としてSupportSQLiteQuery型のオブジェクトを受け取ります。

interface MyDao {

    /*

     * 動的に構築されたクエリを実行する例

     * @param query SQLクエリを保持するSupportSQLiteQueryオブジェクト

     */

    @RawQuery

    suspend fun executeDynamicQuery(query: SupportSQLiteQuery): List<MyEntity>



    // 必要に応じて、他のRoomメソッドも定義

    // @Query("SELECT * FROM my_entities WHERE id = :id")

    // suspend fun getById(id: Long?): MyEntity? // 例としてNullableも追加

}

ここで重要なのは、executeDynamicQueryメソッドがSupportSQLiteQueryを受け取る点です。このSupportSQLiteQueryのインスタンスをKotlinコード内で生成し、動的にSQLクエリを構築していきます。

KotlinコードでSQL構文を動的に構築する手順

それでは、具体的なSQL構文の構築手順を見ていきましょう。今回は、複数のキーワードでAND検索を行う例を考えます。

1. 検索キーワードの準備と制約チェック

まず、ユーザーから入力された検索キーワードを処理します。

全角スペースを半角スペースに変換したり、複数のキーワードに分割したり、不要な空白を除去するといった前処理が考えられます。

また、検索キーワードの数に上限を設けることも重要です。

これは、SQLiteのクエリパラメータ数の上限（デフォルト999個）など、データベースの制約に起因するパフォーマンス問題やエラーを防ぐためです。

// 例: ユーザー入力から取得したキーワード文字列

val userInputKeyword = "Kotlin Room Android"



val queryKeywords = if (userInputKeyword.isNotEmpty()) {

    userInputKeyword.replace("　".toRegex(), " ") // 全角スペースを半角に

        .split(" ".toRegex()) // 半角スペースで分割

        .filter { it.isNotBlank() } // 空白のキーワードを除去

} else emptyList()



// SQLiteのパラメータ数上限などを考慮し、キーワード数に上限を設ける

val KEYWORD_LIMIT_SIZE = 10 // 例えば、最大10個のキーワードを許容

if (queryKeywords.size > KEYWORD_LIMIT_SIZE) {

    // ここでエラーを通知したり、処理を中断する

    // throw CustomKeywordLimitExceededException("キーワードが多すぎます。最大${KEYWORD_LIMIT_SIZE}個までです。")

    println("キーワードが上限を超えています。検索条件を絞ってください。")

    return // あるいはエラーを返す

}