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

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

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

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

    • API เป้าหมายระดับ 19 (KitKat) ขึ้นไป
    • ใช้ Android 4.4 ขึ้นไป
    • การใช้งาน Jetpack (AndroidX) ซึ่งมีคุณสมบัติตรงตามข้อกำหนดของเวอร์ชันเหล่านี้
      • com.android.tools.build:gradle v7.3.0 ขึ้นไป
      • compileSdkVersion 28 ขึ้นไป

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

  • ลงชื่อเข้าใช้ Firebase โดยใช้ ของคุณได้

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


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


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

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

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

คุณต้องสร้าง Firebase ก่อนจึงจะเพิ่ม Firebase ลงในแอป Android ได้ เพื่อเชื่อมต่อกับแอป 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. คลิกดาวน์โหลด google-services.json เพื่อรับ Firebase Android ไฟล์การกำหนดค่าเซิร์ฟเวอร์

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

  2. หากต้องการทำให้ค่าในไฟล์การกำหนดค่า google-services.json เข้าถึงได้ Firebase SDK ปลั๊กอิน 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.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: เพิ่ม 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.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 เวอร์ชันที่เข้ากันได้เสมอ ห้องสมุด

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

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

    dependencies {
  // ...

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

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

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

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

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


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

Firebase Assistant จะลงทะเบียน แอปด้วยโปรเจ็กต์ Firebase และเพิ่มไฟล์ Firebase, ปลั๊กอิน, และทรัพยากร Dependency สำหรับโปรเจ็กต์ 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 ผู้ช่วย!

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

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


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

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

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

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

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

 33.2.0
AdMob com.google.android.gms:play-services-ads 23.3.0
Analytics com.google.firebase:firebase-analytics 22.1.0
ผู้ให้บริการที่กำหนดเอง 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-เบต้า13
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-เบต้า13
ปลั๊กอิน App Distribution com.google.firebase:firebase-appdistribution-gradle 5.0.0
Authentication com.google.firebase:firebase-auth 23.0.0
Cloud Firestore com.google.firebase:firebase-firestore 25.1.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions 21.0.0
Cloud Messaging com.google.firebase:firebase-messaging 24.0.1
Cloud Storage com.google.firebase:firebase-storage 21.0.0
Crashlytics com.google.firebase:firebase-crashlytics 19.0.3
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.0.3
ปลั๊กอิน Crashlytics com.google.firebase:firebase-crashlytics-gradle 3.0.2
การรองรับโมดูลฟีเจอร์แบบไดนามิก com.google.firebase:firebase-dynamic-module-support 16.0.0-เบต้า03
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging 21.0.0
(ต้องระบุ)
In-App Messaging จอแสดงผล com.google.firebase:firebase-inappmessaging-display 21.0.0
(ต้องระบุ)
การติดตั้ง Firebase ครั้ง com.google.firebase:firebase-installations 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader 25.0.0
Performance Monitoring com.google.firebase:firebase-perf 21.0.1
ปลั๊กอิน 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.0
Vertex AI in Firebase com.google.firebase:firebase-vertexai 16.0.0-เบต้า
ปลั๊กอินบริการ Google Play com.google.gms:google-services 4.4.2
คลังที่เลิกใช้งาน
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.1.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-เบต้า13
Authentication com.google.firebase:firebase-auth-ktx 23.0.0
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.0
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.0.0
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.0.1
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.0
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.0.3
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.0
(ต้องระบุ)
In-App Messaging จอแสดงผล com.google.firebase:firebase-inappmessaging-display-ktx 21.0.0
(ต้องระบุ)
การติดตั้ง Firebase ครั้ง com.google.firebase:firebase-installations-ktx 18.0.0
Firebase ML Model Downloader API com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.0
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.1
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0
Remote Config 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

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

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

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

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

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

  • ดูเวลาและสาเหตุที่แอปของคุณขัดข้องด้วย Crashlytics

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