Uygulamanızdan işlev çağırma


Cloud Functions for Firebase istemci SDK'ları, işlevleri doğrudan bir Firebase uygulamasından çağırmanızı sağlar. Uygulamanızdan bir işlevi bu şekilde çağırmak için Cloud Functions içinde HTTP Callable işlevi yazıp dağıtın ve ardından işlevi uygulamanızdan çağırmak için istemci mantığı ekleyin.

HTTP ile çağrılabilen işlevlerin HTTP işlevlerine benzer olduğunu ancak aynı olmadığını unutmayın. HTTP ile çağrılabilen işlevleri kullanmak için platformunuzun istemci SDK'sını arka uç API'siyle birlikte kullanmanız (veya protokolü uygulamanız) gerekir. Çağrılabilirler, HTTP işlevlerinden şu temel farklılıklara sahiptir:

  • Kullanılabilir olduğunda, çağrılabilirler, Firebase Authentication jetonları, FCM jetonları ve App Check jetonları isteklere otomatik olarak dahil edilir.
  • Tetikleyici, istek gövdesini otomatik olarak seri durumdan çıkarır ve kimlik doğrulama jetonlarını doğrular.

Cloud Functions 2. nesil ve sonraki sürümler için Firebase SDK'sı, HTTPS ile çağrılabilen işlevleri desteklemek üzere aşağıdaki Firebase istemci SDK'sı minimum sürümleriyle birlikte çalışır:

  • Apple platformları için Firebase SDK'sı 11.15.0
  • Firebase SDK'sı Android 21.2.1
  • Firebase Modüler Web SDK'sı v. 9.7.0

Desteklenmeyen bir platformda oluşturulan bir uygulamaya benzer işlevler eklemek istiyorsanız 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 ile çağrılabilir bir işlevin nasıl yazılacağı, dağıtılacağı ve çağrılacağıyla ilgili talimatlar verilmektedir.

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

Bu bölümdeki kod örnekleri, istemci SDK'larından birini kullanarak sunucu tarafı işlevine nasıl istek gönderileceğini ve nasıl yanıt alınacağını gösteren eksiksiz bir hızlı başlangıç örneğine dayanmaktadı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

HTTPS ile çağrılabilir bir işlev oluşturmak için platformunuzun istek işleyicisini (functions.https.onCall) veya on_call) 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 aktarılan verilerin yanı sıra kimlik doğrulama durumu gibi ek bağlam bilgilerini içerir. Örneğin, bir kısa mesajı Realtime Database konumuna kaydeden, çağrılabilir bir işlev için data, auth içinde kimlik doğrulama bilgileriyle birlikte mesaj metnini içerebilir:

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ılabilir işlevin konumu ile çağıran istemcinin konumu arasındaki mesafe, ağ gecikmesine neden olabilir. Performansı optimize etmek için geçerli olduğu durumlarda işlev konumunu belirtmeyi ve istemci tarafında SDK'yı başlattığınızda ayarlanan konumla çağrılabilir konumunu eşleştirmeyi unutmayın.

İsteğe bağlı olarak, arka uç kaynaklarınızı faturalandırma sahtekarlığı veya kimlik avı gibi kötüye kullanımlardan korumak için App Check onay ekleyebilirsiniz. Cloud Functions için App Check zorunlu kılma özelliğini etkinleştirme başlıklı makaleye bakın.

Sonucu geri gönderme

Verileri istemciye geri göndermek için JSON olarak kodlanabilen verileri döndürün. Örneğin, 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'ya döndürülür. Node.js'de bu işlem, JavaScript sözü kullanılarak eşzamansız 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}

Yayın sonuçları gönderme ve alma

Çağrılabilir işlevler, yayın sonuçlarını işleme mekanizmalarına sahiptir. Akış gerektiren bir kullanım alanınız varsa çağrılabilir istekte akışı yapılandırabilir ve ardından işlevi çağırmak için istemci SDK'sındaki uygun yöntemi kullanabilirsiniz.

Yayın sonuçlarını gönderme

Zaman içinde oluşturulan sonuçları (ör. bir dizi ayrı API isteğinden veya üretken yapay zeka API'sinden) verimli bir şekilde yayınlamak için çağrılabilir isteğinizdeki acceptsStreaming özelliğini kontrol edin. Bu özellik true olarak ayarlandığında sonuçları response.sendChunk() ile istemciye geri aktarabilirsiniz.

Örneğin, bir uygulamanın birden fazla konum için hava durumu tahmini verilerini alması gerekiyorsa çağrılabilir işlev, tüm tahmin istekleri çözülene kadar bekletmek yerine, her konumun tahminini ayrı ayrı akış yanıtı isteyen istemcilere gönderebilir:

exports.getForecast = onCall(async (request, response) => {
  if (request.data?.locations?.length < 1) {
    throw new HttpsError("invalid-argument", "Missing locations to forecast");
  }

  // fetch forecast data for all requested locations
  const allRequests = request.data.locations.map(
      async ({latitude, longitude}) => {
        const forecast = await weatherForecastApi(latitude, longitude);
        const result = {latitude, longitude, forecast};

        // clients that support streaming will have each
        // forecast streamed to them as they complete
        if (request.acceptsStreaming) {
          response.sendChunk(result);
        }

        return result;
      },
  );

  // Return the full set of data to all clients
  return Promise.all(allRequests);
});

response.sendChunk() işleyişinin, istemcinin isteğiyle ilgili belirli ayrıntılara bağlı olduğunu unutmayın:

  1. İstemci, akış yanıtı isterse: response.sendChunk(data) Veri parçasını hemen gönderir.

  2. İstemci, akış yanıtı istemezse: response.sendChunk() Bu arama için herhangi bir işlem yapılmaz. Tüm veriler hazır olduğunda tam yanıt gönderilir.

Müşterinin akış şeklinde yanıt isteyip istemediğini belirlemek için request.acceptsStreaming özelliğini kontrol edin. Örneğin, request.acceptsStreaming yanlışsa istemci artımlı teslimat beklemediği için özellikle tek tek parçaların hazırlanması veya gönderilmesiyle ilgili kaynak yoğun işleri atlamaya karar verebilirsiniz.

Yayın sonuçlarını alma

Tipik bir senaryoda istemci, .stream yöntemiyle akış isteğinde bulunur ve sonuçları yineler:

Swift

func listenToWeatherForecast() async throws {
    isLoading = true
    defer { isLoading = false }

    Functions
      .functions(region: "us-central1")
    let getForecast: Callable<WeatherRequest, StreamResponse<WeatherResponse, [WeatherResponse]>> = Functions.functions().httpsCallable("getForecast")

    let request = WeatherRequest(locations: locations)
    let stream = try getForecast.stream(request)

    for try await response in stream {
      switch response {
      case .message(let singleResponse):
        weatherData["\(singleResponse.latitude),\(singleResponse.longitude)"] = singleResponse
      case .result(let arrayOfResponses):
        for response in arrayOfResponses {
          weatherData["\(response.latitude),\(response.longitude)"] = response
        }
        print("Stream ended.")
        return
      }
    }
  }

Web

// Get the callable by passing an initialized functions SDK.
const getForecast = httpsCallable(functions, "getForecast");

// Call the function with the `.stream()` method to start streaming.
const { stream, data } = await getForecast.stream({
  locations: favoriteLocations,
});

// The `stream` async iterable returned by `.stream()`
// will yield a new value every time the callable
// function calls `sendChunk()`.
for await (const forecastDataChunk of stream) {
  // update the UI every time a new chunk is received
  // from the callable function
  updateUi(forecastDataChunk);
}

// The `data` promise resolves when the callable
// function completes.
const allWeatherForecasts = await data;
finalizeUi(allWeatherForecasts);

Gösterildiği gibi stream async iterable'ı döngüye alın. data sözü bekleniyor. Bu, istemciye isteğin tamamlandığını gösterir.

Kotlin

// Get the callable by passing an initialized functions SDK.
val getForecast = functions.getHttpsCallable("getForecast");

// Call the function with the `.stream()` method and convert it to a flow
getForecast.stream(
  mapOf("locations" to favoriteLocations)
).asFlow().collect { response ->
  when (response) {
    is StreamResponse.Message -> {
      // The flow will emit a [StreamResponse.Message] value every time the
      // callable function calls `sendChunk()`.
      val forecastDataChunk = response.message.data as Map<String, Any>
      // Update the UI every time a new chunk is received
      // from the callable function
      updateUI(
        forecastDataChunk["latitude"] as Double,
        forecastDataChunk["longitude"] as Double,
        forecastDataChunk["forecast"] as Double,
      )
    }
    is StreamResponse.Result -> {
      // The flow will emit a [StreamResponse.Result] value when the
      // callable function completes.
      val allWeatherForecasts = response.result.data as List<Map<String, Any>>
      finalizeUI(allWeatherForecasts)
    }
  }
}

asFlow() uzantısı işlevini kullanmak için org.jetbrains.kotlinx:kotlinx-coroutines-reactive kitaplığını uygulamanın build.gradle(.kts) dosyasına bağımlılık olarak ekleyin.

Java

// Get the callable by passing an initialized functions SDK.
HttpsCallableReference getForecast = mFunctions.getHttpsCallable("getForecast");
getForecast.stream(
  new HashMap<String, Object>() {{
    put("locations", favoriteLocations);
  }}
).subscribe(new Subscriber<StreamResponse>() {
  @Override
  public void onSubscribe(Subscription subscription) {
    subscription.request(Long.MAX_VALUE);
  }

  @Override
  public void onNext(StreamResponse streamResponse) {
    if (streamResponse instanceof StreamResponse.Message) {
      // The flow will emit a [StreamResponse.Message] value every time the
      // callable function calls `sendChunk()`.
      StreamResponse.Message response = (StreamResponse.Message) streamResponse;
      Map<String, Object> forecastDataChunk =
        (Map<String, Object>) response.getMessage().getData();
      // Update the UI every time a new chunk is received
      // from the callable function
      updateUI(
        (double) forecastDataChunk.get("latitude"),
        (double) forecastDataChunk.get("longitude"),
        (double) forecastDataChunk.get("forecast")
      );
    } else if(streamResponse instanceof StreamResponse.Result) {
      // The flow will emit a [StreamResponse.Result] value when the
      // callable function completes.
      StreamResponse.Result response = (StreamResponse.Result) streamResponse;
      List<Map<String, Object>> allWeatherForecasts =
        (List<Map<String, Object>>) response.getResult().getData();
      finalizeUI();
    }
  }

  @Override
  public void onError(Throwable throwable) {
    // an error occurred in the function
  }

  @Override
  public void onComplete() {

  }
});

CORS'u (Merkezler Arası Kaynak Paylaşımı) yapılandırma

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

Varsayılan olarak, çağrılabilir işlevlerde CORS, tüm kaynaklardan gelen isteklere izin verecek şekilde yapılandırılır. Tüm kaynaklar arası isteklerin değil, yalnızca bazılarının yapılmasına izin vermek için izin verilmesi gereken belirli alan adlarının veya normal ifadelerin listesini iletin. Ö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 yararlı hata ayrıntıları almasını sağlamak için functions.https.HttpsError veya https_fn.HttpsError örneği oluşturarak (Node.js için reddedilen bir Promise döndürerek) çağrılabilir bir öğeden hatalar döndürün. Hata, gRPC Durum kodları bölümünde listelenen değerlerden biri olabilen bir code özelliğine sahiptir. Hatalarda, varsayılan olarak boş dize olan bir message dizesi de bulunur. Ayrıca, isteğe bağlı olarak rastgele bir değere sahip details alanı da içerebilirler. İşlevlerinizden HTTPS hatası dışında bir hata döndürülürse istemciniz bunun yerine INTERNAL mesajı ve internal koduyla bir hata alır.

Örneğin, bir işlev, çağıran istemciye döndürülecek hata mesajlarıyla veri doğrulama ve kimlik doğrulama hataları verebilir:

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

index.js içinde tamamlanmış bir çağrılabilir işlevi kaydettikten sonra, firebase deploy komutunu ç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 --only bağımsız değişkenini gösterildiği gibi kullanarak kısmi dağıtımlar yapın:

firebase deploy --only functions:addMessage

İşlevleri dağıtırken izin hatalarıyla karşılaşırsanız dağıtım komutlarını çalıştıran kullanıcıya uygun IAM rollerinin atandığından emin olun.

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

Ön koşulları karşıladığınızdan emin olun, ardından gerekli bağımlılıkları ve istemci kitaplıklarını uygulamanıza ekleyin.

iOS+

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

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

  1. Xcode'da, uygulamanız açıkken File > Add Packages (Dosya > Paket Ekle) seçeneğine gidin.
  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ının Other Linker Flags (Diğer Bağlayıcı İşaretleri) bölümüne ekleyin.
  6. İşlem tamamlandığında Xcode otomatik olarak arka planda bağımlılarınızı çözümlemeye ve indirmeye başlar.

Web

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

     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ünüzün (uygulama düzeyinde) Gradle dosyasında (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. Kitaplık sürüm oluşturmayı kontrol etmek için Firebase Android BoM kullanmanızı öneririz.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:33.16.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)  Firebase kitaplığı bağımlılıklarını BoM kullanmadan ekleyin.

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

    Uygulamanızda birden fazla Firebase kitaplığı kullanıyorsanız kitaplık sürümlerini yönetmek için BoM kullanmanızı önemle tavsiye ederiz. Bu sayede tüm sürümlerin uyumlu olması sağlanır.

    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.2.1")
    }
    Kotlin'e özgü bir kitaplık modülü mü arıyorsunuz? Ekim 2023 (Firebase BoM 32.5.0)'ten itibaren hem Kotlin hem de Java geliştiriciler ana kitaplık modülünü kullanabilir (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

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

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 hata verirse veya sonuçtaki söz reddedilirse istemci hata alır.

İşlev tarafından döndürülen hata function.https.HttpsError türündeyse istemci, sunucu hatasından code, message ve details hatalarını alır. Aksi takdirde, hata INTERNAL mesajını ve INTERNAL kodunu içerir. Arama yapılabilir işlevinizdeki 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

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

Önerilir: App Check ile kötüye kullanımı önleyin

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