เพิ่ม Firebase ให้กับโปรเจ็กต์ Android ของคุณ

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

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

• ตรวจสอบให้แน่ใจว่าโครงการของคุณตรงตามข้อกำหนดเหล่านี้:

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

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

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

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

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

• ตัวเลือกที่ 1 : (แนะนำ) ใช้เวิร์กโฟลว์การตั้งค่าคอนโซล Firebase
• ตัวเลือกที่ 2 : ใช้ Android Studio Firebase Assistant (อาจต้องกำหนดค่าเพิ่มเติม)

ตัวเลือกที่ 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 ( plat_android ) หรือ เพิ่มแอป เพื่อเริ่มเวิร์กโฟลว์การตั้งค่า

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

   ชื่อแพ็คเกจคืออะไร และคุณจะพบได้ที่ไหน

   • ชื่อแพ็กเกจ จะระบุแอปของคุณบนอุปกรณ์และใน Google Play Store โดยไม่ซ้ำกัน

   • ชื่อแพ็กเกจ มักถูกอ้างถึงเป็น ID แอปพลิเคชัน

   • ค้นหาชื่อแพ็กเกจของแอปในไฟล์ Gradle ของโมดูล (ระดับแอป) โดยปกติจะเป็น app/build.gradle (ตัวอย่างชื่อแพ็กเกจ: com.yourcompany.yourproject )

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

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

   ชื่อเล่นแอป และ ใบรับรองการลงนาม Debug SHA-1 ใช้ใน Firebase อย่างไร

   • ชื่อเล่นแอป : ตัวระบุความสะดวกภายในที่มองเห็นได้เฉพาะคุณในคอนโซล Firebase

   • แก้ไขจุดบกพร่องใบรับรองการลงนาม SHA-1 : จำเป็นต้อง มีแฮช SHA-1 โดย Firebase Authentication (เมื่อใช้ Google Sign In หรือ การลงชื่อเข้าใช้ด้วยหมายเลขโทรศัพท์ ) และ Firebase Dynamic Links

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

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

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

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

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

   คุณต้องรู้อะไรบ้างเกี่ยวกับไฟล์ปรับแต่งนี้

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

   • คุณดาวน์โหลด ไฟล์กำหนดค่า Firebase อีกครั้งได้ทุกเมื่อ

   • ตรวจสอบให้แน่ใจว่าชื่อไฟล์ config ไม่ได้ต่อท้ายด้วยอักขระเพิ่มเติม เช่น (2)

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

   1. ในไฟล์ Gradle ระดับรูท (ระดับโครงการ) ( <project>/build.gradle ) ให้เพิ่มปลั๊กอินบริการของ Google เป็นการพึ่งพา buildscript:

      buildscript {
      
          repositories {
            // Make sure that you have the following two repositories
            google()  // Google's Maven repository
            mavenCentral()  // Maven Central repository
          }
      
          dependencies {
            ...
      
            // Add the dependency for the Google services Gradle plugin
            classpath 'com.google.gms:google-services:4.3.15'
          }
      }
      
      allprojects {
        ...
      
        repositories {
          // Make sure that you have the following two repositories
          google()  // Google's Maven repository
          mavenCentral()  // Maven Central repository
        }
      }
      

   2. ในไฟล์ Gradle ของ โมดูล (ระดับแอป) (โดยปกติคือ <project>/<app-module>/build.gradle ) ให้เพิ่มปลั๊กอินบริการของ Google:

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

   เปิดใช้งานการวิเคราะห์แล้ว

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.3')
   
     // 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-ktx'
   
     // 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-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.3')
   
     // 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+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.3')
   
     // 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-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

   Java

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

   คุณได้รับความล้มเหลวในการสร้างเกี่ยวกับการเรียกใช้การสนับสนุนแบบกำหนดเองและการเปิดใช้งานการแยกน้ำตาลหรือไม่ นี่คือวิธีการแก้ไข

   การสร้าง Gradle ที่ใช้ Android Gradle plugin (AGP) v4.2 หรือรุ่นก่อนหน้าจำเป็นต้องเปิดใช้งานการรองรับ Java 8 มิฉะนั้น โปรเจ็กต์ Android เหล่านี้จะล้มเหลวในการสร้างเมื่อเพิ่ม Firebase SDK

   หากต้องการแก้ไขความล้มเหลวของบิลด์นี้ คุณสามารถทำตามหนึ่งในสองตัวเลือกต่อไปนี้:

   • เพิ่ม compileOptions จากข้อความแสดงข้อผิดพลาดไปยังไฟล์ build.gradle ระดับแอป ของคุณ
   • เพิ่ม minSdkVersion สำหรับโครงการ Android ของคุณเป็น 26 หรือสูงกว่า

   เรียนรู้เพิ่มเติมเกี่ยวกับความล้มเหลวของการสร้างนี้ใน คำถามที่พบบ่อยนี้

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

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

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

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

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

   • Windows / Linux: วิธีใช้ > ตรวจสอบการอัปเดต
   • macOS: Android Studio > ตรวจสอบการอัปเดต

2. เปิดตัวช่วย Firebase: เครื่องมือ > Firebase

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

   1. คลิก เชื่อมต่อกับ Firebase เพื่อเชื่อมต่อโครงการ Android ของคุณกับ Firebase

      เวิร์กโฟลว์นี้ทำอะไร

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

        เคล็ดลับบางประการเกี่ยวกับการตั้งค่าโปรเจ็กต์ Firebase มีดังนี้

        • ดู แนวทางปฏิบัติที่ดีที่สุด ของเราในการเพิ่มแอปในโครงการ Firebase รวมถึงวิธีจัดการตัวแปรหลายตัว

        • หากคุณสร้างโครงการใหม่ เราขอแนะนำให้คุณตั้งค่า Google Analytics สำหรับโครงการของคุณ ซึ่งจะช่วยให้คุณได้รับประสบการณ์ที่ดีที่สุดจากการใช้ผลิตภัณฑ์ Firebase มากมาย

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

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

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

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

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

แค่นั้นแหละ! อย่าลืมตรวจสอบ ขั้นตอนถัดไป ที่แนะนำ

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

ห้องสมุดที่มีอยู่

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

• เอกสารอ้างอิง ( Kotlin+KTX | Java )

• ที่เก็บ Firebase Android SDK GitHub

โปรดทราบว่าเมื่อใช้ Firebase Android BoM คุณจะไม่ต้องระบุเวอร์ชันของไลบรารีแต่ละเวอร์ชันเมื่อคุณประกาศการอ้างอิงไลบรารีของ Firebase ใน build.gradle

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

เพิ่มบริการ Firebase ในแอปของคุณ:

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

• ตั้งค่าขั้นตอนการยืนยันตัวตนผู้ใช้ด้วย Authentication

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

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

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

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

• ค้นหาว่าเมื่อใดและเพราะเหตุใดแอปของคุณจึงหยุดทำงานด้วย Crashlytics

เรียนรู้เกี่ยวกับ Firebase:

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

• ไปที่ เรียนรู้เพิ่มเติมเกี่ยวกับ Android และ Firebase หากคุณมีคำถามเกี่ยวกับแนวคิดที่ไม่คุ้นเคยหรือเฉพาะเจาะจงสำหรับการพัฒนา Firebase และ Android

• สำรวจ แอป Firebase ตัวอย่าง

• รับประสบการณ์จริงด้วย Firebase Android Codelab

• เรียนรู้เพิ่มเติมเกี่ยวกับ Firebase ในหลักสูตรวันหยุดสุดสัปดาห์

• เตรียมเปิดตัวแอปของคุณ:

  • ตั้งค่า การแจ้งเตือนงบประมาณ สำหรับโครงการของคุณใน Google Cloud Console
  • ตรวจสอบ แดชบอร์ด การใช้งานและการเรียกเก็บเงิน ในคอนโซล Firebase เพื่อดูภาพรวมของการใช้งานโครงการของคุณในบริการต่างๆ ของ Firebase
  • ตรวจสอบ รายการตรวจสอบการเปิดใช้ Firebase

• มีปัญหากับ Firebase และโครงการ Android ของคุณหรือไม่ ไปที่ การแก้ไขปัญหาและคำถามที่พบบ่อยเกี่ยวกับ Android