Firebase Data Connect 클라이언트 SDK를 사용하면 Firebase 앱에서 서버 측 쿼리 및 변형을 직접 호출할 수 있습니다. Data Connect 서비스에 배포할 스키마, 쿼리, 변형을 설계할 때 맞춤 클라이언트 SDK를 동시에 생성합니다. 그런 다음 이 SDK의 메서드를 클라이언트 로직에 통합합니다.
다른 곳에서 언급했듯이 Data Connect 쿼리와 변형은 클라이언트 코드에 의해 제출되지 않고 서버에서 실행됩니다. 대신 배포 시 Data Connect 작업은 Cloud Functions와 같은 서버에 저장됩니다. 즉, 기존 사용자 (예: 이전 앱 버전)가 중단되지 않도록 해당하는 클라이언트 측 변경사항을 배포해야 합니다.
따라서 Data Connect는 서버에 배포된 스키마, 쿼리, 변형의 프로토타입을 제작할 수 있는 개발자 환경과 도구를 제공합니다. 프로토타입을 제작하는 동안 클라이언트 측 SDK도 자동으로 생성됩니다.
서비스 및 클라이언트 앱에 대한 업데이트를 반복하면 서버 측 및 클라이언트 측 업데이트를 모두 배포할 수 있습니다.
클라이언트 개발 워크플로란 무엇인가요?
시작하기를 따른 경우 Data Connect의 전체 개발 흐름을 살펴봤을 것입니다. 이 가이드에서는 스키마에서 Android SDK를 생성하고 클라이언트 쿼리 및 변형을 사용하는 방법에 관한 자세한 정보를 확인할 수 있습니다.
요약하자면, 생성된 Android SDK를 클라이언트 앱에서 사용하려면 다음 필수 단계를 따르세요.
- Android 앱에 Firebase를 추가합니다.
- Gradle에서 Data Connect을 종속 항목으로 구성합니다.
- Kotlin Serialization Gradle 플러그인과 Gradle 종속 항목을 추가합니다.
그런 다음 아래를 실행합니다.
- 앱 스키마를 개발합니다.
SDK 생성 설정:
- Data Connect VS Code 확장 프로그램의 앱에 SDK 추가 버튼
connector.yaml업데이트
Data Connect 에뮬레이터를 설정하고 사용하여 반복합니다.
Kotlin SDK 생성
Firebase CLI를 사용하여 앱에서 Data Connect 생성 SDK를 설정합니다.
init 명령어는 현재 폴더의 모든 앱을 감지하고 생성된 SDK를 자동으로 설치해야 합니다.
firebase init dataconnect:sdk
프로토타입 제작 중에 SDK 업데이트
Data Connect VS Code 확장 프로그램을 설치한 경우 생성된 SDK가 항상 최신 상태로 유지됩니다.
Data Connect VS Code 확장 프로그램을 사용하지 않는 경우 Firebase CLI를 사용하여 생성된 SDK를 최신 상태로 유지할 수 있습니다.
firebase dataconnect:sdk:generate --watch빌드 파이프라인에서 SDK 생성
Firebase CLI를 사용하여 CI/CD 빌드 프로세스에서 Data Connect SDK를 생성할 수 있습니다.
firebase dataconnect:sdk:generate클라이언트 코드 설정
클라이언트 코드에 Data Connect 통합
생성된 SDK와 Data Connect를 사용하도록 클라이언트 코드를 설정하려면 먼저 표준 Firebase 설정 안내를 따르세요.
그런 다음 app/build.gradle.kts의 plugins 섹션에 다음을 추가합니다.
// The Firebase team tests with version 1.8.22; however, other 1.8 versions,
// and all newer versions are expected work too.
kotlin("plugin.serialization") version "1.8.22" // MUST match the version of the Kotlin compiler
그런 다음 app/build.gradle.kts의 dependencies 섹션에 다음을 추가합니다.
implementation(platform("com.google.firebase:firebase-bom:34.11.0"))
implementation("com.google.firebase:firebase-dataconnect")
implementation("com.google.firebase:firebase-auth") // Optional
implementation("com.google.firebase:firebase-appcheck") // Optional
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3") // Newer versions should work too
implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.5.1") // Newer versions should work too
Data Connect Android SDK 초기화
Data Connect를 설정하는 데 사용한 정보를 사용하여 Data Connect 인스턴스를 초기화합니다 (Firebase 콘솔 Data Connect 탭에서 모두 확인 가능).
ConnectorConfig 객체
SDK에는 커넥터 구성 객체가 필요합니다.
이 객체는 dataconnect.yaml의 serviceId 및 location, connector.yaml의 connectorId에서 자동으로 생성됩니다.
커넥터 인스턴스 가져오기
이제 구성 객체를 설정했으므로 Data Connect 커넥터 인스턴스를 가져옵니다. 커넥터 코드는 Data Connect 에뮬레이터에 의해 생성됩니다. 커넥터 이름이 movies이고 Kotlin 패키지가 connector.yaml에 지정된 대로 com.myapplication인 경우 다음을 호출하여 커넥터 객체를 가져옵니다.
val connector = com.myapplication.MoviesConnector.instance
Android SDK에서 쿼리 및 변형 사용
커넥터 객체를 사용하면 GraphQL 소스 코드에 정의된 대로 쿼리와 변형을 실행할 수 있습니다. 커넥터에 다음과 같은 작업이 정의되어 있다고 가정해 보겠습니다.
mutation createMovie($title: String!, $releaseYear: Int!, $genre: String!, $rating: Int!) {
movie_insert(data: {
title: $title
releaseYear: $releaseYear
genre: $genre
rating: $rating
})
}
query getMovieByKey($key: Movie_Key!) {
movie(key: $key) { id title }
}
query listMoviesByGenre($genre: String!) {
movies(where: {genre: {eq: $genre}}) {
id
title
}
}
다음과 같이 영화를 만들고 검색할 수 있습니다.
val connector = MoviesConnector.instance
val addMovieResult1 = connector.createMovie.execute(
title = "Empire Strikes Back",
releaseYear = 1980,
genre = "Sci-Fi",
rating = 5
)
val movie1 = connector.getMovieByKey.execute(addMovieResult1.data.key)
println("Empire Strikes Back: ${movie1.data.movie}")
여러 영화를 가져올 수도 있습니다.
val connector = MoviesConnector.instance
val addMovieResult2 = connector.createMovie.execute(
title="Attack of the Clones",
releaseYear = 2002,
genre = "Sci-Fi",
rating = 5
)
val listMoviesResult = connector.listMoviesByGenre.execute(genre = "Sci-Fi")
println(listMoviesResult.data.movies)
쿼리의 execute() 메서드 호출을 사용하여 새 쿼리 결과가 검색될 때만 결과를 생성하는 Flow를 수집할 수도 있습니다.
val connector = MoviesConnector.instance
connector.listMoviesByGenre.flow(genre = "Sci-Fi").collect { data ->
println(data.movies)
}
connector.createMovie.execute(
title="A New Hope",
releaseYear = 1977,
genre = "Sci-Fi",
rating = 5
)
connector.listMoviesByGenre.execute(genre = "Sci-Fi") // will cause the Flow to get notified
열거형 필드 변경사항 처리
앱의 스키마는 열거형을 포함할 수 있으며, 이는 GraphQL 쿼리를 통해 액세스할 수 있습니다.
앱의 디자인이 변경되면 지원되는 새 enum 값을 추가할 수 있습니다. 예를 들어 애플리케이션의 수명 주기 후반에 AspectRatio enum에 FULLSCREEN 값을 추가한다고 가정해 보겠습니다.
Data Connect 워크플로에서는 로컬 개발 도구를 사용하여 쿼리와 SDK를 업데이트할 수 있습니다.
하지만 업데이트된 클라이언트 버전을 출시하기 전에 배포된 이전 클라이언트가 중단될 수 있습니다.
복원력 있는 구현 예
생성된 SDK는 알 수 없는 값의 처리를 강제합니다. 고객의 코드가 EnumValue 객체를 래핑 해제해야 하기 때문입니다. 이 객체는 알려진 enum 값의 경우 EnumValue.Known이고 알 수 없는 값의 경우 EnumValue.Unknown입니다.
val result = connector.listMoviesByAspectRatio.execute(AspectRatio.WIDESCREEN)
val encounteredAspectRatios = mutableSetOf<String>()
result.data.movies
.mapNotNull { it.otherAspectRatios }
.forEach { otherAspectRatios ->
otherAspectRatios
.filterNot { it.value == AspectRatio.WIDESCREEN }
.forEach {
when (it) {
is EnumValue.Known -> encounteredAspectRatios.add(it.value.name)
is EnumValue.Unknown ->
encounteredAspectRatios.add("[unknown ratio: ${it.stringValue}]")
}
}
}
println(
"Widescreen movies also include additional aspect ratios: " +
encounteredAspectRatios.sorted().joinToString()
)
클라이언트 측 캐싱 사용 설정
Data Connect에는 선택적 클라이언트 측 캐싱 기능이 있으며, connector.yaml 파일을 수정하여 이 기능을 사용 설정할 수 있습니다. 이 기능을 사용 설정하면 생성된 클라이언트 SDK가 쿼리 응답을 로컬로 캐시하므로 앱에서 실행하는 데이터베이스 요청 수를 줄일 수 있으며 네트워크 사용 가능 여부가 중단될 때 앱의 데이터베이스 종속 부분이 작동할 수 있습니다.
클라이언트 측 캐싱을 사용 설정하려면 커넥터 구성에 클라이언트 캐싱 구성을 추가하세요.
generate:
kotlinSdk:
outputDir: "../android"
package: "com.google.firebase.dataconnect.generated"
clientCache:
maxAge: 5s
storage: persistent
이 구성에는 두 개의 매개변수가 있으며 둘 다 선택사항입니다.
maxAge: 클라이언트 SDK가 최신 값을 가져오기 전에 캐시된 응답이 있을 수 있는 최대 기간입니다. 예: '0', '30s', '1h30m'maxAge의 기본값은0입니다. 즉, 응답이 캐시되지만 클라이언트 SDK는 항상 최신 값을 가져옵니다. 캐시된 값은CACHE_ONLY이execute()으로 지정된 경우에만 사용됩니다.storage: 클라이언트 SDK는persistent스토리지 또는memory에 응답을 캐시하도록 구성할 수 있습니다.persistent스토리지에 캐시된 결과는 앱을 다시 시작해도 유지됩니다. Android SDK에서 기본값은persistent입니다.
커넥터의 캐싱 구성을 업데이트한 후 클라이언트 SDK를 재생성하고 앱을 다시 빌드합니다. 이렇게 하면 execute()에서 응답을 캐시하고 구성한 정책에 따라 캐시된 값을 사용합니다. 일반적으로 이 과정은 사용자의 추가 단계 없이 자동으로 진행됩니다. 하지만 다음 사항에 유의하세요.
execute()의 기본 동작은 위에 설명된 대로 쿼리에 대한 결과가 캐시되고 캐시된 값이maxAge보다 오래되지 않은 경우 캐시된 값을 사용하는 것입니다. 이 기본 동작을PREFER_CACHE정책이라고 합니다.캐시된 값만 제공 (
CACHE_ONLY)하거나 서버에서 최신 값을 무조건 가져오도록 (SERVER_ONLY)execute()의 개별 호출에 지정할 수도 있습니다.val queryResult = queryRef.execute(QueryRef.FetchPolicy.CACHE_ONLY)val queryResult = queryRef.execute(QueryRef.FetchPolicy.SERVER_ONLY)Android 애플리케이션 프로토타입 제작 및 테스트
로컬 에뮬레이터를 사용하도록 클라이언트 계측
Data Connect VS Code 확장 프로그램에서든 CLI에서든 Data Connect 에뮬레이터를 사용할 수 있습니다.
에뮬레이터에 연결하도록 앱을 계측하는 것은 두 시나리오 모두 동일합니다.
val connector = MoviesConnector.instance // Connect to the emulator on "10.0.2.2:9399" connector.dataConnect.useEmulator() // (alternatively) if you're running your emulator on non-default port: connector.dataConnect.useEmulator(port = 9999) // Make calls from your app프로덕션 리소스로 전환하려면 에뮬레이터에 연결하는 줄을 주석 처리합니다.
Data Connect SDK의 데이터 유형
Data Connect 서버는 일반적인 GraphQL 데이터 유형과 맞춤 GraphQL 데이터 유형을 나타냅니다. 이는 SDK에서 다음과 같이 표현됩니다.
Data Connect 유형 Kotlin 문자열 문자열 정수 Int (32비트 정수) 부동 소수점 수 Double (64비트 부동 소수점) 불리언 불리언 UUID java.util.UUID 날짜 com.google.firebase.dataconnect.LocalDate (16.0.0-beta03까지는 java.util.Date였음) 타임스탬프 com.google.firebase.Timestamp Int64 긺 모두 com.google.firebase.dataconnect.AnyValue