🫙Android 로그인 토큰 저장 : Proto Datastore 적용하기

Proto Datastore 개념 이해하기

Jetpack의 Datastore은 프로토콜 버퍼를 사용하여 키-값 쌍 또는 유형이 지정된 객체를 저장할 수 있는 데이터 저장소 솔루션이다. 

Datastore은 kotlin의 코루틴 및 Flow를 사용하여 비동기적이고 일관된 트랜잭션 방식으로 데이터를 저장한다. 

 

이 때 2가지의 저장소를 제공한다.

1️⃣Proto Datastore : 맞춤 데이터 유형의 인스턴스로 데이터를 저장한다. 유형 안전성을 제공하며 프로토콜 버퍼를 사용하여 스키마를 정의한다.

2️⃣Preferences Datastore : 키를 사용하여 데이터에 저장 & 액세스를 한다 유형 안전성을 제공하지 않으며 사전에 정의된 스키마가 필요하지 않다.

 

 

❓ 유형 안전성을 제공하면 무엇이 다른걸까?

🗨️프로그램에서 데이터 유형을 올바르게 사용하도록 보장하는 개념이다. 즉 변수에 저장된 데이터가 해당 변수의 유형과 일치하는지를 확인한다. 이를 통해 컴파일 시점에 데이터 유형 오류를 감지하여 코드 오류를 줄일 수 있다.

 

❓ 프로토콜 버퍼란?

🗨️ 구조화된 데이터를 효율적으로 직렬화하는 방법을 의미한다. 

 

❓  스키마란?

🗨️ 스키마는 메시지의 구조를 정의하는 규칙을 의미한다. 

 

protobuf 객체 정의 및 사용

Proto Datastore 구현은 Datastore 및 프로토콜 버퍼를 사용하여 유형이 지정된 객체를 디스크에 유지한다.

1️⃣ proto 파일 만들기 - 스키마 정의하기

proto 파일에서 스키마를 정의해준다. 

proto를 사용하려며 app/src/main/proto/ 디렉터리의 proto 파일에 사전 정의된 스키마가 있어야한다. 

사전 정의된 스키마는 Proto에 유지하는 객체의 유형을 정의한다. 

우리는 로그인 요청 시 응답으로 오는 access token과 refresh token 두 가지의 객체를 표현해준다.

DataStore에 저장된 UserToken 클래스 아래에 이 두 플래그를 통합해주었다. 

 

이 때 protobuf의 각 구조는 message 키워드를 사용하여 정의한다.

구조의 각 요소는 유형과 이름에 따라 메시지 내에 정의되며 1부터 차례대로 순서가 할당된다. 

syntax = "proto3";

option java_package = "com.teamfilmo.filmo.data.local.model";
option java_multiple_files = true;

message UserToken {
    string access_token = 1;
    string refresh_token = 2;
}

 

Proto 스키마를 정의하는 방법 

1️⃣첫번째 줄에 proto3 systax을 사용한다고 적어준다. 만약 적어주지 않으면 프로토콜 버퍼 컴파일러는 proto2를 사용한다고 가정한다.

2️⃣UserToken message 정의는 access_token과 refresh_token 2가지의 필드를 지정한다. 이러한 메시지에 포함하고 싶은 데이터 각각의 필드는 이름과 타입을 가진다. 

3️⃣필드에는 수를 지정해주어야한다. 이 때 수는 반드시 유일해야한다(unique) 

 

이렇게 proto 파일에 정의하고 프로젝트를 다시 빌드하면 UserToken message는 컴파일 시간에 객체의 클래스를 생성한다. 

 

❣️ 처음에 코드를 받았을 때는 정의된 UserToken 클래스가 없어서 에러가 발생하였다. 그래서 개발자분께 파일이 없다고 질문을 드렸고, 빌드 후에 생성된다는 답변을 받았다. 그 이유가 위와 같았다!!

 

이제 이렇게 유형이 지정된 UserToken 객체를 저장해줄 Proto Datastore을 만들어주자. 저장해주기 위해서는 2단계를 거쳐야한다. 

- Serializer<T>를 구현하는 클래스 정의하기

- dataStore로 만든 속성 위임을 사용하여 DataStore<T >의 인스턴스를 만들어준다.

 

여기서 T는  proto 파일에 정의된 유형을 의미한다. 

 

아래의  seirializer 만들기  내용부터 살펴보자!

 

2️⃣serializer 만들기

proto 파일에 정의한 데이터 유형 ( access_token과 refresh_token을 읽고 쓰는 방법을 Datastore에 알리려면 serializer을 구현해야한다. serializer 클래스가 데이터 유형을 읽고 쓰는 방법을 Datastore에 알려주는 역할을 한다.

또한 serializer는 디스크에 데이터가 없을 때(파일이 생성되지 않을 경우) 반환될 seriazlier기본값도 정의해주어야한다.

 

object UserTokenSerializer : Serializer<UserToken> {
    private val TAG = this::class.java.simpleName

    override val defaultValue: UserToken
        get() = UserToken.getDefaultInstance()

    override suspend fun readFrom(input: InputStream): UserToken {
        try {
            return UserToken.parseFrom(input)
        } catch (e: InvalidProtocolBufferException) {
            throw CorruptionException("Cannot read proto.", e)
        }
    }

    override suspend fun writeTo(
        t: UserToken,
        output: OutputStream,
    ) {
        t.writeTo(output)
    }
}

 

이제 앞서 말했던 DataStore<T>의 인스턴스를 만들어줄 차례이다. 아래의 내용도 살펴보자

Proto Datastore에서 데이터 유지

1️⃣Datastore 만들기

access_token과 refresh_token은 Datastore 객체의 AuthRepository에 저장되어야한다.

Datastore 인스턴스를 만들기 위해 dataStore 위임을 사용하여 수신기로 Context를 사용한다. 

 

이 위임에는 두가지 필수 매개변수가 있다.

- Datastore가 작동할 파일의 이름 : user_token_pb 

    -> 이는 데이터를 저장하는데 사용할 파일을 Datastore에 알려준다.

- Datastore에서 사용되는 유형을 위한 serializer : UserTokenSerializer

    -> 이는 앞서 정의해준 serializer 클래스의 이름을 Datastore에 알려준다.

 

object DataStoreConfig {
    const val USER_TOKEN_DATA_STORE_FILE_NAME = "user_token.pb"
}

val Context.userToken: DataStore<UserToken> by dataStore(
    fileName = DataStoreConfig.USER_TOKEN_DATA_STORE_FILE_NAME,
    serializer = UserTokenSerializer,
)

 

 

dataStore 위임은 애플리케이션에 이 이름을 가진 Datastore 인스턴스가 하나만 있음을 보장해준다. 현재 AuthRepository는 생성자 매개변수로 DataStore 인스턴스를 가져와야한다. 

우리는 di를 사용하므로 아래와 같이 모듈로 정의해두었다.

@Module
@InstallIn(SingletonComponent::class)
object LocalModule {
    @Provides
    fun provideDataStoreUserToken(
        @ApplicationContext context: Context,
    ): DataStore<UserToken> {
        return context.userToken
    }
}

 

2️⃣ Proto Datastore에서 데이터 읽기 

구현해줄 함수를 인터페이스로 정의해준다. 

interface UserTokenSource {
    fun getUserToken(): Flow<String>

    suspend fun setUserToken(token: String)

    fun getRefreshToken(): Flow<String>

    suspend fun setRefreshToken(token: String)

    suspend fun updateToken(
        accessToken: String,
        refreshToken: String,
    )

    suspend fun clearUserToken()
}

 

Proto Datastore은 Flow<UserToken>에 저장된 데이터를 노출한다. 

DataStore.data를 사용하여 저장된 객체에서 적절한 속성의 Flow를 노출한다. 

class UserTokenSourceImpl
    @Inject
    constructor(
        private val dataStore: DataStore<UserToken>,
    ) : UserTokenSource {
        override fun getUserToken(): Flow<String> {
            return dataStore.data.map {
                it.accessToken
            }
        }

        override suspend fun setUserToken(token: String) {
            dataStore.updateData {
                it.copy {
                    accessToken = token
                }
            }
        }

        override fun getRefreshToken(): Flow<String> {
            return dataStore.data.map {
                it.refreshToken
            }
        }

        override suspend fun setRefreshToken(token: String) {
            dataStore.updateData {
                it.copy {
                    refreshToken = token
                }
            }
        }

        override suspend fun updateToken(
            accessToken: String,
            refreshToken: String,
        ) {
            dataStore.updateData {
                it.copy {
                    this.accessToken = accessToken
                    this.refreshToken = refreshToken
                }
            }
        }

        override suspend fun clearUserToken() {
            dataStore.updateData {
                userToken {
                    clearAccessToken()
                    clearRefreshToken()
                }
            }
        }
    }

 

Proto Datastore에 데이터 쓰기

 

데이터를 쓸 수 있도록 suspend 정지 함수인 DataStore.updateData 함수를 제공하고 있다. 이 함수에서 매개변수로 token을 가져올 수 있다. 이를 업데이트 해주려면 UserToken.copy를 통해 객체를 만들고 새로운 token으로 accessToken을 업데이트 해준다. 

 

updateData( )는 데이터의 현재 상태를 데이터 유형의 인스턴스로 제공하고 원자적 읽기-쓰기-수정 작업을 통해 트랜잭션 방식으로 데이터를 업데이트한다. 코루틴은 데이터가 디스크에 유지되면 완료가 된다.

override suspend fun setUserToken(token: String) {
    dataStore.updateData {
        it.copy {
            accessToken = token
        }
    }
}

 

❓공식문서는 toBuilder( )를 통해 객체를 복사한다. 우리 코드는 .copy( )를 사용하는데 이 두가지 방식의 차이는 뭘까?

🗨️ toBuilder()와 copy()는 모두 객체를 복사하는데 사용되는 함수이다. 차이를 알아보자

 

객체 변경 방식

-  toBuilder( )는 객체의 빌더를 반환한다. 빌더를 사용하여 객체의 속성을 변경한 후 build() 메서드를 호추랗며 새 객체를 만들 수 있다.

- copy()는 객체의 새로운 복사본을 반환한다. 새 복사본에는 원본 객체의 모든 속성값이 포함된다. 이때 변경하려는 속성값을 직접 지정할 수 있다.

 

성능

- toBuilder()는 일반적으로 객체의 모든 속성을 복사해야하기 때문에 copy()보다 성능이 낮댜.

- copy()를 통해 만들어진 새 복사본에는 원본 객체의 모든 속성 값이 포함되지만 변경하려는 속성 값만 복사하면 된다. 이는 toBuilder()보다 성능이 높은 편이다.

 

유용한 상황

- toBuilder()는 복잡한 변경을 수행할 때 더 유형한다. 빌더를 사용하여 여러 속성을 변경하거나 조건부로 속성을 변경할 수 있다.

- copy()는 간단한 변경을 수행할 때 더 유용하다. 한두개의 속성을 변경해야하는 경우 copy()를 사용하는 것이 더 간단하다.

 

우리 코드에 더 적절한 것은?

우리는 accessToken 속성만 변경하면 되기 때문에 copy()를 사용하는 것이 더 간단하고 직관적이다.