Başlayın: İlk işlevlerinizi yazın, test edin ve dağıtın


Cloud Functions'ı kullanmaya başlamak için gerekli kurulum görevleriyle başlayan ve birbiriyle ilişkili iki işlevi oluşturma, test etme ve dağıtma adımlarıyla ilerleyen bu eğitim boyunca ilerleyebilirsiniz:

  • Metin değerini kabul eden ve bunu Cloud Firestore'a yazan bir URL'yi gösteren "mesaj ekle" işlevi.
  • Cloud Firestore yazmasında tetiklenen ve metni büyük harfe dönüştüren bir "büyük harfli yap" işlevi.

Bu örnek için Cloud Firestore ve HTTP tetikli JavaScript işlevleri seçtik. Bunun nedeni, bu arka plan tetikleyicilerinin Firebase Local Emulator Suite aracılığıyla kapsamlı bir şekilde test edilebilmesidir. Bu araç seti; Realtime Database, PubSub, Auth ve HTTP çağrılabilir tetikleyicilerini de destekler. Remote Config, TestLab ve Analytics tetikleyicileri gibi diğer arka plan tetikleyicilerinin tümü, bu sayfada açıklanmayan araç grupları kullanılarak etkileşimli bir şekilde test edilebilir.

Bu eğiticinin aşağıdaki bölümlerinde örneği derlemek, test etmek ve dağıtmak için gereken adımlar ayrıntılı olarak açıklanmaktadır. Bunun yerine kodu çalıştırıp denetlemek isterseniz Örnek kodun tamamını inceleyin bölümüne geçin.

Firebase Projesi oluşturma

  1. Firebase konsolunda Proje ekle'yi tıklayın.

    • Firebase kaynaklarını mevcut bir Google Cloud projesine eklemek için projenin adını girin veya açılır menüden proje adını seçin.

    • Yeni bir proje oluşturmak için istediğiniz proje adını girin. İsteğe bağlı olarak proje adının altında gösterilen proje kimliğini de düzenleyebilirsiniz.

  2. İstenirse Firebase şartlarını inceleyip kabul edin.

  3. Devam'ı tıklayın.

  4. (İsteğe bağlı) Aşağıdaki Firebase ürünlerinden herhangi birini kullanarak optimum bir deneyim yaşamanızı sağlayan, projenizde Google Analytics'i ayarlayın:

    Mevcut bir Google Analytics hesabını seçin veya yeni bir hesap oluşturun.

    Yeni bir hesap oluşturursanız Analytics raporlama konumunuzu seçip projeniz için veri paylaşım ayarlarını ve Google Analytics şartlarını kabul edin.

  5. Proje oluştur'u (veya mevcut bir Google Cloud projesi kullanıyorsanız Firebase'i ekle'yi) tıklayın.

Firebase, Firebase projeniz için kaynakları otomatik olarak sağlar. İşlem tamamlandığında Firebase konsolunda Firebase projenizin genel bakış sayfasına yönlendirilirsiniz.

Node.js ve Firebase CLI'yi ayarlama

İşlevleri yazmak için Node.js ortamına ve işlevleri Cloud Functions çalışma zamanına dağıtmak için Firebase CLI'ya ihtiyacınız vardır. Node.js ve npm'yi yüklemek için Node Version Manager önerilir.

Node.js ve npm'yi yükledikten sonra tercih ettiğiniz yöntemle Firebase CLI'yi yükleyin. CLI'ı npm aracılığıyla yüklemek için şunu kullanın:

npm install -g firebase-tools

Bu işlem, dünya genelinde kullanılabilen firebase komutunu yükler. Komut başarısız olursa npm izinlerini değiştirmeniz gerekebilir. En son firebase-tools sürümüne güncellemek için aynı komutu yeniden çalıştırın.

Projenizi ilk kullanıma hazırlayın

Cloud Functions için Firebase SDK'sını ilk kullanıma hazırlarken, bağımlılıklar ve minimum sayıda örnek kod içeren boş bir proje oluşturur ve işlev oluşturmak için TypeScript veya JavaScript'i seçersiniz. Bu eğitimde Cloud Firestore'u ilk kullanıma hazırlamanız da gerekir.

Projenizi ilk kullanıma hazırlamak için:

  1. Tarayıcı üzerinden giriş yapmak ve Firebase CLI'da kimlik doğrulaması yapmak için firebase login komutunu çalıştırın.
  2. Firebase proje dizininize gidin.
  3. firebase init firestore komutunu çalıştırın. Bu eğiticide, Firestore kuralları ve dizin dosyaları istendiğinde varsayılan değerleri kabul edebilirsiniz. Bu projede henüz Cloud Firestore kullanmadıysanız Cloud Firestore'u kullanmaya başlama bölümünde açıklandığı gibi Firestore için başlangıç modu ve konum seçmeniz gerekir.
  4. firebase init functions komutunu çalıştırın. CLI, mevcut bir kod tabanını seçmenizi veya ilk kullanıma hazırlamanızı ve yeni bir kod tabanını adlandırmanızı ister. Yeni başlarken, varsayılan konumda tek bir kod tabanı yeterli olur. Daha sonra uygulamanız genişledikçe işlevleri kod tabanlarında düzenlemek isteyebilirsiniz.
  5. CLI, dil desteği için size iki seçenek sunar:

    Bu eğitim için JavaScript'i seçin.

  6. CLI, npm ile bağımlılıkları yükleme seçeneği sunar. Bağımlılıkları başka bir şekilde yönetmek istiyorsanız reddetme işlemi güvenle yapılabilir. Ancak reddederseniz işlevlerinizi emüle etmeden veya dağıtmadan önce npm install komutunu çalıştırmanız gerekir.

Bu komutlar başarıyla tamamlandıktan sonra proje yapınız şöyle görünür:

myproject
 +- .firebaserc    # Hidden file that helps you quickly switch between
 |                 # projects with `firebase use`
 |
 +- firebase.json  # Describes properties for your project
 |
 +- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # main source file for your Cloud Functions code
      |
      +- node_modules/ # directory where your dependencies (declared in
                       # package.json) are installed

Başlatma sırasında oluşturulan package.json dosyası önemli bir anahtar içeriyor: "engines": {"node": "16"}. İşlevler yazma ve dağıtma için Node.js sürümünüzü belirtir. Desteklenen diğer sürümleri seçebilirsiniz.

Gerekli modülleri içe aktarma ve bir uygulamayı başlatma

Kurulum görevlerini tamamladıktan sonra, kaynak dizini açabilir ve aşağıdaki bölümlerde açıklandığı gibi kod eklemeye başlayabilirsiniz. Bu örnek için projeniz, Düğüm require ifadelerini kullanarak Cloud Functions ve Yönetici SDK'sı modüllerini içe aktarmalıdır. index.js dosyanıza aşağıdaki gibi satırlar ekleyin:

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();

Bu satırlar firebase-functions ve firebase-admin modüllerini yükler ve Cloud Firestore değişikliklerinin yapılabildiği bir admin uygulama örneği başlatır. Admin SDK desteğinin sunulduğu her yerde, FCM, Authentication ve Firebase Realtime Database'de olduğu gibi, Cloud Functions'ı kullanarak Firebase'i entegre etmek için etkili bir yöntem sunar.

Firebase CLI, projenizi ilk kullanıma hazırladığınızda Firebase ve Cloud Functions Düğümü için Firebase SDK modüllerini otomatik olarak yükler. Projenize üçüncü taraf kitaplıkları eklemek için package.json öğesini değiştirip npm install komutunu çalıştırabilirsiniz. Daha fazla bilgi için Bağımlılıkları Yönetme bölümüne bakın.

addMessage() işlevini ekleyin

addMessage() işlevi için şu satırları index.js işlevine ekleyin:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});

addMessage() işlevi, bir HTTP uç noktasıdır. Uç noktaya yapılan tüm istekler, ExpressJS stilinde Request ve Response nesnelerinin onRequest() geri çağırmasına geçirilmesiyle sonuçlanır.

HTTP işlevleri eşzamanlıdır (çağrılabilir işlevlere benzer). Bu nedenle, mümkün olduğunca hızlı bir şekilde yanıt göndermeniz ve Cloud Firestore'u kullanarak işi ertelemeniz gerekir. addMessage() HTTP işlevi, HTTP uç noktasına bir metin değeri iletir ve bunu /messages/:documentId/original yolu altındaki veritabanına ekler.

makeUppercase() işlevini ekleyin

makeUppercase() işlevi için şu satırları index.js işlevine ekleyin:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });

makeUppercase() işlevi, Cloud Firestore'a yazıldığında yürütülür. ref.set işlevi, dinlenecek dokümanı tanımlar. Performansı korumak için olabildiğince ayrıntılı bilgi vermelisiniz.

Ayraçlar (ör. {documentId}), geri çağırmada eşleşen verilerini gösteren "parametreleri" çevreleyen joker karakterlerdir.

Cloud Firestore, yeni mesaj eklendiğinde onCreate() geri çağırma işlemini tetikler.

Cloud Firestore etkinlikleri gibi etkinliğe dayalı işlevler eşzamansızdır. Geri çağırma işlevi bir null, Object veya Promise döndürmelidir. Hiçbir şey döndürmezseniz işlev zaman aşımına uğrar, bir hata sinyali verir ve yeniden denenir. Senkronizasyon, Eş Zamansız ve Vaatler bölümünü inceleyin.

İşlevlerinizin yürütmesini emüle edin

Firebase Local Emulator Suite, bir Firebase projesine dağıtmak yerine yerel makinenizde uygulama derleyip test etmenize olanak tanır. Geliştirme sırasında yerel test yapılmasını kesinlikle öneririz çünkü bu yöntem, üretim ortamında maliyet oluşturabilecek kodlama hatalarından (ör. sonsuz döngü) karşılaşma riskini azaltır.

İşlevlerinizi emüle etmek için:

  1. firebase emulators:start komutunu çalıştırın ve Emulator Suite kullanıcı arayüzünün URL'sinin çıkışını kontrol edin. Varsayılan olarak localhost:4000 değerine ayarlanır, ancak makinenizde farklı bir bağlantı noktasında barındırılabilir. Emulator Suite kullanıcı arayüzünü açmak için bu URL'yi tarayıcınıza girin.

  2. addMessage() HTTP işlevinin URL'si için firebase emulators:start komutunun çıktısını kontrol edin. http://localhost:5001/MY_PROJECT/us-central1/addMessage özelliğine benzer bir görünümdedir, ancak aşağıdaki özellikleri sunar:

    1. MY_PROJECT, proje kimliğinizle değiştirilecek.
    2. Bağlantı noktası yerel makinenizde farklı olabilir.
  3. İşlev URL'sinin sonuna ?text=uppercaseme sorgu dizesini ekleyin. URL şuna benzer şekilde görünecektir: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. İsterseniz "büyük harfli" mesajını özel bir iletiyle değiştirebilirsiniz.

  4. URL'yi tarayıcınızda yeni bir sekmede açarak yeni bir mesaj oluşturun.

  5. Emulator Suite kullanıcı arayüzünde işlevlerin etkilerini görüntüleyin:

    1. Günlükler sekmesinde, addMessage() ve makeUppercase() işlevlerinin çalıştırıldığını belirten yeni günlükler gösterilir:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. Firestore sekmesinde, orijinal mesajınızın yanı sıra mesajınızın büyük harfli sürümünü de içeren bir doküman görürsünüz (orijinali "bÜYÜK HARF" ise "BÜYÜK HARF" görürsünüz).

İşlevleri üretim ortamına dağıtma

İşlevleriniz emülatörde istediğiniz gibi çalıştıktan sonra bunları üretim ortamında dağıtma, test etme ve çalıştırma işlemlerine devam edebilirsiniz. Önerilen Node.js 14 çalışma zamanı ortamına dağıtım yapmak için projenizin Blaze fiyatlandırma planı kapsamında olması gerektiğini unutmayın. Cloud Functions fiyatlandırmasını inceleyin.

Eğiticiyi tamamlamak için işlevlerinizi dağıtın ve ardından addMessage() komutunu yürüterek makeUppercase() komutunu çalıştırın.

  1. İşlevlerinizi dağıtmak için şu komutu çalıştırın:

     firebase deploy --only functions
     

    Bu komutu çalıştırdığınızda Firebase CLI, tüm HTTP işlev uç noktalarının URL'sini verir. Terminalinizde şuna benzer bir satır görmeniz gerekir:

    Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
    

    URL, proje kimliğinizin yanı sıra HTTP işlevinin bölgesini içerir. Şu anda bu konuda endişelenmenize gerek olmasa da bazı üretim HTTP işlevleri ağ gecikmesini en aza indirmek için bir konum belirtmelidir.

    "Projeye erişim yetkilendirilemedi" gibi erişim hatalarıyla karşılaşırsanız proje takma adınızı kontrol etmeyi deneyin.

  2. KSA'nın addMessage() URL çıkışını kullanarak bir metin sorgusu parametresi ekleyin ve bunu bir tarayıcıda açın:

    https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
    

    İşlev, tarayıcıyı yürütür ve metin dizesinin depolandığı veritabanı konumundaki Firebase konsoluna yönlendirir. Bu yazma etkinliği, dizenin büyük harfli sürümünü yazan makeUppercase() işlemini tetikler.

İşlevleri dağıtıp yürüttükten sonra günlükleri Google Cloud konsolunda görüntüleyebilirsiniz. Geliştirme veya üretimde işlevleri silmeniz gerekiyorsa Firebase CLI'yi kullanın.

Üretimde, çalıştırılacak minimum ve maksimum örnek sayısını ayarlayarak işlev performansını optimize etmek ve maliyetleri kontrol etmek isteyebilirsiniz. Bu çalışma zamanı seçenekleri hakkında daha fazla bilgi için Ölçeklendirme davranışını kontrol etme bölümüne bakın.

Örnek kodun tamamını inceleyin

addMessage() ve makeUppercase() işlevlerini içeren tamamlanmış functions/index.js aşağıda verilmiştir. Bu işlevler, bir parametreyi Cloud Firestore'a değer yazan ve ardından dizedeki tüm karakterleri büyüterek dönüştüren bir HTTP uç noktasına aktarmanıza olanak tanır.

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });

Sonraki adımlar

Bu belgelerde, Cloud Functions için işlevleri yönetme ve Cloud Functions tarafından desteklenen tüm etkinlik türlerinin nasıl işleneceği hakkında daha fazla bilgi edinebilirsiniz.

Cloud Functions hakkında daha fazla bilgi edinmek için aşağıdakileri de yapabilirsiniz: