Как вызывать функции из приложения (1-е поколение)

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

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

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

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

  • Firebase SDK для платформ Apple 13.0.0
  • Firebase SDK для Android 23.0.0
  • Firebase Modular Web SDK версии 9.7.0

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

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

Чтобы создать вызываемую функцию HTTPS, используйте functions.https.onCall. Этот метод принимает два параметра: data и необязательный context.

  // Saves a message to the Firebase Realtime Database but sanitizes the
  // text by removing swearwords.
  exports.addMessage = functions.https.onCall((data, context) => {
    // ...
  });
  

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

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

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

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

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

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

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

Чтобы вернуть данные после асинхронной операции, верните объект Promise. Данные, возвращенные обещанием, отправляются обратно клиенту. Например, вы можете вернуть очищенный текст, который вызываемая функция записала в Realtime Database:

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

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

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

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

// 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, она будет развернута вместе со всеми остальными функциями при запуске firebase deploy. Чтобы развернуть только вызываемую функцию, используйте аргумент --only, как показано ниже, для выполнения частичного развертывания:

firebase deploy --only functions:addMessage

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

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

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

iOS+

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

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

  1. Откройте проект приложения в Xcode и перейдите в меню File (Файл) > Add Packages (Добавить пакеты).
  2. Когда появится запрос, добавьте хранилище Firebase SDK для платформ Apple:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Выберите библиотеку Cloud Functions.
  5. Добавьте флаг -ObjC в раздел Other Linker Flags (Другие флаги компоновщика) в настройках сборки целевого объекта.
  6. После этого Xcode автоматически начнет распознавать и скачивать зависимости в фоновом режиме.

Web

  1. Следуйте инструкциям, чтобы добавить Firebase в веб-приложение. Обязательно выполните в терминале следующую команду:
    npm install firebase@13.0.0 --save
  2. Вручную добавьте Firebase Core и 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);

Web

  1. Следуйте инструкциям, чтобы добавить Firebase в веб-приложение.
  2. Добавьте в приложение основные клиентские библиотеки Firebase и Cloud Functions:
    <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-functions.js"></script>

SDK Cloud Functions также доступен в виде пакета npm.

  1. Выполните в терминале следующую команду:
    npm install firebase@8.10.1 --save
  2. Вручную добавьте Firebase Core и Cloud Functions:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");

Kotlin

  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:35.0.2"))
    
        // 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:23.0.0")
    }

Java

  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:35.0.2"))
    
        // 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:23.0.0")
    }

Dart

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

  2. Чтобы установить плагин, выполните следующую команду в корневом каталоге проекта Flutter:

    flutter pub add cloud_functions
    
  3. После этого пересоберите приложение Flutter:

    flutter run
    
  4. После установки вы можете получить доступ к плагину cloud_functions, импортировав его в код Dart:

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

Для C++ с Android:

  1. Следуйте инструкциям, чтобы добавить Firebase в проект C++.
  2. Добавьте библиотеку firebase_functions в файл CMakeLists.txt.

Для C++ на платформах Apple:

  1. Следуйте инструкциям, чтобы добавить Firebase в проект C++.
  2. Добавьте pod-файл Cloud Functions в Podfile:
    pod 'Firebase/Functions'
  3. Сохраните файл и выполните следующую команду:
    pod install
  4. Добавьте в проект Xcode фреймворки Firebase Core и Cloud Functions из Firebase C++ SDK.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Следуйте инструкциям, чтобы добавить Firebase в проект Unity.
  2. Добавьте FirebaseFunctions.unitypackage из Firebase Unity SDK в проект Unity.

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

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

Swift

lazy var functions = Functions.functions()

Objective-C

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

Web

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

Web

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

Kotlin

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

Java

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

Dart

final functions = FirebaseFunctions.instance;

C++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

Unity

functions = Firebase.Functions.DefaultInstance;

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

Swift

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
  }
}

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

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

Kotlin

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
        }
}

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

Dart

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

C++

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

Unity

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. Ознакомьтесь с рекомендациями по обработке ошибок в вызываемой функции.

Swift

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]
  }
  // ...
}

Objective-C

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

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

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

Kotlin

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

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

Dart

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

C++

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

Unity

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

Как задать время ожидания клиента

По умолчанию клиентские SDK Cloud Functions используют 70-секундный тайм-аут для вызываемых запросов. Если вызываемая функция выполняется дольше 70 секунд, клиентский SDK завершает запрос с ошибкой DEADLINE_EXCEEDED (deadline-exceeded), даже если вы настроили более длительное время ожидания на стороне сервера.

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

  1. Увеличьте время ожидания функции на стороне сервера (см. раздел Как задать время ожидания и распределение памяти).
  2. Увеличьте время ожидания на стороне клиента при настройке вызываемой ссылки в приложении:

Swift

let callable = functions.httpsCallable("addMessage")
callable.timeoutInterval = 300  // 300 seconds (default is 70)
let result = try await callable.call(["text": text, "push": true])

Objective-C

FIRHTTPSCallable *callable = [self.functions HTTPSCallableWithName:@"addMessage"];
callable.timeoutInterval = 300;  // 300 seconds (default is 70)
[callable callWithObject:@{@"text": text, @"push": @YES}
              completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  // ...
}];

Web

var addMessage = firebase.functions().httpsCallable('addMessage', {
  timeout: 300000,  // 300 seconds in milliseconds (default is 70000)
});
addMessage({ text: messageText })
  .then((result) => {
    // ...
  });

Web

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

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage', {
  timeout: 300000,  // 300 seconds in milliseconds (default is 70000)
});
const result = await addMessage({ text: messageText });

Kotlin

val callable = functions.getHttpsCallable("addMessage")
callable.setTimeout(300L, TimeUnit.SECONDS)
val result = callable.call(data).await()

Java

HttpsCallableReference callable = mFunctions.getHttpsCallable("addMessage");
callable.setTimeout(300L, TimeUnit.SECONDS);
Task<HttpsCallableResult> result = callable.call(data);

Dart

final callable = FirebaseFunctions.instance.httpsCallable(
  'addMessage',
  options: HttpsCallableOptions(
    timeout: const Duration(seconds: 300),
  ),
);
final result = await callable.call({
  'text': text,
  'push': true,
});

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

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