สร้างและจัดการทริกเกอร์เหตุการณ์ที่กำหนดเอง

ด้วย Cloud Functions (รุ่นที่ 2) คุณสามารถเรียกใช้ฟังก์ชันเพื่อตอบสนองต่อเหตุการณ์ที่กำหนดเองได้ เหตุการณ์เหล่านี้เป็นเหตุการณ์ที่จัดทำโดยผู้ให้บริการเหตุการณ์พิเศษหรือเพิ่มเติม ซึ่งแตกต่างจากเหตุการณ์ Firebase ที่ Firebase SDK สำหรับ Cloud Functions รองรับโดยเนทีฟ แอปของคุณสามารถตอบสนองต่อเหตุการณ์ที่ได้รับจาก Firebase Extensionsผ่านทริกเกอร์เหตุการณ์ที่กำหนดเอง หรือคุณจะเผยแพร่เหตุการณ์ที่กำหนดเองและฟังก์ชันทริกเกอร์ของคุณเองเพื่อตอบสนองต่อเหตุการณ์เหล่านั้นก็ได้

เหตุการณ์ที่กำหนดเองทั้งหมดเป็นไปตาม รูปแบบเหตุการณ์ JSON ของ CloudEvents และเผยแพร่ไปยัง Eventarc Eventarc ค่าธรรมเนียมการใช้งาน

เรียกใช้ฟังก์ชันด้วยเหตุการณ์ที่กำหนดเอง

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

  1. เผยแพร่เหตุการณ์ที่ต้องการไปยังแชแนล Eventarc หรือระบุเหตุการณ์ที่พร้อมใช้งานซึ่งส่วนขยายที่คุณติดตั้งไว้มีให้
  2. ในโค้ดฟังก์ชัน ให้สมัครรับข้อมูลเหตุการณ์ในช่อง Eventarc ด้วย เครื่องจัดการเหตุการณ์
  3. ในฟังก์ชัน ให้แยกวิเคราะห์เพย์โหลดที่ส่งคืนในออบเจ็กต์ CloudEvent และดำเนินการตามตรรกะที่กำหนดเองที่แอปของคุณต้องการ

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

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

เผยแพร่กิจกรรมไปยังช่อง

ระบบจะเผยแพร่เหตุการณ์ Eventarc ไปยังแชแนล แชแนลเป็นวิธีจัดกลุ่มเหตุการณ์ที่เกี่ยวข้องและจัดการสิทธิ์เข้าถึง เมื่อติดตั้งส่วนขยายหรือติดตั้งใช้งานฟังก์ชันที่ใช้เหตุการณ์ที่กำหนดเอง Firebase จะสร้างแชแนลเริ่มต้นชื่อ firebase ในภูมิภาค us-central1 โดยอัตโนมัติ Firebase Admin SDK มี eventarc แพ็กเกจย่อยสำหรับการเผยแพร่ไปยังช่อง

หากต้องการเผยแพร่เหตุการณ์จากเซิร์ฟเวอร์ที่เชื่อถือได้ (หรือฟังก์ชันอื่น) โดยใช้ แชแนลเริ่มต้น ให้ทำดังนี้

import {getEventarc} from 'firebase-admin/eventarc';

getEventarc().channel().publish({
    type: 'achieved-leaderboard',
    subject: 'Welcome to the top 10',
    data: {
      message: 'You have achieved the nth position in our leaderboard!  To see . . .'
    }
});

นอกจากจะสร้างแชแนลเริ่มต้นโดยอัตโนมัติแล้ว Firebase ยังตั้งค่า ตัวแปรสภาพแวดล้อม EVENTARC_CLOUD_EVENT_SOURCE ซึ่งระบุแหล่งที่มา ของเหตุการณ์ด้วย หากเผยแพร่กิจกรรมภายนอก Cloud Functions for Firebase คุณจะต้องเพิ่มฟิลด์ source ในเพย์โหลดของกิจกรรมอย่างชัดเจน

จัดการเหตุการณ์ที่กำหนดเอง

คุณจัดการเหตุการณ์ที่กําหนดเองทั้งหมด รวมถึงเหตุการณ์ส่วนขยายได้ด้วยตัวแฮนเดิล onCustomEventPublished หรือ on_custom_event_published ก่อนอื่น ให้นำเข้าแฮนเดิลนี้จาก Eventarc SDK พร้อมกับ Firebase Admin SDK:

Node.js

const {onCustomEventPublished} = require("firebase-functions/v2/eventarc");
const logger = require("firebase-functions/logger");
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

index.js

Python

from firebase_admin import firestore, initialize_app
from firebase_functions import eventarc_fn
main.py

ในโค้ดฟังก์ชัน ให้ส่งชื่อเหตุการณ์ตามที่แสดงสำหรับฟังก์ชันตัวอย่าง

Node.js

exports.onimageresized = onCustomEventPublished(
    "firebase.extensions.storage-resize-images.v1.complete",
    (event) => {
      logger.info("Received image resize completed event", event);
      // For example, write resized image details into Firestore.
      return getFirestore()
          .collection("images")
          .doc(event.subject.replace("/", "_")) // original file path
          .set(event.data); // resized images paths and sizes
    });
index.js

Python

@eventarc_fn.on_custom_event_published(
    event_type="firebase.extensions.storage-resize-images.v1.complete")
def onimageresized(event: eventarc_fn.CloudEvent) -> None:
    print("Received image resize completed event: ", event.type)

    if not isinstance(event.subject, str):
        print("No 'subject' data.")
        return

    # For example, write resized image details into Firestore.
    firestore_client: google.cloud.firestore.Client = firestore.client()
    collection = firestore_client.collection("images")
    doc = collection.document(event.subject.replace("/", "_"))  # original file path
    doc.set(event.data)  # resized images paths and sizes
main.py

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

เผยแพร่และจัดการกิจกรรมในช่องที่ไม่ใช่ช่องเริ่มต้น

ช่องที่กำหนดเองมีประโยชน์ในกรณีที่คุณต้องการสิทธิ์พิเศษ หรือมีข้อกำหนดอื่นๆ และไม่ต้องการให้กิจกรรมทั้งหมดมีระดับการเข้าถึงและการมองเห็นเท่ากัน คุณสร้างแชแนลของคุณเองได้โดยใช้ คอนโซล Google Cloud การเผยแพร่และการติดตามกิจกรรมต้องดำเนินการในช่องเดียวกัน

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

Node.js

import { onCustomEventPublished } from "firebase-functions/v2/eventarc";

export const func = onCustomEventPublished(
    {
      eventType: "firebase.extensions.storage-resize-images.v1.complete",
      channel: "locations/us-west1/channels/firebase",
      region: "us-west1",
    },
    (event) => { ... });

Python

@eventarc_fn.on_custom_event_published(
    event_type="firebase.extensions.storage-resize-images.v1.complete",
    channel="locations/us-west1/channels/firebase",
    region="us-west1")
def onimageresizedwest(event: eventarc_fn.CloudEvent) -> None:
    print("Received image resize completed event: ", event.type)
    # ...
main.py