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

پیش نیازها

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

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

    • سطح 21 API (Lollipop) یا بالاتر را هدف قرار می دهد
    • از اندروید 5.0 یا بالاتر استفاده می کند
    • از Jetpack (AndroidX) استفاده می‌کند، که شامل برآورده کردن الزامات نسخه است:
      • com.android.tools.build:gradle v7.3.0 یا جدیدتر
      • compileSdkVersion 28 یا بالاتر

  • یک دستگاه فیزیکی راه اندازی کنید یا از یک شبیه ساز برای اجرای برنامه خود استفاده کنید.
    توجه داشته باشید که Firebase SDK با وابستگی به خدمات Google Play به دستگاه یا شبیه ساز نیاز دارد که سرویس های Google Play را نصب کرده باشد.

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

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


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

  • گزینه 1 : (توصیه می شود) از گردش کار راه اندازی کنسول Firebase استفاده کنید.
  • گزینه 2 : از Android Studio Firebase Assistant استفاده کنید (ممکن است نیاز به پیکربندی اضافی داشته باشد).


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

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

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

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

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

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

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

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

  3. نام بسته برنامه خود را در قسمت نام بسته Android وارد کنید.

  4. (اختیاری) اطلاعات دیگر برنامه را وارد کنید: نام مستعار برنامه و گواهی امضای اشکال زدایی SHA-1 .

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

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

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

    1. برای دریافت فایل پیکربندی Android Firebase خود، روی Download google-services.json کلیک کنید.

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

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

    1. در فایل Gradle سطح ریشه (سطح پروژه) خود ( <project>/build.gradle.kts یا <project>/build.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.4.2" 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.2' apply false
}

    2. در فایل Gradle ماژول (سطح برنامه) خود (معمولا <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.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'
  // ...
}

مرحله 4 : SDK های 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:33.7.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 استفاده می‌کند.

    به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

    Analytics فعال نیست 

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:33.7.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 استفاده می‌کند.

    به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

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

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

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


گزینه 2 : Firebase را با استفاده از Firebase Assistant اضافه کنید

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

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

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

  2. دستیار Firebase را باز کنید: Tools > Firebase .

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

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

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

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

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

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

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

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


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

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

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

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

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

 33.7.0
AdMob com.google.android.gms:play-services-ads 23.6.0
Analytics com.google.firebase:firebase-analytics 22.1.2
ارائه دهنده سفارشی App Check com.google.firebase:firebase-appcheck 18.0.0
ارائه دهنده رفع اشکال App Check com.google.firebase:firebase-appcheck-debug 18.0.0
App Check Play Integrity ارائه دهنده com.google.firebase:firebase-appcheck-playintegrity 18.0.0
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta14
API App Distribution com.google.firebase:firebase-appdistribution-api 16.0.0-beta14
پلاگین App Distribution com.google.firebase:firebase-appdistribution-gradle 5.0.0
Authentication com.google.firebase:firebase-auth 23.1.0
Cloud Firestore com.google.firebase:firebase-firestore 25.1.1
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions 21.1.0
Cloud Messaging com.google.firebase:firebase-messaging 24.1.0
Cloud Storage com.google.firebase:firebase-storage 21.0.1
Crashlytics com.google.firebase:firebase-crashlytics 19.3.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.3.0
پلاگین Crashlytics com.google.firebase:firebase-crashlytics-gradle 3.0.2
پشتیبانی از ماژول ویژگی پویا com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging 21.0.1
(الزامی)
نمایش In-App Messaging com.google.firebase:firebase-inappmessaging-display 21.0.1
(الزامی)
تاسیسات Firebase com.google.firebase:firebase-installations 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader 25.0.1
Performance Monitoring com.google.firebase:firebase-perf 21.0.3
افزونه Performance Monitoring com.google.firebase:perf-plugin 1.4.2
Realtime Database com.google.firebase:firebase-database 21.0.0
Remote Config com.google.firebase:firebase-config 22.0.1
Vertex AI in Firebase com.google.firebase:firebase-vertexai 16.0.2
افزونه خدمات گوگل پلی com.google.gms:google-services 4.4.2
کتابخانه های منسوخ شده
ارائه دهنده SafetyNet را App Check com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing 20.0.0

ماژول های Firebase KTX

Analytics com.google.firebase:firebase-analytics-ktx 22.1.2
ارائه دهنده سفارشی App Check com.google.firebase:firebase-appcheck-ktx 18.0.0
API App Distribution com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta14
Authentication com.google.firebase:firebase-auth-ktx 23.1.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.1
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.1.0
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.1.0
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.1
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.3.0
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.1
(الزامی)
نمایش In-App Messaging com.google.firebase:firebase-inappmessaging-display-ktx 21.0.1
(الزامی)
تاسیسات Firebase com.google.firebase:firebase-installations-ktx 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.1
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.3
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0
Remote Config com.google.firebase:firebase-config-ktx 22.0.1

کتابخانه های Firebase ML Kit

APIهای مدل سفارشی Firebase ML com.google.firebase:firebase-ml-model-interpreter 22.0.4
API های Firebase ML Vision com.google.firebase:firebase-ml-vision 24.1.0
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 16.1.2
Firebase ML : AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML : API های زبان طبیعی com.google.firebase:firebase-ml-natural-language 22.0.1
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 20.0.9
Firebase ML : مدل پاسخ هوشمند com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8


مراحل بعدی

خدمات Firebase را به برنامه خود اضافه کنید:

  • با Analytics در مورد رفتار کاربر اطلاعاتی کسب کنید.

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

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

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

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

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

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

درباره Firebase بیاموزید: