Check out what’s new from Firebase at Google I/O 2022. Learn more

Uygulamanızdan arama işlevleri

Firebase istemci SDK'ları için Bulut İşlevleri, işlevleri doğrudan bir Firebase uygulamasından çağırmanıza olanak tanır. Uygulamanızdan bu şekilde bir işlevi çağırmak için, Bulut İşlevlerinde bir HTTPS Çağrılabilir işlevi yazıp dağıtın ve ardından işlevi uygulamanızdan çağırmak için istemci mantığı ekleyin.

HTTPS çağrılabilir işlevlerinin benzer olduğunu, ancak HTTP işlevleriyle aynı olmadığını akılda tutmak önemlidir. HTTPS çağrılabilir işlevlerini kullanmak için, platformunuz için istemci SDK'sını functions.https arka uç API'si ile birlikte kullanmanız (veya protokolü uygulamanız) gerekir. Callable'ların HTTP işlevlerinden şu temel farkı vardır:

  • Çağrılabilirlerle, Firebase Kimlik Doğrulama belirteçleri, FCM belirteçleri ve varsa Uygulama Kontrolü belirteçleri isteklere otomatik olarak dahil edilir.
  • functions.https.onCall tetikleyicisi, istek gövdesini otomatik olarak seri durumdan çıkarır ve kimlik doğrulama belirteçlerini doğrular.

Firebase SDK for Cloud Functions v0.9.1 ve üstü, 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 9.0.0
  • Android 20.1.0 için Firebase SDK'sı
  • Firebase JavaScript SDK'sı 8.10.1
  • Firebase Modüler Web SDK v. 9.0

Desteklenmeyen bir platformda oluşturulmuş bir uygulamaya benzer işlevler eklemek istiyorsanız, https.onCall için Protokol Belirtimi'ne bakın . Bu kılavuzun geri kalanı, Apple platformları, Android, web, C++ ve Unity için HTTPS çağrılabilir işlevinin nasıl yazılacağı, dağıtılacağı ve çağrılacağına ilişkin yönergeler sağlar.

Çağrılabilir işlevi yazın ve dağıtın

HTTPS çağrılabilir bir işlev 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, bir metin mesajını Gerçek Zamanlı Veritabanına kaydeden çağrılabilir bir işlev için, context parametreleri kullanıcı kimlik doğrulama bilgilerini temsil ederken, data mesaj metnini içerebilir:

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

Çağrılabilir işlevin konumu ile arayan istemcinin konumu arasındaki mesafe, ağ gecikmesine neden olabilir. Performansı optimize etmek için, uygun olduğunda işlev konumunu belirtmeyi düşünün ve istemci tarafında SDK'yı başlattığınızda çağrılabilir konumun ayarlanan konumla hizalandığından emin olun.

İsteğe bağlı olarak, arka uç kaynaklarınızı fatura sahtekarlığı veya kimlik avı gibi kötüye kullanımdan korumaya yardımcı olması için bir Uygulama Kontrolü onayı ekleyebilirsiniz. Bulut İşlevleri için Uygulama Kontrolü zorlamasını etkinleştirme bölümüne bakın.

Sonucu geri gönderme

Verileri istemciye geri göndermek için JSON kodlu olabilecek verileri 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,
};

Zaman uyumsuz bir işlemden sonra verileri döndürmek için bir söz verin. Söz tarafından döndürülen veriler müşteriye geri gönderilir. Örneğin, çağrılabilir işlevin Gerçek Zamanlı Veritabanına yazdığı temizlenmiş metni döndürebilirsiniz:

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

Hataları işleme

İstemcinin yararlı hata ayrıntılarını almasını sağlamak için, bir functions.https.HttpsError örneğini atarak (veya reddedilen bir Sözü döndürerek) çağrılabilir bir öğeden hataları döndürün. Hata, functions.https.HttpsError listelenen değerlerden biri olabilen bir code özelliğine sahiptir. Hatalar ayrıca, varsayılan olarak boş bir dize olan bir dize message sahiptir. Ayrıca isteğe bağlı bir değere sahip isteğe bağlı details alanına da sahip olabilirler. HttpsError dışında bir hata atılırsa, istemciniz bunun yerine INTERNAL mesajı ve internal koduyla bir hata alır.

Örneğin, bir işlev, çağıran istemciye geri dönmek için 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 functions.https.HttpsError('invalid-argument', 'The function must be called with ' +
      'one arguments "text" containing the message text to add.');
}
// Checking that the user is authenticated.
if (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

Çağrılabilir işlevi dağıtın

Tamamlanmış bir çağrılabilir işlevi index.js içinde kaydettikten sonra, firebase deploy . Yalnızca çağrılabilir olanı dağıtmak için, kısmi dağıtımları gerçekleştirmek için gösterildiği gibi --only argümanını 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.

Müşteri geliştirme ortamınızı kurun

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+

Firebase'i Apple uygulamanıza eklemek için talimatları izleyin.

Firebase bağımlılıklarını kurmak ve yönetmek için Swift Paket Yöneticisi'ni kullanın.

  1. Xcode'da, uygulama projeniz açıkken File > Add Packages seçeneğine gidin.
  2. İstendiğinde, Firebase Apple platformları SDK deposunu ekleyin:
  3.   https://github.com/firebase/firebase-ios-sdk
      
  4. Bulut İşlevleri kitaplığını seçin.
  5. Bittiğinde, Xcode otomatik olarak bağımlılıklarınızı arka planda çözmeye ve indirmeye başlayacaktır.

Web version 9

  1. Firebase'i Web uygulamanıza eklemek için talimatları izleyin. Terminalinizden aşağıdaki komutu çalıştırdığınızdan emin olun:
    npm install firebase@9.8.1 --save
    
  2. Hem Firebase çekirdeğini 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 version 8

  1. Firebase'i Web uygulamanıza eklemek için talimatları izleyin.
  2. Firebase çekirdeğini 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>
    

Bulut İşlevleri SDK'sı, bir npm paketi olarak da mevcuttur.

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

Java

  1. Firebase'i Android uygulamanıza eklemek için talimatları izleyin.

  2. Firebase Android BoM kullanarak, modülünüzdeki (uygulama düzeyi) Gradle dosyanızdaki (genellikle app/build.gradle ) Cloud Functions Android kitaplığına bağımlılığı bildirin.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:30.0.1')
    
        // Declare 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'u kullanarak uygulamanız her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanır.

    (Alternatif) BoM kullanmadan Firebase kitaplık bağımlılıklarını bildirin

    Firebase Malzeme Listesini kullanmamayı seçerseniz, her bir 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'yi kullanmanızı şiddetle tavsiye ettiğimizi unutmayın; bu, tüm sürümlerin uyumlu olmasını sağlar.

    dependencies {
        // Declare the dependency for the Cloud Functions library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions:20.1.0'
    }
    

Kotlin+KTX

  1. Firebase'i Android uygulamanıza eklemek için talimatları izleyin.

  2. Firebase Android BoM kullanarak, modülünüzdeki (uygulama düzeyi) Gradle dosyanızdaki (genellikle app/build.gradle ) Cloud Functions Android kitaplığına bağımlılığı bildirin.

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

    Firebase Android BoM'u kullanarak uygulamanız her zaman Firebase Android kitaplıklarının uyumlu sürümlerini kullanır.

    (Alternatif) BoM kullanmadan Firebase kitaplık bağımlılıklarını bildirin

    Firebase Malzeme Listesini kullanmamayı seçerseniz, her bir 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'yi kullanmanızı şiddetle tavsiye ettiğimizi unutmayın; bu, tüm sürümlerin uyumlu olmasını sağlar.

    dependencies {
        // Declare 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-ktx:20.1.0'
    }
    

Dart

  1. Firebase'i Flutter uygulamanıza eklemek için talimatları izleyin.

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

    flutter pub add cloud_functions
    
  3. Tamamlandığında, 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 eklemek için talimatları izleyin.
  2. firebase_functions kitaplığını CMakeLists.txt dosyanıza ekleyin.

Apple platformlu C++ için :

  1. Firebase'i C++ projenize eklemek için talimatları izleyin.
  2. Bulut İşlevleri bölmesini Pod dosyanıza Podfile :
    pod 'Firebase/Functions'
  3. Dosyayı kaydedin ve çalıştırın:
    pod install
  4. Firebase C++ SDK'dan Firebase çekirdeğini ve Cloud Functions çerçevelerini Xcode projenize ekleyin.
    • firebase.framework
    • firebase_functions.framework

Birlik

  1. Unity projenize Firebase eklemek için talimatları izleyin.
  2. Firebase Unity SDK'sından FirebaseFunctions.unity paketini FirebaseFunctions.unitypackage projenize ekleyin.

İstemci SDK'sını başlat

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

Süratli

lazy var functions = Functions.functions()

Amaç-C

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

Web version 8

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 version 9

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

Java

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

Kotlin+KTX

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

Dart

final functions = FirebaseFunctions.instance;

C++

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

Birlik

functions = Firebase.Functions.DefaultInstance;

işlevi çağır

Süratli

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

Amaç-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 version 8

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

Web version 9

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

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

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

Dart

final result =
    await FirebaseFunctions.instance.httpsCallable('addMessage').call();

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

Birlik

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

İşlev tarafından döndürülen hata function.https.HttpsError türündeyse, istemci sunucu hatasından hata code , message ve details alır. Aksi takdirde, hata INTERNAL INTERNAL içerir. Çağrılabilir işlevinizdeki hataların nasıl ele alınacağına ilişkin kılavuza bakın.

Süratli

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

Amaç-C

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

Web version 8

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 version 9

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

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

                    // ...
                }

                // ...
            }
        });

Kotlin+KTX

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

                // ...
            }

            // ...
        })

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

Birlik

 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ı başlatmadan önce, çağrılabilir işlev uç noktalarınıza yalnızca uygulamalarınızın erişebildiğinden emin olmak için Uygulama Kontrolünü etkinleştirmelisiniz.