OrmaからRoomに移行する 2nd Season

社内勉強会 #深いい勉強会 の資料です

Transcript

1. Orma͔ΒRoomʹҠߦ͢Δ 2nd Season
2. Young @nana music Android Engineer
3. എܠ • Orma͔ΒRoomʹҠߦͨ͠͸ͳ͠ͷଓ͖ • 1st Season • https://speakerdeck.com/akihitookada/ androidban-nanatotetafalseyong-sok- hua-todatabase • ϦϦʔεͨ͠
4. ϦϦʔεޙ • ໰͍߹Θͤɺ൵͠Έͷ੠ • Ϧετ͕දࣔ͞Εͳ͍
5. Τϥʔͷ૿Ճ • Crashlytics্ͰΤϥʔ͕૿͍͑ͯΔ
6. Τϥʔ಺༰ • DB͔ΒσʔλΛऔಘ࣌ʹΤϥʔ • Orma͔ΒͷϚΠάϨʔγϣϯʹࣦഊ͍ͯ͠Δ java.lang.Exception: Room cannot verify the data integrity. Looks like you've changed schema but forgot to update the version number. You can simply fix this by increasing the version number. java.lang.Exception: attempt to re-open an already-closed object: SQLiteDatabase: /data/user/0/com.app.name/databases/app.db
7. ΤϥʔݪҼ • όʔδϣϯίʔυΛ্͛ͳ͔͔ͬͨΒʁ • ϚΠάϨʔγϣϯίʔυΛॻ͔ͳ͔͔ͬͨΒʁ
8. ࠶ݱੑ • ࠶ݱ͠ͳ͍ • QAͰ΋࠶౓֬ೝͯ͠΋Βͬͨ
9. ෮چํ๏ • ΞϓϦͷઃఆ͔ΒɺσʔλΛΫϦΞ͢Δ • ࠶ىಈޙʹDB͕ੜ੒͞ΕΔͷͰ෮چ͢Δ
10. ରԠํ਑ • Өڹ΋େ͖͍ͷͰhotfix • όʔδϣϯίʔυΛ্͛Δ • ϚΠάϨʔγϣϯίʔυΛॻ͘ • ϚΠάϨʔγϣϯςετίʔυΛॻ͘ • QAͰςετΛͯ͠΋Β͏
11. • όʔδϣϯίʔυΛ্͛Δ ࣮૷ AppDatabase.kt @Database(entities = [(UserEntity::class)], version = 2) abstract class AppDatabase : RoomDatabase() { // Some implementation }
12. • VersionຖͷSchemeఆٛΛjsonͰग़ྗ • ॻ͖ग़͞Εͨjson͸ɺMigration TestͰར༻Ͱ͖Δ • VersionຖͷཤྺΛࢀরͰ͖ΔΑ͏ʹɺjsonΛGitͷRepositoryʹ Commit͓ͯ͘͠ ࣮૷ app/build.gradle javaCompileOptions { annotationProcessorOptions { arguments = ["room.schemaLocation": "$projectDir/schemas".toString()] } }
13. • Migration Code ࣮૷ Migration1To2.kt private const val TABLE_NAME_TEMP = "${TABLE_NAME}_new" class Migration1To2 : Migration(1, 2) { override fun migrate(database: SupportSQLiteDatabase) { // 1. Create new table database.execSQL("CREATE TABLE IF NOT EXISTS `$TABLE_NAME_TEMP` " + "(`_id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL," + " `username` TEXT)") // 2. Copy the data database.execSQL("INSERT INTO $TABLE_NAME_TEMP (username) " + "SELECT username " + "FROM $TABLE_NAME") // 3. Remove the old table database.execSQL("DROP TABLE $TABLE_NAME") // 4. Change the table name to the correct one database.execSQL("ALTER TABLE $TABLE_NAME_TEMP RENAME TO $TABLE_NAME”) } }
14. • DatabaseͷInstanceੜ੒࣌ʹMigrationΛઃఆ ࣮૷ AppDatabase.kt abstract class AppDatabase : RoomDatabase() { private fun buildDatabase(context: Context) = Room.databaseBuilder(context.applicationContext, AppDatabase::class.java, DB_NAME) .addMigrations(Migration1To2()) .build() // Some Implementation }
15. ςετ • Set up 1 MigrationTest.kt // Helper for creating Room databases and migrations @get:Rule public var migrationTestHelper = MigrationTestHelper(InstrumentationRegistry.getInstrumentation(), AppDatabase::class.java.canonicalName, FrameworkSQLiteOpenHelperFactory()) // Helper for creating SQLite database in version 1 private lateinit var sqliteTestDbHelper: SqliteTestDbOpenHelper private val migratedRoomDatabase: AppDatabase get() { val database = Room.databaseBuilder(InstrumentationRegistry.getTargetContext(), AppDatabase::class.java, TEST_DB_NAME) .addMigrations(Migration1To2()) .build() migrationTestHelper.closeWhenFinished(database) return database }
16. ςετ • Set up 2 MigrationTest.kt @Before @Throws(Exception::class) fun setUp() { // To test migrations from version 1 of the database, we need to create the database // with version 1 using SQLite API sqliteTestDbHelper = SqliteTestDbOpenHelper(InstrumentationRegistry.getTargetContext(), TEST_DB_NAME) // We're creating the table for every test, to ensure that the table is in the correct state SqliteDatabaseTestHelper.createTable(sqliteTestDbHelper) } @After @Throws(Exception::class) fun tearDown() { // Clear the database after every test SqliteDatabaseTestHelper.clearDatabase(sqliteTestDbHelper) }
17. ςετ • Test 1 - Migration Test MigrationTest.kt @Test @Throws(IOException::class) fun migrationFrom1To2_containsCorrectDataTest() { // Create the database with the initial version 1 schema and insert a user val id = SqliteDatabaseTestHelper.insertUser(User, sqliteTestDbHelper) migrationTestHelper.runMigrationsAndValidate(TEST_DB_NAME, 2, true, Migration1To2()) // Get the latest, migrated, version of the database val latestDb = migratedRoomDatabase // Check that the correct data is in the database latestDb.userDao().getUserById(id.toInt()) .test() .awaitDone(5, TimeUnit.SECONDS) .assertValue { (_, userName) -> userName.equals(USER.userName) } }
18. ςετ • Test 2 - New Version Test MigrationTest.kt @Test @Throws(IOException::class) fun startInVersion2_containsCorrectDataTest() { // Create the database with version 2 val db = migrationTestHelper.createDatabase(TEST_DB_NAME, 2) // db has schema version 2. insert some data val id = insertUser(USER, db) db.close() // open the db with Room val appDatabase = migratedRoomDatabase // verify that the data is correct appDatabase.userDao().getUserById(id.toInt()) .test() .awaitDone(5, TimeUnit.SECONDS) .assertValue { (_, userName) -> userName.equals(USER.userName) } }
19. ϦϦʔε • Special Thanks : QA Team
20. ϦϦʔεޙ • ໰͍߹Θͤͳ͘ͳͬͨ • ൵͠Έ͸΋͏ͳ͍
21. Τϥʔͷݮগ • Crashlytics্ͰΤϥʔ͕ݮͬͨ
22. ·ͱΊ • όʔδϣϯʹର͢Δೝ͕ࣝ؁͔ͬͨͷͰ൓ল • Migration΋ॳΊ͸େม͚ͩͲܗ͕Ͱ͖ͯ͠·͑͹ ͔࣍Β͸ָͦ͏ • ࠓճͷࣄ৅͸ɺDatabase VersionΛ্͛Δ͚ͩͰ ΋࣏͔ͬͨ΋͠Εͳ͍ • ஈ֊తϦϦʔεͰ࣏Δ͔֬ೝͯ͠΋Α͔ͬͨ
23. ࢀߟ • https://developer.android.com/training/ data-storage/room/migrating-db-versions • https://github.com/googlesamples/android- architecture-components/tree/master/ PersistenceMigrationsSample