Funkcje nawiązywania połączeń z aplikacji


Pakiety SDK klienta Cloud Functions for Firebase umożliwiają wywoływanie funkcji bezpośrednio z aplikacji Firebase. Aby wywołać funkcję z aplikacji w ten sposób, napisz i wdróż funkcję wywołującą HTTP w Cloud Functions, a potem dodaj logikę klienta, aby wywołać funkcję z aplikacji.

Pamiętaj, że funkcje wywoływane przez HTTP są podobne, ale nie identyczne. Aby korzystać z funkcji wywoływanych przez HTTP, musisz użyć pakietu SDK klienta dla swojej platformy w połączeniu z interfejsem API backendu (lub zaimplementować protokół). Funkcje callable różnią się od funkcji HTTP pod następującymi kluczowymi względami:

  • W przypadku elementów wywołujących tokeny Firebase Authentication, tokeny FCM i tokeny App Check (jeśli są dostępne) są automatycznie uwzględniane w żądaniach.
  • Wyzwalacz automatycznie deserializuje treść żądania i weryfikuje tokeny uwierzytelniania.

Pakiet SDK Firebase dla Cloud Functions drugiej generacji lub nowszej współpracuje z tymi minimalnymi wersjami pakietu klienta SDK Firebase, które obsługują funkcje wywoływane przez HTTPS:

  • Pakiet SDK usługi Firebase na platformy Apple w wersji 11.4.0
  • Pakiet SDK Firebase dla usługi Android w wersji 21.0.0
  • Pakiet Firebase Modular Web SDK w wersji 9.7.0

Jeśli chcesz dodać podobne funkcje 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 tworzenia, wdrażania i wywoływania funkcji HTTP dla platform Apple, Androida, aplikacji internetowych, C++ i Unity.

napisać i wdrażać funkcję wywołującą,

Użyj metody functions.https.onCall, aby utworzyć wywoływaną funkcję HTTPS. Ta metoda przyjmuje 2 parametry: data i opcjonalnie 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 możliwej do wywołania, która zapisuje SMS-a w interfejsie Realtime Database, np. data może zawierać tekst wiadomości, a parametry context reprezentują informacje dotyczące uwierzytelniania 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;
index.js

Odległość między lokalizacją wywoływanej funkcji a lokalizacją wywołującego klienta może powodować opóźnienia sieciowe. Aby zoptymalizować wydajność, rozważ określenie lokalizacji funkcji, gdy jest to konieczne. Pamiętaj, aby dopasować lokalizację funkcji do lokalizacji określonej podczas inicjowania pakietu SDK po stronie klienta.

Opcjonalnie możesz załączyć zaświadczenie App Check, aby chronić zasoby backendu przed nadużyciami, takimi jak oszustwa związane z płatnościami czy wyłudzanie informacji. Zapoznaj się z sekcją Włączanie egzekwowania zasad App Check w domenie Cloud Functions.

Odbieram wynik

Aby wysłać dane z powrotem do klienta, zwracaj 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,
};
index.js

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

Obsługa błędów

Aby zapewnić klientowi przydatne informacje o błędach, zwracaj błędy z funkcji wywoływalnej, rzucając instancją functions.https.HttpsError (lub zwracając obietnicę odrzuconą za pomocą tej instancji). Błąd ma atrybut code, który może być jedną z wartości wymienionych w functions.https.HttpsError. Błędy te zawierają 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 Twoich funkcji zostanie zgłoszony błąd inny niż HttpsError, klient zamiast tego otrzyma komunikat o błędzie z komunikatem INTERNAL i kodem internal.

Funkcja może na przykład zwracać błędy weryfikacji danych i błędy uwierzytelniania, które są przekazywane do wywołującego klienta za pomocą komunikatów o błędach:

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

Wdrażanie funkcji możliwej do wywołania

Po zapisaniu w funkcji index.js gotowej funkcji wywoływalnej zostanie ona wdrożona wraz z wszystkimi innymi funkcjami podczas wykonywania funkcji firebase deploy. Aby wdrożyć tylko element możliwy do wywołania, użyj argumentu --only jak pokazano na ekranie do przeprowadzenia wdrożeń częściowych:

firebase deploy --only functions:addMessage

Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, upewnij się, że do użytkownika wykonującego polecenia wdrożeniowe są przypisane odpowiednie role uprawnień.

Konfigurowanie środowiska programistycznego klienta

Sprawdź, czy spełniasz wymagania wstępne, a potem dodaj do aplikacji wymagane zależności i biblioteki klienta.

iOS+

Wykonaj instrukcje dodawania Firebase do aplikacji Apple.

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

  1. Po otwarciu projektu aplikacji w Xcode wybierz 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
  3. Wybierz bibliotekę Cloud Functions.
  4. Dodaj flagę -ObjC do sekcji Inne flagi łączące w ustawieniach kompilacji celu.
  5. Gdy to zrobisz, Xcode automatycznie zacznie wyszukiwać i pobierać zależności w tle.

Web

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do aplikacji internetowej. W terminalu uruchom to polecenie: 
    npm install firebase@11.0.1 --save

  2. Wymagaj ręcznie zarówno podstawowej usługi Firebase, jak i usługi 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 te instrukcje, aby dodać Firebase do swojej aplikacji internetowej.
  2. Dodaj do swojej aplikacji podstawowe biblioteki Firebase i Cloud Functions biblioteki klienta: 
    <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ęczne wymaganie podstawowych ustawień Firebase i Cloud Functions: 
    const firebase = require("firebase");
// Required for side-effects
require("firebase/functions");

Kotlin+KTX

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

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

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

    Dzięki użyciu Firebase Android BoMaplikacja zawsze będzie używać zgodnych wersji bibliotek Firebase na Androida.

    (Alternatywnie) Dodaj zależności bibliotek Firebase bez korzystania z BoM

    Jeśli zdecydujesz się nie używać Firebase BoM, musisz określić każdą wersję biblioteki Firebase w jej wierszu zależności.

    Jeśli w aplikacji używasz kilku bibliotek Firebase, zdecydowanie zalecamy korzystanie z BoM do zarządzania wersjami bibliotek. Dzięki temu wszystkie wersje będą ze sobą zgodne. 

    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:21.0.0")
}
         Szukasz modułu biblioteki Kotlin? Od października 2023 r. (Firebase BoM 32.5.0) deweloperzy Kotlina i Java mogą korzystać z głównego modułu biblioteki (szczegółowe informacje znajdziesz w często zadawanych pytaniach dotyczących tej inicjatywy).

Java

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

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

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

    Gdy używasz interfejsu Firebase Android BoM, Twoja aplikacja zawsze używa zgodnych wersji bibliotek Firebase na Androida.

    (Alternatywnie) Dodaj zależności bibliotek Firebase bez korzystania z BoM

    Jeśli zdecydujesz się nie używać Firebase BoM, musisz określić każdą wersję biblioteki Firebase w jej wierszu zależności.

    Pamiętaj, że jeśli w swojej aplikacji używasz wielu bibliotek Firebase, zdecydowanie zalecamy korzystanie z BoM do zarządzania wersjami bibliotek. Dzięki temu będziesz mieć pewność, że wszystkie wersje są zgodne. 

    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:21.0.0")
}
         Szukasz modułu biblioteki dla Kotlina? Od października 2023 r. (Firebase BoM 32.5.0) deweloperzy Kotlina i Java mogą korzystać z głównego modułu biblioteki (szczegółowe informacje znajdziesz w często zadawanych pytaniach dotyczących tej inicjatywy).

Dart

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do aplikacji Flutter.

  2. Aby zainstalować wtyczkę, uruchom to polecenie z poziomu głównego projektu Flutter:

    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 Darta:

    import 'package:cloud_functions/cloud_functions.dart';

C++

W przypadku C++ na Androida:

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do projektu C++.
  2. Dodaj bibliotekę firebase_functions do pliku CMakeLists.txt.

W przypadku C++ na platformach Apple:

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do projektu C++.
  2. Dodaj blok reklamowy Cloud Functions do Podfile: 
    pod 'Firebase/Functions'
  3. Zapisz plik i uruchom: 
    pod install
  4. Dodaj podstawowe platformy Firebase i platformy Cloud Functions z pakietu SDK Firebase C++ do projektu Xcode.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do projektu Unity.
  2. Dodaj FirebaseFunctions.unitypackage z Firebase Unity SDK do projektu Unity.

Inicjowanie pakietu SDK klienta

Inicjalizacja instancji Cloud Functions:

Swift

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

Objective-C

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

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+KTX 

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

Java 

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

Dart 

final functions = FirebaseFunctions.instance;

C++

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

Unity

functions = Firebase.Functions.DefaultInstance;

Wywołaj funkcję

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

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

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

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

Klient otrzyma błąd, jeśli serwer wyrzucił błąd lub jeśli wynikowa 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 komunikat o błędzie zawiera komunikat INTERNAL i kod INTERNAL. Zapoznaj się ze wskazówkami dotyczącymi obsługi błędów w funkcji wywoływanej.

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

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

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

Przed opublikowaniem aplikacji włącz App Check, aby mieć pewność, że tylko Twoje aplikacje mają dostęp do punktów końcowych funkcji, które można wywołać.