Uygulamanızdan işlev çağırma


Cloud Functions for Firebase istemci SDK'ları, işlevleri doğrudan bir Firebase uygulamasından çağırmanıza olanak tanır. Bir işlevi uygulamanızdan bu şekilde çağırmak için Cloud Functions'te bir HTTP çağrılabilir işlevi yazıp dağıtın ve ardından işlevi uygulamanızdan çağırmak için istemci mantığı ekleyin.

HTTP çağrılabilir işlevlerinin HTTP işlevlerine benzer ancak aynı olmadığını unutmayın. HTTP'de çağrılabilir işlevleri kullanmak için arka uç API ile birlikte platformunuzun istemci SDK'sını kullanmanız (veya protokolü uygulamanız) gerekir. Aranabilir cihazlarda bu tuşlar bulunur ve HTTP işlevlerinden farkı:

  • Çağrılanabilir öğelerle, Firebase Authentication jetonlar, FCM jetonlar ve App Check jetonlar varsa isteklere otomatik olarak dahil edilir.
  • Tetikleyici, istek gövdesinde otomatik olarak seri durumdan çıkar ve kimlik doğrulama jetonlarını doğrular.

Cloud Functions 2. nesil ve üstü için Firebase SDK'sı bu Firebase istemcisiyle birlikte çalışıyor HTTPS çağrılabilir işlevlerini desteklemek için minimum SDK sürümleri:

  • Apple platformları için Firebase SDK'sı 11.2.0
  • Android 21.0.0 için Firebase SDK'sı
  • Firebase Modüler Web SDK'sı 9.7.0 sürümü

Desteklenmeyen bir sürüme sahip bir uygulamaya benzer işlevler eklemek https.onCall için Protokol Spesifikasyonu'na bakın. Bu kılavuzun geri kalanında, Apple platformları, Android, web, C++ ve Unity için HTTP çağrılabilir işlev yazma, dağıtma ve çağırma talimatları verilmiştir.

Çağrılabilir işlevi yazma ve dağıtma

Bu bölümdeki kod örnekleri, istemci SDK'larından birini kullanarak sunucu tarafı bir işleve nasıl istek gönderileceğini ve yanıt alınacağını gösteren eksiksiz bir hızlı başlangıç örneğine dayanır. Başlamak için gerekli modülleri içe aktarın:

Node.js

// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/v2/https");
const {logger} = require("firebase-functions/v2");

// Dependencies for the addMessage function.
const {getDatabase} = require("firebase-admin/database");
const sanitizer = require("./sanitizer");

Python

# Dependencies for callable functions.
from firebase_functions import https_fn, options

# Dependencies for writing to Realtime Database.
from firebase_admin import db, initialize_app

Platformunuz (functions.https.onCall) için istek işleyiciyi kullanma veya on_call) işlevini kullanın. Bu yöntem bir istek parametresi alır:

Node.js

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

Python

@https_fn.on_call()
def addmessage(req: https_fn.CallableRequest) -> Any:
    """Saves a message to the Firebase Realtime Database but sanitizes the text
    by removing swear words."""

request parametresi, istemci uygulamasından iletilen verilerin yanı sıra kimlik doğrulama durumu gibi ek içerikleri de içerir. Realtime Database cihazına kısa mesaj kaydeden çağrılabilir bir işlev için örneğin, data kimlik doğrulama bilgilerinin yanı sıra ileti metnini de içerebilir auth içinde:

Node.js

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

Python

# Message text passed from the client.
text = req.data["text"]
# Authentication / user information is automatically added to the request.
uid = req.auth.uid
name = req.auth.token.get("name", "")
picture = req.auth.token.get("picture", "")
email = req.auth.token.get("email", "")

Çağrılanabilir işlevin konumu ile konum arasındaki mesafe bağlantısında gecikme yaşanabilir. Performansı optimize etmek için, geçerli olduğu durumlarda fonksiyon konumunu belirtmeyi düşünün ve çağrılabilir öğenin konumunu, istemci tarafında SDK'yı başlattığınızda ayarlanan konumla uyumlu hale getirdiğinizden emin olun.

İsteğe bağlı olarak, arka uç kaynaklarınızı faturalandırma sahtekarlığı veya kimlik avı gibi kötüye kullanımlara karşı korumaya yardımcı olması için bir App Check tasdiki ekleyebilirsiniz. Cloud Functions için App Check yaptırımını etkinleştirme başlıklı makaleyi inceleyin.

Sonucu geri gönderme

Verileri istemciye geri göndermek için JSON kodlu veriler döndürün. Örneğin, örneği: bir toplama işleminin sonucunu döndürmek için:

Node.js

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

Python

return {
    "firstNumber": first_number,
    "secondNumber": second_number,
    "operator": "+",
    "operationResult": first_number + second_number
}

Mesaj metni örneğindeki temizlenmiş metin hem istemciye hem de Realtime Database'e döndürülür. Node.js'de bu işlem, JavaScript promise kullanılarak asenkron olarak yapılabilir:

Node.js

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

Python

# Saving the new message to the Realtime Database.
sanitized_message = sanitize_text(text)  # Sanitize message.
db.reference("/messages").push({  # type: ignore
    "text": sanitized_message,
    "author": {
        "uid": uid,
        "name": name,
        "picture": picture,
        "email": email
    }
})
print("New message written")

# Returning the sanitized message to the client.
return {"text": sanitized_message}

CORS'yi (Kaynaklar Arası Kaynak Paylaşımı) yapılandırma

İşlevinize hangi kaynakların erişebileceğini kontrol etmek için cors seçeneğini kullanın.

Çağrılabilir işlevlerin CORS'si varsayılan olarak tüm kaynaklar. Kaynaklar arası isteklerin tümüne değil de bazılarına izin vermek için veya normal ifadelerle ilgili daha fazla bilgi sahibi olursunuz. Örneğin:

Node.js

const { onCall } = require("firebase-functions/v2/https");

exports.getGreeting = onCall(
  { cors: [/firebase\.com$/, "https://flutter.com"] },
  (request) => {
    return "Hello, world!";
  }
);

Kaynaklar arası istekleri yasaklamak için cors politikasını false olarak ayarlayın.

Hataları işleme

İstemcinin faydalı hata ayrıntılarını aldığından emin olmak için çağrılanabilir bir cihazdan hata döndürün şunu içeren bir örnek göndererek (veya Node.js'nin, functions.https.HttpsError veya https_fn.HttpsError. Hatanın, gRPC'de listelenen değerlerden biri olabilecek bir code özelliği var. Durum kodları. Hatalarda ayrıca, varsayılan olarak ayarlanan message dizesi de bulunur. kullanabilirsiniz. Ayrıca, isteğe bağlı bir details alanı da isteğe bağlı değer. Fonksiyonlarınızdan HTTPS hatası dışında bir hata atılırsa istemciniz bunun yerine INTERNAL mesajını ve kodu içeren bir hata alıyor internal.

Örneğin, bir işlev veri doğrulama ve kimlik doğrulama hataları gönderebilir hata mesajlarıyla birlikte arayan istemciye geri dönün:

Node.js

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

Python

# Checking attribute.
if not isinstance(text, str) or len(text) < 1:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
                              message=('The function must be called with one argument, "text",'
                                       " containing the message text to add."))

# Checking that the user is authenticated.
if req.auth is None:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.FAILED_PRECONDITION,
                              message="The function must be called while authenticated.")

Çağrılabilir işlevi dağıtma

Tamamlanmış bir çağrılabilir işlevi index.js içine kaydettikten sonra, firebase deploy'ü çalıştırdığınızda bu işlev diğer tüm işlevlerle birlikte dağıtılır. Yalnızca çağrılabilir öğeyi dağıtmak için kısmi dağıtımlar gerçekleştirmek üzere gösterildiği gibi --only bağımsız değişkenini kullanın:

firebase deploy --only functions:addMessage

İşlevleri dağıtırken izin hatalarıyla karşılaşırsanız şunların sağlandığından emin olun: uygun IAM rollerini kullanıcıya atanır.

İstemci geliştirme ortamınızı ayarlama

Tüm ön koşulları karşıladığınızdan emin olun, ardından gerekli bağımlılıkları eklemeniz gerekir.

iOS ve üzeri

Firebase'i Apple uygulamanıza ekleme talimatlarını uygulayın.

Firebase bağımlılıklarını yükleyip yönetmek için Swift Package Manager'ı kullanın.

  1. Xcode'da, uygulama projeniz açıkken Dosya > Paket Ekle'yi tıklayın.
  2. İstendiğinde Firebase Apple platformlar SDK deposunu ekleyin:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Cloud Functions kitaplığını seçin.
  5. -ObjC işaretini, hedefinizin derleme ayarlarındaki Diğer Bağlayıcı İşaretleri bölümüne ekleyin.
  6. İşlem tamamlandığında Xcode, arka planda bağımlılarınızı otomatik olarak çözümlemeye ve indirmeye başlar.

Web

  1. Firebase'i web uygulamanıza ekleme talimatlarını uygulayın. Terminalinizde aşağıdaki komutu çalıştırdığınızdan emin olun:
    npm install firebase@10.13.2 --save
  2. Hem Firebase Core'u hem de Cloud Functions'ü manuel olarak zorunlu kılın:

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

Android

  1. Firebase'i Android uygulamanıza ekleme talimatlarını uygulayın.

  2. Modül (uygulama düzeyi) Gradle dosyanıza (genellikle <project>/<app-module>/build.gradle.kts veya <project>/<app-module>/build.gradle) Android için Cloud Functions kitaplığının bağımlılığını ekleyin. Şunu kullanmanızı öneririz: Firebase Android BoM Kitaplık'ta sürüm oluşturmayı kontrol etmek için

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

    Firebase Android BoM kullanıldığında uygulamanız Firebase Android kitaplıklarının daima uyumlu sürümlerini kullanır.

    (Alternatif) BoM

    Firebase BoM kullanmamayı seçerseniz her Firebase kitaplık sürümünü bağımlılık satırında belirtmeniz gerekir.

    Uygulamanızda birden çok Firebase kitaplığı kullanıyorsanız, kitaplık sürümlerini yönetmek için BoM kullanmanızı öneririz. Bu, tüm sürümlerin uyumlu olduğundan emin olun.

    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")
    }
    Kotlin'e özel bir kitaplık modülü mü arıyorsunuz? Ekim 2023'ten (Firebase BoM 32.5.0) itibaren hem Kotlin hem de Java geliştiricileri ana kitaplık modülünden yararlanabilir (ayrıntılar için bu girişimle ilgili SSS bölümüne bakın).

İstemci SDK'sını başlatma

Cloud Functions örneğini başlatın:

Swift

lazy var functions = Functions.functions()

Objective-C

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

Java

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

İşlevi çağırma

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

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

İstemcideki hataları işleme

Sunucu bir hata atarsa veya sonuçta ortaya çıkan söz reddedilirse istemci bir hata alır.

İşlev function.https.HttpsError türündeyse istemci code, message ve details hatasını sunucu hatası. Aksi takdirde hata mesajında INTERNAL ve INTERNAL kodu yer alır. Çağırılabilir işlevinizde hataları nasıl ele alacağınızla ilgili yönergeleri inceleyin.

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

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

Uygulamanızı kullanıma sunmadan önce, yalnızca uygulamalarınızın çağrılabilir işlev uç noktalarınıza erişebilmesini sağlamak için App Check seçeneğini etkinleştirmeniz gerekir.