Firebase را به پروژه اندروید خود اضافه کنید

پیش‌نیازها

• اندروید استودیو را به آخرین نسخه نصب یا به‌روزرسانی کنید.

• مطمئن شوید که پروژه شما این الزامات را برآورده می‌کند (توجه داشته باشید که برخی از محصولات ممکن است الزامات سختگیرانه‌تری داشته باشند):

  • هدف API سطح ۲۱ (لالی‌پاپ) یا بالاتر
  • از اندروید ۵.۰ یا بالاتر استفاده می‌کند
  • از Jetpack (AndroidX) استفاده می‌کند که شامل برآورده کردن این الزامات نسخه می‌شود:
    • com.android.tools.build:gradle نسخه ۷.۳.۰ یا بالاتر
    • compileSdkVersion ۲۸ یا بالاتر

• یک دستگاه فیزیکی راه‌اندازی کنید یا از یک شبیه‌ساز برای اجرای برنامه خود استفاده کنید.
  توجه داشته باشید که SDK های فایربیس که به سرویس‌های گوگل پلی وابسته هستند، نیاز دارند که دستگاه یا شبیه‌ساز، سرویس‌های گوگل پلی را نصب کرده باشد.

• با استفاده از حساب گوگل خود وارد فایربیس شوید .

اگر از قبل پروژه اندروید ندارید و فقط می‌خواهید یک محصول Firebase را امتحان کنید، می‌توانید یکی از نمونه‌های شروع سریع ما را دانلود کنید.

شما می‌توانید برنامه اندروید خود را با استفاده از یکی از گزینه‌های زیر به Firebase متصل کنید:

• گزینه ۱ : (توصیه می‌شود) از گردش کار تنظیم کنسول Firebase استفاده کنید.
• گزینه ۲ : استفاده از دستیار اندروید استودیو فایربیس (ممکن است به پیکربندی اضافی نیاز داشته باشد).

گزینه ۱ : اضافه کردن فایربیس با استفاده از کنسول Firebase

اضافه کردن Firebase به برنامه شما شامل وظایفی هم در کنسول Firebase و هم در پروژه اندروید باز شما می‌شود (برای مثال، شما فایل‌های پیکربندی Firebase را از کنسول دانلود می‌کنید، سپس آنها را به پروژه اندروید خود منتقل می‌کنید).

مرحله ۱ : ایجاد یک پروژه Firebase

قبل از اینکه بتوانید Firebase را به برنامه اندروید خود اضافه کنید، باید یک پروژه Firebase ایجاد کنید تا به برنامه اندروید شما متصل شود. برای کسب اطلاعات بیشتر در مورد پروژه‌های Firebase، به بخش «درک پروژه‌های Firebase» مراجعه کنید.

مرحله ۲ : برنامه خود را در Firebase ثبت کنید

برای استفاده از فایربیس در برنامه اندروید خود، باید برنامه خود را در پروژه فایربیس خود ثبت کنید. ثبت برنامه اغلب "افزودن" برنامه به پروژه شما نامیده می‌شود.

1. به کنسول Firebase بروید.

2. در مرکز صفحه نمای کلی پروژه، روی آیکون اندروید ( plat_android ) یا افزودن برنامه کلیک کنید تا گردش کار راه‌اندازی شود.

3. نام بسته برنامه خود را در فیلد نام بسته اندروید وارد کنید.

   نام بسته چیست و از کجا می‌توان آن را پیدا کرد؟

   • نام بسته، برنامه شما را به طور منحصر به فرد در دستگاه و فروشگاه گوگل پلی مشخص می‌کند.

   • نام بسته اغلب به عنوان شناسه برنامه (Application ID) شناخته می‌شود.

   • نام بسته برنامه خود را در فایل Gradle ماژول (سطح برنامه) خود، که معمولاً app/build.gradle است، پیدا کنید (به عنوان مثال نام بسته: com.yourcompany.yourproject ).

   • توجه داشته باشید که مقدار نام بسته به حروف بزرگ و کوچک حساس است و پس از ثبت برنامه اندروید Firebase در پروژه Firebase شما، نمی‌توان آن را برای این برنامه تغییر داد.

4. (اختیاری) یک نام مستعار برنامه وارد کنید، که یک شناسه داخلی و راحت است که فقط در کنسول Firebase برای شما قابل مشاهده است.

5. روی ثبت برنامه کلیک کنید.

مرحله 3 : یک فایل پیکربندی Firebase اضافه کنید

1. فایل پیکربندی فایربیس برنامه خود ( google-services.json ) را دانلود و سپس به کدبیس خود اضافه کنید:

   1. برای دریافت فایل پیکربندی Firebase برنامه خود، روی «دانلود google-services.json» کلیک کنید.

   2. فایل پیکربندی خود را به دایرکتوری ریشه ماژول (سطح برنامه) برنامه خود منتقل کنید.

   چه چیزهایی در مورد این فایل پیکربندی باید بدانید؟

   • فایل پیکربندی Firebase حاوی شناسه‌های منحصر به فرد اما غیر محرمانه برای پروژه و برنامه شما است. برای کسب اطلاعات بیشتر در مورد این فایل پیکربندی، به بخش «درک پروژه‌های Firebase» مراجعه کنید.

   • شما می‌توانید فایل پیکربندی Firebase خود را در هر زمانی دوباره دانلود کنید.

   • مطمئن شوید که نام فایل پیکربندی با کاراکترهای اضافی مانند (2) ضمیمه نشده باشد.

2. برای اینکه مقادیر موجود در فایل پیکربندی google-services.json شما برای SDK های Firebase قابل دسترسی باشند، به افزونه Gradle مربوط به سرویس‌های گوگل ( google-services ) نیاز دارید.

   1. در فایل Gradle سطح ریشه (سطح پروژه) خود ( <project>/build.gradle.kts یا <project>/build.gradle )، افزونه سرویس‌های گوگل را به عنوان یک وابستگی اضافه کنید:

      Kotlin

      plugins {
        id("com.android.application") version "7.3.0" apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id("com.google.gms.google-services") version "4.4.4" apply false
      }

      Groovy

      plugins {
        id 'com.android.application' version '7.3.0' apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id 'com.google.gms.google-services' version '4.4.4' apply false
      }

   2. در فایل Gradle ماژول (سطح برنامه) خود (معمولاً <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle )، افزونه سرویس‌های گوگل را اضافه کنید:

      Kotlin

      plugins {
        id("com.android.application")
      
        // Add the Google services Gradle plugin
        id("com.google.gms.google-services")
        // ...
      }

      Groovy

      plugins {
        id 'com.android.application'
      
        // Add the Google services Gradle plugin
        id 'com.google.gms.google-services'
        // ...
      }

مرحله ۴ : اضافه کردن SDK های فایربیس به برنامه شما

1. در فایل Gradle ماژول (سطح برنامه) خود (معمولاً <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle )، وابستگی‌های محصولات Firebase را که می‌خواهید در برنامه خود استفاده کنید، اضافه کنید. توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌بندی کتابخانه استفاده کنید.

   Analytics فعال شد

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:34.4.0"))
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Add the dependency for the Firebase SDK for Google Analytics
     implementation("com.google.firebase:firebase-analytics")
   
     // TODO: Add the dependencies for any other Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation("com.google.firebase:firebase-auth")
     implementation("com.google.firebase:firebase-firestore")
   }

   با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخه‌های سازگار کتابخانه‌های اندروید Firebase استفاده خواهد کرد.

   Analytics فعال نیست

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:34.4.0"))
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // TODO: Add the dependencies for Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation("com.google.firebase:firebase-auth")
     implementation("com.google.firebase:firebase-firestore")
   }

   با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخه‌های سازگار کتابخانه‌های اندروید Firebase استفاده خواهد کرد.

2. پس از افزودن وابستگی‌ها برای محصولاتی که می‌خواهید استفاده کنید، پروژه اندروید خود را با فایل‌های Gradle همگام‌سازی کنید.

   آیا در مورد پشتیبانی از invoke-custom و فعال کردن desugaring با خطای ساخت مواجه می‌شوید؟ در اینجا نحوه رفع آن آمده است.

   نسخه‌های Gradle که از افزونه Android Gradle (AGP) نسخه ۴.۲ یا قدیمی‌تر استفاده می‌کنند، باید پشتیبانی از Java 8 را فعال کنند. در غیر این صورت، این پروژه‌های اندروید هنگام اضافه کردن Firebase SDK با خطای build مواجه می‌شوند.

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

   • compileOptions ذکر شده از پیام خطا را به فایل build.gradle.kts یا build.gradle در سطح برنامه خود اضافه کنید.
   • مقدار minSdk برای پروژه اندروید خود به ۲۶ یا بالاتر افزایش دهید.

   در این سوالات متداول درباره این شکست ساخت بیشتر بدانید.

همین! می‌توانید برای بررسی مراحل پیشنهادی بعدی، به ادامه مطلب بروید.

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

گزینه ۲ : اضافه کردن فایربیس با استفاده از دستیار فایربیس

دستیار فایربیس، برنامه شما را در یک پروژه فایربیس ثبت می‌کند و فایل‌ها، افزونه‌ها و وابستگی‌های لازم فایربیس را به پروژه اندروید شما اضافه می‌کند - همه اینها از داخل اندروید استودیو!

1. پروژه اندروید خود را در اندروید استودیو باز کنید، سپس مطمئن شوید که از آخرین نسخه‌های اندروید استودیو و دستیار فایربیس استفاده می‌کنید:

   • ویندوز / لینوکس: راهنما > بررسی به‌روزرسانی‌ها
   • macOS: اندروید استودیو > بررسی به‌روزرسانی‌ها

2. دستیار فایربیس را باز کنید: ابزارها > فایربیس .

3. در پنل دستیار ، یک محصول Firebase را برای افزودن به برنامه خود انتخاب کنید. بخش آن را گسترش دهید، سپس روی لینک آموزش کلیک کنید (برای مثال، Analytics > ثبت یک رویداد تجزیه و تحلیل ).

   1. برای اتصال پروژه اندروید خود به فایربیس، روی گزینه Connect to Firebase کلیک کنید.

      این گردش کار چه کاری انجام می‌دهد؟

      • این گردش کار به طور خودکار یک برنامه اندروید Firebase جدید با استفاده از نام بسته برنامه شما ایجاد می‌کند. می‌توانید این برنامه اندروید Firebase جدید را در یک پروژه Firebase موجود یا یک پروژه جدید ایجاد کنید.

        در اینجا چند نکته در مورد راه‌اندازی پروژه Firebase شما آورده شده است:

        • بهترین شیوه‌های ما برای افزودن برنامه‌ها به یک پروژه Firebase، از جمله نحوه مدیریت چندین نوع برنامه را بررسی کنید.

        • اگر یک پروژه جدید ایجاد می‌کنید، اکیداً توصیه می‌کنیم که Google Analytics برای پروژه خود تنظیم کنید، که به شما امکان می‌دهد با استفاده از بسیاری از محصولات Firebase تجربه بهینه‌ای داشته باشید.

      • این گردش کار همچنین فایل پیکربندی اندروید پروژه Firebase شما ( google-services.json ) را به دایرکتوری module (app-level) برنامه شما اضافه می‌کند.

   2. برای افزودن یک محصول Firebase دلخواه (مثلاً افزودن Analytics به برنامه‌تان ) روی دکمه کلیک کنید.

4. برنامه خود را همگام‌سازی کنید تا مطمئن شوید که همه وابستگی‌ها نسخه‌های لازم را دارند.

5. در پنل دستیار ، دستورالعمل‌های باقی‌مانده برای تنظیم محصول Firebase انتخابی خود را دنبال کنید.

6. هر تعداد محصول Firebase که می‌خواهید از طریق دستیار Firebase اضافه کنید!

همین! حتماً مراحل بعدی توصیه شده را بررسی کنید.

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

کتابخانه‌های موجود

این بخش محصولات Firebase پشتیبانی شده برای اندروید و وابستگی‌های Gradle آنها را فهرست می‌کند. درباره این کتابخانه‌های اندروید Firebase بیشتر بدانید:

• مستندات مرجع ( کاتلین | جاوا )

• مخزن گیت‌هاب فایربیس اندروید SDK

توجه داشته باشید که هنگام استفاده از Firebase Android BoM ، هنگام اعلام وابستگی‌های کتابخانه Firebase در فایل پیکربندی Gradle build خود، نسخه‌های کتابخانه‌های جداگانه را مشخص نمی‌کنید.

^{منطق هوش مصنوعی فایربیس قبلاً با بسته‌ی com.google.firebase:firebase-vertexai « هوش مصنوعی ورتکس در فایربیس » نامیده می‌شد.}

مراحل بعدی

سرویس‌های فایربیس را به برنامه خود اضافه کنید:

• با استفاده از منطق هوش مصنوعی فایربیس، ویژگی‌های هوش مصنوعی مولد را با مدل‌های Gemini و Imagen بسازید.

• با استفاده Analytics بینشی در مورد رفتار کاربر به دست آورید.

• یک جریان احراز هویت کاربر با Authentication تنظیم کنید.

• داده‌ها، مانند اطلاعات کاربر، را با Cloud Firestore یا Realtime Database ذخیره کنید.

• فایل‌هایی مانند عکس‌ها و ویدیوها را با Cloud Storage ذخیره کنید.

• کد بک‌اند را فعال کنید که در یک محیط امن با Cloud Functions اجرا می‌شود.

• ارسال اعلان‌ها با Cloud Messaging

• با Crashlytics بفهمید چه زمانی و چرا برنامه‌تان از کار می‌افتد.

آشنایی با فایربیس:

• برای کسب اطلاعات بیشتر در مورد پروژه‌های فایربیس و بهترین شیوه‌های انجام پروژه‌ها، به بخش «درک پروژه‌های فایربیس» مراجعه کنید.

• اگر در مورد مفاهیمی که ناآشنا هستند یا مختص توسعه Firebase و اندروید هستند سؤالی دارید ، به بخش «درباره اندروید و Firebase بیشتر بدانید» مراجعه کنید.

• نمونه‌هایی از برنامه‌های Firebase را بررسی کنید.

• با Firebase Android Codelab تجربه عملی کسب کنید.

• در یک دوره آخر هفته، با Firebase بیشتر آشنا شوید.

• برای راه‌اندازی برنامه خود آماده شوید:

  • هشدارهای بودجه را برای پروژه خود در کنسول Google Cloud تنظیم کنید.
  • داشبورد «مصرف و پرداخت» را در کنسول Firebase رصد کنید تا تصویری کلی از میزان مصرف پروژه خود در چندین سرویس فایربیس داشته باشید.
  • چک لیست راه اندازی Firebase را مرور کنید.

• آیا با فایربیس و پروژه اندروید خود مشکل دارید؟ از بخش عیب‌یابی و سوالات متداول اندروید دیدن کنید.