ปลั๊กอิน Google Services Gradle

บทนำ

การเปิดใช้ Google API หรือบริการของ Firebase ในแอปพลิเคชัน Android อาจต้องเพิ่มปลั๊กอิน google-services ลงในไฟล์ build.gradle

dependencies {
    classpath 'com.google.gms:google-services:4.5.0'
    // ...
}

ปลั๊กอิน google-services มีหน้าที่หลัก 2 อย่างดังนี้

1. ประมวลผลไฟล์ google-services.json และสร้างทรัพยากร Android ที่ใช้ในโค้ดของแอปพลิเคชัน ได้ ดูข้อมูลเพิ่มเติมได้ที่การเพิ่มไฟล์ JSON

2. เพิ่มการขึ้นต่อกันสำหรับไลบรารีพื้นฐานที่จำเป็นสำหรับบริการที่คุณเปิดใช้ ขั้นตอนนี้กำหนดให้คุณต้องใช้ปลั๊กอิน Google Services Gradle ในไฟล์ app/build.gradle ดังนี้
   apply plugin: 'com.google.gms.google-services'

   คุณดูผลลัพธ์ของขั้นตอนนี้ได้โดยเรียกใช้ ./gradlew :app:dependencies

การเพิ่มไฟล์ JSON

โดยทั่วไปแล้วไฟล์ google-services.json จะอยู่ในไดเรกทอรี app/ (ที่รูทของโมดูลแอป Android Studio) ตั้งแต่เวอร์ชัน 2.2.0 เป็นต้นมา ปลั๊กอินรองรับไฟล์ JSON ที่เฉพาะเจาะจงสำหรับประเภทบิลด์และเวอร์ชันผลิตภัณฑ์ โครงสร้างไดเรกทอรีทั้งหมดต่อไปนี้ใช้ได้

// dogfood and release are build types.
app/
    google-services.json
    src/dogfood/google-services.json
    src/release/google-services.json
    ...

หมายเหตุ: การระบุไฟล์ google-services.json ในไดเรกทอรีรีลีสช่วยให้คุณดูแลโปรเจ็กต์ Firebase แยกต่างหากสำหรับ APK ที่ใช้งานจริงได้

เมื่อใช้ Product Flavor โครงสร้างไดเรกทอรีที่ซับซ้อนมากขึ้นต่อไปนี้ก็ใช้ได้เช่นกัน

// free and paid are product flavors.
app/
    google-services.json
    src/dogfood/paid/google-services.json
    src/release/free/google-services.json
    ...

การประมวลผลไฟล์ JSON

ไฟล์ google-services.json มีโครงสร้างพื้นฐานดังนี้

{
  "project_info": {...},
  "client": [...],
}

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

เมื่อประมวลผลไฟล์ JSON สำหรับแอป Android ปลั๊กอินจะใช้ออบเจ็กต์ client ที่ตรงกับชื่อแพ็กเกจ (สำหรับประเภทบิลด์ปัจจุบัน) ตามตรรกะต่อไปนี้เท่านั้น

• สำหรับสมาชิกแต่ละคนในอาร์เรย์ client ให้ทำดังนี้
  • ตรวจสอบค่าของ client_info/android_client_info/package_name
  • หากชื่อแพ็กเกจตรงกับค่านี้ ให้แสดงผลออบเจ็กต์สมาชิก
• หากไม่มีสมาชิก client รายใดตรงกับชื่อแพ็กเกจ ระบบจะแสดงข้อยกเว้น

สำหรับส่วนที่เหลือของเอกสารนี้ เราจะใช้ {YOUR_CLIENT} เพื่ออ้างถึงสมาชิกของอาร์เรย์ client ที่กำหนดโดยขั้นตอนข้างต้น

ผลลัพธ์หลักของการประมวลผล JSON คือการสร้างไฟล์ XML 2 ไฟล์ที่คุณอ้างอิงเป็นทรัพยากร Android ในโค้ด Java ได้ ตัวอย่างของแต่ละไฟล์มีดังนี้

app/build/generated/res/google-services/{build_type}/values/values.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <! -- Present in all applications -->
    <string name="google_app_id" translatable="false">1:1035469437089:android:73a4fb8297b2cd4f</string>

    <! -- Present in applications with the appropriate services configured -->
    <string name="gcm_defaultSenderId" translatable="false">1035469437089</string>
    <string name="default_web_client_id" translatable="false">337894902146-e4uksm38sne0bqrj6uvkbo4oiu4hvigl.apps.googleusercontent.com</string>
    <string name="ga_trackingId" translatable="false">UA-65557217-3</string>
    <string name="firebase_database_url" translatable="false">https://example-url.firebaseio.com</string>
    <string name="google_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="google_crash_reporting_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="project_id" translatable="false">mydemoapp</string>

</resources>

app/build/generated/res/google-services/{flavor}/{build_type}/xml/global_tracker.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="ga_trackingId" translatable="false">UA-65557218-3</string>
</resources>

ค่าทุกค่าในไฟล์ XML จะอยู่ในไฟล์ google-services.json ในตำแหน่งด้านล่าง หากโปรเจ็กต์ Android มีการกำหนดค่าบางอย่างที่ป้องกันไม่ให้คุณใช้ปลั๊กอิน google-services คุณสามารถสร้างไฟล์ XML ขึ้นมาใหม่ด้วยตนเองได้อย่างปลอดภัยโดยใช้ค่าต่อไปนี้

google_app_id:

{YOUR_CLIENT}/client_info/mobilesdk_app_id

gcm_defaultSenderId:

project_info/project_number

default_web_client_id:

{YOUR_CLIENT}/oauth_client/client_id (client_type == 3)

ga_trackingId:

{YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id

firebase_database_url:

project_info/firebase_url

google_api_key:

{YOUR_CLIENT}/api_key/current_key

google_crash_reporting_api_key:

{YOUR_CLIENT}/api_key/current_key

project_id:

project_info/project_id

การแก้ปัญหา

Q: เมื่อสร้าง ฉันได้รับข้อความแสดงข้อผิดพลาดต่อไปนี้ "File google-services.json is missing from module root folder. The Google Services Plugin cannot function without it"

A: คอนโซล Firebase จะช่วยคุณ ดาวน์โหลด google-services.json นอกจากนี้ คู่มือเริ่มต้นใช้งานฉบับย่อสำหรับ API ส่วนใหญ่จะมีวิธีการสร้างไฟล์นี้ เมื่อดาวน์โหลดไฟล์ google-services.json แล้ว ให้คัดลอกไฟล์ดังกล่าว ลงในโฟลเดอร์ app/ ของโปรเจ็กต์ Android Studio หรือลงใน app/src/{build_type} หากคุณใช้ประเภทบิลด์หลายประเภท

Q: ฉันไม่พบสัญลักษณ์ "R.string.gcm_defaultSenderId", "R.xml.global_tracker" และอื่นๆ

A: ตรวจสอบว่าชื่อแพ็กเกจในไฟล์ build.gradle ตรงกับชื่อแพ็กเกจที่คุณป้อนเมื่อสร้างไฟล์ google-services.json หากไม่แน่ใจ ให้ทำตามขั้นตอนเริ่มต้นใช้งานอีกครั้งและรับไฟล์ JSON ใหม่