ปลั๊กอิน Google Services Gradle

บทนำ

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

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

ปลั๊กอิน google-services มี 2 ฟังก์ชันหลักดังนี้

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

2. เพิ่มทรัพยากร Dependency สำหรับไลบรารีพื้นฐานที่จำเป็นสำหรับบริการที่คุณมี เปิดอยู่ ในขั้นตอนนี้ คุณต้องใช้ Gradle บริการของ Google ในไฟล์ 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 เวอร์ชันที่ใช้งานจริง

เมื่อมีการใช้เวอร์ชันผลิตภัณฑ์ โครงสร้างไดเรกทอรีที่ซับซ้อนขึ้นเหล่านี้ ยังใช้ได้

// 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 ออบเจ็กต์ที่ตรงกับชื่อแพ็กเกจ (สำหรับบิลด์ปัจจุบัน type) ตามตรรกะต่อไปนี้

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

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

ผลลัพธ์หลักของการประมวลผล JSON คือการสร้างไฟล์ XML สองไฟล์ที่คุณ สามารถใช้อ้างอิงเป็นทรัพยากร 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

การแก้ปัญหา

ถาม: ขณะสร้าง ฉันเห็นข้อความแสดงข้อผิดพลาดต่อไปนี้ "ไฟล์ google-services.json หายไปจากโฟลเดอร์รากของโมดูล บริการของ Google ปลั๊กอินจะทำงานไม่ได้หากไม่มีเครื่องมือนี้"

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

ถาม: ฉันไม่พบสัญลักษณ์ "R.string.gcm_defaultSenderId" "R.xml.global_tracker" ฯลฯ

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