Fique por dentro dos destaques do Firebase no Google I/O 2023. Saiba mais

Chamar funções no seu aplicativo

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 HTTPS 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 HTTPS são semelhantes, mas não são idênticas às funções HTTP. Além disso, a assinatura do callback mudou entre as funções da 1° e da 2° geração:

// Adds two numbers to each other.
exports.addnumbers = onCall((request) => {
  // Numbers passed from the client.
  const firstNumber = request.data.firstNumber;
  const secondNumber = request.data.secondNumber;

  // Checking that attributes are present and are numbers.
  if (!Number.isFinite(firstNumber) || !Number.isFinite(secondNumber)) {
    // Throwing an HttpsError so that the client gets the error details.
    throw new HttpsError("invalid-argument", "The function must be called " +
            "with two arguments \"firstNumber\" and \"secondNumber\" which " +
            "must both be numbers.");
  }

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

Confira a seguir as principais diferenças 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 functions.https.onCall 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 plataformas da Apple 10.9.0
SDK do Firebase para Android 20.3.0
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 HTTPS chamável em plataformas da Apple, Android, Web, C++ e Unity.

Escrever e implantar a função chamável

Use o método onCall do subpacote functions/v2/https para criar uma função HTTP chamável. Esse método usa um parâmetro event com as propriedades data, auth, app e instanceToken:

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

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:

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

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.

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:

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

Para retornar dados após uma operação assíncrona, retorne uma promessa. Os dados retornados pela promessa são enviados de volta ao cliente. Por exemplo, você pode retornar o texto limpo que a função chamável escreveu no 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};
})index.js

Tratar erros

Para garantir que o cliente receba detalhes úteis de erros, retorne erros de uma função chamável ao emitir (ou retornar uma promessa rejeitada com) uma instância de functions.https.HttpsError. O erro tem um atributo code que pode ser um dos valores listados em functions.https.HttpsError. 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 HttpsError for emitido pelas suas funções, seu 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:

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

Como 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.

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

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

Escolha a biblioteca do Cloud Functions.
Quando terminar, o Xcode começará a resolução e fará o download das dependências em segundo plano automaticamente.

Web version 9

Siga as instruções para adicionar o Firebase ao seu app da Web. Execute o seguinte comando no seu terminal:
```
npm install firebase@9.21.0 --save
```

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

Siga as instruções para adicionar o Firebase ao seu app Android.
No arquivo do Gradle (nível do app) do módulo, (geralmente <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.0.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-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.0'
}
```

Java

Siga as instruções para adicionar o Firebase ao seu app Android.
No arquivo do Gradle (nível do app) do módulo, (geralmente <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.0.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'
}
```
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.0'
}
```

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

Web version 9

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.functionsMainActivity.kt

Java

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

Chamar a função

Swift

let addMessageURL = URL(string: "https://addmessage-xyz1234-uc.a.run.app/addMessage")!

functions.httpsCallable(addMessageURL).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
  }
}

Web version 9

import { getFunctions, httpsCallableFromURL } from 'firebase/functions';

const functions = getFunctions();
const addMessage = httpsCallableFromURL(
  functions,
  // the URL of the function
  "https://addmessage-xyz1234-uc.a.run.app/addMessage"
);

addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    const data = result.data;
    const sanitizedMessage = data.text;
  });

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
            // The URL of the function
            .getHttpsCallableFromUrl(URL("https://addmessage-xyz1234-uc.a.run.app/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
            }
}

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

Web version 9

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

const functions = getFunctions();
const addMessage = httpsCallableFromURL(
  functions,
  // the URL of the function
  "https://addmessage-xyz1234-uc.a.run.app/addMessage"
);

addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    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+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

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.