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'ta bir HTTP Callable 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 bunların HTTP işlevlerine aynı olmadığını göz önünde bulundurmak önemlidir. HTTP çağrılabilir işlevlerini kullanmak için platformunuzun istemci SDK'sını arka uç API ile birlikte kullanmanız (veya protokolü uygulamanız) gerekir. Çağrılabilir öğeler, HTTP işlevlerinden şu temel farklara sahiptir:

  • Çağrı yapılabilir; Firebase Authentication jetonları, FCM jetonları ve varsa Uygulama Kontrolü 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 üstü için Firebase SDK'sı, HTTPS çağrılabilir işlevlerini desteklemek için bu Firebase istemci SDK'sının minimum sürümleriyle birlikte çalışır:

  • Apple platformları için Firebase SDK'sı 10.26.0
  • Android 21.0.0 için Firebase SDK'sı
  • Firebase Modüler Web SDK s. 9.7.0

Desteklenmeyen bir platformda oluşturulan bir uygulamaya benzer işlevler eklemek istiyorsanız https.onCall için Protokol Özellikleri'ni inceleyin. Bu kılavuzun geri kalanında Apple platformları, Android, web, C++ ve Unity için HTTP çağrılabilir işlevin nasıl yazılacağı, dağıtılacağı ve çağrılacağı ile ilgili talimatlar sağlanmaktadır.

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

HTTPS çağrılabilir işlevi oluşturmak için functions.https.onCall kullanın. Bu yöntem iki parametre alır: data ve isteğe bağlı context:

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

Örneğin, Realtime Database'e kısa mesaj kaydeden bir çağrılabilir işlev için data, mesaj metnini içerebilir, context parametreleri ise kullanıcı kimlik doğrulama bilgilerini temsil edebilir:

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

Çağrılabilir işlevin konumu ile çağıran istemcinin konumu arasındaki mesafe, ağ gecikmesine neden olabilir. Performansı optimize etmek için uygun olan yerlerde işlev konumunu belirtmeyi düşünün ve istemci tarafında SDK'yı başlatırken çağrılabilir konumun konumunu ayarlanan konumla hizaladığınızdan emin olun.

İsteğe bağlı olarak, arka uç kaynaklarınızı faturalandırma sahtekarlığı veya kimlik avı gibi kötüye kullanıma karşı korumaya yardımcı olmak için bir Uygulama Kontrolü onayı ekleyebilirsiniz. Bkz. Cloud Functions için Uygulama Kontrolü'nü zorunlu kılma.

Sonucu geri gönderme

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

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

Eşzamansız bir işlemden sonra veri döndürmek için bir söz döndürün. Vaat karşılığında döndürülen veriler müşteriye geri gönderilir. Örneğin, çağrılabilir işlevin Realtime Database'e yazdığı arındırılmış metni döndürebilirsiniz:

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

Hataları işleme

İstemcinin yararlı hata ayrıntılarını aldığından emin olmak için functions.https.HttpsError öğesinin bir örneğini göndererek (veya reddedilen bir Promise hatası döndürerek) bir çağrılabilir hatadan hata döndürün. Hata, functions.https.HttpsError adresinde listelenen değerlerden biri olabilecek bir code özelliği içeriyor. Hatalarda varsayılan olarak boş dize olan message dizesi de var. Ayrıca isteğe bağlı bir değere sahip isteğe bağlı details alanı da olabilir. İşlevlerinizde HttpsError dışında bir hata oluşursa istemciniz INTERNAL mesajı ve internal koduyla birlikte bir hata alır.

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

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

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

index.js içinde tamamlanmış bir çağrılabilir işlev kaydedildikten sonra, firebase deploy çalıştırdığınızda 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 amacıyla --only bağımsız değişkenini gösterildiği gibi kullanı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ı ayarlama

Tüm ö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 ve üzeri

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

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

  1. Xcode'da, uygulama projeniz açıkken File > Add Packages'a (Dosya > Paket Ekle) gidin.
  2. İstendiğinde Firebase Apple platform 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ılıklarınızı çözümlemeye ve indirmeye otomatik olarak başlar.

Web Modüler API'si

  1. Firebase'i web uygulamanıza ekleme talimatlarını uygulayın. Terminalinizden şu komutu çalıştırdığınızdan emin olun:
    npm install firebase@10.12.1 --save
    
  2. Hem Firebase Core 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);
    

Web ad alanına sahip API'sı

  1. Web uygulamanıza Firebase'i ekleme talimatlarını uygulayın.
  2. Firebase Core ve Cloud Functions istemci kitaplıklarını uygulamanıza ekleyin:
    <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>
    

Cloud Functions SDK, npm paketi olarak da kullanılabilir.

  1. Terminalinizden şu komutu çalıştırın:
    npm install firebase@8.10.1 --save
    
  2. Hem Firebase Core hem de Cloud Functions'ı manuel olarak zorunlu kılın:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Kotlin+KTX

  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. Kitaplık sürümü oluşturmayı kontrol etmek için Firebase Android BoM'u kullanmanızı öneririz.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:33.0.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 her zaman uyumlu sürümlerini kullanır.

    (Alternatif) Firebase kitaplığı bağımlılıklarını BoM'u kullanmadan ekleyin

    Firebase BoM'yi kullanmamayı seçerseniz 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 tüm sürümlerin uyumlu olmasını sağlamak için BoM kullanmanızı kesinlikle öneririz.

    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üne başvurabilir. (Ayrıntılar için Bu girişimle ilgili sık sorulan sorular bölümüne göz atın).

Java

  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. Kitaplık sürümü oluşturmayı kontrol etmek için Firebase Android BoM'u kullanmanızı öneririz.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:33.0.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 her zaman uyumlu sürümlerini kullanır.

    (Alternatif) Firebase kitaplığı bağımlılıklarını BoM'u kullanmadan ekleyin

    Firebase BoM'yi kullanmamayı seçerseniz 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 tüm sürümlerin uyumlu olmasını sağlamak için BoM kullanmanızı kesinlikle öneririz.

    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üne başvurabilir. (Ayrıntılar için Bu girişimle ilgili sık sorulan sorular bölümüne göz atın).

Dart

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

  2. Flutter projenizin kök dizininden, aşağıdaki komutu çalıştırarak eklentiyi yükleyin:

    flutter pub add cloud_functions
    
  3. Tamamlandıktan sonra Flutter uygulamanızı yeniden oluşturun:

    flutter run
    
  4. Yüklendikten sonra, cloud_functions eklentisini Dart kodunuza içe aktararak erişebilirsiniz:

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

Android'de C++ için:

  1. Firebase'i C++ projenize ekleme talimatlarını uygulayın.
  2. firebase_functions kitaplığını CMakeLists.txt dosyanıza ekleyin.

Apple platformlarındaki C++ için:

  1. Firebase'i C++ projenize ekleme talimatlarını uygulayın.
  2. Cloud Functions kapsülünü Podfile cihazınıza ekleyin:
    pod 'Firebase/Functions'
  3. Dosyayı kaydedin ve şunu çalıştırın:
    pod install
  4. Firebase C++ SDK'sındaki Firebase temel ve Cloud Functions çerçevelerini Xcode projenize ekleyin.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Firebase'i Unity projenize ekleme talimatlarını uygulayın.
  2. Firebase Unity SDK'daki FirebaseFunctions.unitypackage öğesini Unity projenize ekleyin.

İ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 ad alanına sahip API'sı

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

Web Modüler API'si

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

Unity

functions = Firebase.Functions.DefaultInstance;

İş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 ad alanına sahip API'sı

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

Web Modüler API'si

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

İşlevin döndürdüğü 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. Çağrılabilir işlevinizdeki hataları işleme hakkında bilgi edinin.

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 ad alanına sahip API'sı

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 Modüler API'si

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

Çağrılabilir işlev uç noktalarınıza yalnızca uygulamalarınızın erişebildiğinden emin olmak için uygulamanızı kullanıma sunmadan önce Uygulama Kontrolü'nü etkinleştirmeniz gerekir.