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şlev ç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.

Bu HTTPS çağrılabilir fonksiyonları benzer ancak HTTP benzer olmayan fonksiyonlar olduğunu akılda tutmak önemlidir. HTTPS çağrılabilir fonksiyonlarını kullanmak için birlikte sizin platformu için istemci SDK kullanmalıdır functions.https arka uç API (veya protokol uygulamak). Callable'ların HTTP işlevlerinden şu temel farkı vardır:

  • Çağrılabilir öğelerle, Firebase Kimlik Doğrulama belirteçleri, FCM belirteçleri ve varsa Uygulama Kontrolü belirteçleri isteklere otomatik olarak dahil edilir.
  • functions.https.onCall tetik otomatik istek gövdesini deserializes ve auth belirteçleri doğrular.

Cloud Functions v0.9.1 ve üstü için Firebase SDK, HTTPS Callable işlevlerini desteklemek için bu Firebase istemci SDK'sının minimum sürümleriyle birlikte çalışır:

  • iOS 8.7.0 için Firebase SDK'sı
  • Android 20.0.1 için Firebase SDK'sı
  • Firebase JavaScript SDK'sı 8.10.0
  • Firebase Modüler Web SDK v. 9.0

Desteklenmeyen bir platform üzerine inşa bir uygulamaya benzer işlevler eklemek isterseniz, bkz için Protokol Spesifikasyonu'nda https.onCall . Bu kılavuzun geri kalanı, iOS, 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 talimatlar sağlar.

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

Kullanım functions.https.onCall HTTPS çağrılabilir işlevi oluşturun. Bu yöntem, iki parametre 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) => {
  // ...
});

Gerçek zamanlı Veritabanı kısa mesaj kurtaran bir çağrılabilir işlevi için, örneğin, data iken, mesaj metnini içerebilir context parametreleri kullanıcı kimlik doğrulama bilgilerini temsil:

// 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ğ gecikmesi oluşturabilir. Optimize performansı için, belirterek düşünün fonksiyon konumunu uygulanabildiği yerde ve ne zaman konum kümesiyle çağrılabilir konumu hizalamak için emin olun SDK başlatmak istemci tarafında.

İ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. Bkz App Bulut Fonksiyonlar için uygulanmasını kontrol etkinleştirin .

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

İstemci atma (veya Promise ile reddedilen dönen) bir örneğini tarafından kullanışlı hata ayrıntılarını, bir çağrılabilir dönüş hatalarını ulaştırmak için functions.https.HttpsError . Hata vardır code listelenen değerlerden biri olabilir özelliği functions.https.HttpsError . Hatalar da bir dize var message hangi boş bir dizeye varsayılan. Onlar da isteğe bağlı olabilir details keyfi değerle alanını. Daha bir hata diğer ederse HttpsError Fonksiyonlarınızdan ateslenen, müşteriniz yerine mesajını içeren bir hata alır INTERNAL ve kod internal .

Ö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

Eğer içinde tamamlanmış bir çağrılabilir işlevi kaydettikten sonra index.js , bu çalışan tüm diğer fonksiyonları ile birlikte dağıtıldığı firebase deploy . Sadece çağrılabilir dağıtmak için, kullanımı --only gerçekleştirmek için gösterildiği gibi bağımsız değişken kısmi dağıtır :

$ firebase deploy --only functions:addMessage

İşlevlerini dağıtırken sen izinleri hatalarla karşılaşırsanız, emin uygun olun IAM rolleri dağıtım komutları çalıştırarak kullanıcıya atanır.

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

  1. İçin talimatları uygulayın iOS uygulamasına Firebase ekleyin .
  2. Sizin için Bulut Fonksiyonlar Modülü ekleyerek Podfile :
    pod 'Firebase/Functions'
  3. Dosyaya kaydet, sonra çalıştırın:
    pod install

Web sürümü 9

  1. İçin talimatları uygulayın Web uygulamasına Firebase ekleyin . : Terminal aşağıdaki komutu çalıştırmak için emin olun
    npm install firebase@9.0.2 --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 sürümü 8

  1. İçin talimatları uygulayın Web uygulamasına Firebase ekleyin .
  2. Uygulamanıza Firebase çekirdek ve Bulut Fonksiyonlar istemci kitaplıkları ekleyin:
    <script src="https://www.gstatic.com/firebasejs/8.10.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.10.0/firebase-functions.js"></script>
    

Cloud Functions SDK, bir npm paketi olarak da mevcuttur.

  1. : Terminal aşağıdaki komutu çalıştırın
    npm install firebase@8.10.0 --save
    
  2. El ile Firebase çekirdek ve Bulut Fonksiyonlar hem gerektirir:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Java

  1. İçin talimatları uygulayın Android uygulamasına Firebase ekleyin .

  2. Kullanılması Firebase Android Bom , senin modülü (uygulama düzeyinde) Gradle dosyası (genellikle Cloud Fonksiyonlar Android kütüphane için bağımlılık beyan app/build.gradle ).

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

    Kullanarak Firebase Android Bom , uygulamanızın her zaman Firebase Android kütüphanelerin uyumlu versiyonlarını kullanacak.

    (Alternatif) Bom kullanmadan Firebase kütüphane bağımlılıklarını beyan

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

    Eğer uygulamanızda birden Firebase kitaplıkları kullanırsanız, biz çok tüm versiyonlar uyumlu olmasını sağlar kütüphane sürümlerini yönetmek için Bom kullanmanızı öneririz olduğunu unutmayın.

    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.0.1'
    }
    

Kotlin+KTX

  1. İçin talimatları uygulayın Android uygulamasına Firebase ekleyin .

  2. Kullanılması Firebase Android Bom , senin modülü (uygulama düzeyinde) Gradle dosyası (genellikle Cloud Fonksiyonlar Android kütüphane için bağımlılık beyan app/build.gradle ).

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

    Kullanarak Firebase Android Bom , uygulamanızın her zaman Firebase Android kütüphanelerin uyumlu versiyonlarını kullanacak.

    (Alternatif) Bom kullanmadan Firebase kütüphane bağımlılıklarını beyan

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

    Eğer uygulamanızda birden Firebase kitaplıkları kullanırsanız, biz çok tüm versiyonlar uyumlu olmasını sağlar kütüphane sürümlerini yönetmek için Bom kullanmanızı öneririz olduğunu unutmayın.

    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.0.1'
    }
    

C++

Android ile C ++ için:

  1. İçin talimatları uygulayın C ++ projeye Firebase ekleyin .
  2. Ekle firebase_functions sizin için kütüphane CMakeLists.txt dosyası.

IOS ile C ++ için:

  1. İçin talimatları uygulayın C ++ projeye Firebase ekleyin .
  2. Sizin için Bulut Fonksiyonlar Modülü ekleyerek Podfile :
    pod 'Firebase/Functions'
  3. Dosyaya kaydet, sonra çalıştırın:
    pod install
  4. Dan Firebase çekirdek ve Bulut Fonksiyonlar çerçeveleri ekle Firebase C ++ SDK Xcode projesine.
    • firebase.framework
    • firebase_functions.framework

Birlik

  1. İçin talimatları uygulayın sizin Birlik projesine Firebase ekleyin .
  2. Ekle FirebaseFunctions.unitypackage gelen Firebase Birlik SDK sizin Birlik projesine.

İ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 sürümü 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 sürümü 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

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 == FIRFunctionsErrorDomain) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web sürümü 8

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

Web sürümü 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
            }
}

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.

İşlevi tarafından döndürülen hata tipi ise function.https.HttpsError ardından istemci hatası aldığında code , message ve details sunucu hatadan. Aksi takdirde, hata iletisini içeren INTERNAL ve kodu INTERNAL . Olan kılavuzlar bakın hataları işlemek için çağrılabilir işlevi.

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 == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

Web sürümü 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 sürümü 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
                }

                // ...
            }

            // ...
        })

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, imkan vermelidir Uygulama Kontrolü yalnızca uygulamalar çağrılabilir işlevi son noktalarını erişebilmesini sağlamak yardımına.