ขยาย Cloud Firestore ด้วย Cloud Functions (รุ่นที่ 1)

Cloud Functions ช่วยให้คุณติดตั้งใช้งานโค้ด Node.js เพื่อจัดการเหตุการณ์ที่ทริกเกอร์โดยการเปลี่ยนแปลงในฐานข้อมูล Cloud Firestore ได้ ซึ่งช่วยให้คุณเพิ่มฟังก์ชันการทำงานฝั่งเซิร์ฟเวอร์ลงในแอปได้อย่างง่ายดายโดยไม่ต้องเรียกใช้เซิร์ฟเวอร์ของคุณเอง

ดูตัวอย่างกรณีการใช้งานได้ที่หัวข้อฉันจะทำอะไรได้บ้างด้วย Cloud Functions หรือที่เก็บ GitHub ตัวอย่างฟังก์ชัน

ทริกเกอร์ฟังก์ชัน Cloud Firestore รายการ

SDK ของ Cloud Functions for Firebase จะส่งออกออบเจ็กต์ functions.firestore ที่ช่วยให้คุณสร้างตัวแฮนเดิลที่เชื่อมโยงกับเหตุการณ์ Cloud Firestore ที่เฉพาะเจาะจงได้

หากยังไม่มีโปรเจ็กต์ที่เปิดใช้ Cloud Functions for Firebase โปรดอ่านเริ่มต้นใช้งาน: เขียนและติดตั้งใช้งานฟังก์ชันแรกของคุณเพื่อกำหนดค่าและตั้งค่าโปรเจ็กต์ Cloud Functions for Firebase

การเขียนฟังก์ชันที่ทริกเกอร์โดย Cloud Firestore

กำหนดทริกเกอร์ฟังก์ชัน

หากต้องการกำหนดทริกเกอร์ Cloud Firestore ให้ระบุเส้นทางเอกสารและประเภทเหตุการณ์ ดังนี้

const functions = require('firebase-functions');

exports.myFunction = functions.firestore
  .document('my-collection/{docId}')
  .onWrite((change, context) => { /* ... */ });

เส้นทางเอกสารสามารถอ้างอิงเอกสารที่เจาะจงหรือรูปแบบไวลด์การ์ดก็ได้

ระบุเอกสารเดียว

หากต้องการทริกเกอร์เหตุการณ์สำหรับการเปลี่ยนแปลงใดๆ ในเอกสารที่เฉพาะเจาะจง คุณสามารถใช้ฟังก์ชันต่อไปนี้

// Listen for any change on document `marie` in collection `users`
exports.myFunctionName = functions.firestore
    .document('users/marie').onWrite((change, context) => {
      // ... Your code here
    });
index.js

ระบุกลุ่มเอกสารโดยใช้ไวลด์การ์ด

หากต้องการแนบเงื่อนไขให้กลุ่มเอกสาร เช่น เอกสารใดก็ได้ในคอลเล็กชันหนึ่งๆ ให้ใช้ {wildcard} แทนรหัสเอกสาร ดังนี้

// Listen for changes in all documents in the 'users' collection
exports.useWildcard = functions.firestore
    .document('users/{userId}')
    .onWrite((change, context) => {
      // If we set `/users/marie` to {name: "Marie"} then
      // context.params.userId == "marie"
      // ... and ...
      // change.after.data() == {name: "Marie"}
    });
index.js

ในตัวอย่างนี้ เมื่อมีการเปลี่ยนแปลงฟิลด์ใดก็ตามในเอกสารใดก็ตามใน users ระบบจะจับคู่กับไวลด์การ์ดที่ชื่อ userId

หากเอกสารใน users มีคอลเล็กชันย่อย และมีการเปลี่ยนแปลงช่องในเอกสารของคอลเล็กชันย่อยรายการใดรายการหนึ่ง ไวลด์การ์ด userId จะไม่ทริกเกอร์

ระบบจะดึงข้อมูลไวลด์การ์ดที่ตรงกันจากเส้นทางเอกสารและจัดเก็บไว้ใน context.params คุณสามารถกำหนดไวลด์การ์ดได้มากเท่าที่ต้องการเพื่อแทนที่คอลเล็กชันหรือรหัสเอกสารที่ชัดเจน เช่น

// Listen for changes in all documents in the 'users' collection and all subcollections
exports.useMultipleWildcards = functions.firestore
    .document('users/{userId}/{messageCollectionId}/{messageId}')
    .onWrite((change, context) => {
      // If we set `/users/marie/incoming_messages/134` to {body: "Hello"} then
      // context.params.userId == "marie";
      // context.params.messageCollectionId == "incoming_messages";
      // context.params.messageId == "134";
      // ... and ...
      // change.after.data() == {body: "Hello"}
    });
index.js

ทริกเกอร์เหตุการณ์

ทริกเกอร์ฟังก์ชันเมื่อมีการสร้างเอกสารใหม่

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

exports.createUser = functions.firestore
    .document('users/{userId}')
    .onCreate((snap, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = snap.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

เรียกใช้ฟังก์ชันเมื่อมีการอัปเดตเอกสาร

นอกจากนี้ คุณยังทริกเกอร์ฟังก์ชันให้เริ่มทำงานเมื่อมีการอัปเดตเอกสารได้โดยใช้ฟังก์ชัน onUpdate() ร่วมกับไวลด์การ์ด ตัวอย่างฟังก์ชันนี้จะเรียกใช้ updateUser หากผู้ใช้เปลี่ยนโปรไฟล์

exports.updateUser = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the document
      // e.g. {'name': 'Marie', 'age': 66}
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();

      // access a particular field as you would any JS property
      const name = newValue.name;

      // perform desired operations ...
    });
index.js

ทริกเกอร์ฟังก์ชันเมื่อมีการลบเอกสาร

นอกจากนี้ คุณยังเรียกใช้ฟังก์ชันเมื่อมีการลบเอกสารได้โดยใช้ฟังก์ชัน onDelete() ร่วมกับไวลด์การ์ด ตัวอย่างฟังก์ชันนี้จะเรียกใช้ deleteUser เมื่อผู้ใช้ลบโปรไฟล์ผู้ใช้ของตนเอง

exports.deleteUser = functions.firestore
    .document('users/{userID}')
    .onDelete((snap, context) => {
      // Get an object representing the document prior to deletion
      // e.g. {'name': 'Marie', 'age': 66}
      const deletedValue = snap.data();

      // perform desired operations ...
    });
index.js

ทริกเกอร์ฟังก์ชันสำหรับการเปลี่ยนแปลงทั้งหมดในเอกสาร

หากไม่สนใจประเภทเหตุการณ์ที่เริ่มทำงาน คุณสามารถฟังการเปลี่ยนแปลงทั้งหมดในเอกสาร Cloud Firestore โดยใช้ฟังก์ชัน onWrite() กับไวลด์การ์ด ตัวอย่างฟังก์ชันนี้จะเรียกใช้ modifyUser หากมีการสร้าง อัปเดต หรือลบผู้ใช้

exports.modifyUser = functions.firestore
    .document('users/{userID}')
    .onWrite((change, context) => {
      // Get an object with the current document value.
      // If the document does not exist, it has been deleted.
      const document = change.after.exists ? change.after.data() : null;

      // Get an object with the previous document value (for update or delete)
      const oldDocument = change.before.data();

      // perform desired operations ...
    });
index.js

ข้อมูลการอ่านและการเขียน

เมื่อมีการเรียกใช้ฟังก์ชัน ระบบจะแสดงภาพรวมของข้อมูลที่เกี่ยวข้องกับเหตุการณ์ คุณสามารถใช้สแนปชอตนี้เพื่ออ่านหรือเขียนลงในเอกสารที่ทริกเกอร์เหตุการณ์ หรือใช้ Firebase Admin SDK เพื่อเข้าถึงส่วนอื่นๆ ของฐานข้อมูล

ข้อมูลเหตุการณ์

ข้อมูลการอ่าน

เมื่อมีการเรียกใช้ฟังก์ชัน คุณอาจต้องการรับข้อมูลจากเอกสารที่อัปเดตแล้ว หรือรับข้อมูลก่อนการอัปเดต คุณสามารถรับข้อมูลก่อนหน้าได้โดยใช้ change.before.data() ซึ่งมีสแนปชอตเอกสารก่อนการอัปเดต ในทำนองเดียวกัน change.after.data() จะมีสถานะสแนปชอตของเอกสารหลังจากการอัปเดต

exports.updateUser2 = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Get an object representing the current document
      const newValue = change.after.data();

      // ...or the previous value before this update
      const previousValue = change.before.data();
    });
index.js

คุณสามารถเข้าถึงพร็อพเพอร์ตี้ได้เช่นเดียวกับในออบเจ็กต์อื่นๆ หรือจะใช้ฟังก์ชัน get เพื่อเข้าถึงช่องที่ต้องการก็ได้ ดังนี้

// Fetch data using standard accessors
const age = snap.data().age;
const name = snap.data()['name'];

// Fetch data using built in accessor
const experience = snap.get('experience');
index.js

ข้อมูลสำหรับการเขียน

การเรียกใช้ฟังก์ชันแต่ละครั้งจะเชื่อมโยงกับเอกสารที่เฉพาะเจาะจงในฐานข้อมูล Cloud Firestore คุณสามารถเข้าถึงเอกสารดังกล่าวเป็น DocumentReference ในพร็อพเพอร์ตี้ ref ของภาพรวมที่แสดงผลไปยังฟังก์ชันของคุณ

DocumentReference นี้มาจาก Cloud Firestore Node.js SDK และมีเมธอดต่างๆ เช่น update(), set() และ remove() เพื่อให้คุณแก้ไขเอกสารที่ทริกเกอร์ฟังก์ชันได้อย่างง่ายดาย

// Listen for updates to any `user` document.
exports.countNameChanges = functions.firestore
    .document('users/{userId}')
    .onUpdate((change, context) => {
      // Retrieve the current and previous value
      const data = change.after.data();
      const previousData = change.before.data();

      // We'll only update if the name has changed.
      // This is crucial to prevent infinite loops.
      if (data.name == previousData.name) {
        return null;
      }

      // Retrieve the current count of name changes
      let count = data.name_change_count;
      if (!count) {
        count = 0;
      }

      // Then return a promise of a set operation to update the count
      return change.after.ref.set({
        name_change_count: count + 1
      }, {merge: true});
    });
index.js

ข้อมูลนอกเหตุการณ์ทริกเกอร์

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

const admin = require('firebase-admin');
admin.initializeApp();

const db = admin.firestore();

exports.writeToFirestore = functions.firestore
  .document('some/doc')
  .onWrite((change, context) => {
    db.doc('some/otherdoc').set({ ... });
  });

ข้อจำกัด

โปรดทราบข้อจำกัดต่อไปนี้สำหรับทริกเกอร์ Cloud Firestore สำหรับ Cloud Functions

• Cloud Functions (รุ่นที่ 1) ต้องมีฐานข้อมูล "(ค่าเริ่มต้น)" อยู่แล้วในโหมดเนทีฟของ Firestore แต่จะไม่รองรับฐานข้อมูลที่มีชื่อ Cloud Firestore หรือโหมด Datastore โปรดใช้ Cloud Functions (รุ่นที่ 2) เพื่อกำหนดค่าเหตุการณ์ในกรณีดังกล่าว
• การตั้งค่าข้ามโปรเจ็กต์ด้วยทริกเกอร์ Cloud Functions และ Cloud Firestore เป็นข้อจำกัด หากต้องการตั้งค่าทริกเกอร์ Cloud Firestore Cloud Functions ต้องอยู่ในโปรเจ็กต์เดียวกัน
• ไม่รับประกันการจัดลำดับ การเปลี่ยนแปลงอย่างรวดเร็วอาจทำให้เกิดการเรียกใช้ฟังก์ชันในลำดับที่ไม่คาดคิด
• ระบบจะส่งเหตุการณ์อย่างน้อย 1 ครั้ง แต่เหตุการณ์เดียวอาจส่งผลให้มีการเรียกใช้ฟังก์ชันหลายครั้ง หลีกเลี่ยงการใช้กลไกแบบครั้งเดียวพอดี และเขียนฟังก์ชันที่ทำงานซ้ำได้
• Cloud Firestore ในโหมด Datastore ต้องใช้ Cloud Functions (รุ่นที่ 2) Cloud Functions (รุ่นที่ 1) ไม่รองรับโหมด Datastore
• ทริกเกอร์จะเชื่อมโยงกับฐานข้อมูลเดียว คุณไม่สามารถสร้างทริกเกอร์ที่ตรงกับฐานข้อมูลหลายรายการได้
• การลบฐานข้อมูลจะไม่ลบทริกเกอร์สำหรับฐานข้อมูลนั้นโดยอัตโนมัติ ทริกเกอร์จะหยุดส่งเหตุการณ์ แต่จะยังคงอยู่จนกว่าคุณจะลบทริกเกอร์
• หากเหตุการณ์ที่ตรงกันมีขนาดเกินขนาดคำขอสูงสุด ระบบอาจไม่ส่งเหตุการณ์ไปยัง Cloud Functions (รุ่นที่ 1)
  • ระบบจะบันทึกเหตุการณ์ที่ไม่ได้ส่งเนื่องจากขนาดคำขอไว้ในบันทึกของแพลตฟอร์ม และนับรวมในการใช้งานบันทึกสำหรับโปรเจ็กต์
  • คุณสามารถดูบันทึกเหล่านี้ได้ใน Logs Explorer พร้อมข้อความ "ไม่สามารถส่งเหตุการณ์ไปยัง Cloud Function ได้เนื่องจากขนาดเกินขีดจำกัดสำหรับรุ่นที่ 1..." ที่มีความรุนแรงระดับ error คุณจะดูชื่อฟังก์ชันได้ในช่อง functionName หากช่อง receiveTimestamp ยังคงอยู่ภายใน 1 ชั่วโมงนับจากนี้ คุณสามารถอนุมานเนื้อหาเหตุการณ์จริงได้โดยการอ่านเอกสารที่เป็นปัญหาพร้อมสแนปชอตก่อนและหลังการประทับเวลา
  • วิธีหลีกเลี่ยงการส่งอีเมลในลักษณะดังกล่าวมีดังนี้
    • ย้ายข้อมูลและอัปเกรดเป็น Cloud Functions (รุ่นที่ 2)
    • ลดขนาดเอกสาร
    • ลบ Cloud Functions ที่เป็นปัญหา
  • คุณสามารถปิดการบันทึกได้โดยใช้การยกเว้น แต่โปรดทราบว่าระบบจะยังคงไม่ส่งเหตุการณ์ที่ทำให้เกิดข้อผิดพลาด