Wywoływanie funkcji z aplikacji (1 generacji)

Pakiety SDK klienta Cloud Functions for Firebase umożliwiają wywoływanie funkcji bezpośrednio z aplikacji w Firebase. Aby wywołać funkcję z aplikacji w ten sposób, napisz i wdróż funkcję HTTP Callable w Cloud Functions, a następnie dodaj logikę klienta, która będzie wywoływać tę funkcję z aplikacji.

Pamiętaj, że funkcje HTTP Callable są podobne do funkcji HTTP, ale nie są z nimi identyczne. Aby korzystać z funkcji HTTP Callable, musisz używać pakietu SDK klienta na swojej platformie razem z interfejsem API backendu (lub zaimplementować protokół). Funkcje Callable różnią się od funkcji HTTP tymi kluczowymi elementami:

  • W przypadku funkcji Callable tokeny Firebase Authentication, tokeny FCM i tokeny App Check są automatycznie dołączane do żądań, jeśli są dostępne.
  • Wywołanie automatycznie deserializuje treść żądania i weryfikuje tokeny uwierzytelniania.

Pakiet SDK Firebase dla Cloud Functions 2. generacji i nowszych współpracuje z tymi minimalnymi wersjami pakietów SDK klienta Firebase , aby obsługiwać funkcje HTTPS Callable:

  • Firebase SDK na platformy Apple 12.12.0
  • Firebase SDK dla Android 22.1.1
  • Modułowy pakiet SDK Firebase Web w wersji 9.7.0

Jeśli chcesz dodać podobną funkcję do aplikacji utworzonej na nieobsługiwanej platformie, zapoznaj się ze specyfikacją protokołu dla https.onCall. W pozostałej części tego przewodnika znajdziesz instrukcje dotyczące pisania, wdrażania i wywoływania funkcji HTTP Callable na platformach Apple, Androidzie, w internecie, C++ i Unity.

Pisanie i wdrażanie funkcji Callable

Aby utworzyć funkcję HTTPS Callable, użyj functions.https.onCall. Ta metoda przyjmuje 2 parametry: data i opcjonalny context:

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

W przypadku funkcji Callable, która zapisuje wiadomość tekstową w bazie danych czasu rzeczywistego, Realtime Database, na przykład, data może zawierać tekst wiadomości, a parametry context – informacje o uwierzytelnianiu użytkownika:

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

Odległość między lokalizacją funkcji Callable a lokalizacją klienta wywołującego może powodować opóźnienie sieci. Aby zoptymalizować wydajność, rozważ określenie lokalizacji funkcji, jeśli to możliwe, i upewnij się, że lokalizacja funkcji Callable jest zgodna z lokalizacją ustawioną podczas inicjowania pakietu SDK po stronie klienta.

Opcjonalnie możesz dołączyć atest App Check, aby chronić swoje zasoby backendu przed nadużyciami, takimi jak oszukańcze płatności czy wyłudzanie informacji. Przeczytaj artykuł Włączanie App Check egzekwowania w Cloud Functions.

Wysyłanie wyniku

Aby wysłać dane z powrotem do klienta, zwróć dane, które można zakodować w formacie JSON. Aby na przykład zwrócić wynik operacji dodawania:

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

Aby zwrócić dane po operacji asynchronicznej, zwróć obietnicę. Dane zwrócone przez obietnicę są wysyłane z powrotem do klienta. Możesz na przykład zwrócić oczyszczony tekst, który funkcja Callable zapisała w 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};
})

Obsługa błędów

Aby mieć pewność, że klient otrzyma przydatne szczegóły błędu, zwróć błędy z funkcji Callable, zgłaszając (lub zwracając obietnicę odrzuconą przez) instancję functions.https.HttpsError. Błąd ma atrybut code, który może przyjmować jedną z wartości wymienionych w functions.https.HttpsError. Błędy mają też ciąg znaków message, który domyślnie jest pusty. Mogą też mieć opcjonalne pole details z dowolną wartością. Jeśli z funkcji zostanie zgłoszony błąd inny niż HttpsError, klient otrzyma błąd z komunikatem INTERNAL i kodem internal.

Funkcja może na przykład zgłaszać błędy weryfikacji danych i uwierzytelniania z komunikatami o błędach, które mają być zwracane do klienta wywołującego:

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

Wdrażanie funkcji Callable

Gdy zapiszesz ukończoną funkcję Callable w index.js, zostanie ona wdrożona razem z innymi funkcjami po uruchomieniu firebase deploy. Aby wdrożyć tylko funkcję Callable, użyj argumentu --only, jak pokazano poniżej, aby wykonać częściowe wdrożenia:

firebase deploy --only functions:addMessage

Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, upewnij się, że użytkownikowi uruchamiającemu polecenia wdrożenia przypisano odpowiednie role IAM.

Konfigurowanie środowiska programistycznego klienta

Upewnij się, że spełniasz wszystkie wymagania wstępne, a następnie dodaj do aplikacji wymagane zależności i biblioteki klienta.

iOS+

Wykonaj instrukcje, aby dodać Firebase do swojej aplikacji Apple.

Do instalacji zależności Firebase i do zarządzania nimi możesz używać menedżera pakietów Swift.

  1. Po otwarciu projektu aplikacji wybierz w Xcode kolejno File > Add Packages (Plik > Dodaj pakiety).
  2. Gdy pojawi się prośba, dodaj repozytorium pakietu SDK Firebase na platformy Apple:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Wybierz bibliotekę Cloud Functions.
  5. Dodaj flagę -ObjC do sekcji Other Linker Flags (Inne flagi linkera) w ustawieniach kompilacji celu.
  6. Gdy skończysz, Xcode zacznie automatycznie wyszukiwać i pobierać Twoje zależności w tle.

Web

  1. Wykonaj instrukcje, aby dodać Firebase do swojej aplikacji internetowej. Upewnij się, że w terminalu uruchomisz to polecenie:
    npm install firebase@12.12.0 --save
  2. Ręcznie wymagaj zarówno Firebase Core, jak i 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. Wykonaj instrukcje, aby dodać Firebase do swojej aplikacji internetowej.
  2. Dodaj do aplikacji biblioteki klienta Firebase Core i Cloud Functions do swojej aplikacji:
    <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>

Pakiet SDK Cloud Functions jest też dostępny jako pakiet npm.

  1. Uruchom w terminalu to polecenie:
    npm install firebase@8.10.1 --save
  2. Ręcznie wymagaj zarówno Firebase Core, jak i Cloud Functions:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");

Kotlin

  1. Wykonaj instrukcje, aby dodać Firebase do swojej aplikacji na Androida.

  2. W pliku Gradle na poziomie modułu (aplikacji) (zwykle <project>/<app-module>/build.gradle.kts lub <project>/<app-module>/build.gradle), dodaj zależność z biblioteką Cloud Functions na Androida. Do kontrolowania obsługi wersji biblioteki zalecamy używanie Firebase Android BoM.

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

    Gdy korzystamy z Firebase Android BoM, aplikacja zawsze używa zgodnych wersji bibliotek Firebase na Androida.

    (Alternatywnie)  Dodaj zależności biblioteki Firebase bez używania BoM

    Jeśli nie chcesz używać Firebase BoM, musisz określić wersję każdej biblioteki Firebase w wierszu zależności.

    Pamiętaj, że jeśli w aplikacji używasz wielu bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co zapewnia zgodność wszystkich wersji.

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

Java

  1. Wykonaj instrukcje, aby dodać Firebase do swojej aplikacji na Androida.

  2. W pliku Gradle na poziomie modułu (aplikacji) (zwykle <project>/<app-module>/build.gradle.kts lub <project>/<app-module>/build.gradle), dodaj zależność z biblioteką Cloud Functions na Androida. Do kontrolowania obsługi wersji biblioteki zalecamy używanie Firebase Android BoM.

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

    Gdy korzystamy z Firebase Android BoM, aplikacja zawsze używa zgodnych wersji bibliotek Firebase na Androida.

    (Alternatywnie)  Dodaj zależności biblioteki Firebase bez używania BoM

    Jeśli nie chcesz używać Firebase BoM, musisz określić wersję każdej biblioteki Firebase w wierszu zależności.

    Pamiętaj, że jeśli w aplikacji używasz wielu bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co zapewnia zgodność wszystkich wersji.

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

Dart

  1. Wykonaj instrukcje, aby dodać Firebase do swojej aplikacji Flutter.

  2. W katalogu głównym projektu Flutter uruchom to polecenie, aby zainstalować wtyczkę:

    flutter pub add cloud_functions
    
  3. Po zakończeniu ponownie skompiluj aplikację Flutter:

    flutter run
    
  4. Po zainstalowaniu możesz uzyskać dostęp do wtyczki cloud_functions, importując ją w kodzie Dart:

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

W przypadku C++ na Androidzie:

  1. Wykonaj instrukcje, aby dodać Firebase do projektu C++.
  2. Dodaj bibliotekę firebase_functions do pliku CMakeLists.txt.

W przypadku C++ na platformach Apple:

  1. Wykonaj instrukcje, aby dodać Firebase do projektu C++.
  2. Dodaj pod Cloud Functions do pliku Podfile:
    pod 'Firebase/Functions'
  3. Zapisz plik, a następnie uruchom:
    pod install
  4. Dodaj do projektu Xcode platformy Firebase Core i Cloud Functions z Firebase C++ SDK.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Wykonaj instrukcje, aby dodać Firebase do projektu Unity.
  2. Dodaj FirebaseFunctions.unitypackage z Firebase Unity SDK do projektu Unity.

Inicjowanie pakietu SDK klienta

Zainicjuj instancję 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;

Wywoływanie funkcji

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

Obsługa błędów po stronie klienta

Klient otrzymuje błąd, jeśli serwer zgłosił błąd lub jeśli obietnica została odrzucona.

Jeśli błąd zwrócony przez funkcję jest typu function.https.HttpsError, klient otrzymuje błąd code, message, i details z błędu serwera. W przeciwnym razie błąd zawiera komunikat INTERNAL i kod INTERNAL. Dowiedz się, jak obsługiwać błędy w funkcji Callable.

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

Zalecane: zapobieganie nadużyciom za pomocą App Check

Zanim opublikujesz aplikację, włącz App Check , aby mieć pewność, że tylko Twoje aplikacje będą mogły uzyskiwać dostęp do punktów końcowych funkcji Callable.