Подключите свое приложение и начните создавать прототипы

База данных


Прежде чем приступить к работе с Firebase Local Emulator Suite , убедитесь, что вы создали проект Firebase, настроили среду разработки, а также выбрали и установили Firebase SDK для своей платформы в соответствии с темами «Начало работы с Firebase» для вашей платформы: Apple , Android или Web .

Прототип и тест

Local Emulator Suite содержит несколько эмуляторов продуктов, как описано в разделе Введение в Firebase Local Emulator Suite . Вы можете создавать прототипы и тестировать как отдельные эмуляторы, так и комбинации эмуляторов, как вам удобно, в соответствии с тем, какие продукты Firebase вы используете в производстве.

Взаимодействие между базой данных Firebase и эмуляторами функций
Эмуляторы баз данных и Cloud Functions как часть полного Local Emulator Suite .

В этой теме, чтобы представить рабочий процесс Local Emulator Suite , предположим, что вы работаете над приложением, которое использует типичную комбинацию продуктов: базу данных Firebase и облачные функции, запускаемые операциями в этой базе данных.

После локальной инициализации проекта Firebase цикл разработки с использованием Local Emulator Suite обычно будет состоять из трех этапов:

  1. Прототипные функции интерактивны с эмуляторами и Emulator Suite UI .

  2. Если вы используете эмулятор базы данных или эмулятор Cloud Functions , выполните один шаг, чтобы подключить свое приложение к эмуляторам.

  3. Автоматизируйте свои тесты с помощью эмуляторов и пользовательских скриптов.

Локально инициализируйте проект Firebase

Обязательно установите CLI или обновите его до последней версии .

curl -sL firebase.tools | bash

Если вы еще этого не сделали, инициализируйте текущий рабочий каталог как проект Firebase, следуя подсказкам на экране, чтобы указать, что вы используете Cloud Functions и либо Cloud Firestore , либо Realtime Database :

firebase init

Теперь каталог вашего проекта будет содержать файлы конфигурации Firebase, файл определения Firebase Security Rules для базы данных, каталог functions содержащий код облачных функций, и другие вспомогательные файлы.

Прототип интерактивно

Local Emulator Suite разработан для того, чтобы вы могли быстро создавать прототипы новых функций, а встроенный пользовательский интерфейс Suite является одним из самых полезных инструментов прототипирования. Это немного похоже на то, как если бы консоль Firebase работала локально.

Используя Emulator Suite UI , вы можете итерировать дизайн базы данных, пробовать различные потоки данных, включающие облачные функции, оценивать изменения правил безопасности, проверять журналы, чтобы подтвердить, как работают ваши внутренние службы, и многое другое. Затем, если вы хотите начать заново, просто очистите свою базу данных и начните заново с новой идеей дизайна.

Все это доступно при запуске Local Emulator Suite с помощью:

firebase emulators:start

Чтобы создать прототип нашего гипотетического приложения, давайте настроим и протестируем базовую облачную функцию для изменения текстовых записей в базе данных, а также создадим и заполним эту базу данных в Emulator Suite UI для ее запуска.

  1. Создайте облачную функцию, запускаемую записью в базу данных, отредактировав файл functions/index.js в каталоге проекта. Замените содержимое существующего файла следующим фрагментом. Эта функция прослушивает изменения документов в коллекции messages , преобразует содержимое original поля документа в верхний регистр и сохраняет результат в uppercase поле этого документа. 
    2.   const functions = require('firebase-functions/v1');

  exports.makeUppercase = functions.firestore.document('/messages/{documentId}')
      .onCreate((snap, context) => {
        const original = snap.data().original;
        console.log('Uppercasing', context.params.documentId, original);
        const uppercase = original.toUpperCase();
        return snap.ref.set({uppercase}, {merge: true});
      });
  2. Запустите Local Emulator Suite с помощью firebase emulators:start . Cloud Functions и эмуляторы баз данных запускаются, автоматически настраиваясь на взаимодействие.
  3. Просмотрите пользовательский интерфейс в браузере по адресу http://localhost:4000 . Порт 4000 является портом по умолчанию для пользовательского интерфейса, но проверьте сообщения терминала, выводимые Firebase CLI. Обратите внимание на статус доступных эмуляторов. В нашем случае будут запущены эмуляторы Cloud Functions и Cloud Firestore .
    Мой образ
  4. В пользовательском интерфейсе на вкладке Firestore > Данные нажмите Начать сбор и следуйте подсказкам, чтобы создать новый документ в коллекции messages с именем поля original и значением test . Это активирует нашу облачную функцию. Обратите внимание, что вскоре появится новое поле uppercase , заполненное строкой "TEST".
    Мой образМой образ
  5. На вкладке Firestore > Запросы изучите запросы, отправленные в вашу эмулируемую базу данных, включая все оценки Firebase Security Rules , выполненные в рамках выполнения этих запросов.
  6. Проверьте вкладку «Журналы» , чтобы убедиться, что ваша функция не столкнулась с ошибками при обновлении базы данных.

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

Подключите свое приложение к эмуляторам

Когда вы достигнете хорошего прогресса в интерактивном прототипировании и определитесь с дизайном, вы будете готовы добавить код доступа к базе данных в свое приложение с помощью соответствующего SDK. Вы продолжите использовать вкладку базы данных и, для функций, вкладку Logs в Emulator Suite UI чтобы подтвердить, что поведение вашего приложения является правильным.

Помните, что Local Emulator Suite — это локальный инструмент разработки. Записи в ваши производственные базы данных не будут запускать функции, которые вы прототипируете локально.

Чтобы переключиться на выполнение приложением записи в базу данных, вам необходимо указать тестовые классы или конфигурацию приложения на эмуляторе Cloud Firestore .

Kotlin
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val firestore = Firebase.firestore
firestore.useEmulator("10.0.2.2", 8080)

firestore.firestoreSettings = firestoreSettings {
    isPersistenceEnabled = false
}
EmulatorSuite.kt
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFirestore firestore = FirebaseFirestore.getInstance();
firestore.useEmulator("10.0.2.2", 8080);

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(false)
        .build();
firestore.setFirestoreSettings(settings);
EmulatorSuite.java
Быстрый 
let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settings
ViewController.swift

Web 

import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);
fs_emulator_connect.js

Web

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("127.0.0.1", 8080);
}
emulator-suite.js

Автоматизируйте свои тесты с помощью пользовательских скриптов

Теперь последний шаг общего рабочего процесса. После того, как вы создали прототип своей функции в приложении и она выглядит многообещающе на всех ваших платформах, вы можете перейти к окончательной реализации и тестированию. Для модульного тестирования и рабочих процессов CI вы можете запускать эмуляторы, запускать скриптовые тесты и выключать эмуляторы одним вызовом с помощью команды exec : 

firebase emulators:exec "./testdir/test.sh"

Изучите отдельные эмуляторы более подробно

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

Что дальше?

Обязательно прочтите темы, связанные с конкретными эмуляторами, ссылки на которые приведены выше. Затем: