생성된 iOS SDK 사용

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

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

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

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

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

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

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

  1. iOS 앱에 Firebase를 추가합니다.

  2. 생성된 SDK를 사용하려면 Xcode에서 종속 항목으로 구성하세요.

    Xcode 상단 탐색 메뉴에서 File > Add Package Dependencies > Add Local(파일 > 패키지 종속 항목 추가 > 로컬 추가)을 선택하고 생성된 Package.swift가 포함된 폴더를 선택합니다.

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

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

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

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

  4. 쿼리 및 변형 호출 구현

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

Swift 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 빌드 프로세스에서 데이터 커넥트 SDK를 생성할 수 있습니다.

firebase dataconnect:sdk:generate

Data Connect iOS SDK 초기화

Firebase 콘솔의 Data Connect 탭에서 확인할 수 있는 Data Connect 설정에 사용한 정보를 사용하여 Data Connect 인스턴스를 초기화합니다.

커넥터 인스턴스 가져오기

커넥터 코드는 Data Connect 에뮬레이터에 의해 생성됩니다. 커넥터 이름이 movies이고 패키지가 connector.yaml에 지정된 대로 movies인 경우 다음을 호출하여 커넥터 객체를 가져옵니다.

let connector = DataConnect.moviesConnector

쿼리 및 변형 구현

커넥터 객체를 사용하면 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
  }
}

그런 다음 다음과 같이 영화를 만들 수 있습니다.

let mutationResult = try await connector.createMovieMutation.execute(
  title: "Empire Strikes Back",
  releaseYear: 1980,
  genre: "Sci-Fi",
  rating: 5)

print("Movie ID: \(mutationResult.data.movie_insert.id)")

영화를 가져오려면 쿼리 참조를 사용합니다. 모든 쿼리 참조는 관찰 가능한 게시자입니다. 구성된 게시자에 따라 (connector.yaml) 참고) @Observable 매크로 (iOS 17 이상)를 지원하거나 ObservableObject 프로토콜을 구현합니다. 지정하지 않은 경우 기본값은 iOS 17 이상에서 지원되는 @Observable 매크로입니다.

SwiftUI 뷰에서 쿼리 참조의 게시된 data 변수를 사용하여 쿼리 결과를 바인딩하고 쿼리의 execute() 메서드를 호출하여 데이터를 업데이트할 수 있습니다. data 변수는 GQL 쿼리 정의에 정의된 데이터의 모양과 일치합니다.

검색된 모든 결과는 Decodable 프로토콜을 준수합니다. GQL 가져오기에 객체의 기본 키를 포함한 경우 객체도 Identifiable이므로 반복자에서 사용할 수 있습니다. 

struct ListMovieView: View {
    @StateObject private var queryRef = connector.listMoviesByGenreQuery.ref(genre: "Sci-Fi")
    var body: some View {
        VStack {
            Button {
                Task {
                    do {
                        try await refresh()
                    } catch {
                        print("Failed to refresh: \(error)")
                    }
                }
            } label: {
                Text("Refresh")
            }
                // use the query results in a view
            ForEach(queryRef.data?.movies ?? [], id: \.self.id) { movie in
                    Text(movie.title)
                }
            }
    }
    @MainActor
    func refresh() async throws {
        _ = try await queryRef.execute()
    }
}

쿼리는 원샷 실행도 지원합니다. 

let resultData = try await DataConnect.moviesConnector.listMoviesByGenreQuery.execute(genre: "Sci-Fi")

열거형 필드 변경사항 처리

앱의 스키마는 GraphQL 쿼리에서 액세스할 수 있는 열거형을 포함할 수 있습니다.

앱의 디자인이 변경되면 지원되는 새 enum 값을 추가할 수 있습니다. 예를 들어 애플리케이션의 수명 주기 후반에 AspectRatio enum에 FULLSCREEN 값을 추가하기로 결정한다고 가정해 보겠습니다.

Data Connect 워크플로에서는 로컬 개발 도구를 사용하여 쿼리와 SDK를 업데이트할 수 있습니다.

하지만 업데이트된 클라이언트 버전을 출시하기 전에 배포된 이전 클라이언트가 작동하지 않을 수 있습니다.

복원력 있는 구현 예

생성된 SDK는 알 수 없는 값을 처리하도록 강제합니다. 생성된 enum에 _UNKNOWN 값이 포함되어 있고 Swift는 포괄적인 switch 문을 강제하기 때문입니다.

do {
    let result = try await DataConnect.moviesConnector.listMovies.execute()
    if let data = result.data {
        for movie in data.movies {
            switch movie.aspectratio {
                case .ACADEMY: print("academy")
                case .WIDESCREEN: print("widescreen")
                case .ANAMORPHIC: print("anamorphic")
                case ._UNKNOWN(let unknownAspect): print(unknownAspect)
            }
        }
    }
} catch {
    // handle error
}

iOS 애플리케이션 프로토타입 제작 및 테스트

로컬 에뮬레이터를 사용하도록 클라이언트 계측

Data Connect VS Code 확장 프로그램에서든 CLI에서든 Data Connect 에뮬레이터를 사용할 수 있습니다.

에뮬레이터에 연결하도록 앱을 계측하는 것은 두 시나리오 모두 동일합니다.

let connector = DataConnect.moviesConnector
// Connect to the emulator on "127.0.0.1:9399"
connector.useEmulator()

// (alternatively) if you're running your emulator on non-default port:
connector.useEmulator(port: 9999)

// Make calls from your app

Data Connect SDK의 데이터 유형

Data Connect 서버는 일반 및 맞춤 GraphQL 데이터 유형을 나타냅니다. 이는 SDK에서 다음과 같이 표현됩니다.

데이터 연결 유형 Swift
문자열 문자열
정수 정수
부동 소수점 수 Double
불리언 Bool
UUID UUID
날짜 FirebaseDataConnect.LocalDate
타임스탬프 FirebaseCore.Timestamp
Int64 Int64
모두 FirebaseDataConnect.AnyValue