افزودن Firebase به پروژه Android

پیش‌نیازها

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

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

    • سطح میانای برنامه‌سازی کاربردی هدف ۲۴ (Nougat) یا بالاتر
    • از Android نسخه ۷.۰ یا بالاتر استفاده کند
    • از Jetpack (AndroidX) استفاده می‌کند، که شامل برآورده کردن این الزامات نسخه است:
      • com.android.tools.build:gradle نسخه ۷.۳.۰ یا بالاتر
      • ‫compileSdkVersion نسخه ۲۸ یا جدیدتر
  • دستگاهی فیزیکی راه‌اندازی کنید یا از شبیه‌ساز برای اجرای برنامه‌تان استفاده کنید.
    توجه داشته باشید که کیت‌های توسعه نرم‌افزار Firebase با وابستگی به Google Play services نیاز دارند که دستگاه یا شبیه‌ساز Google Play services را نصب کرده باشد.

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


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

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



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

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

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

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

مرحله ۲: ثبت برنامه در Firebase

برای استفاده از Firebase در برنامه Android، باید برنامه‌تان را در پروژه Firebase ثبت کنید. ثبت کردن برنامه اغلب «افزودن» برنامه به پروژه نامیده می‌شود.

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

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

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

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

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

مرحله ۳: افزودن فایل پیکربندی Firebase

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

    1. روی بارگیری google-services.json کلیک کنید تا فایل پیکربندی Firebase برنامه‌تان را دریافت کنید.

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

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

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

      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.6.0" 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.6.0' apply false
      }
    2. در فایل Gradle واحد (سطح برنامه) (معمولاً <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle)، افزایه Gradle سرویس‌های Google را اضافه کنید:

      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'
        // ...
      }

مرحله ۴: افزودن کیت‌های توسعه نرم‌افزار Firebase به برنامه

  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:35.2.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 Android استفاده خواهد کرد.

    ‫Analytics فعال نیست

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation(platform("com.google.firebase:firebase-bom:35.2.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 Android استفاده خواهد کرد.

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

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

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



گزینه ۲: افزودن Firebase بااستفاده از «دستیار Firebase»

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

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

    • Windows / Linux: راهنما > بررسی به‌روزرسانی‌ها
    • macOS: Android Studio > Check for updates (استودیو Android > بررسی به‌روزرسانی‌ها)
  2. «دستیار Firebase» را باز کنید: ابزارها > Firebase.

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

    1. روی اتصال به Firebase کلیک کنید تا پروژه Android خود را به Firebase متصل کنید.

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

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

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

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

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

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



کتابخانه‌های دردسترس

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

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

خدمات یا محصول وابستگی Gradle جدیدترین
نسخه
Analytics اضافه شود؟
Firebase Android BoM
(Bill of Materials)
com.google.firebase:firebase-bom

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

‫۳۵.۲.۰
افزونه Gradle خدمات Google com.google.gms:google-services ‫۴.۶.۰
AdMob com.google.android.gms:play-services-ads ‫۲۵.۵.۰
Firebase AI Logic ۱ com.google.firebase:firebase-ai 18.2.0
Firebase AI Logic On-Device com.google.firebase:firebase-ai-ondevice 16.0.0-beta08
Firebase AI KSP com.google.firebase:firebase-ai-ksp-processor 17.0.0
Analytics com.google.firebase:firebase-analytics 24.0.0
App Check ارائه‌دهنده سفارشی com.google.firebase:firebase-appcheck 20.1.0
ارائه‌کننده اشکال‌زدایی App Check com.google.firebase:firebase-appcheck-debug 20.1.0
App Check ارائه‌دهنده Play Integrity com.google.firebase:firebase-appcheck-playintegrity 20.1.0
App Check ارائه‌دهنده reCAPTCHA com.google.firebase:firebase-appcheck-recaptcha 20.1.0
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta21
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta21
افزونه App Distribution com.google.firebase:firebase-appdistribution-gradle 5.3.1
Authentication com.google.firebase:firebase-auth ‫۲۵.۰.۰
Cloud Firestore com.google.firebase:firebase-firestore ‫۲۷.۲.۰
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions ‫۲۳.۰.۰
Cloud Messaging com.google.firebase:firebase-messaging 26.0.2
Cloud Storage com.google.firebase:firebase-storage ‫۲۳.۰.۰
Crashlytics com.google.firebase:firebase-crashlytics 21.1.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 21.1.0
افزونه Crashlytics com.google.firebase:firebase-crashlytics-gradle ‫۳.۰.۸
پشتیبانی از واحد ویژگی پویا com.google.firebase:firebase-dynamic-module-support 16.0.0-beta05
In-App Messaging com.google.firebase:firebase-inappmessaging ‫۲۳.۰.۰
(الزامی)
نمایشگر In-App Messaging com.google.firebase:firebase-inappmessaging-display ‫۲۳.۰.۰
(الزامی)
Firebase نصب com.google.firebase:firebase-installations ‫۲۰.۰.۰
Performance Monitoring com.google.firebase:firebase-perf ‫۲۳.۰.۱
افزونه Performance Monitoring com.google.firebase:perf-plugin ‫۲.۰.۲
Firebase Phone Number Verification com.google.firebase:firebase-pnv 17.0.0
Realtime Database com.google.firebase:firebase-database ‫۲۳.۰.۰
Remote Config com.google.firebase:firebase-config ‫۲۴.۰.۱
SQL Connect ۲ com.google.firebase:firebase-dataconnect ‫۱۸.۰.۱
کتابخانه‌های منسوخ‌شده یا پشتیبانی‌نشده
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0

ماژول‌های Firebase KTX - دیگر پشتیبانی نمی‌شود

Analytics استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-analytics-ktx
22.5.0
App Check ارائه‌دهنده سفارشی استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-appcheck-ktx
18.0.0
App Distribution API استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-appdistribution-api-ktx
16.0.0-beta15
Authentication استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-auth-ktx
‫۲۳.۲.۱
Cloud Firestore استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-firestore-ktx
‫۲۵.۱.۴
Cloud Functions for Firebase Client SDK استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-functions-ktx
‫۲۱.۲.۱
Cloud Messaging استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-messaging-ktx
‫۲۴.۱.۲
Cloud Storage استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-storage-ktx
‫۲۱.۰.۲
Crashlytics استفاده نکنید؛ کتابخانه‌های پودمان KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-crashlytics-ktx
‫۱۹.۴.۴
Dynamic Links استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-dynamic-links-ktx
22.1.0
In-App Messaging استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-inappmessaging-ktx
‫۲۱.۰.۲
(الزامی)
نمایشگر In-App Messaging استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-inappmessaging-display-ktx
‫۲۱.۰.۲
(الزامی)
Firebase نصب استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-installations-ktx
18.0.0
Firebase ML Model Downloader API استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-ml-modeldownloader-ktx
‫۲۵.۰.۱
Performance Monitoring استفاده نکنید؛ کتابخانه‌های پودمان KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-perf-ktx
21.0.5
Realtime Database استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-database-ktx
21.0.0
Remote Config استفاده نکنید؛ کتابخانه‌های ماژول KTX دیگر پشتیبانی نمی‌شوند.
com.google.firebase:firebase-config-ktx
‫۲۲.۱.۲

کتابخانه‌های Firebase ML و کیت Firebase ML

Firebase ML Custom Model APIs com.google.firebase:firebase-ml-model-interpreter ‫۲۲.۰.۴
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader ‫۲۶.۱.۱
Firebase ML Vision APIs com.google.firebase:firebase-ml-vision ‫۲۴.۱.۰
Firebase ML: مدل برچسب‌گذاری تصویر com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML: مدل تشخیص و ردیابی اشیا com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6
Firebase ML: مدل تشخیص چهره com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML: مدل اسکن رمزینه com.google.firebase:firebase-ml-vision-barcode-model ‫۱۶.۱.۲
Firebase ML: AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl ‫۱۸.۰.۶
Firebase ML: Natural Language APIs com.google.firebase:firebase-ml-natural-language ‫۲۲.۰.۱
Firebase ML: مدل شناسایی زبان com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase ML: Translate Model com.google.firebase:firebase-ml-natural-language-translate-model ‫۲۰.۰.۹
Firebase ML: مدل پاسخ هوشمند com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8

۱ Firebase AI Logic قبلاً «Vertex AI in Firebase» با بسته com.google.firebase:firebase-vertexai نامیده می‌شد.

۲ Firebase SQL Connect قبلاً «Firebase Data Connect» نام داشت.



مراحل بعدی

افزودن سرویس‌های Firebase به برنامه:

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

  • با Analytics، اطلاعات آماری درباره رفتار کاربر به‌دست آورید.

  • راه‌اندازی جریان اصالت‌سنجی کاربر با Authentication.

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

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

  • کد پس‌زمینه را که در محیطی امن اجرا می‌شود با Cloud Functions راه‌اندازی کنید.

  • ارسال اعلان با Cloud Messaging.

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

آشنایی با Firebase: