เพิ่ม Firebase ลงในโปรเจ็กต์ Android

ข้อกำหนดเบื้องต้น

  • ติดตั้งหรืออัปเดต Android Studio เป็นเวอร์ชันล่าสุด

  • ตรวจสอบว่าโปรเจ็กต์เป็นไปตามข้อกำหนดเหล่านี้ (โปรดทราบว่าผลิตภัณฑ์บางอย่าง อาจมีข้อกำหนดที่เข้มงวดกว่า)

    • กำหนดเป้าหมาย API ระดับ 21 (Lollipop) ขึ้นไป
    • ใช้ Android 5.0 ขึ้นไป
    • ใช้ Jetpack (AndroidX) ซึ่งรวมถึงการปฏิบัติตามข้อกำหนดด้านเวอร์ชันต่อไปนี้
      • com.android.tools.build:gradle v7.3.0 ขึ้นไป
      • compileSdkVersion 28 ขึ้นไป

  • ตั้งค่าอุปกรณ์จริงหรือใช้โปรแกรมจำลองเพื่อ เรียกใช้แอป
    โปรดทราบว่า Firebase SDK ที่มี การอ้างอิงบริการ Google Play กำหนดให้ อุปกรณ์หรือโปรแกรมจำลองต้องติดตั้งบริการ Google Play

  • ลงชื่อเข้าใช้ Firebase ด้วยบัญชี Google

หากยังไม่มีโปรเจ็กต์ Android และเพียงต้องการลองใช้ผลิตภัณฑ์ Firebase คุณสามารถดาวน์โหลดตัวอย่างการเริ่มต้นใช้งานอย่างรวดเร็วของเราได้


คุณเชื่อมต่อแอป Android กับ Firebase ได้โดยใช้ตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้


ตัวเลือกที่ 1: เพิ่ม Firebase โดยใช้คอนโซล Firebase

การเพิ่ม Firebase ลงในแอปเกี่ยวข้องกับงานทั้งในคอนโซล Firebase และในโปรเจ็กต์ Android ที่เปิดอยู่ (เช่น คุณดาวน์โหลดไฟล์กำหนดค่า Firebase จากคอนโซล แล้วย้ายไปยังโปรเจ็กต์ Android)

ขั้นตอนที่ 1: สร้างโปรเจ็กต์ Firebase

ก่อนที่จะเพิ่ม Firebase ลงในแอป Android ได้ คุณต้องสร้างโปรเจ็กต์ Firebase เพื่อเชื่อมต่อกับแอป Android โปรดไปที่ทำความเข้าใจโปรเจ็กต์ Firebase เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับโปรเจ็กต์ Firebase

ขั้นตอนที่ 2: ลงทะเบียนแอปกับ Firebase

หากต้องการใช้ Firebase ในแอป Android คุณต้องลงทะเบียนแอปกับโปรเจ็กต์ Firebase การลงทะเบียนแอปมักเรียกว่า "การเพิ่ม" แอปไปยังโปรเจ็กต์

  1. ไปที่คอนโซล Firebase

  2. ที่กึ่งกลางหน้าภาพรวมโปรเจ็กต์ ให้คลิกไอคอน Android () หรือเพิ่มแอปเพื่อเปิดเวิร์กโฟลว์การตั้งค่า

  3. ป้อนชื่อแพ็กเกจของแอปในช่องชื่อแพ็กเกจ Android

  4. (ไม่บังคับ) ป้อนข้อมูลแอปอื่นๆ ดังนี้ ชื่อเล่นของแอปและ SHA-1 ของใบรับรองการลงนามสำหรับแก้ไขข้อบกพร่อง

  5. คลิกลงทะเบียนแอป

ขั้นตอนที่ 3: เพิ่มไฟล์กำหนดค่า Firebase

  1. ดาวน์โหลดแล้วเพิ่มไฟล์กำหนดค่า Firebase ของแอป (google-services.json) ลงในโค้ดเบส

    1. คลิกดาวน์โหลด google-services.json เพื่อรับไฟล์กำหนดค่า Firebase ของแอป

    2. ย้ายไฟล์การกำหนดค่าไปยังไดเรกทอรีรากของโมดูล (ระดับแอป) ของ แอป

  2. หากต้องการให้ SDK ของ Firebase เข้าถึงค่าในgoogle-services.jsonไฟล์กำหนดค่า ได้ คุณต้องมี ปลั๊กอิน Gradle ของบริการของ Google (google-services)

    1. ในไฟล์ Gradle ระดับรูท (ระดับโปรเจ็กต์) (<project>/build.gradle.kts หรือ <project>/build.gradle) ให้เพิ่ม ปลั๊กอินบริการของ Google เป็นทรัพยากร Dependency ดังนี้

      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.3" 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.3' 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: เพิ่ม Firebase SDK ลงในแอป

  1. ในไฟล์ Gradle ระดับโมดูล (ระดับแอป) (โดยปกติคือ <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) ให้เพิ่มทรัพยากร Dependency สำหรับผลิตภัณฑ์ Firebase ที่ต้องการใช้ในแอป เราขอแนะนำให้ใช้ Firebase Android BoM เพื่อควบคุมการกำหนดเวอร์ชันของไลบรารี

    เปิดใช้ Analytics รายการ 

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:34.0.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:34.0.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. หลังจากเพิ่มทรัพยากร Dependency สำหรับผลิตภัณฑ์ที่ต้องการใช้แล้ว ให้ซิงค์โปรเจ็กต์ Android กับไฟล์ Gradle

เพียงเท่านี้ก็เสร็จแล้ว! คุณข้ามไปดูขั้นตอนถัดไปที่แนะนำได้

หากพบปัญหาในการตั้งค่า โปรดไปที่การแก้ปัญหาและคำถามที่พบบ่อยเกี่ยวกับ Android


ตัวเลือกที่ 2: เพิ่ม Firebase โดยใช้ Firebase Assistant

ผู้ช่วย Firebase จะลงทะเบียน แอปของคุณกับโปรเจ็กต์ Firebase และเพิ่มไฟล์ ปลั๊กอิน และทรัพยากร Dependency ของ Firebase ที่จำเป็นลงในโปรเจ็กต์ Android ทั้งหมดนี้ทำได้จากภายใน Android Studio

  1. เปิดโปรเจ็กต์ Android ใน Android Studio แล้วตรวจสอบว่าคุณ ใช้ Android Studio และ Firebase Assistant เวอร์ชันล่าสุด

    • Windows / Linux: ความช่วยเหลือ > ตรวจหาการอัปเดต
    • macOS: Android Studio > ตรวจหาการอัปเดต

  2. เปิด Firebase Assistant: เครื่องมือ > Firebase

  3. ในแผงผู้ช่วย ให้เลือกผลิตภัณฑ์ Firebase ที่จะเพิ่มลงในแอป ขยายส่วนของผลิตภัณฑ์ แล้วคลิกลิงก์บทแนะนำ (เช่น Analytics > บันทึกเหตุการณ์ Analytics)

    1. คลิกเชื่อมต่อกับ Firebase เพื่อเชื่อมต่อโปรเจ็กต์ Android กับ Firebase

    2. คลิกปุ่มเพื่อเพิ่มผลิตภัณฑ์ Firebase ที่ต้องการ (เช่น เพิ่ม Analytics ลงในแอป)

  4. ซิงค์แอปเพื่อให้ทรัพยากร Dependency ทั้งหมดมีเวอร์ชันที่จำเป็น

  5. ในแผงผู้ช่วย ให้ทำตามวิธีการตั้งค่าที่เหลือสำหรับ ผลิตภัณฑ์ Firebase ที่เลือก

  6. เพิ่มผลิตภัณฑ์อื่นๆ ของ Firebase ได้มากเท่าที่ต้องการผ่าน Firebase Assistant

เพียงเท่านี้ก็เสร็จแล้ว! อย่าลืมดูขั้นตอนถัดไปที่แนะนำ

หากพบปัญหาในการตั้งค่า โปรดไปที่การแก้ปัญหาและคำถามที่พบบ่อยเกี่ยวกับ Android


ไลบรารีที่ใช้ได้

ส่วนนี้แสดงผลิตภัณฑ์ Firebase ที่รองรับสำหรับ Android และการอ้างอิง Gradle ของผลิตภัณฑ์เหล่านั้น ดูข้อมูลเพิ่มเติมเกี่ยวกับไลบรารี Firebase Android เหล่านี้

โปรดทราบว่าเมื่อใช้ Firebase Android BoM คุณจะไม่ต้องระบุเวอร์ชันของไลบรารีแต่ละรายการเมื่อประกาศทรัพยากร Dependency ของไลบรารี Firebase ในไฟล์การกำหนดค่าการสร้าง Gradle

บริการหรือผลิตภัณฑ์ การขึ้นต่อกันของ Gradle เวอร์ชัน
ล่าสุด		 เพิ่ม Analytics?
Firebase Android BoM
(Bill of Materials)		 com.google.firebase:firebase-bom

Firebase BoM เวอร์ชันล่าสุดมีไลบรารี Android ของ Firebase แต่ละรายการเวอร์ชันล่าสุด หากต้องการทราบว่าเวอร์ชันไลบรารีใด ที่แมปกับ BoM เวอร์ชันใด ให้ดูบันทึกประจำรุ่น สำหรับ BoM เวอร์ชันนั้น

 34.0.0
AdMob com.google.android.gms:play-services-ads 24.4.0
Firebase AI Logic 1 com.google.firebase:firebase-ai 17.0.0
Analytics com.google.firebase:firebase-analytics 23.0.0
App Check ผู้ให้บริการที่กำหนดเอง com.google.firebase:firebase-appcheck 19.0.0
App Check ผู้ให้บริการแก้ไขข้อบกพร่อง com.google.firebase:firebase-appcheck-debug 19.0.0
App Check ผู้ให้บริการ Play Integrity com.google.firebase:firebase-appcheck-playintegrity 19.0.0
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta16
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta16
App Distribution ปลั๊กอิน com.google.firebase:firebase-appdistribution-gradle 5.1.1
Authentication com.google.firebase:firebase-auth 24.0.0
Cloud Firestore com.google.firebase:firebase-firestore 26.0.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions 22.0.0
Cloud Messaging com.google.firebase:firebase-messaging 25.0.0
Cloud Storage com.google.firebase:firebase-storage 22.0.0
Crashlytics com.google.firebase:firebase-crashlytics 20.0.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 20.0.0
Crashlytics ปลั๊กอิน com.google.firebase:firebase-crashlytics-gradle 3.0.5
Data Connect com.google.firebase:firebase-dataconnect 17.0.0
การรองรับโมดูลฟีเจอร์แบบไดนามิก com.google.firebase:firebase-dynamic-module-support 16.0.0-beta04
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging 22.0.0
(ต้องระบุ)
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display 22.0.0
(ต้องระบุ)
Firebase การติดตั้ง com.google.firebase:firebase-installations 19.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader 26.0.0
Performance Monitoring com.google.firebase:firebase-perf 22.0.0
Performance Monitoring ปลั๊กอิน com.google.firebase:perf-plugin 2.0.0
Realtime Database com.google.firebase:firebase-database 22.0.0
Remote Config com.google.firebase:firebase-config 23.0.0
ปลั๊กอินบริการ Google Play com.google.gms:google-services 4.4.3
ไลบรารีที่เลิกใช้งานแล้ว
App Check ผู้ให้บริการ SafetyNet 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.5.0
App Check ผู้ให้บริการที่กำหนดเอง com.google.firebase:firebase-appcheck-ktx 18.0.0
App Distribution API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta15
Authentication com.google.firebase:firebase-auth-ktx 23.2.1
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.4
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.2.1
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.1.2
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.2
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.4.4
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.2
(ต้องระบุ)
In-App Messaging Display com.google.firebase:firebase-inappmessaging-display-ktx 21.0.2
(ต้องระบุ)
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.5
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0
Remote Config com.google.firebase:firebase-config-ktx 22.1.2

ไลบรารี Firebase ML Kit

Firebase ML Custom Model API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML Vision API 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: Natural Language 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: โมเดลการแปล 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

1 Firebase AI Logic เดิมชื่อ "Vertex AI in Firebase" พร้อมแพ็กเกจ com.google.firebase:firebase-vertexai


ขั้นตอนถัดไป

เพิ่มบริการ Firebase ไปยังแอป

  • สร้างฟีเจอร์ Generative AI ด้วยโมเดล Gemini และ Imagen โดยใช้ Firebase AI Logic

  • รับข้อมูลเชิงลึกเกี่ยวกับพฤติกรรมของผู้ใช้ด้วย Analytics

  • ตั้งค่าโฟลว์การตรวจสอบสิทธิ์ของผู้ใช้ด้วย Authentication

  • จัดเก็บข้อมูล เช่น ข้อมูลผู้ใช้ ด้วย Cloud Firestore หรือ Realtime Database

  • จัดเก็บไฟล์ เช่น รูปภาพและวิดีโอ ด้วย Cloud Storage

  • ทริกเกอร์โค้ดแบ็กเอนด์ที่ทำงานในสภาพแวดล้อมที่ปลอดภัยด้วย Cloud Functions

  • ส่งการแจ้งเตือนด้วย Cloud Messaging

  • ดูว่าแอปขัดข้องเมื่อใดและเพราะเหตุใดด้วย Crashlytics

ดูข้อมูลเกี่ยวกับ Firebase