กำหนดค่าหลายโปรเจ็กต์

หน้านี้อธิบายวิธีใช้โปรเจ็กต์ Firebase มากกว่า 1 โปรเจ็กต์ในแอป

แอปจํานวนมากต้องใช้โปรเจ็กต์ Firebase เพียงโปรเจ็กต์เดียวและการตั้งค่าเริ่มต้นที่อธิบายไว้ในคู่มือเริ่มต้นใช้งาน ตัวอย่างกรณีที่อาจเป็นประโยชน์ในการใช้โปรเจ็กต์ Firebase หลายรายการ ได้แก่

  • การตั้งค่าสภาพแวดล้อมการพัฒนาซอฟต์แวร์เพื่อใช้โปรเจ็กต์ Firebase ที่แตกต่างกันโดยอิงตามประเภทหรือเป้าหมายการสร้าง
  • การเข้าถึงเนื้อหาจากโปรเจ็กต์ Firebase หลายโปรเจ็กต์ในแอป

รองรับสภาพแวดล้อมต่างๆ

กรณีการใช้งานที่พบบ่อยอย่างหนึ่งคือเพื่อรองรับโปรเจ็กต์ Firebase แยกต่างหากสําหรับสภาพแวดล้อมการพัฒนาและที่ใช้งานจริง

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

โดยปกติแล้ว แพลตฟอร์ม Android และ Apple (รวมถึง Wrapper ของ Unity และ C++) จะโหลดการกำหนดค่าจากไฟล์การกําหนดค่า GoogleService-Info.plist ในแพลตฟอร์ม Apple และ google-services.json ใน Android ระบบจะอ่านไฟล์เหล่านี้ลงในออบเจ็กต์ตัวเลือก (FIROption หรือ FirebaseOptions) ที่ออบเจ็กต์แอปพลิเคชันของ Firebase (FIRApp หรือ FirebaseApp) อ้างอิง

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

รองรับสภาพแวดล้อมหลายรายการในแอปพลิเคชันของ Apple

โดยค่าเริ่มต้น FirebaseApp.configure() จะโหลดไฟล์ GoogleService-Info.plist ที่รวมอยู่กับแอปพลิเคชัน หากสภาพแวดล้อมการพัฒนาและเวอร์ชันที่ใช้งานจริงได้รับการกำหนดค่าเป็นเป้าหมายแยกกันใน Xcode คุณจะทำสิ่งต่อไปนี้ได้

  • ดาวน์โหลดไฟล์ GoogleService-Info.plist ทั้ง 2 ไฟล์
  • จัดเก็บไฟล์ 2 ไฟล์ในไดเรกทอรีที่แตกต่างกัน
  • เพิ่มทั้ง 2 รายการลงในโปรเจ็กต์ Xcode
  • เชื่อมโยงไฟล์ต่างๆ กับเป้าหมายต่างๆ โดยใช้แผงเป้าหมาย การเป็นสมาชิก ดังนี้

แผงการเป็นสมาชิกเป้าหมาย

หากบิลด์เป็นส่วนหนึ่งของเป้าหมายเดียว ตัวเลือกที่ดีที่สุดคือตั้งชื่อไฟล์การกำหนดค่าทั้ง 2 ไฟล์ให้ไม่ซ้ำกัน (เช่น GoogleService-Info-Free.plist และ GoogleService-Info-Paid.plist) จากนั้นเลือก plist ที่จะโหลดเมื่อรันไทม์ ดังที่แสดงในตัวอย่างต่อไปนี้

// Load a named file.
let filePath = Bundle.main.path(forResource: "MyGoogleService", ofType: "plist")
guard let fileopts = FirebaseOptions(contentsOfFile: filePath!)
  else { assert(false, "Couldn't load config file") }
FirebaseApp.configure(options: fileopts)

รองรับหลายสภาพแวดล้อมในแอปพลิเคชัน Android

ใน Android ปลั๊กอิน Gradle ของบริการ Google จะประมวลผลไฟล์ google-services.json เป็นทรัพยากรสตริงของ Android คุณสามารถดูว่าระบบสร้างทรัพยากรใดบ้างในเอกสารประกอบของปลั๊กอินบริการของ Google เกี่ยวกับการประมวลผลไฟล์ JSON

คุณมีไฟล์ google-services.json หลายไฟล์สําหรับตัวแปรบิลด์ที่แตกต่างกันได้โดยการวางไฟล์ google-services.json ในไดเรกทอรีเฉพาะที่มีชื่อสําหรับตัวแปรแต่ละรายการในส่วนรูทของโมดูลแอป ตัวอย่างเช่น หากคุณมี Flavor การสร้าง "development" และ "release" การกําหนดค่าอาจจัดระเบียบดังนี้

app/
    google-services.json
    src/development/google-services.json
    src/release/google-services.json
    ...

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบของปลั๊กอินบริการของ Google เกี่ยวกับการเพิ่มไฟล์ JSON

จากนั้น FirebaseInitProvider จะโหลดทรัพยากรเหล่านี้ ซึ่งจะทำงานก่อนโค้ดแอปพลิเคชันและเริ่มต้น Firebase API โดยใช้ค่าเหล่านั้น

เนื่องจากผู้ให้บริการรายนี้อ่านเฉพาะทรัพยากรที่มีชื่อที่รู้จัก อีกทางเลือกหนึ่งคือการเพิ่มทรัพยากรสตริงลงในแอปโดยตรงแทนที่จะใช้ปลั๊กอิน Gradle ของบริการ Google ซึ่งทำได้โดยทำดังนี้

  • การนำปลั๊กอิน google-services ออกจากรูท build.gradle
  • การลบ google-services.json ออกจากโปรเจ็กต์
  • การเพิ่มทรัพยากรสตริงโดยตรง
  • กำลังลบ apply plugin: 'com.google.gms.google-services' ออกจากแอป build.gradle

ใช้โปรเจ็กต์หลายรายการในแอปพลิเคชัน

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

ไม่ว่าในกรณีใด คุณจะต้องสร้างออบเจ็กต์ตัวเลือก Firebase ก่อนเพื่อเก็บข้อมูลการกําหนดค่าสําหรับแอปพลิเคชัน Firebase ดูเอกสารประกอบฉบับเต็มสำหรับตัวเลือกต่างๆ ได้ในเอกสารอ้างอิง API สำหรับคลาสต่อไปนี้

ตัวอย่างการใช้คลาสเหล่านี้เพื่อรองรับหลายโปรเจ็กต์ในแอปพลิเคชันแสดงอยู่ด้านล่าง

Swift

// Configure with manual options. Note that projectID and apiKey, though not
// required by the initializer, are mandatory.
let secondaryOptions = FirebaseOptions(googleAppID: "1:27992087142:ios:2a4732a34787067a",
                                       gcmSenderID: "27992087142")
secondaryOptions.apiKey = "AIzaSyBicqfAZPvMgC7NZkjayUEsrepxuXzZDsk"
secondaryOptions.projectID = "projectid-12345"

// The other options are not mandatory, but may be required
// for specific Firebase products.
secondaryOptions.bundleID = "com.google.firebase.devrel.FiroptionConfiguration"
secondaryOptions.trackingID = "UA-12345678-1"
secondaryOptions.clientID = "27992087142-ola6qe637ulk8780vl8mo5vogegkm23n.apps.googleusercontent.com"
secondaryOptions.databaseURL = "https://myproject.firebaseio.com"
secondaryOptions.storageBucket = "myproject.appspot.com"
secondaryOptions.androidClientID = "12345.apps.googleusercontent.com"
secondaryOptions.deepLinkURLScheme = "myapp://"
secondaryOptions.storageBucket = "projectid-12345.appspot.com"
secondaryOptions.appGroupID = nil

Kotlin

// Manually configure Firebase Options. The following fields are REQUIRED:
//   - Project ID
//   - App ID
//   - API Key
val options = FirebaseOptions.Builder()
    .setProjectId("my-firebase-project")
    .setApplicationId("1:27992087142:android:ce3b6448250083d1")
    .setApiKey("AIzaSyADUe90ULnQDuGShD9W23RDP0xmeDc6Mvw")
    // .setDatabaseUrl(...)
    // .setStorageBucket(...)
    .build()

Java

// Manually configure Firebase Options. The following fields are REQUIRED:
//   - Project ID
//   - App ID
//   - API Key
FirebaseOptions options = new FirebaseOptions.Builder()
        .setProjectId("my-firebase-project")
        .setApplicationId("1:27992087142:android:ce3b6448250083d1")
        .setApiKey("AIzaSyADUe90ULnQDuGShD9W23RDP0xmeDc6Mvw")
        // setDatabaseURL(...)
        // setStorageBucket(...)
        .build();

เว็บ

// The following fields are REQUIRED:
//  - Project ID
//  - App ID
//  - API Key
const secondaryAppConfig = {
    projectId: "<PROJECT_ID>",
    appId: "<APP_ID>",
    apiKey: "<API_KEY>",
    // databaseURL: "...",
    // storageBucket: "...",
};

C++

firebase::AppOptions secondary_app_options;

// API key, app ID, and project ID are always required.
secondary_app_options.set_api_key("<API_KEY>");
secondary_app_options.set_app_id("<GOOGLE_APP_ID>");
secondary_app_options.set_project_id("<PROJECT_ID>");

// The following options are specific to individual Firebase products
// and may not always be required.
secondary_app_options.set_database_url("<DATABASE_URL>");
secondary_app_options.set_messaging_sender_id("<SENDER_ID>");
secondary_app_options.set_storage_bucket("<STORAGE_BUCKET>");

Unity

Firebase.AppOptions secondaryAppOptions = new Firebase.AppOptions {
  ApiKey = "<API_KEY>",
  AppId = "<GOOGLE_APP_ID>",
  ProjectId = "<PROJECT_ID>"
};

Node.js

const secondaryServiceAccount = require('./path/to/serviceAccountKey.json');

// All required options are specified by the service account,
// add service-specific configuration like databaseURL as needed.
const secondaryAppConfig = {
    credential: cert(secondaryServiceAccount),
    // databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
};

Java

FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountKey.json");

FirebaseOptions secondaryAppConfig = new FirebaseOptions.Builder()
  .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
  .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
  .build();

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

ตัวอย่างต่อไปนี้แสดงการเชื่อมต่อกับ Realtime Database ทางเลือก (API สําหรับฟีเจอร์อื่นๆ ของ Firebase จะใช้รูปแบบเดียวกัน)

Swift

// Configure an alternative FIRApp.
FirebaseApp.configure(name: "secondary", options: secondaryOptions)

// Retrieve a previous created named app.
guard let secondary = FirebaseApp.app(name: "secondary")
  else { assert(false, "Could not retrieve secondary app") }


// Retrieve a Real Time Database client configured against a specific app.
let secondaryDb = Database.database(app: secondary)

Kotlin

// Initialize secondary FirebaseApp.
Firebase.initialize(context = this, options, "secondary")

// Retrieve secondary FirebaseApp.
val secondary = Firebase.app("secondary")
// Get the database for the other app.
val secondaryDatabase = Firebase.database(secondary)

Java

// Initialize with secondary app
FirebaseApp.initializeApp(this /* Context */, options, "secondary");

// Retrieve secondary FirebaseApp
FirebaseApp secondary = FirebaseApp.getInstance("secondary");

เว็บ

// Initialize another app with a different config
const secondaryApp = firebase.initializeApp(secondaryAppConfig, "secondary");
// Access services, such as the Realtime Database
// secondaryApp.database();

C++

firebase::App* secondary_app = firebase::App::Create(secondary_app_options, "Secondary");
firebase::database::Database* secondary_database = firebase::database::Database::GetInstance(secondary_app);

Unity

var secondaryApp = Firebase.FirebaseApp.Create(secondaryAppOptions, "Secondary"));
var secondaryDatabase = Firebase.Database.FirebaseDatabase.getInstance(secondaryApp);

Node.js

// Initialize another app with a different config
const secondary = initializeApp(secondaryAppConfig, 'secondary');
// Access services, such as the Realtime Database
// const secondaryDatabase = secondary.database();

Java

// Initialize another app with a different config
FirebaseApp secondaryApp = FirebaseApp.initializeApp(secondaryAppConfig, "secondary");

// Retrieve the database.
FirebaseDatabase secondaryDatabase = FirebaseDatabase.getInstance(secondaryApp);

ตรวจสอบการรายงานที่เชื่อถือได้สําหรับ Analytics

Google Analytics จะรวบรวมเหตุการณ์ตั้งแต่เนิ่นๆ ในขั้นตอนการเริ่มต้นของแอปในบางกรณีก่อนที่จะมีการกําหนดค่าอินสแตนซ์แอป Firebase หลัก ในกรณีเหล่านี้ Firebase จะอ้างอิงทรัพยากร Android หรือGoogleService-Info.plistในแพลตฟอร์ม Apple เพื่อค้นหารหัสแอป Google ที่ถูกต้องเพื่อจัดเก็บเหตุการณ์ ด้วยเหตุนี้ เราจึงขอแนะนำให้ใช้วิธีการกำหนดค่าเริ่มต้นทุกครั้งที่เป็นไปได้

หากจำเป็นต้องมีการกําหนดค่ารันไทม์ โปรดคำนึงถึงข้อควรระวังต่อไปนี้

  1. หากคุณใช้ AdMob และขอโฆษณาเมื่อเริ่มต้นตามที่แนะนํา คุณอาจพลาดข้อมูล Analytics บางรายการที่เกี่ยวข้องกับโฆษณาในอุปกรณ์เคลื่อนที่เมื่อไม่ได้ใช้วิธีการกําหนดค่าตามทรัพยากร
  2. ระบุรหัสแอป Google เพียงรหัสเดียวในแต่ละตัวแปรที่เผยแพร่ของแอป เช่น หากคุณเผยแพร่แอปเวอร์ชัน 1 ที่มี GOOGLE_APP_ID หนึ่งๆ ในการกำหนดค่า แล้วอัปโหลดเวอร์ชัน 2 ที่มีรหัสอื่น อาจทำให้ระบบทิ้งข้อมูลวิเคราะห์
  3. ในแพลตฟอร์ม Apple อย่าเพิ่ม GoogleService-Info.plist ลงในโปรเจ็กต์หากคุณกําลังระบุการกําหนดค่าอื่นที่รันไทม์ เนื่องจากอาจทําให้ GOOGLE_APP_ID เปลี่ยนแปลงอย่างเห็นได้ชัดและทําให้ Analytics สูญหาย