เพิ่ม Firebase ไปยังโปรเจ็กต์ Android

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

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

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

    • กำหนดเป้าหมาย API ระดับ 19 (KitKat) ขึ้นไป
    • ใช้ Android 4.4 ขึ้นไป
    • ใช้ 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 Android (google-services.json) ลงในแอป

    1. คลิก Download google-services.json เพื่อรับไฟล์การกำหนดค่า Firebase Android

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

  2. หากต้องการทำให้ Firebase SDK เข้าถึงค่าในไฟล์การกำหนดค่า 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.1" 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.1' 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) ให้เพิ่มการอ้างอิงสำหรับผลิตภัณฑ์ Firebase ที่คุณต้องการใช้ในแอป เราขอแนะนำให้ใช้ Firebase Android BoM เพื่อควบคุมการกำหนดเวอร์ชันไลบรารี

    เปิดใช้ Analytics แล้ว 

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:33.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 เวอร์ชันที่เข้ากันได้เสมอ

    หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ ตั้งแต่เดือนตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนาซอฟต์แวร์ Kotlin และ Java จะขึ้นอยู่กับโมดูลไลบรารีหลักได้ (ดูรายละเอียดได้ที่คำถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

    ไม่ได้เปิดใช้ Analytics 

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:33.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 เวอร์ชันที่เข้ากันได้เสมอ

    หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ ตั้งแต่เดือนตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนาซอฟต์แวร์ Kotlin และ Java จะขึ้นอยู่กับโมดูลไลบรารีหลักได้ (ดูรายละเอียดได้ที่คำถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

  2. หลังจากเพิ่มทรัพยากร Dependency สำหรับผลิตภัณฑ์ที่ต้องการใช้แล้ว ให้ซิงค์โปรเจ็กต์ Android กับไฟล์ Gradle

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

 33.0.0
AdMob com.google.android.gms:play-services-ads 23.0.0
ข้อมูลวิเคราะห์ com.google.firebase:firebase-analytics 22.0.0
ผู้ให้บริการที่กำหนดเองของ App Check com.google.firebase:firebase-appcheck 18.0.0
ผู้ให้บริการแก้ไขข้อบกพร่องของ App Check com.google.firebase:firebase-appcheck-debug 18.0.0
ผู้ให้บริการด้านความสมบูรณ์ของ Play สำหรับการตรวจสอบแอป com.google.firebase:firebase-appcheck-playintegrity 18.0.0
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-เบต้า12
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-เบต้า12
ปลั๊กอิน App Distribution com.google.firebase:firebase-appdistribution-gradle 5.0.0
การตรวจสอบสิทธิ์ com.google.firebase:firebase-auth 23.0.0
Cloud Firestore com.google.firebase:firebase-firestore 25.0.0
SDK ของไคลเอ็นต์ Cloud สำหรับ Firebase com.google.firebase:firebase-functions 21.0.0
การรับส่งข้อความในระบบคลาวด์ com.google.firebase:firebase-messaging 24.0.0
พื้นที่เก็บข้อมูลระบบคลาวด์ com.google.firebase:firebase-storage 21.0.0
Crashlytics com.google.firebase:firebase-crashlytics 19.0.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.0.0
ปลั๊กอิน Crashlytics com.google.firebase:firebase-crashlytics-gradle 3.0.0
การรองรับโมดูลฟีเจอร์แบบไดนามิก com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
ลิงก์แบบไดนามิก com.google.firebase:firebase-dynamic-links 22.0.0
การรับส่งข้อความในแอป com.google.firebase:firebase-inappsaging 21.0.0
(ต้องระบุ)
การแสดงการรับส่งข้อความในแอป com.google.firebase:firebase-inappmessaging-display 21.0.0
(ต้องระบุ)
การติดตั้ง Firebase com.google.firebase:firebase-installations 18.0.0
API ดาวน์โหลดโมเดล ML ของ Firebase com.google.firebase:firebase-ml-modeldownloader 25.0.0
การตรวจสอบประสิทธิภาพ com.google.firebase:firebase-perf 21.0.0
ปลั๊กอิน Performance Monitoring com.google.firebase:perf-plugin 1.4.2
ฐานข้อมูลเรียลไทม์ com.google.firebase:firebase-database 21.0.0
การกำหนดค่าระยะไกล com.google.firebase:firebase-config 22.0.0
ปลั๊กอินบริการ Google Play com.google.gms:google-services 4.4.1
คลังที่เลิกใช้งานแล้ว
ผู้ให้บริการ SafetyNet การตรวจสอบแอป com.google.firebase:firebase-appcheck-safetynet 16.1.2
การจัดทำดัชนีแอป com.google.firebase:firebase-appindexing 20.0.0

โมดูล Firebase KTX

ข้อมูลวิเคราะห์ com.google.firebase:firebase-analytics-ktx 22.0.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-เบต้า12
การตรวจสอบสิทธิ์ com.google.firebase:firebase-auth-ktx 23.0.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.0.0
SDK ของไคลเอ็นต์ Cloud สำหรับ Firebase com.google.firebase:firebase-functions-ktx 21.0.0
การรับส่งข้อความในระบบคลาวด์ com.google.firebase:firebase-messaging-ktx 24.0.0
พื้นที่เก็บข้อมูลระบบคลาวด์ com.google.firebase:firebase-storage-ktx 21.0.0
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.0.0
ลิงก์แบบไดนามิก com.google.firebase:firebase-dynamic-links-ktx 22.0.0
การรับส่งข้อความในแอป com.google.firebase:firebase-inappmessaging-ktx 21.0.0
(ต้องระบุ)
การแสดงการรับส่งข้อความในแอป com.google.firebase:firebase-inappmessaging-display-ktx 21.0.0
(ต้องระบุ)
การติดตั้ง Firebase com.google.firebase:firebase-installations-ktx 18.0.0
API ดาวน์โหลดโมเดล ML ของ Firebase com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.0
การตรวจสอบประสิทธิภาพ com.google.firebase:firebase-perf-ktx 21.0.0
ฐานข้อมูลเรียลไทม์ com.google.firebase:firebase-database-ktx 21.0.0
การกำหนดค่าระยะไกล com.google.firebase:firebase-config-ktx 22.0.0

ไลบรารี Firebase ML Kit

API รูปแบบที่กำหนดเองของ Firebase ML 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


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

เพิ่มบริการ Firebase ลงในแอป

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

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

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

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

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

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

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

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