Check out what’s new from Firebase at Google I/O 2022. Learn more

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

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

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

  • С вызываемыми объектами токены аутентификации Firebase, токены FCM и токены проверки приложений, если они доступны, автоматически включаются в запросы.
  • Триггер functions.https.onCall автоматически десериализует тело запроса и проверяет токены аутентификации.

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

  • Firebase SDK для платформ Apple 9.0.0
  • Firebase SDK для Android 20.1.0
  • Пакет SDK Firebase для JavaScript 8.10.1
  • Firebase Modular Web SDK версии 9.0

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

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

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

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

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

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

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

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

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

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

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

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

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

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

Чтобы убедиться, что клиент получает полезную информацию об ошибке, возвращайте ошибки из вызываемого объекта, выбрасывая (или возвращая промис, отклоненный) экземпляр 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 functions.https.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 (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

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

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

firebase deploy --only functions:addMessage

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

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

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

iOS+

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

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

  1. В Xcode при открытом проекте приложения перейдите в File > Add Packages .
  2. При появлении запроса добавьте репозиторий SDK Firebase для платформ Apple:
  3.   https://github.com/firebase/firebase-ios-sdk
      
  4. Выберите библиотеку облачных функций.
  5. Когда закончите, Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

Web version 9

  1. Следуйте инструкциям, чтобы добавить Firebase в ваше веб-приложение . Обязательно запустите следующую команду из своего терминала:
    npm install firebase@9.8.1 --save
    
  2. Вручную требуйте как ядро ​​Firebase, так и облачные функции:

     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 version 8

  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 для облачных функций также доступен в виде пакета npm.

  1. Запустите следующую команду из своего терминала:
    npm install firebase@8.10.1 --save
    
  2. Требовать вручную как ядро ​​Firebase, так и облачные функции:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Java

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

  2. Используя Firebase Android BoM , объявите зависимость для библиотеки Cloud Functions Android в файле Gradle вашего модуля (на уровне приложения) (обычно app/build.gradle ).

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:30.0.1')
    
        // Declare 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 {
        // Declare 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:20.1.0'
    }
    

Kotlin+KTX

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

  2. Используя Firebase Android BoM , объявите зависимость для библиотеки Cloud Functions Android в файле Gradle вашего модуля (на уровне приложения) (обычно app/build.gradle ).

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:30.0.1')
    
        // Declare 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-ktx'
    }
    

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

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

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

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

    dependencies {
        // Declare 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-ktx:20.1.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';
    

С++

Для С++ с Android :

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

Для C++ с платформами Apple :

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

Единство

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

Инициализировать клиентский SDK

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

Быстрый

lazy var functions = Functions.functions()

Цель-C

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

Web version 8

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 version 9

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

Java

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

Kotlin+KTX

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

Dart

final functions = FirebaseFunctions.instance;

С++

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

Единство

functions = Firebase.Functions.DefaultInstance;

Вызовите функцию

Быстрый

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

Цель-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 version 8

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

Web version 9

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

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

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

Dart

final result =
    await FirebaseFunctions.instance.httpsCallable('addMessage').call();

С++

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

Цель-C

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

Web version 8

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 version 9

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

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

                    // ...
                }

                // ...
            }
        });

Kotlin+KTX

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

                // ...
            }

            // ...
        })

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

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