ทริกเกอร์ Cloud Firestore

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

ในวงจรชีวิตทั่วไป ฟังก์ชัน Cloud Firestore จะทำสิ่งต่อไปนี้:

  1. รอการเปลี่ยนแปลงในเอกสารเฉพาะ
  2. ทริกเกอร์เมื่อมีเหตุการณ์เกิดขึ้นและดำเนินงาน (ดู สิ่งที่ฉันสามารถทำอะไรกับฟังก์ชั่นคลาวด์? สำหรับตัวอย่างของกรณีการใช้งาน)
  3. รับออบเจ็กต์ข้อมูลที่มีสแน็ปช็อตของข้อมูลที่จัดเก็บไว้ในเอกสารที่ระบุ สำหรับ onWrite หรือ onUpdate เหตุการณ์ข้อมูลวัตถุมีสองภาพรวมที่เป็นตัวแทนของรัฐข้อมูลก่อนและหลังเหตุการณ์วิกฤติ

ระยะห่างระหว่างตำแหน่งของอินสแตนซ์ Firestore และตำแหน่งของฟังก์ชันสามารถสร้างเวลาแฝงของเครือข่ายที่สำคัญได้ เพื่อเพิ่มประสิทธิภาพการปฏิบัติงานให้พิจารณาระบุ ที่ตั้งของฟังก์ชั่น ที่ใช้

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

ฟังก์ชั่นคลาวด์สำหรับ Firebase SDK ส่งออก functions.firestore วัตถุที่ช่วยให้คุณสามารถสร้างไสเชื่อมโยงกับเหตุการณ์ที่เกิดขึ้นเฉพาะเมฆ FireStore

ประเภทงาน สิ่งกระตุ้น
onCreate ทริกเกอร์เมื่อมีการเขียนเอกสารเป็นครั้งแรก
onUpdate ทริกเกอร์เมื่อมีเอกสารอยู่แล้วและมีการเปลี่ยนแปลงค่าใดๆ
onDelete ทริกเกอร์เมื่อเอกสารที่มีข้อมูลถูกลบ
onWrite เรียกเมื่อ onCreate , onUpdate หรือ onDelete จะถูกเรียก

หากคุณไม่ได้มีโครงการที่เปิดใช้งานฟังก์ชั่นสำหรับระบบคลาวด์สำหรับ Firebase ๆ อ่านแล้ว เริ่มต้น: การเขียนและการปรับใช้ฟังก์ชั่นครั้งแรกของคุณ ในการกำหนดค่าและการตั้งค่าฟังก์ชั่นคลาวด์ของคุณสำหรับโครงการ Firebase

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

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

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

Node.js

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

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

เส้นทางเอกสารสามารถอ้างอิงทั้ง เอกสารที่ระบุ หรือ รูปแบบสัญลักษณ์แทน

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

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

Node.js

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

ระบุกลุ่มเอกสารโดยใช้สัญลักษณ์แทน

หากคุณต้องการที่จะแนบทริกเกอร์ให้กับกลุ่มของเอกสารดังกล่าวเป็นเอกสารใด ๆ ในคอลเลกชันบางอย่างแล้วใช้ {wildcard} ในสถานที่ของรหัสเอกสาร:

Node.js

// 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"}
    });

ในตัวอย่างนี้เมื่อเขตข้อมูลใด ๆ ในเอกสารใด ๆ ใน users มีการเปลี่ยนแปลงมันตรงกับตัวแทนที่เรียกว่า userId

หากเอกสารใน users มีการสะสมย่อยและข้อมูลในเอกสารการสะสมย่อยเหล่านั้นมีการเปลี่ยนแปลงที่ userId สัญลักษณ์แทนไม่ได้เรียก

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

Node.js

// 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"}
    });

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

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

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

Node.js

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 ...
    });

ทริกเกอร์ฟังก์ชันเมื่อมีการอัปเดตเอกสาร

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

Node.js

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 ...
    });

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

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

Node.js

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 ...
    });

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

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

Node.js

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 ...
    });

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

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

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

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

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

Node.js

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();
    });

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

Node.js

// 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');

กำลังเขียนข้อมูล

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

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

Node.js

// 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});
    });

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

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

Node.js

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:

  • ไม่รับประกันการสั่งซื้อ การเปลี่ยนแปลงอย่างรวดเร็วสามารถทริกเกอร์การเรียกใช้ฟังก์ชันในลำดับที่ไม่คาดคิดได้
  • เหตุการณ์ถูกส่งอย่างน้อยหนึ่งครั้ง แต่เหตุการณ์เดียวอาจส่งผลให้มีการเรียกใช้ฟังก์ชันหลายรายการ หลีกเลี่ยงการขึ้นอยู่กับว่าครั้งเดียวกลศาสตร์และการเขียน ฟังก์ชั่น idempotent
  • ทริกเกอร์เมฆ FireStore สำหรับฟังก์ชั่นคลาวด์จะใช้ได้เฉพาะ เมฆ FireStore ในโหมดพื้นเมือง ไม่พร้อมใช้งานสำหรับ Cloud Firestore ในโหมด Datastore