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

HTTPS üzerinden çağrılabilen bir işlev oluşturmak için functions.https.onCall öğesini 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) => {
    // ...
  });

Bir kısa mesajı Realtime Database konumuna kaydeden çağrılabilir bir işlev için (ör. data), data mesaj metnini içerebilirken context parametreleri kullanıcı kimlik doğrulama bilgilerini temsil eder:

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

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

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

Eşzamansız bir işlemden sonra veri döndürmek için bir promise döndürün. Söz tarafından döndürülen veriler istemciye geri gönderilir. Örneğin, çağrılabilir işlevin Realtime Database konumuna yazdığı temizlenmiş 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};
})
index.js

Hataları işleme

İstemcinin yararlı hata ayrıntıları almasını sağlamak için functions.https.HttpsError örneği oluşturarak (veya reddedilen bir Promise döndürerek) çağrılabilir bir öğeden hatalar döndürün. Hata, functions.https.HttpsError adresinde listelenen değerlerden birini alabilen bir code özelliğine sahip. 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 HttpsError dışında bir hata döndürülürse istemciniz bunun yerine INTERNAL mesajını ve internal kodunu içeren 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:

// Checking attribute.
if (!(typeof text === "string") || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("invalid-argument", "The function must be called " +
          "with one arguments \"text\" containing the message text to add.");
}
// Checking that the user is authenticated.
if (!request.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("failed-precondition", "The function must be " +
          "called while authenticated.");
}
index.js

Ç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
  3. Cloud Functions kitaplığını seçin.
  4. -ObjC işaretini hedefinizin derleme ayarlarının Other Linker Flags (Diğer Bağlayıcı İşaretleri) bölümüne ekleyin.
  5. İş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);

Web

  1. Firebase'i web uygulamanıza ekleme talimatlarını uygulayın.
  2. Firebase çekirdek 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. Terminalinizde aşağıdaki komutu çalıştırın: 
    npm install firebase@8.10.1 --save
  2. Hem Firebase Core hem de Cloud Functions'ı manuel olarak gerektirir: 
    const firebase = require("firebase");
// Required for side-effects
require("firebase/functions");

Kotlin

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

Java

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

Dart

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

  2. Eklentiyi yüklemek için Flutter projenizin kökünden aşağıdaki komutu çalıştırın:

    flutter pub add cloud_functions

  3. İşlem tamamlandıktan sonra Flutter uygulamanızı yeniden oluşturun:

    flutter run

  4. Yüklendikten sonra cloud_functions eklentisine Dart kodunuza aktararak erişebilirsiniz:

    import 'package:cloud_functions/cloud_functions.dart';

C++

Android ile 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ıyla 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 şu komutu çalıştırın: 
    pod install
  4. Firebase C++ SDK'sından Firebase çekirdeğini 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'sından 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()
CloudAddCell.swift

Objective-C

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

Web 

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

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

Web 

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

Kotlin 

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

Java 

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

Dart 

final functions = FirebaseFunctions.instance;

C++

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

Unity

functions = Firebase.Functions.DefaultInstance;

İş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
  }
}
CommentCell.swift

Objective-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if ([error.domain isEqual:@"com.firebase.functions"]) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[@"details"];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web 

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

Web 

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  });
fb_functions_call_add_message.js

Kotlin 

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true,
    )

    return functions
        .getHttpsCallable("addMessage")
        .call(data)
        .continueWith { task ->
            // This continuation runs on either success or failure, but if the task
            // has failed then result will throw an Exception which will be
            // propagated down.
            val result = task.result?.data as String
            result
        }
}
MainActivity.kt

Java 

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}
MainActivity.java

Dart 

    final result = await FirebaseFunctions.instance.httpsCallable('addMessage').call(
      {
        "text": text,
        "push": true,
      },
    );
    _response = result.data as String;

C++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const std::string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Unity

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

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

Objective-C

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

Web 

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    var code = error.code;
    var message = error.message;
    var details = error.details;
    // ...
  });
callable.js

Web 

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    const code = error.code;
    const message = error.message;
    const details = error.details;
    // ...
  });
fb_functions_call_add_message_error.js

Kotlin 

addMessage(inputMessage)
    .addOnCompleteListener { task ->
        if (!task.isSuccessful) {
            val e = task.exception
            if (e is FirebaseFunctionsException) {
                val code = e.code
                val details = e.details
            }
        }
    }
MainActivity.kt

Java 

addMessage(inputMessage)
  .addOnCompleteListener(new OnCompleteListener<String>() {
    @Override
    public void onComplete(@NonNull Task<String> task) {
      if (!task.isSuccessful()) {
        Exception e = task.getException();
        if (e instanceof FirebaseFunctionsException) {
          FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
          FirebaseFunctionsException.Code code = ffe.getCode();
          Object details = ffe.getDetails();
        }
      }
    }
  });
MainActivity.java

Dart 

try {
  final result =
      await FirebaseFunctions.instance.httpsCallable('addMessage').call();
} on FirebaseFunctionsException catch (error) {
  print(error.code);
  print(error.details);
  print(error.message);
}

C++

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult* result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  std::string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
  // ...

Unity

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});

Ö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.