Журнал отладки DAO базы данных Android Room

Предполагая, что Room использует Sqlite фреймворка в качестве базовой базы данных, операторы могут быть довольно просто зарегистрированы. Единственное ограничение: это можно сделать только на эмуляторе.

Из :

Как видим, значение VERBOSE было успешно установлено. Однако, если мы повторно запустим наше приложение - мы не увидим напечатанных операторов. Чтобы он заработал, нам придется перезапустить все службы, используя adb shell stop, а затем adb shell start.
Если вы Попробую сделать это на обычном устройстве, вы получите следующую ошибку (пробовал с Pixel XL / стоковым Android 9):

alex @ mbpro: ~ $ adb shell start
start: должен быть root
alex @ mbpro: ~ $ adb root
adbd не может запускать как root в производственных сборках

Вот почему мы должны использовать эмулятор:

alex @ mbpro: ~ $ adb root
перезапуск adbd как root
alex @ mbpro: ~ $ adb shell stop
alex @ mbpro : ~ $ запуск оболочки adb

Эмулятор перезапустится.
Запустите приложение, и вы увидите аналогичные операторы Sqlite в logcat:

<redacted..>
V/SQLiteStatements: <redacted>/my_db: "BEGIN EXCLUSIVE;"
V/SQLiteStatements: <redacted>/my_db: "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)"
V/SQLiteStatements: <redacted>/my_db: "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, "3cb5664b6da264c13388292d98141843")"
V/SQLiteStatements: <redacted>/my_db: "CREATE TABLE IF NOT EXISTS `MyTable` (`id` TEXT NOT NULL, `date` INTEGER, `language` TEXT, PRIMARY KEY(`id`))"
<redacted..>
V/SQLiteStatements: <redacted>/my_db: "BEGIN EXCLUSIVE;"
V/SQLiteStatements: <redacted>/my_db: "PRAGMA temp_store = MEMORY;"
V/SQLiteStatements: <redacted>/my_db: "PRAGMA recursive_triggers='ON';"
V/SQLiteStatements: <redacted>/my_db: "CREATE TEMP TABLE room_table_modification_log(version INTEGER PRIMARY KEY AUTOINCREMENT, table_id INTEGER)"
V/SQLiteStatements: <redacted>/my_db: "COMMIT;"
<redacted..>
V/SQLiteStatements: <redacted>/my_db: "SELECT * FROM MyTable"
V/SQLiteStatements: <redacted>/my_db: "SELECT * FROM MyTable WHERE date = 1551562171387 AND language = 'en'"  

Чтобы отменить изменения, используйте эти команды:

alex @ mbpro: ~ $ adb shell setprop log.tag.SQLiteStatements
alex @ mbpro: ~ $ adb shell getprop log.tag.SQLiteStatements
‹- ПУСТОЙ СТРОК -›
alex @ mbpro: ~ $ adb shell stop
alex @ mbpro: ~ $ adb shell start
alex @ mbpro: ~ $ adb unroot
перезапуск adbd как не root

В соответствии с документом Room он выполняет проверку времени компиляции, поэтому если ваш оператор SQL недопустима, сама компиляция не удалась, и в журнале отображается соответствующее сообщение об ошибке.

Также сгенерированный код можно отлаживать по умолчанию, и его можно найти по указанному ниже пути.

сборка> сгенерированный> источник> apt> ваш пакет> yourDao_Impl.java

Этот класс содержит реализацию вашего DAO, вы можете отлаживать этот класс при отладке других классов в своем проекте. :-)

Пример :

Похоже, что на уровне DAO для этого нет никаких крючков. Есть обратные вызовы, связанные с открытием и обновлением базы данных, но не с произвольными вещами.

Однако вы можете отправить запрос функции. Я согласен, что это может быть полезно. Еще лучше была бы общая структура перехватчика в стиле OkHttp.

Начиная с Room 2.3.0-alpha04 (выпущен в декабре 16 2020, может быть стабильным к тому моменту, когда вы это читаете), в Room есть прямая поддержка для регистрации SQL-запросов с новым RoomDatabase.QueryCallback

Вы устанавливаете этот обратный вызов на RoomDatabase.Builder

    fun getDatabase(context: Context): MyDatabase {
        val dbBuilder = Room.databaseBuilder(
            context.applicationContext,
            MyDatabase::class.java, "mydatabase.db"
        )
        dbBuilder.setQueryCallback(RoomDatabase.QueryCallback { sqlQuery, bindArgs ->
            println("SQL Query: $sqlQuery SQL Args: $bindArgs")
        }, Executors.newSingleThreadExecutor())
        return dbBuilder.build()
    }

Обратите внимание, что это всего лишь пример кода, и вам, вероятно, следует убедиться, что MyDatabase является синглтоном в вашем приложении. Еще один совет - запросы журнала только тогда, когда приложение DEBUG: _5 _... и остальной код сверху.

Прокомментируйте, если кому-то нужен пример кода на Java

Когда у меня возникла неизвестная ошибка при вставке или обновлении строки в комнате db, Android не показывает никаких ошибок в консоли отладки. Одна вещь, которую я нашел, как проверить, что происходит во время отладки:

try { someSource.update(someRow) } catch (e: Throwable) { println(e.message) }

Выход:

Ошибка ограничения UNIQUE: quiz.theme (код 2067)

Мне удалось добиться этого с помощью взлома для запросов Select. Это не работает для операций вставки / обновления / удаления :)

Создайте отдельный класс RoomLoggingHelper следующим образом

import android.annotation.SuppressLint
import androidx.room.RoomSQLiteQuery

private const val NULL = 1
private const val LONG = 2
private const val DOUBLE = 3
private const val STRING = 4
private const val BLOB = 5
private const val NULL_QUERY = "NULL"

const val ROOM_LOGGING_TAG = "roomQueryLog"

object RoomLoggingHelper {

    @SuppressLint("RestrictedApi")
    fun getStringSql(query: RoomSQLiteQuery): String {
        val argList = arrayListOf<String>()
        val bindingTypes = query.getBindingTypes()
        var i = 0

        while (i < bindingTypes.size) {
            val bindingType = bindingTypes[i]

            when (bindingType) {
                NULL -> argList.add(NULL_QUERY)
                LONG -> argList.add(query.getLongBindings()[i].toString())
                DOUBLE -> argList.add(query.getDoubleBindings()[i].toString())
                STRING -> argList.add(query.getStringBindings()[i].toString())
            }
            i++
        }

        return String.format(query.sql.replace("?", "%s"), *argList.toArray())
    }

    fun getStringSql(query: String?, args: Array<out Any>?): String? {
        return if (query != null && args != null) {
            String.format(query.replace("?", "%s"), *args)
        } else
            ""
    }
}

private fun RoomSQLiteQuery.getBindingTypes(): IntArray {

    return javaClass.getDeclaredField("mBindingTypes").let { field ->
        field.isAccessible = true
        return@let field.get(this) as IntArray
    }
}

private fun RoomSQLiteQuery.getLongBindings(): LongArray {

    return javaClass.getDeclaredField("mLongBindings").let { field ->
        field.isAccessible = true
        return@let field.get(this) as LongArray
    }
}

private fun RoomSQLiteQuery.getStringBindings(): Array<String> {

    return javaClass.getDeclaredField("mStringBindings").let { field ->
        field.isAccessible = true
        return@let field.get(this) as Array<String>
    }
}

private fun RoomSQLiteQuery.getDoubleBindings(): DoubleArray {

    return javaClass.getDeclaredField("mDoubleBindings").let { field ->
        field.isAccessible = true
        return@let field.get(this) as DoubleArray
    }
}

private fun RoomSQLiteQuery.getIntBindings(): IntArray {

    return javaClass.getDeclaredField("mBindingTypes").let { field ->
        field.isAccessible = true
        return@let field.get(this) as IntArray
    }
}

Или вы можете загрузить этот файл с здесь

Добавьте этот файл в свой проект и вызовите его из класса базы данных комнат следующим образом: Переопределите оба метода query, подобные этому

override fun query(query: SupportSQLiteQuery?): Cursor {
        //This will give you the SQL String
        val queryString = RoomLoggingHelper.getStringSql(query as RoomSQLiteQuery)
        //You can log it in a way you like, I am using Timber
        Timber.d("$ROOM_LOGGING_TAG $queryString")
        return super.query(query)
    }

    override fun query(query: String?, args: Array<out Any>?): Cursor {
        //This will give you the SQL String
        val queryString = RoomLoggingHelper.getStringSql(query, args)
        //You can log it in a way you like, I am using Timber
        Timber.d("$ROOM_LOGGING_TAG $queryString")
        return super.query(query, args)
    }

Отказ от ответственности:

• Я использую Reflection для получения строкового SQL, поэтому используйте его ТОЛЬКО в режиме DEBUG
• Это написано на скорую руку и может содержать ошибки, было бы разумно оставить это в блоке try-catch.
• Кроме того, я тестировал его для строковых аргументов, он должен работать долго и удваиваться, не будет работать для Blobs