Safe args 사용하기

로그인이 구현된 fragment에서 가입되지않은 사용자가 로그인 시도를 할 때, 카카오 로그인에서 반환 받은 access token을 회원가입 페이지로 넘겨야했는데, 이때 서로 다른 Fragment로 작성되어 있는데다 viewmodel도 공유하고 있지않아서 골치가 아팠다. datastore를 이용해 access token을 저장하는 건 미리 짜 두었지만, 간단하게 프래그먼트끼리 값을 넘기는 방법이 없을까 고민하던 중, 프로젝트 팀장형이 safe args라는 키워드를 알려주셨다.

 

safe args는 android jetpack navigation component에 속한 플러그인 중 하나이고, navigation의 탐색 그래프 소스코드의 action에 값을 담아서 넘기는 아주 획기적인 기능을 갖고있다.

대상 사이에서 데이터를 탐색하고 전달할 때 유형 안정성을 제공하는 그래프 플러그인입니다. 인수를 통해 복잡한 데이터 구조를 전달하는 것은 안티패턴으로 간주됩니다. 각 대상은 항목 ID와 같이 필요한 최소 정보를 기반으로 UI 데이터 로드를 담당해야 합니다. 이를 통해 프로세스 재생성이 간소화되고 잠재적 데이터 불일치가 방지됩니다.

내 경우에는 string으로 된 값을 넘기면 되는 상황이라 사용하기 적합한 조건이다. 이제 사용방법을 알아보자

Safe Args 사용법

gradle 플러그인이다 보니, gradle을 사용하지 않는 경우에는 사용할 수 없는 방법이고, 그 때는 bundle을 이용해 값을 넘겨야한다.

최상위 gradle 파일(프로젝트 수준)에 classpath 설정을 추가한다.

buildscript {
    repositories {
        google()
    }
    dependencies {
        val nav_version = "2.5.3"
        classpath("androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version")
    }
}

 

nav_version은 계속 업데이트 될 것이므로 version catalog나 따로 buildSrc 모듈을 만들어서 관리하는 것이 유지 보수에 좋다.

사용할 app / presentation 모듈에 아래 dependency를 추가해준다.

plugins {
    id("androidx.navigation.safeargs.kotlin")
}

 

AndroidX 패키지이기 때문에 gradle.properties파일에 android.useAndroidX=true가 있어야한다. 최근 생성한 프로젝트라면 이미 들어가 있을 것이지만 예전에 생성한 프로젝트라면 없을 수도 있다.

 

이제 코드로 돌아가면, 송신(발신)대상 프래그먼트에서 프래그먼트 이름 + Directions가 생성된다. 이제 값을 넘길 준비를 하겠다. 먼저 값을 담아서 넘길 action에 인수를 설정한다.

<action
    android:id="@+id/action_loginFragment_to_signupFragment"
    app:destination="@id/signupFragment">
    <argument
        android:name="acToken"
        app:argType="string"/>
</action>

 

이 action은 발신대상에서 사용하는 action이다. 수신대상도 argument를 설정해줘야하는데, 수신대상은 fragment에서 값을 받기 때문에 argument의 위치가 action이 아닌 fragment이다.

<fragment
    android:id="@+id/signupFragment"
    android:name="com.shypolarbear.presentation.ui.join.JoinFragment"
    android:label="SignupFragment"
    tools:layout="@layout/fragment_signup">
    <argument
        android:name="acToken"
        app:argType="string"/>
</fragment>

 

이게 수신대상의 설정이다. 이렇게 하면 프래그먼트이름 + Args코드가 생성되어 접근할 수 있다.

코드로 돌아가서, action을 argument값을 넣어서 재정의한다.

sendTokenToJoin = LoginFragmentDirections.actionLoginFragmentToSignupFragment(token.accessToken)

 

Directions에 메서드로 action id가 잡히고, 인수에 사용할 값을 넣으면 된다. 내 코드에서 sendTokenToJoin은 NavDirection Type으로, 따로 navigate하는 코드가 있기때문에 거기서 사용하기 위해lateinit var 선언해뒀다.

수신쪽에서는 더 간단하다. ktx계열 dependency를 사용중이라면(아마 플러그인을 사용중이라면 android-ktx를 쓰고 있을 확률이 높다.) by navArgs()를 이용해 값을 받아올 인스턴스를 생성한다.

private val args: JoinFragmentArgs by navArgs()
val acToken = args.acToken

 

수신대상의 코드다. 탐색 그래프 ui에서 사용하는 방법도 있지만 나는 코드로 작업하는 게 편해서 이렇게 진행했다.

Safe Args 사용이점

공식문서를 보면 유형 안전성이라는 단어가 나온다. 이게 번역이 어색해서 그런건데 Type Safety가 원문에 적혀있는 단어다.

safe args를 사용하면 탐색 그래프 인자에 대한 정보를 컴파일러가 확인하기 때문 컴파일 시점에 에러를 발견 할 수 있어서 런타임 에러를 방지할 수 있다. 

 

(10/11 추가) Safe Args를 쓰면서 DataClass를 넘기는 법

원시타입만 넘기는 게 아니라 DataClass로 넘기고 싶다면 Parcelable로 선언하는 과정이 필요하다.

@Parcelize
data class StoreDataArgs(
    val storeId: Int,
    val storeName: String,
    val imageUrl: String
): Parcelable

Parcelable로 선언해줘서 직렬화/역직렬화 과정에도 사용할 수 있게 data class를 작성한다음

<action
    android:id="@+id/action_navigation_map_to_navigation_detail"
    app:destination="@id/navigation_detail">
    <argument
        android:name="storeInfo"
        app:argType="com.suchelin.android.util.parcelable.StoreDataArgs"/>
</action>

argType에 data class 위치를 넣으면 된다. 수동으로 하면 헷갈릴수도 있으니 이때는 도구를 쓰는 것을 추천한다.

Attributes에 add arguments를 누르면 이렇게 custom parcelable를 지정할 수 있고 IDE가 찾아준다.

참조:

https://developer.android.com/guide/navigation/navigation-pass-data?hl=ko

"댓글, 공감 버튼 한 번씩 누르고 가주시면 큰 힘이 됩니다"