DataStoreを導入してみた

Transcript

1. @kobaken DataStoreΛಋೖͯ͠Έͨ
2. ࣗݾ঺հ • kobakenʢ@koba_dog_ʣ • pixivࣄۀຊ෦ϚϯΨ෦ • AndroidΞϓϦΛͭͬͯ͘·͢ • ࠷ۙ͸ϙέΧͱϫϯϐʔεΧʔυ͕೤͍ʂ
3. ͱ͜ΖͰΈͳ͞Μ
4. pixivίϛοΫͬͯ͝ଘ஌Ͱ͔͢ʁ
5. ίϛοΫΛઆ໌Ͱ͖Δ ͳΜ͔͍͍ײ͡ͷը૾
6. ΈͯͶʂ https://inside.pixiv.blog/2023/01/25/120000
7. ؓ࿩ٳ୊
8. DataStoreͱ͸
9. DataStoreͱ͸ • σʔλΛϩʔΧϧʹӬଓԽͰ͖ΔσʔλετϨʔδιϦϡʔγϣϯ • Android Jetpackʹؚ·Ε͍ͯΔϥΠϒϥϦ • 2020೥9݄ʹ1.0.0-alpha1͕ެ։͞Εͨ • ݱࡏ͸҆ఆ൛ͱͯ͠1.0.0͕ϦϦʔε͞Ε͍ͯΔ
10. DataStoreͷಛ௃ • Kotlin CoroutinesʹରԠ͍ͯ͠Δ • খن໛Ͱ୯७ͳσʔληοτʹద͍ͯ͠Δ • Preferences DataStoreͱProto DataStoreͷ2छྨ͕ଘࡏ͍ͯ͠Δ • SharedPreferences͔ΒͷҠߦ͕Մೳ
11. Kotlin CoroutinesʹରԠ͍ͯ͠Δ • σʔλͷऔಘʹ͸ fl ow • σʔλͷอଘʹ͸suspend
12. CoroutinesରԠ͞Ε͍ͯΔ༷ࢠ public interface DataStore<T> { public val data: Flow<T> public suspend fun updateData(transform: suspend (t: T) -> T): T }
13. খن໛Ͱ୯७ͳσʔληοτʹ࠷దԽ • ୯७ͳσʔλͷΈΛӬଓԽ͢Δ͜ͱ • ෦෼ߋ৽΍ࢀর੔߹ੑΛαϙʔτ͍ͯ͠ͳ͍ • େن໛ɾෳࡶͳσʔληοτ΍෦෼ߋ৽ɺࢀর੔߹ੑΛαϙʔτ͍ͨ͠ ৔߹͸RoomΛ࢖͍·͠ΐ͏
14. 2छྨͷDataStore • Key-ValueϖΞΛѻ͏Preferences DataStore • SharedPreferencesͷ୅ସ • ܕ෇͖ΦϒδΣΫτΛѻ͏Proto DataStore • Protocol bufferΛ࢖༻ͯ͠εΩʔϚఆٛΛ͢Δ • ܕ҆શ
15. SharedPreferences
16. SharedPreferences vs DataStore 
 https://medium.com/androiddevelopers/introduction-to-jetpack-datastore-3dc8d74139e7
17. SharedPreferences͔ΒҠߦ͢ΔϝϦοτ • ඇಉظAPI͕αϙʔτ͞Ε͍ͯΔͨΊɺUIϒϩοΩϯάʹΑΔδϟϯΫ΍ ANRͷൃੜϦεΫ͕ܰݮ͢Δ • σʔλͷҰ؏ੑɾ੔߹ੑ͕औΕ͍ͯΔ • ϚΠάϨʔγϣϯʹରԠ͍ͯ͠Δ
18. Google→։ൃऀ΁ • ʮSharedPreferencesΛ࢖༻ͯ͠σʔλΛอଘ͍ͯ͠Δ৔߹͸ɺ DataStoreʹҠߦ͢Δ͜ͱΛݕ౼͍ͯͩ͘͠͞ɻʯ https://developer.android.com/topic/libraries/architecture/datastore
19. ಋೖͯ͠ΈΔ
20. Preferences DataStore
21. ґଘؔ܎ͷ௥Ճ dependencies { implementation "androidx.datastore:datastore-preferences:1.0.0" }
22. Preferences DataStoreΛ࡞੒ val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = “settings")
23. Preferences DataStoreΛ࡞੒ val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = “settings") ⚠1ϑΝΠϧʹରͯ͠DataStoreͷΠϯελϯε͸γϯάϧτϯʹ͢Δ͜ͱ⚠ →ಉϓϩηε্ʹॴఆϑΝΠϧʹରͯ͠ΞΫςΟϒͳDataStore͕ෳ਺͋Δͱ σʔλʹ৮ΕΔࡍʹIllegalStateExceptionΛεϩʔ͢Δ
24. Preferences DataStoreΛ࡞੒ val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = “settings")
25. DataStoreͷinterfaceʢ࠶ܝʣ public interface DataStore<T> { public val data: Flow<T> public suspend fun updateData(transform: suspend (t: T) -> T): T }
26. ಡΈऔΓ val COMIC_USER_IDS = stringSetPreferencesKey("comic_user_ids") val comicUserIdsFlow: Flow<Set<String>> = context.dataStore.data .map { preferences -> preferences[COMIC_USER_ID] ?: emptySet() }
27. ಡΈऔΓ val COMIC_USER_IDS = stringSetPreferencesKey("comic_user_ids") val comicUserIdsFlow: Flow<Set<String>> = context.dataStore.data .map { preferences -> preferences[COMIC_USER_ID] ?: emptySet() } booleanPreferencesKey 
 intPreferencesKey longPreferencesKey fl oatPreferencesKey 
 stringPreferencesKey
28. ॻ͖ࠐΈ val COMIC_USER_IDS = stringSetPreferencesKey("comic_user_ids") context.dataStore.edit { preferences -> preferences[COMIC_USER_IDS] = newUserIds }
29. SharedPreferences→DataStore΁ͷҠߦ const val PREFERENCES_NAME = "..." val Context.dataStore by preferencesDataStore( name = PREFERENCES_NAME, produceMigrations = { context -> SharedPreferencesMigration( context = context, sharedPreferencesName = PREFERENCES_NAME, // ࢦఆͨ͠keyͷΈҠߦͰ͖ΔʂʢσϑΥϧτҾ਺͸MIGRATE_ALL_KEYSʣ keysToMigrate = setOf(Key.COMIC_USER_IDS) ) } )
30. SharedPreferences→DataStore΁ͷҠߦ const val PREFERENCES_NAME = "..." val Context.dataStore by preferencesDataStore( name = PREFERENCES_NAME, produceMigrations = { context -> SharedPreferencesMigration( context = context, sharedPreferencesName = PREFERENCES_NAME, // ࢦఆͨ͠keyͷΈҠߦͰ͖ΔʂʢσϑΥϧτҾ਺͸MIGRATE_ALL_KEYSʣ keysToMigrate = setOf(Key.COMIC_USER_IDS) ) } )
31. pixivίϛοΫͰͷӡ༻ํ๏
32. pixivίϛοΫͰͷํ਑ • ৽ن࣮૷Ͱ͸ੵۃతʹPreferences DataStoreΛ࠾༻͢Δ • طଘͷSharedPreferences͸ख͕ۭ͍ͨͱ͖ʹҠߦΛݕ౼ • 1िؒͷ10%Λ಺෦඼࣭޲্ʹࣗ༝ʹ౰ͯΒΕΔʢ10%ϧʔϧʣ
33. pixivίϛοΫͰͷӡ༻ • Preferences DataStoreΛѻ͏interfaceΛఆٛ • ӬଓԽ͍ͨ͠σʔλ͕͋Ε͹ͦͷinterfaceΛܧঝ࣮ͯ͠૷͢Δ
34. DataStoreͷΠϯελϯεΛऔಘͰ͖ΔΑ͏ʹ͢Δ private const val PREFERENCES_NAME = "......" val Context.dataStore by preferencesDataStore( name = PREFERENCES_NAME )
35. γϯάϧτϯͳDataStoreΛѻ͑ΔinterfaceΛఆٛ interface Preference { val context: Context val dataStore: DataStore<Preferences> get() = context.dataStore }
36. ѻ͏σʔλʹԠͯ͡DataStoreͷ࣮૷Λ͢Δ interface ComicUserIdsPreference : Preference<Set<String>> { val userIds: Flow<Set<String>> suspend fun add(id: String) suspend fun remove(id: String) }
37. ѻ͏σʔλʹ Ԡͯ͡DataStore ͷ࣮૷Λॻ͘ class ComicUserIdsPreferenceImpl @Inject( override val context: Context ) : ComicUserIdsPreference { override val userIds: Flow<Set<String>> get() = dataStore.data .catch { if (exception is IOException) { emit(emptyPreferences()) } else { throw exception } } .map { it[PreferencesKeys.ComicUserIds.key] ?: emptySet() } override suspend fun add(id: String) { dataStore.edit { it[PreferencesKeys.ComicUserIds.key] = it[PreferencesKeys.ComicUserIds.key].plus(id).toSet() } } override suspend fun remove(id: String) { dataStore.edit { it[PreferencesKeys.ComicUserIds.key] = it[PreferencesKeys.ComicUserIds.key].minus(id).toSet() } } } Dagger2ͰDIͯ͠·͢ ʢhilitҠߦ͍ͨ͠……ʣ
38. KeyΛ؅ཧ͢Δ sealed class PreferencesKeys<T>(val key: Preferences.Key<T>) { object ComicUserIds : PreferencesKeys<Set<String>>(stringSetPreferencesKey("comic_user_ids")) ... } class PreferenceTest { @Test fun checkDuplicatedKeys() { val subClasses = PreferencesKeys::class.sealedSubclasses val nonDuplicatedKeys = subClasses.map { it.objectInstance?.key?.name }.toSet() Truth.assertThat(nonDuplicatedKeys.count()).isEqualTo(subClasses.count()) } } KeyͷॏෳΛ๷͙ͨΊʹsealed classͰఆٛ ॏෳνΣοΫͷςετ΋͔ͬ͠Γ࣮ࢪ
39. ಉظͰ஋Λऔಘͨ͘͠ͳͬͨέʔε
40. ΞϓϦىಈ࣌ͷςʔϚ൓ө
41. ઃఆ͕൓ө͞ΕΔલʹભҠͯ͠͠·͍ ҙਤ͠ͳ͍ςʔϚ͕ͪΒ͍ͭͯ͠·͏
42. Կ͕ى͍ͬͯ͜Δͷ͔ • ΞϓϦىಈ࣌ʹApplicationΫϥεͰςʔϚઃఆΛऔಘͯ͠ద༻͍ͯ͠Δ • ςʔϚઃఆ͸Preferences DataStoreͰӬଓԽ͍ͯ͠Δ • DataStore͸ಉظॲཧʹରԠ͍ͯ͠ͳ͍ • ΞϓϦىಈˠϗʔϜը໘΁ͷը໘ભҠʹςʔϚͷ൓ө͕ؒʹ߹Θͣɺσ ϑΥϧτͷςʔϚ͕൓ө͞ΕΔ • ͦͷޙɺඇಉظʹ൓ө͞ΕͨςʔϚઃఆ͕ద༻͞Εͨ
43. Կ͕ى͍ͬͯ͜Δͷ͔ • ΞϓϦىಈ࣌ʹApplicationΫϥεͰςʔϚઃఆΛऔಘͯ͠ద༻͍ͯ͠Δ • ςʔϚઃఆ͸Preferences DataStoreͰӬଓԽ͍ͯ͠Δ • DataStore͸ಉظॲཧʹରԠ͍ͯ͠ͳ͍ • ΞϓϦىಈˠϗʔϜը໘΁ͷը໘ભҠʹςʔϚͷ൓ө͕ؒʹ߹Θͣɺσ ϑΥϧτͷςʔϚ͕൓ө͞ΕΔ • ͦͷޙɺඇಉظʹ൓ө͞ΕͨςʔϚઃఆ͕ద༻͞Εͨ
44. ղܾࡦ • DataStore͔Β஋Λऔಘ͢ΔͷΛಉظॲཧʹ͢Δ • runBlockingͱFlow# fi rstΛۦ࢖͢Δ • SharedPreferencesΛ࢖͏
45. DataStoreͰಉظॲཧ͢Δ // ςʔϚͷద༻͕׬ྃ͢ΔͷΛ଴ͭͨΊʹrunBlockingͰॲཧ͢Δ runBlocking { initTheme() } private suspend fun initTheme() { themeSettingPreference.currentThemeStatus.first().let { AppCompatDelegate.setDefaultNightMode( it.getAppTheme().convertNightModeParameter() ) } }
46. runBlocking͢Δͱ͖ͷ஫ҙࣄ߲ • લఏͱͯ͠ਪ঑͞ΕΔํ๏Ͱ͸ͳ͍ • ຖճϑΝΠϧͷI/O͕૸Δͱ͍͏Θ͚Ͱ͸ͳ͍ͷͰɺͦΕΛཧղͯ͠ར༻͢Δͷ͸ΞϦ • UIεϨουΛϒϩοΩϯά͢ΔͷͰɺδϟϯΫ΍ANRͷՄೳੑ͸͋Δ • ैདྷͷSharedPreferencesͱಉ͡ • ෳ਺ՕॴͰݺͼग़͢৔߹͸ࣄલʹϓϦϩʔυΛ͓ͯ͘͠ͷ͕ྑ͍ • 2ճ໨Ҏ߱ͷݺͼग़͠Ͱ͸ϝϞϦΩϟογϡʹώοτ͢Δ • Activity#onCreateͱ͔ͰݺͿͱΑ͍
47. ·ͱΊ
48. ·ͱΊ • DataStoreͱ͸৽͍͠ϩʔΧϧετϨʔδιϦϡʔγϣϯͰ͋Δ • Kotlin Coroutines/FlowʹରԠ͍ͯ͠Δ • SharedPreferences͔ΒͷϚΠάϨʔγϣϯ΋Մೳ • ಉظॲཧ͕ඞཁʹͳͬͨΒrunBlocking͢Δ
49. ͋Γ͕ͱ͏͍͟͝·ͨ͠🙇
50. ࢀߟจݙ • ެࣜυΩϡϝϯτΨΠυ • Introduction to Jetpack DataStore • ϓϩμΫτͰ҆શʹDataStoreҠߦ͢Δ • ୤SharedPreferencesɺDataStoreҠߦͯ͠ΈΑ͏