생성된 Android SDK 사용

Firebase Data Connect 클라이언트 SDK를 사용하면 Firebase 앱에서 서버 측 쿼리 및 변형을 직접 호출할 수 있습니다. Data Connect 서비스에 배포할 스키마, 쿼리, 변형을 설계할 때 맞춤 클라이언트 SDK를 동시에 생성합니다. 그런 다음 이 SDK의 메서드를 클라이언트 로직에 통합합니다.

다른 곳에서 언급했듯이 Data Connect 쿼리와 뮤테이션은 클라이언트 코드에서 제출되지 않고 서버에서 실행된다는 점에 유의해야 합니다. 대신 배포되면 Data Connect 작업이 Cloud Functions와 같이 서버에 저장됩니다. 즉, 기존 사용자 (예: 이전 앱 버전)가 중단되지 않도록 해당하는 클라이언트 측 변경사항을 배포해야 합니다.

따라서 Data Connect는 서버에 배포된 스키마, 쿼리, 변형을 프로토타입으로 만들 수 있는 개발자 환경과 도구를 제공합니다. 프로토타입을 만드는 동안 클라이언트 측 SDK도 자동으로 생성됩니다.

서비스 및 클라이언트 앱에 대한 업데이트를 반복하면 서버 측 및 클라이언트 측 업데이트를 모두 배포할 수 있습니다.

클라이언트 개발 워크플로란 무엇인가요?

시작하기를 따른 경우 Data Connect의 전반적인 개발 흐름을 살펴봤을 것입니다. 이 가이드에서는 스키마에서 Android SDK를 생성하고 클라이언트 쿼리 및 변형을 사용하는 방법에 관한 자세한 정보를 확인할 수 있습니다.

요약하자면, 생성된 Android SDK를 클라이언트 앱에서 사용하려면 다음 필수 단계를 따라야 합니다.

1. Android 앱에 Firebase를 추가합니다.
2. Gradle에서 Data Connect을 종속 항목으로 구성합니다.
3. Kotlin Serialization Gradle 플러그인과 Gradle 종속 항목을 추가합니다.

그런 다음 아래를 실행합니다.

1. 앱 스키마를 개발합니다.

2. SDK 생성을 설정합니다.

   • Data Connect VS Code 확장 프로그램의 앱에 SDK 추가 버튼
   • connector.yaml 업데이트

3. 클라이언트 코드를 초기화하고 라이브러리를 가져옵니다.

4. 쿼리 및 변형 호출 구현

5. Data Connect 에뮬레이터를 설정하고 사용하여 반복합니다.

Kotlin SDK 생성

대부분의 Firebase 프로젝트와 마찬가지로 Firebase Data Connect 클라이언트 코드 작업은 로컬 프로젝트 디렉터리에서 이루어집니다. Data Connect VS Code 확장 프로그램과 Firebase CLI는 모두 클라이언트 코드를 생성하고 관리하는 데 중요한 로컬 도구입니다.

SDK 생성 옵션은 프로젝트를 초기화할 때 생성된 dataconnect.yaml 파일의 여러 항목에 키가 지정됩니다.

SDK 생성 초기화

connectorId: movies
generate:
  kotlinSdk:
    outputDir: ../../../src/main/java/com/myapplication
    package: com.myapplication

outputDir를 생성된 코드가 배치될 디렉터리의 경로로 바꿉니다. 이 경로는 connector.yaml 파일 자체를 포함하는 디렉터리를 기준으로 합니다. package을 생성된 파일에서 사용할 Kotlin 패키지 문으로 바꾸거나 package을 생략하여 기본 패키지를 사용합니다.

프로토타입 제작 중에 SDK 업데이트

Data Connect VS Code 확장 프로그램과 Data Connect 에뮬레이터를 사용하여 대화형으로 프로토타입을 제작하는 경우 스키마, 쿼리, 변형을 정의하는 .gql 파일을 수정하는 동안 SDK 소스 파일이 자동으로 생성되고 업데이트됩니다. 이는 핫 (재)로드 워크플로에서 유용한 기능이 될 수 있습니다.

또는 .gql 파일이 변경될 때마다 CLI를 사용하여 SDK를 재생성할 수 있습니다.

firebase dataconnect:sdk:generate --watch

통합 및 프로덕션 출시용 SDK 생성

CI 테스트를 위해 제출할 프로젝트 소스를 준비하는 등의 일부 시나리오에서는 일괄 업데이트를 위해 Firebase CLI를 호출할 수 있습니다.

이러한 경우에는 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:33.16.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를 설정하는 데 사용한 정보 (Firebase 콘솔의 Data Connect 탭에서 모두 사용 가능)를 사용하여 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

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 데이터 유형을 나타냅니다. 이는 SDK에서 다음과 같이 표현됩니다.