شروع به کار با Firebase SQL Connect در iOS

در این شروع سریع، یک پایگاه داده نمونه کوچک ایجاد و مستقر خواهید کرد و ازطریق برنامه iOS به آن دسترسی خواهید داشت.

پیش‌نیازها

برای تکمیل این شروع سریع، به موارد زیر نیاز دارید:

  • محیطی که ابزارهای زیر در آن نصب شده باشد:
    • نسخه جدیدی از Xcode.
    • واسط خط فرمان Firebase. اگر NPM را نصب کرده‌اید، این دستور را اجرا کنید:
      npm install -g firebase-tools@latest
      درغیراین‌صورت، برای دستورالعمل‌های نصب به اسناد مراجعه کنید.
  • حساب Google داشته باشید.

آموزش گام‌به‌گام

آموزش گام‌به‌گام

۱. ایجاد پروژه Xcode جدید

در Xcode، پروژه جدیدی با الگوی برنامه ایجاد کنید.

نام پروژه را Quickstart با شناسه دسته نرم‌افزاری com.example.Quickstart بگذارید.

کادر گفتگوی پروژه جدید Xcode

پروژه را در پوشه‌ای خالی، مثل ~/qs-ios، ایجاد کنید. Xcode پوشه‌ای به نام ~/qs-ios/Quickstart ایجاد خواهد کرد که حاوی فایل‌های پروژه شما است.

۲. مقداردهی اولیه پروژه Firebase

به دایرکتوری پروژه Xcode بروید و پروژه Firebase را در آن مقداردهی اولیه کنید.

cd ~/qs-ios
firebase login --reauth
firebase init dataconnect

وقتی درخواست شد، گزینه‌های زیر را انتخاب کنید:

  • پروژه Firebase جدیدی ایجاد کنید.
  • با Gemini طرح‌واره ایجاد نکنید (در این آموزش، از طرح‌واره نمونه ازپیش‌ساخته‌شده استفاده خواهید کرد).
  • یک نمونه و پایگاه داده آزمایشی رایگان Cloud SQL راه‌اندازی کنید.

مقادیر پیش‌فرض را برای همه پیام‌واره‌های دیگر بپذیرید.

سپس، برنامه iOS را در پروژه Firebase خود ثبت کنید.

firebase apps:create --bundle-id com.example.Quickstart ios ios-quickstart

وقتی از شما خواسته شد «شناسه App Store» را مشخص کنید، کلید Enter را فشار دهید تا از این مرحله رد شوید.

firebase apps:sdkconfig ios -o Quickstart/GoogleService-Info.plist

در Xcode، File > Add Files to "Quickstart" (فایل > افزودن فایل به «شروع سریع») را انتخاب کنید و فایل GoogleService-Info.plist را انتخاب کنید.

۳. تعاریف نمونه GraphQL را مرور کنید

در SQL Connect، همه طرح‌واره‌ها و عملیات پایگاه داده‌تان را بااستفاده از GraphQL تعریف می‌کنید. وقتی پروژه‌تان را مقداردهی اولیه کردید، Firebase CLI چند تعریف نمونه برای شروع کار ایجاد کرد.

dataconnect/schema/schema.gql (excerpt)
type Movie @table {
  title: String!
  imageUrl: String!
  genre: String
}

type MovieMetadata @table {
  movie: Movie! @unique
  rating: Float
  releaseYear: Int
  description: String
}
dataconnect/example/queries.gql (excerpt)
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

۴. استقرار طرح‌واره‌ها و عملیات

هرگاه در طرح‌واره‌ها، پُرسمان‌ها، یا جهش‌های پایگاه داده‌تان تغییری ایجاد می‌کنید، باید آن‌ها را مستقر کنید تا تغییراتتان در پایگاه داده اعمال شود.

firebase deploy --only dataconnect

۵. پایگاه داده را با داده‌های نمونه‌گیری‌شده تغذیه کنید

این داده‌های اولیه چیزی را دراختیارتان قرار می‌دهد که هنگام آزمایش برنامه نمونه به آن نگاه کنید. توجه داشته باشید که در این مرحله، GraphQL دلخواه را اجرا می‌کنید که برای کارهای اداری مجاز است.

firebase dataconnect:execute dataconnect/seed_data.gql

‫۶. تولید کیت توسعه نرم‌افزار کارخواه iOS

این فرمان از تعاریف GraphQL شما برای تولید کیت توسعه نرم‌افزار مشتری iOS به‌طور خاص برای پایگاه داده شما استفاده می‌کند. از این کتابخانه در برنامه مشتری‌تان برای انجام همه عملیات پایگاه داده استفاده می‌کنید.

با افزودن تعاریف به connector.yaml، می‌توانید برای چندین پلاتفرم کتابخانه تولید کنید، ازجمله Kotlin برای Android، جاوا اسکریپت برای وب، و Flutter.

firebase dataconnect:sdk:generate
کیت توسعه نرم‌افزار iOS خودکار تولیدشده (گزیده)
public class ListMoviesQuery {

  // ...

  @MainActor
  public func execute(
    fetchPolicy: QueryFetchPolicy = .preferCache,
  ) async throws -> OperationResult<ListMoviesQuery.Data> {
    var variables = ListMoviesQuery.Variables()

    let ref = dataConnect.query(
      name: "ListMovies", variables: variables, resultsDataType: ListMoviesQuery.Data.self,
      publisher: .observableMacro)

    let refCast = ref as! QueryRefObservation<ListMoviesQuery.Data, ListMoviesQuery.Variables>
    return try await refCast.execute(fetchPolicy: fetchPolicy)
  }
}

‫۷. افزودن وابستگی‌های Firebase به پروژه Xcode

کتابخانه تولیدشده را بااستفاده از Swift Package Manager به پروژه‌تان اضافه کنید. وقتی کتابخانه تولیدشده را اضافه می‌کنید، این کتابخانه به‌طور گذرا شامل کتابخانه‌های اصلی Firebase و کتابخانه Firebase SQL Connect خواهد بود.

در نوار پیمایش Xcode، فایل > افزودن وابستگی‌های بسته > افزودن محلی را انتخاب کنید و پوشه حاوی کتابخانه تولیدشده، FirebaseDataConnectGenerated/DataConnectGenerated/ را انتخاب کنید. پوشه صحیح حاوی فایلی با نام Package.swift خواهد بود.

‫۸. نوشتن کارخواه iOS نمونه

محتویات Quickstart/QuickstartApp.swift را با این برنامه ساده iOS جایگزین کنید.

توجه داشته باشید که برنامه دسترسی لازم به پایگاه داده را بااستفاده از تابعی از کیت توسعه نرم‌افزار تولیدشده تکمیل می‌کند.

import SwiftUI
import FirebaseCore
import FirebaseDataConnect
import DataConnectGenerated

@main
struct QuickstartApp: App {
  init() {
    FirebaseApp.configure()
  }
  var body: some Scene {
    WindowGroup {
      ListMovieView()
    }
  }
}

struct ListMovieView: View {
  @State private var moviesData: ListMoviesQuery.Data?

  var body: some View {
    VStack {
      ForEach(moviesData?.movies ?? []) { movie in
        Text(movie.title)
      }
    }
    .task {
      let result = try? await DataConnect.exampleConnector
          .listMoviesQuery.execute()
      self.moviesData = result?.data
    }
  }
}

‫۹. برنامه را امتحان کنید

از Xcode، برنامه نمونه را اجرا کنید تا آن را در عمل ببینید.

مراحل بعدی

افزونه SQL Connect VS Code را امتحان کنید

هنگام توسعه با SQL Connect، اکیداً توصیه می‌کنیم از افزونه SQL Connect VS Code استفاده کنید. حتی اگر از Visual Studio Code به‌عنوان محیط توسعه اصلی خود استفاده نمی‌کنید، این افزونه چندین ویژگی ارائه می‌دهد که توسعه طرح‌واره و عملیات را راحت‌تر می‌کند:

  • سرور زبان GraphQL که بررسی نحو و پیشنهادهای تکمیل خودکار مختص SQL Connect را ارائه می‌دهد
  • دکمه‌های CodeLens در خط کد شما که به شما امکان می‌دهد داده‌ها را از فایل‌های تعریف طرح‌واره خود بخوانید و بنویسید و پرسمان‌ها و جهش‌ها را از تعاریف عملیات خود اجرا کنید.
  • کیت‌های توسعه نرم‌افزار تولیدشده‌تان را به‌طور خودکار با تعاریف GraphQL همگام‌سازی کنید.
  • راه‌اندازی شبیه‌ساز محلی ساده شده است.
  • استقرار ساده‌شده برای تولید.

از شبیه‌ساز SQL Connect برای توسعه محلی استفاده کنید

اگرچه این آموزش به شما نشان داد که چگونه طرح‌واره‌ها و عملیات SQL Connect را مستقیماً در محیط تولید مستقر کنید، احتمالاً نمی‌خواهید درحالی‌که به‌طور فعال درحال توسعه برنامه‌تان هستید، تغییراتی در پایگاه داده تولید خود ایجاد کنید. درعوض، شبیه‌ساز SQL Connect را راه‌اندازی کنید و کار توسعه خود را به‌جای محیط تولید، در آن انجام دهید. شبیه‌ساز یک نمونه محلی PGlite راه‌اندازی می‌کند که رفتاری مشابه نمونه زنده PostgreSQL در Cloud SQL دارد.

با نحوه نوشتن طرح‌واره‌ها و عملیات برای برنامه‌تان آشنا شوید

هنگام توسعه برنامه‌ها با SQL Connect، طراحی طرح‌واره‌ها و عملیات شما یکی از اولین و مهم‌ترین وظایف توسعه‌ای است که تکمیل خواهید کرد.

  • ‫Gemini در کنسول Firebase یک ابزار هوش مصنوعی است که می‌تواند طرح‌واره‌های SQL Connect را از شرح زبان طبیعی برنامه شما تولید کند. این ابزار می‌تواند به شما کمک کند خیلی سریع شروع کنید، به‌ویژه اگر قبلاً با پایگاه‌های داده رابطه‌ای کار نکرده باشید.
  • یا می‌توانید طرح‌واره‌ها، پُرسمان‌ها، و جهش‌های پایگاه داده را مستقیماً بااستفاده از GraphQL بنویسید. با راهنمایی‌های موجود در طراحی طرح‌واره‌های SQL Connect شروع کنید، و سپس به صفحه‌های بعدی بروید تا با نحوه نوشتن عملیات آشنا شوید.

با نحوه دریافت به‌روزرسانی‌های هم‌زمان از SQL Connect آشنا شوید

می‌توانید از SQL Connect برای نوشتن برنامه‌های کارخواه استفاده کنید که به تغییر داده‌ها در زمان واقعی واکنش نشان می‌دهند. دریافت به‌روزرسانی‌های هم‌زمان از SQL Connect را ببینید.