Funkcje połączeń z Twojej aplikacji


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

Należy pamiętać, że funkcje wywoływalne HTTP są podobne, ale nie identyczne z funkcjami HTTP. Aby korzystać z funkcji wywoływalnych HTTP, musisz użyć klienta SDK dla swojej platformy wraz z interfejsem API zaplecza (lub zaimplementować protokół). Funkcje wywoływalne różnią się od funkcji HTTP następującą kluczową różnicą:

  • W przypadku elementów wywoływalnych tokeny uwierzytelniania Firebase, tokeny FCM i tokeny sprawdzania aplikacji, jeśli są dostępne, są automatycznie uwzględniane w żądaniach.
  • Wyzwalacz automatycznie deserializuje treść żądania i sprawdza poprawność tokenów uwierzytelniania.

Pakiet Firebase SDK dla Cloud Functions drugiej generacji i nowszy współpracuje z następującymi minimalnymi wersjami pakietu SDK klienta Firebase w celu obsługi funkcji wywoływalnych HTTPS:

  • Zestaw SDK Firebase dla platform Apple 10.19.0
  • Pakiet SDK Firebase dla Androida 20.4.0
  • Firebase Modular Web SDK wersja 9.7.0

Jeśli chcesz dodać podobną funkcjonalność do aplikacji zbudowanej na nieobsługiwanej platformie, zapoznaj się ze specyfikacją protokołu dla https.onCall . Pozostała część tego przewodnika zawiera instrukcje dotyczące pisania, wdrażania i wywoływania funkcji wywoływalnej HTTP dla platform Apple, Android, sieci Web, C++ i Unity.

Napisz i wdróż funkcję wywoływalną

Użyj functions.https.onCall , aby utworzyć funkcję wywoływalną HTTPS. Ta metoda przyjmuje dwa 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) => {
  // ...
});

Na przykład w przypadku wywoływalnej funkcji, która zapisuje wiadomość tekstową w bazie danych czasu rzeczywistego, data mogą zawierać tekst wiadomości, podczas gdy parametry context reprezentują informacje o autoryzacji użytkownika:

// Message text passed from the client.
const text = data.text;
// Authentication / user information is automatically added to the request.
const uid = context.auth.uid;
const name = context.auth.token.name || null;
const picture = context.auth.token.picture || null;
const email = context.auth.token.email || null;

Odległość między lokalizacją wywoływanej funkcji a lokalizacją klienta wywołującego może powodować opóźnienia w sieci. Aby zoptymalizować wydajność, rozważ określenie lokalizacji funkcji, jeśli ma to zastosowanie, i pamiętaj o wyrównaniu lokalizacji wywoływanej z lokalizacją ustawioną podczas inicjowania zestawu SDK po stronie klienta.

Opcjonalnie możesz dołączyć zaświadczenie sprawdzania aplikacji, aby chronić zasoby backendu przed nadużyciami, takimi jak oszustwa związane z rachunkami lub wyłudzanie informacji. Zobacz Włączanie wymuszania sprawdzania aplikacji dla funkcji Cloud Functions .

Przesyłam wynik

Aby wysłać dane z powrotem do klienta, zwróć dane, które można zakodować w formacie JSON. Na przykład, aby 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 w ramach promesy są odsyłane do klienta. Na przykład możesz zwrócić oczyszczony tekst, który funkcja wywoływalna zapisała w bazie danych czasu rzeczywistego:

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

Obsługuj błędy

Aby mieć pewność, że klient otrzyma przydatne szczegóły błędu, zwróć błędy z wywoływalnego obiektu, zgłaszając (lub zwracając odrzuconą obietnicę) instancję functions.https.HttpsError . Błąd ma atrybut code , który może mieć jedną z wartości wymienionych functions.https.HttpsError . Błędy mają również message w postaci ciągu znaków, który domyślnie jest pustym ciągiem. Mogą również posiadać opcjonalne pole details z dowolną wartością. Jeśli w funkcjach zostanie zgłoszony błąd inny niż HttpsError , klient zamiast tego otrzyma błąd z komunikatem INTERNAL i kodem internal .

Na przykład funkcja może zgłaszać błędy sprawdzania poprawności i uwierzytelniania wraz z komunikatami o błędach, aby powrócić do wywołującego klienta:

// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.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 (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

Wdróż funkcję wywoływalną

Po zapisaniu ukończonej wywoływalnej funkcji w index.js , jest ona wdrażana wraz ze wszystkimi innymi funkcjami po uruchomieniu firebase deploy . Aby wdrożyć tylko to, co można wywołać, użyj argumentu --only , jak pokazano, aby wykonać częściowe wdrożenie :

firebase deploy --only functions:addMessage

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

Skonfiguruj środowisko programistyczne klienta

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

iOS+

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

Użyj Menedżera pakietów Swift, aby zainstalować zależności Firebase i zarządzać nimi.

  1. W Xcode, przy otwartym projekcie aplikacji, przejdź do File > Add Packages .
  2. Po wyświetleniu monitu dodaj repozytorium SDK platform Firebase Apple:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Wybierz bibliotekę Cloud Functions.
  5. Dodaj flagę -ObjC do sekcji Inne flagi linkera w ustawieniach kompilacji celu.
  6. Po zakończeniu Xcode automatycznie rozpocznie rozwiązywanie i pobieranie zależności w tle.

Modułowe API sieciowe

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej aplikacji internetowej . Upewnij się, że uruchomiłeś następującą komendę na swoim terminalu:
    npm install firebase@10.7.1 --save
    
  2. Ręcznie wymagaj zarówno rdzenia Firebase, jak i funkcji chmury:

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

Internetowy interfejs API z przestrzenią nazw

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej aplikacji internetowej .
  2. Dodaj biblioteki klienckie 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>
    

Zestaw SDK Cloud Functions jest również dostępny jako pakiet npm.

  1. Uruchom następującą komendę na swoim terminalu:
    npm install firebase@8.10.1 --save
    
  2. Ręcznie wymagaj zarówno rdzenia Firebase, jak i funkcji chmury:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Kotlin+KTX

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej 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ść dla Cloud Functions biblioteka dla Androida. Zalecamy używanie Firebase Android BoM do kontrolowania wersji bibliotek.

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

    Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać z kompatybilnych wersji bibliotek Firebase Android.

    (Alternatywa) Dodaj zależności biblioteki Firebase bez użycia BoM

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

    Pamiętaj, że jeśli używasz w swojej aplikacji wielu bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co gwarantuje, że wszystkie wersje będą kompatybilne.

    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.4.0")
    }
    
    Szukasz modułu bibliotecznego specyficznego dla Kotlina? Począwszy od października 2023 r. (Firebase BoM 32.5.0) zarówno programiści Kotlin, jak i Java mogą polegać na głównym module biblioteki (więcej informacji można znaleźć w często zadawanych pytaniach dotyczących tej inicjatywy ).

Java

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej 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ść dla Cloud Functions biblioteka dla Androida. Zalecamy używanie Firebase Android BoM do kontrolowania wersji bibliotek.

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

    Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać z kompatybilnych wersji bibliotek Firebase Android.

    (Alternatywa) Dodaj zależności biblioteki Firebase bez użycia BoM

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

    Pamiętaj, że jeśli używasz w swojej aplikacji wielu bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co gwarantuje, że wszystkie wersje będą kompatybilne.

    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.4.0")
    }
    
    Szukasz modułu bibliotecznego specyficznego dla Kotlina? Począwszy od października 2023 r. (Firebase BoM 32.5.0) zarówno programiści Kotlin, jak i Java mogą polegać na głównym module biblioteki (więcej informacji można znaleźć w często zadawanych pytaniach dotyczących tej inicjatywy ).

Dart

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

  2. W katalogu głównym projektu Flutter uruchom następujące polecenie, aby zainstalować wtyczkę:

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

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

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

Dla C++ z Androidem :

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

Dla C++ z platformami Apple :

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojego projektu C++ .
  2. Dodaj moduł Cloud Functions do swojego Podfile :
    pod 'Firebase/Functions'
  3. Zapisz plik, a następnie uruchom:
    pod install
  4. Dodaj rdzeń Firebase i frameworki Cloud Functions z pakietu SDK Firebase C++ do swojego projektu Xcode.
    • firebase.framework
    • firebase_functions.framework

Jedność

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

Zainicjuj zestaw SDK klienta

Zainicjuj instancję Cloud Functions:

Szybki

lazy var functions = Functions.functions()

Cel C

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

Internetowy interfejs API z przestrzenią nazw

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

Modułowe API sieciowe

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

Java

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

Dart

final functions = FirebaseFunctions.instance;

C++

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

Jedność

functions = Firebase.Functions.DefaultInstance;

Wywołaj funkcję

Szybki

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

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

Internetowy interfejs API z przestrzenią nazw

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });

Modułowe API sieciowe

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

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

Jedność

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ługuj błędy na kliencie

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

Jeśli błąd zwrócony przez funkcję jest function.https.HttpsError , wówczas klient otrzymuje code błędu, message i details błędu serwera. W przeciwnym razie błąd zawiera komunikat INTERNAL i kod INTERNAL . Zobacz wskazówki dotyczące obsługi błędów w funkcji wywoływalnej.

Szybki

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

Cel C

if (error) {
  if ([error.domain isEqual:@"com.firebase.functions"]) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[@"details"];
  }
  // ...
}

Internetowy interfejs API z przestrzenią nazw

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

Modułowe API sieciowe

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

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

Jedność

 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 uruchomieniem aplikacji należy włączyć Sprawdzanie aplikacji , aby mieć pewność, że tylko Twoje aplikacje będą miały dostęp do punktów końcowych funkcji, które można wywołać.

,


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

Należy pamiętać, że funkcje wywoływalne HTTP są podobne, ale nie identyczne z funkcjami HTTP. Aby korzystać z funkcji wywoływalnych HTTP, musisz użyć klienta SDK dla swojej platformy wraz z interfejsem API zaplecza (lub zaimplementować protokół). Funkcje wywoływalne różnią się od funkcji HTTP następującą kluczową różnicą:

  • W przypadku elementów wywoływalnych tokeny uwierzytelniania Firebase, tokeny FCM i tokeny sprawdzania aplikacji, jeśli są dostępne, są automatycznie uwzględniane w żądaniach.
  • Wyzwalacz automatycznie deserializuje treść żądania i sprawdza poprawność tokenów uwierzytelniania.

Pakiet Firebase SDK dla Cloud Functions drugiej generacji i nowszy współpracuje z następującymi minimalnymi wersjami pakietu SDK klienta Firebase w celu obsługi funkcji wywoływalnych HTTPS:

  • Zestaw SDK Firebase dla platform Apple 10.19.0
  • Pakiet SDK Firebase dla Androida 20.4.0
  • Firebase Modular Web SDK wersja 9.7.0

Jeśli chcesz dodać podobną funkcjonalność do aplikacji zbudowanej na nieobsługiwanej platformie, zapoznaj się ze specyfikacją protokołu dla https.onCall . Pozostała część tego przewodnika zawiera instrukcje dotyczące pisania, wdrażania i wywoływania funkcji wywoływalnej HTTP dla platform Apple, Android, sieci Web, C++ i Unity.

Napisz i wdróż funkcję wywoływalną

Użyj functions.https.onCall , aby utworzyć funkcję wywoływalną HTTPS. Ta metoda przyjmuje dwa 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) => {
  // ...
});

Na przykład w przypadku wywoływalnej funkcji, która zapisuje wiadomość tekstową w bazie danych czasu rzeczywistego, data mogą zawierać tekst wiadomości, podczas gdy parametry context reprezentują informacje o autoryzacji użytkownika:

// Message text passed from the client.
const text = data.text;
// Authentication / user information is automatically added to the request.
const uid = context.auth.uid;
const name = context.auth.token.name || null;
const picture = context.auth.token.picture || null;
const email = context.auth.token.email || null;

Odległość między lokalizacją wywoływanej funkcji a lokalizacją klienta wywołującego może powodować opóźnienia w sieci. Aby zoptymalizować wydajność, rozważ określenie lokalizacji funkcji, jeśli ma to zastosowanie, i pamiętaj o wyrównaniu lokalizacji wywoływanej z lokalizacją ustawioną podczas inicjowania zestawu SDK po stronie klienta.

Opcjonalnie możesz dołączyć zaświadczenie sprawdzania aplikacji, aby chronić zasoby backendu przed nadużyciami, takimi jak oszustwa związane z rachunkami lub wyłudzanie informacji. Zobacz Włączanie wymuszania sprawdzania aplikacji dla funkcji Cloud Functions .

Przesyłam wynik

Aby wysłać dane z powrotem do klienta, zwróć dane, które można zakodować w formacie JSON. Na przykład, aby 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 w ramach promesy są odsyłane do klienta. Na przykład możesz zwrócić oczyszczony tekst, który funkcja wywoływalna zapisała w bazie danych czasu rzeczywistego:

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

Obsługuj błędy

Aby mieć pewność, że klient otrzyma przydatne szczegóły błędu, zwróć błędy z wywoływalnego obiektu, zgłaszając (lub zwracając odrzuconą obietnicę) instancję functions.https.HttpsError . Błąd ma atrybut code , który może mieć jedną z wartości wymienionych functions.https.HttpsError . Błędy mają również message w postaci ciągu znaków, który domyślnie jest pustym ciągiem. Mogą również posiadać opcjonalne pole details z dowolną wartością. Jeśli w funkcjach zostanie zgłoszony błąd inny niż HttpsError , klient zamiast tego otrzyma błąd z komunikatem INTERNAL i kodem internal .

Na przykład funkcja może zgłaszać błędy sprawdzania poprawności i uwierzytelniania wraz z komunikatami o błędach, aby powrócić do wywołującego klienta:

// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.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 (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

Wdróż funkcję wywoływalną

Po zapisaniu ukończonej wywoływalnej funkcji w index.js , jest ona wdrażana wraz ze wszystkimi innymi funkcjami po uruchomieniu firebase deploy . Aby wdrożyć tylko to, co można wywołać, użyj argumentu --only , jak pokazano, aby wykonać częściowe wdrożenie :

firebase deploy --only functions:addMessage

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

Skonfiguruj środowisko programistyczne klienta

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

iOS+

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

Użyj Menedżera pakietów Swift, aby zainstalować zależności Firebase i zarządzać nimi.

  1. W Xcode, przy otwartym projekcie aplikacji, przejdź do File > Add Packages .
  2. Po wyświetleniu monitu dodaj repozytorium SDK platform Firebase Apple:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Wybierz bibliotekę Cloud Functions.
  5. Dodaj flagę -ObjC do sekcji Inne flagi linkera w ustawieniach kompilacji celu.
  6. Po zakończeniu Xcode automatycznie rozpocznie rozwiązywanie i pobieranie zależności w tle.

Modułowe API sieciowe

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej aplikacji internetowej . Upewnij się, że uruchomiłeś następującą komendę na swoim terminalu:
    npm install firebase@10.7.1 --save
    
  2. Ręcznie wymagaj zarówno rdzenia Firebase, jak i funkcji chmury:

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

Internetowy interfejs API z przestrzenią nazw

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej aplikacji internetowej .
  2. Dodaj biblioteki klienckie 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>
    

Zestaw SDK Cloud Functions jest również dostępny jako pakiet npm.

  1. Uruchom następującą komendę na swoim terminalu:
    npm install firebase@8.10.1 --save
    
  2. Ręcznie wymagaj zarówno rdzenia Firebase, jak i funkcji chmury:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Kotlin+KTX

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej 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ść dla Cloud Functions biblioteka dla Androida. Zalecamy używanie Firebase Android BoM do kontrolowania wersji bibliotek.

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

    Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać z kompatybilnych wersji bibliotek Firebase Android.

    (Alternatywa) Dodaj zależności biblioteki Firebase bez użycia BoM

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

    Pamiętaj, że jeśli używasz w swojej aplikacji wielu bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co gwarantuje, że wszystkie wersje będą kompatybilne.

    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.4.0")
    }
    
    Szukasz modułu bibliotecznego specyficznego dla Kotlina? Począwszy od października 2023 r. (Firebase BoM 32.5.0) zarówno programiści Kotlin, jak i Java mogą polegać na głównym module biblioteki (więcej informacji można znaleźć w często zadawanych pytaniach dotyczących tej inicjatywy ).

Java

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojej 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ść dla Cloud Functions biblioteka dla Androida. Zalecamy używanie Firebase Android BoM do kontrolowania wersji bibliotek.

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

    Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać z kompatybilnych wersji bibliotek Firebase Android.

    (Alternatywa) Dodaj zależności biblioteki Firebase bez użycia BoM

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

    Pamiętaj, że jeśli używasz w swojej aplikacji wielu bibliotek Firebase, zdecydowanie zalecamy używanie BoM do zarządzania wersjami bibliotek, co gwarantuje, że wszystkie wersje będą kompatybilne.

    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.4.0")
    }
    
    Szukasz modułu bibliotecznego specyficznego dla Kotlina? Począwszy od października 2023 r. (Firebase BoM 32.5.0) zarówno programiści Kotlin, jak i Java mogą polegać na głównym module biblioteki (więcej informacji można znaleźć w często zadawanych pytaniach dotyczących tej inicjatywy ).

Dart

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

  2. W katalogu głównym projektu Flutter uruchom następujące polecenie, aby zainstalować wtyczkę:

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

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

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

Dla C++ z Androidem :

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

Dla C++ z platformami Apple :

  1. Postępuj zgodnie z instrukcjami, aby dodać Firebase do swojego projektu C++ .
  2. Dodaj moduł Cloud Functions do swojego Podfile :
    pod 'Firebase/Functions'
  3. Zapisz plik, a następnie uruchom:
    pod install
  4. Dodaj rdzeń Firebase i frameworki Cloud Functions z pakietu SDK Firebase C++ do swojego projektu Xcode.
    • firebase.framework
    • firebase_functions.framework

Jedność

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

Zainicjuj zestaw SDK klienta

Zainicjuj instancję Cloud Functions:

Szybki

lazy var functions = Functions.functions()

Cel C

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

Internetowy interfejs API z przestrzenią nazw

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

Modułowe API sieciowe

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

Java

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

Dart

final functions = FirebaseFunctions.instance;

C++

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

Jedność

functions = Firebase.Functions.DefaultInstance;

Wywołaj funkcję

Szybki

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

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

Internetowy interfejs API z przestrzenią nazw

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });

Modułowe API sieciowe

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

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

Jedność

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ługuj błędy na kliencie

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

Jeśli błąd zwrócony przez funkcję jest function.https.HttpsError , wówczas klient otrzymuje code błędu, message i details błędu serwera. W przeciwnym razie błąd zawiera komunikat INTERNAL i kod INTERNAL . Zobacz wskazówki dotyczące obsługi błędów w funkcji wywoływalnej.

Szybki

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

Cel C

if (error) {
  if ([error.domain isEqual:@"com.firebase.functions"]) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[@"details"];
  }
  // ...
}

Internetowy interfejs API z przestrzenią nazw

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

Modułowe API sieciowe

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

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

Jedność

 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 uruchomieniem aplikacji należy włączyć Sprawdzanie aplikacji , aby mieć pewność, że tylko Twoje aplikacje będą miały dostęp do punktów końcowych funkcji, które można wywołać.