Chamar funções do seu aplicativo

Os SDKs de cliente do Cloud Functions para Firebase permitem chamar funções diretamente de um aplicativo do Firebase. Para chamar uma função do seu aplicativo dessa maneira, escreva e implante uma função HTTPS Callable no Cloud Functions e adicione a lógica do cliente para chamar a função do seu aplicativo.

É importante ter em mente que as funções que podem ser chamadas HTTPS são semelhantes, mas não idênticas às funções HTTP. Além disso, observe que a assinatura de retorno de chamada mudou entre v1 e v2:

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

Até que o Cloud Functions v2 ofereça suporte a URLs cloudfunctions.net, você terá que usar um inicializador diferente em seu código de cliente. Em vez de fornecer um nome de função, forneça um URL completo para o SDK do cliente. O URL da sua função é impresso no final de um comando de firebase deploy :

Function URL (shoulddance(us-west1)): https://shoulddance-uvb3o4q2mq-uw.a.run.app

Callables têm estas diferenças importantes das funções HTTP:

  • Com callables, tokens Firebase Authentication, tokens FCM e tokens App Check, quando disponíveis, são incluídos automaticamente nas solicitações.
  • 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 v2 e superior interage com estas versões mínimas do SDK do cliente do Firebase para oferecer suporte a funções HTTPS que podem ser chamadas:

  • SDK do Firebase para plataformas Apple 9.4.0
  • SDK do Firebase para Android 20.1.0
  • SDK da Web modular do Firebase v. 9.7.0

Se você quiser adicionar uma funcionalidade semelhante a um aplicativo criado em uma plataforma sem suporte, consulte a Especificação de protocolo para https.onCall . O restante deste guia fornece instruções sobre como escrever, implantar e chamar uma função que pode ser chamada HTTPS para plataformas Apple, Android, Web, C++ e Unity.

Escreva e implante a função que pode ser chamada

Use o método onCall do subpacote functions/v2/https para criar uma função que pode ser chamada HTTP. Esse método usa um parâmetro de 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) => {
  // ...
});

Para uma função que pode ser chamada que salva uma mensagem de texto no Realtime Database, por exemplo, data podem conter o texto da mensagem, juntamente com 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;

A distância entre a localização da função que pode ser chamada e a localização do cliente chamador pode criar latência de rede. Para otimizar o desempenho, considere especificar o local da função quando aplicável e certifique-se de alinhar o local do callable com o local definido ao inicializar o SDK no lado do cliente.

Opcionalmente, você pode anexar um atestado do App Check para ajudar a proteger seus recursos de back-end contra abusos, como fraude de cobrança ou phishing. Consulte Ativar a aplicação do App Check para o Cloud Functions .

Enviando de volta o resultado

Para enviar dados de volta ao cliente, retorne dados que possam ser codificados em 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,
};

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 um texto limpo que a função que pode ser chamada gravou 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};
})

Lidar com erros

Para garantir que o cliente obtenha detalhes úteis do erro, retorne erros de um callable lançando (ou retornando uma Promise rejeitada com) uma instância de functions.https.HttpsError . O erro tem um atributo de code que pode ser um dos valores listados em functions.https.HttpsError . Os erros também têm uma string message , cujo padrão é uma string vazia. Eles também podem ter um campo de details opcional com um valor arbitrário. Se um erro diferente de HttpsError for lançado de suas funções, seu cliente receberá um erro com a mensagem INTERNAL e o código internal .

Por exemplo, uma função pode gerar erros de validação e autenticação de dados com mensagens de erro para retornar ao cliente de chamada:

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

Implante a função que pode ser chamada

Depois de salvar uma função chamável concluída em index.js , ela é implantada junto com todas as outras funções quando você executa o firebase deploy . Para implantar apenas o que pode ser chamado, use o argumento --only conforme mostrado para executar implantações parciais :

firebase deploy --only functions:addMessage

Se você encontrar erros de permissão ao implantar funções, certifique-se de que as funções apropriadas do IAM sejam atribuídas ao usuário que executa os comandos de implantação.

Configure seu ambiente de desenvolvimento do cliente

Certifique-se de atender a todos os pré-requisitos e adicione as dependências e bibliotecas de cliente necessárias ao seu aplicativo.

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.

  1. No Xcode, com seu projeto de aplicativo aberto, navegue até File > Add Packages .
  2. Quando solicitado, adicione o repositório do SDK das plataformas Firebase Apple:
  3.   https://github.com/firebase/firebase-ios-sdk
  4. Escolha a biblioteca do Cloud Functions.
  5. Quando terminar, o Xcode começará automaticamente a resolver e baixar suas dependências em segundo plano.

Web version 9

  1. Siga as instruções para adicionar o Firebase ao seu aplicativo da Web . Certifique-se de executar o seguinte comando no seu terminal:
    npm install firebase@9.9.2 --save
    
  2. Exija 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);
    

Java

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

  2. Usando o Firebase Android BoM , declare a dependência da biblioteca Android do Cloud Functions no arquivo Gradle do módulo (nível do aplicativo) (geralmente app/build.gradle ).

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

    Ao usar o Firebase Android BoM , seu aplicativo sempre usará versões compatíveis das bibliotecas do Firebase Android.

    (Alternativa) Declare dependências da biblioteca do Firebase sem usar o BoM

    Se você optar por não usar o Firebase BoM, deverá especificar cada versão da biblioteca do Firebase em sua linha de dependência.

    Observe que, se você usa várias bibliotecas do Firebase em seu aplicativo, é altamente recomendável usar o BoM para gerenciar as versões da biblioteca, o que garante que todas as versões sejam compatíveis.

    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. Siga as instruções para adicionar o Firebase ao seu aplicativo Android .

  2. Usando o Firebase Android BoM , declare a dependência da biblioteca Android do Cloud Functions no arquivo Gradle do módulo (nível do aplicativo) (geralmente app/build.gradle ).

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

    Ao usar o Firebase Android BoM , seu aplicativo sempre usará versões compatíveis das bibliotecas do Firebase Android.

    (Alternativa) Declare dependências da biblioteca do Firebase sem usar o BoM

    Se você optar por não usar o Firebase BoM, deverá especificar cada versão da biblioteca do Firebase em sua linha de dependência.

    Observe que, se você usa várias bibliotecas do Firebase em seu aplicativo, é altamente recomendável usar o BoM para gerenciar as versões da biblioteca, o que garante que todas as versões sejam compatíveis.

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

Inicialize o SDK do cliente

Inicialize uma instância do Cloud Functions:

Rápido

lazy var functions = Functions.functions()

Objetivo-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions 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

Chame a função

Rápido

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

Lidar com erros no cliente

O cliente recebe um erro se o servidor gerar um erro ou se a promessa resultante for rejeitada. Se o erro retornado pela função for do tipo function.https.HttpsError , o cliente receberá o code de erro , a message e os details do erro do servidor. Caso contrário, o erro contém a mensagem INTERNAL e o código INTERNAL . Consulte as orientações sobre como lidar com erros em sua função que pode ser chamada.

Rápido

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

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

Antes de iniciar seu aplicativo, você deve habilitar o App Check para ajudar a garantir que apenas seus aplicativos possam acessar seus endpoints de função chamáveis.