Chamar funções no seu aplicativo

2ª geração 1ª geração

Com os SDKs do cliente do Cloud Functions para Firebase, é possível chamar funções diretamente de um app do Firebase. Para isso, crie e implante uma função HTTP chamável no Cloud Functions e adicione a lógica do cliente para chamar a função no seu app.

É importante ter em mente que as funções chamáveis HTTP são semelhantes, mas não são idênticas às funções HTTP. Para usar as funções HTTP chamáveis, use o SDK do cliente da sua plataforma com a API de back-end ou implemente o protocolo. Confira a seguir a diferença entre as funções chamáveis e as HTTP:

• Com as funções chamáveis, os tokens do Firebase Authentication, do FCM e do App Check serão incluídos automaticamente nas solicitações quando estiverem disponíveis.
• O gatilho desserializa automaticamente o corpo da solicitação e valida os tokens de autenticação.

O SDK do Firebase para Cloud Functions (2ª geração) e versões posteriores interopera com as versões mínimas do SDK de cliente do Firebase para oferecer suporte a funções HTTPS chamáveis:

• SDK do Firebase para as plataformas da Apple 10.15.0
• SDK do Firebase para Android 20.3.1
• SDK modular do Firebase para Web 9.7.0

Se você quiser adicionar um recurso semelhante a um app criado em uma plataforma sem suporte, consulte a Especificação de protocolo para https.onCall. Você vai encontrar instruções na outra parte deste guia sobre como criar, implantar e chamar uma função HTTP chamável em plataformas da Apple, Android, Web, C++ e Unity.

Escrever e implantar a função chamável

Os exemplos de código nesta seção são baseados em uma amostra de início rápido completa que demonstra como enviar solicitações para uma função do lado do servidor e receber uma resposta usando um dos SDKs do cliente. Para começar, importe os módulos necessários:

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

Python (pré-lançamento)

# 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

Use o gerenciador de solicitações da plataforma (functions.https.onCall) ou on_call para criar uma função HTTPS chamável. Esse método usa um parâmetro de solicitação:

Node.js

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

Python (pré-lançamento)

@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

O parâmetro request contém dados transmitidos do app cliente, além de mais contexto, como o estado de autenticação. Para uma função chamável que salva uma mensagem de texto no Realtime Database, por exemplo, data pode conter o texto da mensagem, além de informações de autenticação em 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

Python (pré-lançamento)

# 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

A distância entre o local da função chamável e o do cliente que faz o chamado pode criar uma latência de rede significativa. Para otimizar o desempenho, especifique o local da função, quando aplicável, e alinhe o local da função chamável com o local definido ao inicializar o SDK no lado do cliente.

Como alternativa, é possível anexar um atestado do App Check para ajudar a proteger seus recursos de back-end contra abusos, como fraude de faturamento ou phishing. Consulte Ativar a aplicação do App Check no Cloud Functions.

Observação: use apenas as APIs de back-end functions.https ou firebase_functions.https_fn para gravar funções chamáveis. A API de gatilho HTTP é totalmente independente e não interoperável com esse tipo de função.

Como enviar o resultado de volta

Para enviar dados de volta para o cliente, retorne dados que podem ser codificados com JSON. Por exemplo, para retornar o resultado de uma operação de adição:

Node.js

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

Python (pré-lançamento)

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

O texto limpo do exemplo de texto da mensagem é retornado ao cliente e ao Realtime Database. No Node.js, isso pode ser feito de maneira assíncrona, usando uma promessa do 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

Python (pré-lançamento)

# 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

Configurar CORS (Compartilhamento de recursos entre origens)

Use a opção cors para controlar quais origens podem acessar a função.

Por padrão, as funções chamáveis têm o CORS configurado para permitir solicitações de todas as origens. Para permitir algumas solicitações de origem cruzada, mas não todas, transmita uma lista de domínios específicos ou expressões regulares que precisam ser permitidas. Exemplo:

Node.js

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

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

Para proibir solicitações de origem cruzada, defina a política cors como false.

Tratar erros

Para garantir que o cliente receba detalhes úteis de erros, retorne erros de uma função chamável ao emitir (ou Node.js retorna uma promessa rejeitada com) uma instância de functions.https.HttpsError ou https_fn.HttpsError. O erro tem um atributo code que pode ser um dos valores listados nos códigos de status do gRPC. Os erros também têm uma string message, que tem como padrão uma string vazia. Eles também podem ter um campo details opcional com um valor arbitrário. Se um erro diferente de HTTPS for gerado pelas suas funções, o cliente receberá um erro com a mensagem INTERNAL e o código internal.

Por exemplo, uma função pode emitir erros de validação de dados e autenticação com mensagens de erro para retornar ao cliente que faz o chamado:

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

Python (pré-lançamento)

# 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

Implantar a função chamável

Depois que você salva uma função chamável completa dentro do index.js, ela é implantada com todas as outras funções quando você executa firebase deploy. Para implementar somente a função chamável, use o argumento --only conforme mostrado a fim de executar implantações parciais:

firebase deploy --only functions:addMessage

Se você encontrar erros de permissão ao implantar funções, verifique se os papéis do IAM apropriados estão atribuídos ao usuário que executa os comandos de implantação.

Como configurar o ambiente de desenvolvimento do cliente

Verifique se você cumpre todos os pré-requisitos e adicione as dependências e bibliotecas de cliente necessárias ao app.

iOS+

Siga as instruções para adicionar o Firebase ao seu app da Apple.

Use o Swift Package Manager para instalar e gerenciar as dependências do Firebase.

Acesse nosso guia de instalação e conheça as diferentes maneiras de adicionar SDKs do Firebase ao seu projeto da Apple, incluindo detalhes sobre importação direta de frameworks e uso do CocoaPods.

1. No Xcode, com seu projeto do app aberto, navegue até File > Add Packages.
2. Quando solicitado, adicione o repositório do SDK do Firebase para as plataformas Apple:

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

Observação: novos projetos precisam usar a versão padrão (mais recente) do SDK, mas você pode escolher uma mais antiga, se necessário.
3. Escolha a biblioteca do Cloud Functions.
4. Quando terminar, o Xcode vai começar a resolver e fazer o download das dependências em segundo plano automaticamente.

API modular da Web

1. Siga as instruções para adicionar o Firebase ao seu app da Web. Execute o seguinte comando no seu terminal:

   npm install firebase@10.4.0 --save
   

2. Solicite manualmente o Firebase Core e o 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);
   

Kotlin+KTX

1. Siga as instruções para adicionar o Firebase ao seu app Android.

2. No arquivo do Gradle (nível do app) do módulo, (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), adicione a dependência da biblioteca do Cloud Functions para Android. Para gerenciar o controle de versões das bibliotecas, recomendamos usar a BoM do Firebase para Android.

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

   Com a BoM do Firebase para Android, seu app sempre vai usar versões compatíveis das bibliotecas do Firebase para Android.

   (Alternativa) Adicionar dependências das bibliotecas do Firebase sem usar a BoM

   Se você preferir não usar a BoM do Firebase, especifique cada versão das bibliotecas do Firebase na linha de dependência correspondente.

   Se você usa várias bibliotecas do Firebase no seu app, recomendamos utilizar a BoM para gerenciar as versões delas, porque isso ajuda a garantir a compatibilidade de todas as bibliotecas.

   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-ktx:20.3.1")
   }
   

Java

1. Siga as instruções para adicionar o Firebase ao seu app Android.

2. No arquivo do Gradle (nível do app) do módulo, (geralmente <project>/<app-module>/build.gradle.kts ou <project>/<app-module>/build.gradle), adicione a dependência da biblioteca do Cloud Functions para Android. Para gerenciar o controle de versões das bibliotecas, recomendamos usar a BoM do Firebase para Android.

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

   Com a BoM do Firebase para Android, seu app sempre vai usar versões compatíveis das bibliotecas do Firebase para Android.

   (Alternativa) Adicionar dependências das bibliotecas do Firebase sem usar a BoM

   Se você preferir não usar a BoM do Firebase, especifique cada versão das bibliotecas do Firebase na linha de dependência correspondente.

   Se você usa várias bibliotecas do Firebase no seu app, recomendamos utilizar a BoM para gerenciar as versões delas, porque isso ajuda a garantir a compatibilidade de todas as bibliotecas.

   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:20.3.1")
   }
   

Inicializar o SDK cliente

Inicialize uma instância do Cloud Functions:

Swift

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

Objective-C

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

API modular da 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

Observação: para chamar uma função em execução em qualquer local diferente do padrão us-central1, é preciso definir o valor apropriado na inicialização. Por exemplo, no Android, a inicialização é feita com getInstance(FirebaseApp app, String region).

Chamar a função

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
  }
}
CommentCell.swift

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"];
}];

API com namespace da 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

API modular da 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;

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

Como solucionar erros no cliente

O cliente vai receber um erro se o servidor tiver emitido um erro ou se a promessa resultante tiver sido recusada.

Se o erro retornado pela função for do tipo function.https.HttpsError, o cliente vai receber code, message e details do erro do servidor. Caso contrário, o erro vai conter a mensagem INTERNAL e o código INTERNAL. Consulte as orientações sobre como tratar erros na sua função chamável.

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

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

API com namespace da 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

API modular da 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);
}

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

Recomendado: evite abusos com o App Check

Antes de iniciar o app, ative o App Check para ajudar a garantir que somente seus apps possam acessar os endpoints da função chamável.