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

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

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

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

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

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

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

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

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

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

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

  • ดาวน์โหลดทั้ง GoogleService-Info.plist ไฟล์
  • เก็บไฟล์ทั้ง 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 ไฟล์ google-services.json จะประมวลผลเป็นทรัพยากรสตริง Android โดยปลั๊กอิน Gradle ของบริการ Google คุณดูทรัพยากรที่สร้างได้ในเอกสารประกอบเกี่ยวกับปลั๊กอิน Google Services ในหัวข้อการประมวลผลไฟล์ JSON

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

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

ดูข้อมูลเพิ่มเติมได้ในเอกสาร Google Services Plugin เรื่องการเพิ่มไฟล์ 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 ที่แตกต่างกันเพื่ออ้างอิงแต่ละโปรเจ็กต์แยกกัน คุณจะต้องเริ่มต้นอินสแตนซ์อื่นๆ เหล่านี้เอง

ในทั้ง 2 กรณี คุณต้องสร้างออบเจ็กต์ตัวเลือก 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
AppDelegate.swift

Kotlin+KTX 

// 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()
MainActivity.kt

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();
MainActivity.java

เว็บไซต์

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

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'
};
index.js

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 เพิ่มเติมได้ โปรดทราบว่าในตัวอย่างทั้งหมดที่แสดง เราจะใช้สตริงรอง ชื่อนี้จะใช้เพื่อเรียกข้อมูลอินสแตนซ์แอปพลิเคชันและเพื่อแยกจากอินสแตนซ์อื่นๆ รวมถึงอินสแตนซ์เริ่มต้น (ชื่อ [ค่าเริ่มต้น]) คุณควรเลือกสตริงที่เหมาะกับ การใช้งานโปรเจ็กต์ 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)
AppDelegate.swift

Kotlin+KTX 

// 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)
MainActivity.kt

Java 

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

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

เว็บไซต์

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

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();
index.js

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 สูญเสียข้อมูล