Watch demos on how to build & run AI-powered apps with Firebase at Demo Day '24. Watch now.

Эта страница переведена с помощью Cloud Translation API.

Триггеры базы данных реального времени

С помощью Cloud Functions вы можете обрабатывать события в Firebase Realtime Database без необходимости обновлять клиентский код. Cloud Functions позволяют выполнять операции Realtime Database с полными административными привилегиями и гарантируют, что каждое изменение в Realtime Database обрабатывается индивидуально. Вы можете вносить изменения Firebase Realtime Database с помощью DataSnapshot или Admin SDK .

В типичном жизненном цикле функция Firebase Realtime Database выполняет следующие действия:

Ожидает изменений в определенном местоположении Realtime Database .
Запускается при возникновении события и выполняет свои задачи (примеры вариантов использования см. в разделе «Что я могу делать с Cloud Functions ? »).
Получает объект данных, содержащий снимок данных, хранящихся в указанном документе.

Запустить функцию Realtime Database

Создайте новые функции для событий Realtime Database с помощью functions.database . Чтобы контролировать срабатывание функции, укажите один из обработчиков событий и укажите путь Realtime Database , где она будет прослушивать события.

Установите обработчик событий

Функции позволяют обрабатывать события Realtime Database на двух уровнях специфичности; вы можете прослушивать только события создания, обновления или удаления, или вы можете прослушивать любые изменения любого типа в пути. Cloud Functions поддерживает следующие обработчики событий для Realtime Database :

onWrite() , который срабатывает, когда данные создаются, обновляются или удаляются в Realtime Database .
onCreate() , который срабатывает при создании новых данных в Realtime Database .
onUpdate() , который срабатывает при обновлении данных в Realtime Database .
onDelete() , который срабатывает при удалении данных из Realtime Database .

Укажите экземпляр и путь

Чтобы контролировать, когда и где должна срабатывать ваша функция, вызовите ref(path) для указания пути и, при необходимости, укажите экземпляр Realtime Database с помощью instance('INSTANCE_NAME') . Если вы не укажете экземпляр, функция развернется в экземпляре Realtime Database по умолчанию для проекта Firebase. Например:

Экземпляр Realtime Database по умолчанию: functions.database.ref('/foo/bar')
Экземпляр с именем «my-app-db-2»: functions.database.instance('my-app-db-2').ref('/foo/bar')

Эти методы предписывают вашей функции обрабатывать записи по определенному пути в экземпляре Realtime Database . Спецификации пути соответствуют всем операциям записи, касающимся пути, включая записи, происходящие где-либо ниже него. Если вы установите путь для своей функции как /foo/bar , он будет соответствовать событиям в обоих этих местах:

 /foo/bar
 /foo/bar/baz/really/deep/path

В любом случае Firebase интерпретирует, что событие происходит в /foo/bar , а данные события включают старые и новые данные в /foo/bar . Если данные о событиях могут быть большими, рассмотрите возможность использования нескольких функций на более глубоких путях вместо одной функции в корне вашей базы данных. Для достижения наилучшей производительности запрашивайте данные только на самом глубоком уровне.

Вы можете указать компонент пути как подстановочный знак, заключив его в фигурные скобки; ref('foo/{bar}') соответствует любому дочернему элементу /foo . Значения этих компонентов пути с подстановочными знаками доступны в объекте EventContext.params вашей функции. В этом примере значение доступно как context.params.bar .

Пути с подстановочными знаками могут соответствовать нескольким событиям одной записи. Вставка из

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

дважды соответствует пути "/foo/{bar}" : один раз с "hello": "world" и снова с "firebase": "functions" .

Обработка данных о событиях

При обработке события Realtime Database возвращаемым объектом данных является DataSnapshot . Для событий onWrite или onUpdate первым параметром является объект Change , содержащий два моментальных снимка, представляющих состояние данных до и после инициирующего события. Для событий onCreate и onDelete возвращаемый объект данных представляет собой снимок созданных или удаленных данных.

В этом примере функция получает снимок по указанному пути, преобразует строку в этом месте в верхний регистр и записывает эту измененную строку в базу данных:

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });index.js

Доступ к информации аутентификации пользователя

Из EventContext.auth и EventContext.authType вы можете получить доступ к информации о пользователе, включая разрешения, для пользователя, который запустил функцию. Это может быть полезно для обеспечения соблюдения правил безопасности, позволяя вашей функции выполнять различные операции в зависимости от уровня разрешений пользователя:

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');

exports.simpleDbFunction = functions.database.ref('/path')
    .onCreate((snap, context) => {
      if (context.authType === 'ADMIN') {
        // do something
      } else if (context.authType === 'USER') {
        console.log(snap.val(), 'written by', context.auth.uid);
      }
    });

Кроме того, вы можете использовать информацию аутентификации пользователя, чтобы «выдавать себя за пользователя» и выполнять операции записи от имени пользователя. Обязательно удалите экземпляр приложения, как показано ниже, чтобы предотвратить проблемы с параллелизмом:

exports.impersonateMakeUpperCase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snap, context) => {
      const appOptions = JSON.parse(process.env.FIREBASE_CONFIG);
      appOptions.databaseAuthVariableOverride = context.auth;
      const app = admin.initializeApp(appOptions, 'app');
      const uppercase = snap.val().toUpperCase();
      const ref = snap.ref.parent.child('uppercase');

      const deleteApp = () => app.delete().catch(() => null);

      return app.database().ref(ref).set(uppercase).then(res => {
        // Deleting the app is necessary for preventing concurrency leaks
        return deleteApp().then(() => res);
      }).catch(err => {
        return deleteApp().then(() => Promise.reject(err));
      });
    });

Чтение предыдущего значения

Объект Change имеет свойство before , которое позволяет вам проверить, что было сохранено в Realtime Database до события. Свойство before возвращает DataSnapshot , где все методы (например, val() и exists() ) ссылаются на предыдущее значение. Вы можете снова прочитать новое значение, используя исходный DataSnapshot или прочитав свойство after . Это свойство любого Change представляет собой еще один DataSnapshot представляющий состояние данных после того, как произошло событие.

Например, свойство before можно использовать, чтобы гарантировать, что функция будет отображать текст только в верхнем регистре при его первом создании:

exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onWrite((change, context) => {
      // Only edit data when it is first created.
      if (change.before.exists()) {
        return null;
      }
      // Exit when the data is deleted.
      if (!change.after.exists()) {
        return null;
      }
      // Grab the current value of what was written to the Realtime Database.
      const original = change.after.val();
      console.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return change.after.ref.parent.child('uppercase').set(uppercase);
    });

В типичном жизненном цикле функция Firebase Realtime Database выполняет следующие действия:

Ожидает изменений в определенном местоположении Realtime Database .
Запускается при возникновении события и выполняет свои задачи (примеры вариантов использования см. в разделе «Что я могу делать с Cloud Functions ? »).
Получает объект данных, содержащий снимок данных, хранящихся в указанном документе.

Запустить функцию Realtime Database

Установите обработчик событий

onWrite() , который срабатывает, когда данные создаются, обновляются или удаляются в Realtime Database .
onCreate() , который срабатывает при создании новых данных в Realtime Database .
onUpdate() , который срабатывает при обновлении данных в Realtime Database .
onDelete() , который срабатывает при удалении данных из Realtime Database .

Укажите экземпляр и путь

Экземпляр Realtime Database по умолчанию: functions.database.ref('/foo/bar')
Экземпляр с именем «my-app-db-2»: functions.database.instance('my-app-db-2').ref('/foo/bar')

 /foo/bar
 /foo/bar/baz/really/deep/path

Пути с подстановочными знаками могут соответствовать нескольким событиям одной записи. Вставка из

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

дважды соответствует пути "/foo/{bar}" : один раз с "hello": "world" и снова с "firebase": "functions" .

Обработка данных о событиях

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });index.js

Доступ к информации аутентификации пользователя

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');

exports.simpleDbFunction = functions.database.ref('/path')
    .onCreate((snap, context) => {
      if (context.authType === 'ADMIN') {
        // do something
      } else if (context.authType === 'USER') {
        console.log(snap.val(), 'written by', context.auth.uid);
      }
    });

exports.impersonateMakeUpperCase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snap, context) => {
      const appOptions = JSON.parse(process.env.FIREBASE_CONFIG);
      appOptions.databaseAuthVariableOverride = context.auth;
      const app = admin.initializeApp(appOptions, 'app');
      const uppercase = snap.val().toUpperCase();
      const ref = snap.ref.parent.child('uppercase');

      const deleteApp = () => app.delete().catch(() => null);

      return app.database().ref(ref).set(uppercase).then(res => {
        // Deleting the app is necessary for preventing concurrency leaks
        return deleteApp().then(() => res);
      }).catch(err => {
        return deleteApp().then(() => Promise.reject(err));
      });
    });

Чтение предыдущего значения

exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onWrite((change, context) => {
      // Only edit data when it is first created.
      if (change.before.exists()) {
        return null;
      }
      // Exit when the data is deleted.
      if (!change.after.exists()) {
        return null;
      }
      // Grab the current value of what was written to the Realtime Database.
      const original = change.after.val();
      console.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return change.after.ref.parent.child('uppercase').set(uppercase);
    });

В типичном жизненном цикле функция Firebase Realtime Database выполняет следующие действия:

Ожидает изменений в определенном местоположении Realtime Database .
Триггеры, когда происходит событие и выполняет свои задачи (см. Что я могу сделать с Cloud Functions ? Для примеров вариантов использования).
Получает объект данных, который содержит снимок данных, хранящихся в указанном документе.

Запустить функцию Realtime Database

Создайте новые функции для событий Realtime Database с functions.database . Чтобы контролировать, когда функция запускается, укажите один из обработчиков событий и укажите путь Realtime Database , где она будет прослушать события.

Установите обработчик событий

Функции позволяют вам обрабатывать события Realtime Database на двух уровнях специфичности; Вы можете слушать специально для событий создания, обновления или удаления, или вы можете прослушать любое изменение любого вида на путь. Cloud Functions поддерживают эти обработчики событий для Realtime Database :

onWrite() , который запускается, когда данные создаются, обновлены или удаляются в Realtime Database .
onCreate() , который запускается, когда новые данные создаются в Realtime Database .
onUpdate() , который запускается, когда данные обновляются в Realtime Database .
onDelete() , который запускается, когда данные удаляются из Realtime Database .

Укажите экземпляр и путь

Чтобы управлять тем, когда и когда ваша функция должна запустить, вызовите ref(path) чтобы указать путь, и при желании укажите экземпляр Realtime Database с instance('INSTANCE_NAME') . Если вы не указали экземпляр, функция развертывается в экземпляре Realtime Database для проекта Firebase, например:

Экземпляр Realtime Database по умолчанию: functions.database.ref('/foo/bar')
Экземпляр с именем "my-app-db-2": functions.database.instance('my-app-db-2').ref('/foo/bar')

Эти методы направляют вашу функцию для обработки записей на определенном пути в экземпляре Realtime Database . Спецификации пути соответствуют всем писаниям, которые касаются пути, в том числе писает, что происходит в любом месте под ним. Если вы установите путь для вашей функции как /foo/bar , он соответствует событиям в обоих этих местах:

 /foo/bar
 /foo/bar/baz/really/deep/path

В любом случае, Firebase интерпретирует, что событие происходит в /foo/bar , а данные о событии включают старые и новые данные AT /foo/bar . Если данные события могут быть большими, рассмотрите возможность использования нескольких функций на более глубоких путях вместо одной функции вблизи корня вашей базы данных. Для достижения наилучшей производительности запросить только данные на самом глубоком уровне.

Вы можете указать компонент пути в качестве подстановочного знака, окружая его кудрявыми кронштейнами; ref('foo/{bar}') соответствует любому ребенку /foo . Значения этих компонентов пути подстановочного знака доступны в объекте EventContext.params вашей функции. В этом примере значение доступно как context.params.bar .

Пути с подстановочными знаками могут соответствовать нескольким событиям из одной записи. Вставка

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

соответствует пути "/foo/{bar}" дважды: один раз с "hello": "world" и снова с "firebase": "functions" .

Обрабатывать данные о событиях

При обработке события Realtime Database возвращаемый объект данных является DataSnapshot . Для событий onWrite или onUpdate первый параметр - это объект Change , который содержит два снимка, которые представляют состояние данных до и после события запуска. Для событий onCreate и onDelete возвращаемый объект данных представляет собой снимок созданных или удаленных данных.

В этом примере функция извлекает снимок для указанного пути, преобразует строку в этом месте в верхний регистр и записывает, что измененная строка в базу данных:

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });index.js

Доступ к информации аутентификации пользователей

От EventContext.auth и EventContext.authType вы можете получить доступ к информации пользователя, включая разрешения, для пользователя, который запустил функцию. Это может быть полезно для обеспечения соблюдения правил безопасности, позволяя вашей функции выполнять различные операции на основе уровня разрешений пользователя:

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');

exports.simpleDbFunction = functions.database.ref('/path')
    .onCreate((snap, context) => {
      if (context.authType === 'ADMIN') {
        // do something
      } else if (context.authType === 'USER') {
        console.log(snap.val(), 'written by', context.auth.uid);
      }
    });

Кроме того, вы можете использовать информацию об аутентификации пользователей, чтобы «выдать себя за пользователя и выполнить операции записи от имени пользователя. Обязательно удалите экземпляр приложения, как показано ниже, чтобы предотвратить проблемы с параллелизмом:

exports.impersonateMakeUpperCase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snap, context) => {
      const appOptions = JSON.parse(process.env.FIREBASE_CONFIG);
      appOptions.databaseAuthVariableOverride = context.auth;
      const app = admin.initializeApp(appOptions, 'app');
      const uppercase = snap.val().toUpperCase();
      const ref = snap.ref.parent.child('uppercase');

      const deleteApp = () => app.delete().catch(() => null);

      return app.database().ref(ref).set(uppercase).then(res => {
        // Deleting the app is necessary for preventing concurrency leaks
        return deleteApp().then(() => res);
      }).catch(err => {
        return deleteApp().then(() => Promise.reject(err));
      });
    });

Чтение предыдущего значения

Объект Change имеет свойство before свойством, которое позволяет вам проверять то, что было сохранено в Realtime Database до события. Свойство before возврата DataSnapshot , где все методы (например, val() и exists() ), относятся к предыдущему значению. Вы можете снова прочитать новое значение, используя оригинальный DataSnapshot или прочитав свойство after . Это свойство в любом Change - это еще один DataSnapshot представляющий состояние данных после того, как событие произошло.

Например, свойство before можно использовать, чтобы убедиться, что функция текст только в верхних целях, когда оно впервые создано:

exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onWrite((change, context) => {
      // Only edit data when it is first created.
      if (change.before.exists()) {
        return null;
      }
      // Exit when the data is deleted.
      if (!change.after.exists()) {
        return null;
      }
      // Grab the current value of what was written to the Realtime Database.
      const original = change.after.val();
      console.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return change.after.ref.parent.child('uppercase').set(uppercase);
    });