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 ( plat_android ) یا افزودن برنامه کلیک کنید تا گردش کار راه اندازی راه اندازی شود.

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

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

   • نام بسته به طور منحصر به فرد برنامه شما را در دستگاه و در فروشگاه Google Play شناسایی می کند.

   • نام بسته اغلب به عنوان شناسه برنامه شناخته می شود.

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

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

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

   نام مستعار برنامه و گواهی امضای اشکال زدایی SHA-1 چگونه در Firebase استفاده می شود؟

   • نام مستعار برنامه : یک شناسه داخلی و راحت که فقط برای شما در کنسول Firebase قابل مشاهده است

   • گواهی امضای اشکال زدایی SHA-1 : یک هش SHA-1 توسط Firebase Authentication (هنگام استفاده از ورود به سیستم Google یا ورود به شماره تلفن ) و Firebase Dynamic Links لازم است.

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

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

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

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

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

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

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

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

   • مطمئن شوید که نام فایل پیکربندی با کاراکترهای اضافی مانند (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.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 Android استفاده می‌کند.

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

   Analytics فعال نیست

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

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

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

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

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

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

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

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

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

اگر برای راه‌اندازی مشکل دارید، به عیب‌یابی و سؤالات متداول 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 کلیک کنید.

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

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

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

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

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

      • این گردش کار همچنین فایل پیکربندی Android پروژه Firebase شما ( google-services.json ) را به فهرست ماژول (سطح برنامه) برنامه شما اضافه می کند.

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

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

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

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

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

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

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

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

• مستندات مرجع ( Kotlin+KTX | جاوا )

• Firebase Android SDK GitHub مخزن

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

مراحل بعدی

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

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

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

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

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

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

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

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

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

• برای کسب اطلاعات بیشتر درباره پروژه‌های Firebase و بهترین روش‌ها برای پروژه‌ها، از Understand Firebase Projects دیدن کنید.

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

• نمونه برنامه های Firebase را کاوش کنید.

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

• با Firebase در دوره آخر هفته بیشتر بیاموزید.

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

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

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