Вызов функций из вашего приложения

2-е поколение 1-е поколение

Cloud Functions for Firebase позволяют вызывать функции непосредственно из приложения Firebase. Чтобы вызвать функцию из вашего приложения таким образом, напишите и разверните функцию HTTP Callable в Cloud Functions , а затем добавьте клиентскую логику для вызова функции из вашего приложения.

Важно помнить, что вызываемые функции HTTP похожи, но не идентичны функциям HTTP. Чтобы использовать вызываемые функции HTTP, вы должны использовать клиентский SDK для вашей платформы вместе с серверным API (или реализовать протокол). Вызываемые объекты имеют следующие ключевые отличия от функций HTTP:

• При использовании вызываемых объектов в запросы автоматически включаются токены Firebase Authentication , токены FCM и токены App Check , если они доступны.
• Триггер автоматически десериализует тело запроса и проверяет токены аутентификации.

Firebase SDK для Cloud Functions 2-го поколения и выше взаимодействует с этими минимальными версиями клиентского SDK Firebase для поддержки вызываемых функций HTTPS:

• Firebase SDK для платформ Apple 11.5.0
• Firebase SDK для Android 21.1.0
• Модульный веб-SDK Firebase версии 9.7.0

Если вы хотите добавить аналогичную функциональность в приложение, созданное на неподдерживаемой платформе, см. спецификацию протокола https.onCall . Остальная часть этого руководства содержит инструкции по написанию, развертыванию и вызову вызываемой функции HTTP для платформ Apple, Android, Интернета, C++ и Unity.

Напишите и разверните вызываемую функцию

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

Node.js

// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/v2/https");
const {logger} = require("firebase-functions/v2");

// Dependencies for the addMessage function.
const {getDatabase} = require("firebase-admin/database");
const sanitizer = require("./sanitizer");
index.js

Питон

# Dependencies for callable functions.
from firebase_functions import https_fn, options

# Dependencies for writing to Realtime Database.
from firebase_admin import db, initialize_app
main.py

Используйте обработчик запросов для вашей платформы ( functions.https.onCall ) или on_call , чтобы создать вызываемую функцию HTTPS. Этот метод принимает параметр запроса:

Node.js

// Saves a message to the Firebase Realtime Database but sanitizes the
// text by removing swearwords.
exports.addmessage = onCall((request) => {
  // ...
});
index.js

Питон

@https_fn.on_call()
def addmessage(req: https_fn.CallableRequest) -> Any:
    """Saves a message to the Firebase Realtime Database but sanitizes the text
    by removing swear words."""
main.py

Параметр request содержит данные, переданные из клиентского приложения, а также дополнительный контекст, например состояние аутентификации. Например, для вызываемой функции, которая сохраняет текстовое сообщение в Realtime Database , data могут содержать текст сообщения вместе с информацией для аутентификации в auth :

Node.js

// Message text passed from the client.
const text = request.data.text;
// Authentication / user information is automatically added to the request.
const uid = request.auth.uid;
const name = request.auth.token.name || null;
const picture = request.auth.token.picture || null;
const email = request.auth.token.email || null;
index.js

Питон

# Message text passed from the client.
text = req.data["text"]
main.py
# Authentication / user information is automatically added to the request.
uid = req.auth.uid
name = req.auth.token.get("name", "")
picture = req.auth.token.get("picture", "")
email = req.auth.token.get("email", "")
main.py

Расстояние между местоположением вызываемой функции и местоположением вызывающего клиента может привести к задержке в сети. Чтобы оптимизировать производительность, рассмотрите возможность указания местоположения функции , где это применимо, и обязательно согласуйте расположение вызываемого объекта с расположением, установленным при инициализации SDK на стороне клиента.

При желании вы можете прикрепить подтверждение App Check , чтобы защитить ваши серверные ресурсы от злоупотреблений, таких как мошенничество с выставлением счетов или фишинг. См . раздел Включение принудительной App Check для Cloud Functions .

Примечание. Для написания вызываемых функций используйте только API-интерфейсы functions.https или firebase_functions.https_fn . API триггера HTTP полностью отдельный и несовместим с вызываемыми функциями.

Отправка обратно результата

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

Node.js

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: "+",
  operationResult: firstNumber + secondNumber,
};
index.js

Питон

return {
    "firstNumber": first_number,
    "secondNumber": second_number,
    "operator": "+",
    "operationResult": first_number + second_number
}
main.py

Обработанный текст из примера текста сообщения возвращается как клиенту, так и в Realtime Database . В Node.js это можно сделать асинхронно с помощью обещания JavaScript:

Node.js

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize message.

return getDatabase().ref("/messages").push({
  text: sanitizedMessage,
  author: {uid, name, picture, email},
}).then(() => {
  logger.info("New Message written");
  // Returning the sanitized message to the client.
  return {text: sanitizedMessage};
})
index.js

Питон

# Saving the new message to the Realtime Database.
sanitized_message = sanitize_text(text)  # Sanitize message.
db.reference("/messages").push({  # type: ignore
    "text": sanitized_message,
    "author": {
        "uid": uid,
        "name": name,
        "picture": picture,
        "email": email
    }
})
print("New message written")

# Returning the sanitized message to the client.
return {"text": sanitized_message}
main.py

Настройка CORS (совместное использование ресурсов между источниками)

Используйте опцию cors , чтобы контролировать, какие источники могут получить доступ к вашей функции.

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

Node.js

const { onCall } = require("firebase-functions/v2/https");

exports.getGreeting = onCall(
  { cors: [/firebase\.com$/, "https://flutter.com"] },
  (request) => {
    return "Hello, world!";
  }
);

Чтобы запретить запросы между источниками, установите для политики cors значение false .

Обработка ошибок

Чтобы гарантировать, что клиент получает полезную информацию об ошибках, возвращайте ошибки из вызываемого объекта, выдавая (или для Node.js возвращая обещание, отклоненное с помощью) экземпляр functions.https.HttpsError или https_fn.HttpsError . Ошибка имеет атрибут code , который может быть одним из значений, перечисленных в кодах состояния gRPC. Ошибки также имеют строковое message , которое по умолчанию представляет собой пустую строку. Они также могут иметь необязательное поле details с произвольным значением. Если в ваших функциях возникает ошибка, отличная от ошибки HTTPS, ваш клиент вместо этого получает ошибку с сообщением INTERNAL и кодом internal .

Например, функция может выдавать ошибки проверки и аутентификации данных с сообщениями об ошибках для возврата вызывающему клиенту:

Node.js

// Checking attribute.
if (!(typeof text === "string") || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("invalid-argument", "The function must be called " +
          "with one arguments \"text\" containing the message text to add.");
}
// Checking that the user is authenticated.
if (!request.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("failed-precondition", "The function must be " +
          "called while authenticated.");
}
index.js

Питон

# Checking attribute.
if not isinstance(text, str) or len(text) < 1:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
                              message=('The function must be called with one argument, "text",'
                                       " containing the message text to add."))

# Checking that the user is authenticated.
if req.auth is None:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.FAILED_PRECONDITION,
                              message="The function must be called while authenticated.")
main.py

Развертывание вызываемой функции

После сохранения завершенной вызываемой функции в index.js она развертывается вместе со всеми другими функциями при запуске firebase deploy . Чтобы развернуть только вызываемый объект, используйте аргумент --only как показано, для выполнения частичного развертывания :

firebase deploy --only functions:addMessage

Если вы столкнулись с ошибками разрешений при развертывании функций, убедитесь, что соответствующие роли IAM назначены пользователю, выполняющему команды развертывания.

Настройте среду разработки клиентов

Убедитесь, что вы соответствуете всем предварительным требованиям, а затем добавьте в свое приложение необходимые зависимости и клиентские библиотеки.

iOS+

Следуйте инструкциям, чтобы добавить Firebase в свое приложение Apple .

Используйте Swift Package Manager для установки зависимостей Firebase и управления ими.

Посетите наше руководство по установке, чтобы узнать о различных способах добавления Firebase SDK в ваш проект Apple, включая прямой импорт фреймворков и использование CocoaPods.

1. В Xcode, открыв проект приложения, выберите «Файл» > «Добавить пакеты» .
2. При появлении запроса добавьте репозиторий Firebase SDK для платформ Apple:

  https://github.com/firebase/firebase-ios-sdk.git

Примечание. В новых проектах должна использоваться версия SDK по умолчанию (последняя), но при необходимости вы можете выбрать более старую версию.
3. Выберите библиотеку Cloud Functions .
4. Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей цели.
5. По завершении Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

Web

1. Следуйте инструкциям, чтобы добавить Firebase в свое веб-приложение . Обязательно запустите следующую команду со своего терминала:

   npm install firebase@11.0.2 --save

2. Вручную потребуйте как ядро ​​Firebase, так и Cloud Functions :

    import { initializeApp } from 'firebase/app';
    import { getFunctions } from 'firebase/functions';
   
    const app = initializeApp({
        projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
        apiKey: '### FIREBASE API KEY ###',
        authDomain: '### FIREBASE AUTH DOMAIN ###',
      });
    const functions = getFunctions(app);

Андроид

1. Следуйте инструкциям, чтобы добавить Firebase в свое приложение для Android .

2. В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) добавьте зависимость для Cloud Functions . библиотека для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.6.0"))
   
       // Add the dependency for the Cloud Functions library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions")
   }

   Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.

   (Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM

   Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.

   Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.

   dependencies {
       // Add the dependency for the Cloud Functions library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions:21.1.0")
   }

   Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).

Инициализируйте клиентский SDK

Инициализируйте экземпляр Cloud Functions :

Быстрый

lazy var functions = Functions.functions()
CloudAddCell.swift

Цель-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];
CloudAddCell.m

Web

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

Kotlin+KTX

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functions
MainActivity.kt

Java

private FirebaseFunctions mFunctions;
// ...
mFunctions = FirebaseFunctions.getInstance();
MainActivity.java

Примечание. Чтобы вызвать функцию, работающую в любом месте, кроме us-central1 по умолчанию, вы должны установить соответствующее значение при инициализации. Например, на Android вы должны инициализировать getInstance(FirebaseApp app, String region) .

Вызов функции

Быстрый

functions.httpsCallable("addMessage").call(["text": inputField.text]) { result, error in
  if let error = error as NSError? {
    if error.domain == FunctionsErrorDomain {
      let code = FunctionsErrorCode(rawValue: error.code)
      let message = error.localizedDescription
      let details = error.userInfo[FunctionsErrorDetailsKey]
    }
    // ...
  }
  if let data = result?.data as? [String: Any], let text = data["text"] as? String {
    self.resultField.text = text
  }
}
CommentCell.swift

Цель-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if ([error.domain isEqual:@"com.firebase.functions"]) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[@"details"];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });
callable.js

Web

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  });
fb_functions_call_add_message.js

Kotlin+KTX

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true,
    )

    return functions
        .getHttpsCallable("addMessage")
        .call(data)
        .continueWith { task ->
            // This continuation runs on either success or failure, but if the task
            // has failed then result will throw an Exception which will be
            // propagated down.
            val result = task.result?.data as String
            result
        }
}
MainActivity.kt

Java

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}
MainActivity.java

Dart

    final result = await FirebaseFunctions.instance.httpsCallable('addMessage').call(
      {
        "text": text,
        "push": true,
      },
    );
    _response = result.data as String;

С++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const std::string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Единство

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

Обработка ошибок на клиенте

Клиент получает сообщение об ошибке, если сервер выдал ошибку или полученное обещание было отклонено.

Если ошибка, возвращаемая функцией, имеет тип function.https.HttpsError , то клиент получает code ошибки, message и details об ошибке сервера. В противном случае ошибка содержит сообщение INTERNAL и код INTERNAL . См. руководство по обработке ошибок в вызываемой функции.

Быстрый

if let error = error as NSError? {
  if error.domain == FunctionsErrorDomain {
    let code = FunctionsErrorCode(rawValue: error.code)
    let message = error.localizedDescription
    let details = error.userInfo[FunctionsErrorDetailsKey]
  }
  // ...
}
CloudAddCell.swift

Цель-C

if (error) {
  if ([error.domain isEqual:@"com.firebase.functions"]) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[@"details"];
  }
  // ...
}
CloudAddCell.m

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    var code = error.code;
    var message = error.message;
    var details = error.details;
    // ...
  });
callable.js

Web

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    const code = error.code;
    const message = error.message;
    const details = error.details;
    // ...
  });
fb_functions_call_add_message_error.js

Kotlin+KTX

addMessage(inputMessage)
    .addOnCompleteListener { task ->
        if (!task.isSuccessful) {
            val e = task.exception
            if (e is FirebaseFunctionsException) {
                val code = e.code
                val details = e.details
            }
        }
    }
MainActivity.kt

Java

addMessage(inputMessage)
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (!task.isSuccessful()) {
                    Exception e = task.getException();
                    if (e instanceof FirebaseFunctionsException) {
                        FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
                        FirebaseFunctionsException.Code code = ffe.getCode();
                        Object details = ffe.getDetails();
                    }
                }
            }
        });
MainActivity.java

Dart

try {
  final result =
      await FirebaseFunctions.instance.httpsCallable('addMessage').call();
} on FirebaseFunctionsException catch (error) {
  print(error.code);
  print(error.details);
  print(error.message);
}

С++

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult* result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  std::string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
  // ...

Единство

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});

Рекомендуется: предотвратите злоупотребления с помощью App Check

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