Jetpack datastore入門

新しいデータ永続化の方法！
Jetpack DataStoreの紹介

自己紹介
古川真次（ふるしん）
　@furusin_oriver
Sansan,Inc. Android Engineer
大阪府在住
趣味：勉強会の主催
GDG Osaka オーガナイザー
Kansai.kt オーガナイザー
夢：オンラインイベントでOk, Googleを叫ぶ

Jetpack DataStoreとは
● 2020年 9月 2日に1.0.0-alpha01として発表
● SharedPreferences に代わるものとして提案された、新しいデータの永続化方法
● 動作はKotlin CoroutinesのFlow
● DataStoreには2種類
○ Preferences DataStore: Key-Value ペアを保存します
○ Proto DataStore: 型付きオブジェクトを保存できます（ Protocol Buffer）
■ TypeSafe
https://developer.android.com/jetpack/androidx/releases/datastore

※CoroutinesのFlowを知りたい方は
５分でわかるKotlin Coroutines Flow
https://speakerdeck.com/sys1yagi/5fen-tewakarukotlin-coroutines-flow
スタートダッシュAndroid
〜アプリエンジニアの必須ノウハウをサクっと押さえる
https://amzn.to/2FF5say

Preferences Datastore
● SharedPreferencesに限りなく近い
● 格納できる型はInt, Long, Boolean, Float, String, Setのみ

Preferences DataStoreの使い方
build.gradle編
1. build.gradleに `datastore-preferences` を追加
dependencies {
// Preferences DataStore
implementation "androidx.datastore:datastore-preferences:1.0.0-alpha01"
}

インスタンス生成編
2. DataStoreのインスタンスを生成
import androidx.datastore.preferences.createDataStore
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val dataStore = createDataStore(name = "preferences")
}
}

}
}
DataStoreの
インスタンスを生成

}
}
androidx.datastore.preferencesの
createDataStore

3. editメソッドを使ってデータを格納
データ格納編
import androidx.datastore.preferences.edit
import androidx.datastore.preferences.preferencesKey
GlobalScope.launch {
saveName()
}
}
private suspend fun saveName() {
dataStore.edit { prefernces: MutablePreferences ->
prefernces[PreferencesKeys.KEY_NAME] = "furusin"
}
}
private object PreferencesKeys {
val KEY_NAME = preferencesKey<String>("KEY_NAME")
}

saveName()
}
}
}
}
}
データ格納編
suspend fun DataStore<Preferences>.edit(
transform: suspend (MutablePreferences) -> Unit
): Preferences {
return this.updateData {
// It's safe to return MutablePreferences since we make a defensive copy in
// PreferencesDataStore.updateData()
it.toMutablePreferences().apply { transform(this) }
}
}

saveName()
}
}
}
}
}
データ格納編

saveName()
}
}
}
}
}
データ格納編
/**
* Get a preference Key of type T. Type T must be one of: Int, Long, Boolean, Float, String.
* Use the [preferencesSetKey] function to create a preference key for Set<String>. No
* other types are supported.
* …
*/
inline fun <reified T : Any> preferencesKey(name: String): Preferences.Key<T>

saveName()
}
}
}
}
}
データ格納編
inline fun <reified T : Any> preferencesKey(name: String): Preferences.Key<T> {
return when (T::class) {
Int::class -> {
Preferences.Key<T>(name)
}
String::class -> {
}
Boolean::class -> {
}
Float::class -> {
}
Long::class -> {
}
Set::class -> {
throw IllegalArgumentException("Use `preferencesSetKey` to create keys for Sets.")
}
else -> {
throw IllegalArgumentException("Type not supported: ${T::class.java}")
}
}
}

saveName()
}
}
// prefernces[PreferencesKeys.KEY_NAME] = "furusin"
prefernces.set(PreferencesKeys.KEY_NAME, "furusin")
}
}
}
データ格納編
operator fun <T> set(key: Key<T>, value: T) {
setUnchecked(key, value)
}

4. Coroutines Flowのcollectを使って呼び出し
データ呼び出し編
findViewById<Button>(R.id.loadButton).setOnClickListener {
getName().collect {
Log.d("test", "name = $it")
}
}
}
}
private fun getName(): Flow<String> =
dataStore.data.map { preferences ->
preferences[PreferencesKeys.KEY_NAME] ?: "NO NAME"
}

getName().collect {
}
}
}
}
}
interface DataStore<T> {
val data: Flow<T>
suspend fun updateData(transform: suspend (t: T) -> T): T
}

getName().collect {
}
}
}
}
// preferences[PreferencesKeys.KEY_NAME] ?: "NO NAME"
preferences.get(PreferencesKeys.KEY_NAME) ?: "NO NAME"
}
abstract operator fun <T> get(key: Key<T>): T?

getName().collect {
}
}
}
}

1. build.gradleに追加
implementation "androidx.datastore:datastore-preferences:1.0.0-alpha01"
3. DataStoreのeditメソッドでデータを格納
dataStore.edit { prefernces: MutablePreferences -> prefernces[PreferencesKeys.KEY_NAME] = "furusin" }
}
4. DataStoreのdataからCoroutines Flowのcollectを使ってデータを取得
dataStore.data.map { preferences -> preferences[PreferencesKeys.KEY_NAME] ?: "NO NAME" }
.collect { Log.d("test", "name = $it") }
}
まとめ編

Proto Datastore
● Protocol Bufferを使用
● どんな型でも格納できる

Proto Datastoreの使い方
準備編
1. Protocol Bufferを使えるようにする
a. トップレベルのbuild.gradleに情報を追加
buildscript {
dependencies {
classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.13'
}
}

準備編
a. app/build.gradleに追加
apply plugin: 'com.google.protobuf'
dependencies {
implementation 'com.google.protobuf:protobuf-lite:3.0.1'
}
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.0.0'
}
plugins {
javalite {
artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0"
}
}
generateProtoTasks {
all().each { task ->
task.plugins {
javalite {}
}
}
}
}

build.gradle編
a. app/build.gradleに追加
dependencies {
// Proto DataStore
implementation "androidx.datastore:datastore-core:1.0.0-alpha01"
implementation 'com.google.protobuf:protobuf-lite:3.0.1'
}

データの型編
1. DataStoreで格納したい型を宣言
syntax = "proto3";
option java_package = "net.furusin.www.jetpackdatastoresample";
option java_multiple_files = true;
message User {
int32 age = 1;
string name = 2;
}

Serializerを用意編
1. Serializerを継承したObjectを準備
object UserSerializer : Serializer<User> {
override fun readFrom(input: InputStream): User {
try {
return User.parseFrom(input)
} catch (exception: InvalidProtocolBufferException) {
throw CorruptionException("Cannot read proto.", exception)
}
}
override fun writeTo(t: User, output: OutputStream) {
t.writeTo(output)
}
}
interface Serializer<T> {
fun readFrom(input: InputStream): T
fun writeTo(t: T, output: OutputStream)
}

Serializerを用意編
1. Serializerを継承したObjectを準備
object UserSerializer : Serializer<User> {
override fun readFrom(input: InputStream): User {
try {
return User.parseFrom(input)
} catch (exception: InvalidProtocolBufferException) {
throw CorruptionException("Cannot read proto.", exception)
}
}
override fun writeTo(t: User, output: OutputStream) {
t.writeTo(output)
}
}
TODO(b/151635324):
consider changing InputStream to File.

2. createDataStoreメソッドを使ってインスタンスを生成
import androidx.datastore.createDataStore
lateinit var dataStore: DataStore<User>
dataStore = createDataStore(fileName = "preferences", serializer = UserSerializer)
}
}

2. createDataStoreメソッドを使ってインスタンスを生成
import androidx.datastore.createDataStore
lateinit var dataStore: DataStore<User>
dataStore = createDataStore(fileName = "preferences", serializer = UserSerializer)
}
}
androidx.datastoreの
createDataStore

データ格納編
2. upDateDataメソッドを使ってデータを更新
private suspend fun setUserAge(age: Int) {
dataStore.updateData { currentUser: User ->
currentUser.toBuilder()
.setAge(age)
.build()
}
}
private suspend fun setUserName(name: String) {
.setName(name)
.build()
}
}

データ格納編
private suspend fun setUserAge(age: Int) {
.setAge(age)
.build()
}
}
private suspend fun setUserName(name: String) {
.setName(name)
.build()
}
}
/**
* Updates the data transactionally in an atomic read-modify-write operation.
* …
*/
suspend fun updateData(transform: suspend (t: T) -> T): T

getStoredUser().collect {
Log.d("test", "age = ${it.age}, name = ${it.name}")
}
}
}
private fun getStoredUser(): Flow<User> = dataStore.data

1. protocol Bufferを使えるようにする
2. 保存したいデータを .protoファイルとして定義する
message User { }
3. Serializerを作る
object UserSerializer : Serializer<User> { }
4. データを更新（保存）する
.setAge(age)
.build()
}
5. データを取得する
dataStore.data.collect { Log.d("test", "age = ${it.age}, name = ${it.name}") }
Proto DataStoreの使い方
まとめ編

Jetpack Datastoreの特徴
https://android-developers.googleblog.com/2020/09/prefer-storing-data-with-jetpack.html

SharedPreferencesから
DataStoreに移行する方法
package androidx.datastore.migrations
class SharedPreferencesMigration<T>
@JvmOverloads // Generate constructors for default params for java users.
constructor(
private val context: Context,
private val sharedPreferencesName: String,
keysToMigrate: Set<String>? = MIGRATE_ALL_KEYS,
private val deleteEmptyPreferences: Boolean = true,
private val shouldRunMigration: suspend (T) -> Boolean = { true },
private val migrate: suspend (SharedPreferencesView, T) -> T
) : DataMigration<T>

SharedPreferencesから
DataStoreに移行する方法
package androidx.datastore.migrations
class SharedPreferencesMigration<T>
@JvmOverloads // Generate constructors for default params for java users.
constructor(
private val context: Context,
private val sharedPreferencesName: String,
keysToMigrate: Set<String>? = MIGRATE_ALL_KEYS,
private val deleteEmptyPreferences: Boolean = true,
private val shouldRunMigration: suspend (T) -> Boolean = { true },
private val migrate: suspend (SharedPreferencesView, T) -> T
) : DataMigration<T>
/**
* DataMigration from SharedPreferences to DataStore.
*
* Example usage:
*
* val sharedPrefsMigration = SharedPreferencesMigration(
* context,
* mySharedPreferencesName
* ) { prefs: SharedPreferencesView, myData: MyData ->
* myData.toBuilder().setCounter(prefs.getCounter(COUNTER_KEY, default = 0)).build()
* }
*…
*/

Room vs DataStore
● 以下のような場合はRoom
○ 大規模 or 複雑なデータを保存したい
○ データを部分的に更新したい
● 以下のような場合はDataStore
○ 小さなデータを保存したい
○ 部分的な更新は必要ない
○ 今まで「SharedPreferencesを使おうかな」と思い浮かぶ所

参考文献
● 公式ドキュメント
○ https://developer.android.com/topic/libraries/architecture/datastore
● 公式ブログ
○ https://android-developers.googleblog.com/2020/09/prefer-storing-data-with-jetpack.
html
● Codelabs
○ https://codelabs.developers.google.com/codelabs/android-preferences-d
atastore/index.html
○ https://codelabs.developers.google.com/codelabs/android-proto-datasto
re/index.html
● サンプルプログラム
○ https://github.com/furusin/JetpackDataStoreSample
■ try_preferences_datastore
■ try_proto_datastore

ご清聴ありがとうございました
Ask the Speakerはこちら
https://meet.google.com/vdu-oryz-kcj

Jetpack datastore入門

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Jetpack datastore入門

Similar to Jetpack datastore入門 (20)

More from furusin

More from furusin (17)

Recently uploaded

Recently uploaded (8)

Jetpack datastore入門