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.

İşlevleri içeren örnek kodun tamamını aşağıda bulabilirsiniz:

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

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

initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = 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 getFirestore()
      .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 saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

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

  const uppercase = original.toUpperCase();

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

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()


@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")


@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})
main.py

Bu eğitim hakkında

Bu örnek için Cloud Firestore ve HTTP tetiklemeli işlevler seçtik. Bunun nedeni, bu arka plan tetikleyicilerinin Firebase Local Emulator Suite üzerinden kapsamlı bir şekilde test edilebilmesidir. Bu araç seti; Realtime Database, Cloud Storage, PubSub, Auth ve HTTP çağrılabilir tetikleyicilerini de destekler. Remote Config ve TestLab tetikleyicileri gibi diğer arka plan tetikleyicisi türleri, 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.

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:

   Firebase Crashlytics Firebase Cloud Messaging

   Firebase uygulama içi mesajlaşma Firebase Uzaktan Yapılandırma

   Remote Config kişiselleştirmesi Firebase A/B Testi

   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.

Ortamınızı ve Firebase CLI'yi ayarlama

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 örnek kod içeren boş bir proje oluşturursunuz. Node.js kullanıyorsanız işlev oluşturmak için TypeScript veya JavaScript'i seçebilirsiniz. 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 şu seçenekleri sunar:

   • JavaScript
   • TypeScript
   • Python

   Bu eğitim için JavaScript veya Python'u seçin. TypeScript'te yazma için TypeScript ile yazma işlevleri konusuna bakın.

6. CLI size bağımlılıkları yükleme seçeneği sunar. Bağımlılıkları başka bir şekilde yönetmek istiyorsanız bunu güvenle reddedebilirsiniz.

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

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
      |
      +- main.py      # Main source file for your Cloud Functions code
      |
      +- requirements.txt  #  List of the project's modules and packages 
      |
      +- venv/ # Directory where your dependencies are installed

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 projenizde Cloud Functions ve Admin SDK modüllerini içe aktarmalısınız. Kaynak dosyanıza aşağıdaki gibi satırlar ekleyin:

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const {logger} = require("firebase-functions");
const {onRequest} = require("firebase-functions/v2/https");
const {onDocumentCreated} = require("firebase-functions/v2/firestore");

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

initializeApp();
index.js

# The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
from firebase_functions import firestore_fn, https_fn

# The Firebase Admin SDK to access Cloud Firestore.
from firebase_admin import initialize_app, firestore
import google.cloud.firestore

app = initialize_app()
main.py

Bu satırlar gerekli modülleri yükler ve Cloud Firestore değişikliklerinin yapılabildiği bir admin uygulama örneğini 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 Admin SDK ve Cloud Functions için Firebase SDK modüllerini otomatik olarak yükler. Projenize üçüncü taraf kitaplıkları ekleme hakkında daha fazla bilgi için Bağımlılıkları Yönetme bölümüne bakın.

"Mesaj ekle" işlevini ekleyin

"Mesaj ekle" işlevi için, şu satırları kaynak dosyanıza ekleyin:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addmessage = 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 getFirestore()
      .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.`});
});
index.js

@https_fn.on_request()
def addmessage(req: https_fn.Request) -> https_fn.Response:
    """Take the text parameter passed to this HTTP endpoint and insert it into
    a new document in the messages collection."""
    # Grab the text parameter.
    original = req.args.get("text")
    if original is None:
        return https_fn.Response("No text parameter provided", status=400)

    firestore_client: google.cloud.firestore.Client = firestore.client()

    # Push the new message into Cloud Firestore using the Firebase Admin SDK.
    _, doc_ref = firestore_client.collection("messages").add({"original": original})

    # Send back a message that we've successfully written the message
    return https_fn.Response(f"Message with ID {doc_ref.id} added.")
main.py

"Mesaj ekle" işlevi, bir HTTP uç noktasıdır. Uç noktaya yapılan tüm istekler, platformunuzun (onRequest() veya on_request) istek işleyicisine istek ve yanıt nesnelerinin iletilmesiyle 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. "Mesaj ekle" HTTP işlevi, HTTP uç noktasına bir metin değeri iletir ve bunu /messages/:documentId/original yolu altındaki veritabanına ekler.

"Büyük harf yap" işlevini ekleme

"Büyük harf yap" işlevi için, kaynak dosyanıza şu satırları ekleyin:

// Listens for new messages added to /messages/:documentId/original
// and saves an uppercased version of the message
// to /messages/:documentId/uppercase
exports.makeuppercase = onDocumentCreated("/messages/{documentId}", (event) => {
  // Grab the current value of what was written to Firestore.
  const original = event.data.data().original;

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

  const uppercase = original.toUpperCase();

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

@firestore_fn.on_document_created(document="messages/{pushId}")
def makeuppercase(event: firestore_fn.Event[firestore_fn.DocumentSnapshot | None]) -> None:
    """Listens for new documents to be added to /messages. If the document has
    an "original" field, creates an "uppercase" field containg the contents of
    "original" in upper case."""

    # Get the value of "original" if it exists.
    if event.data is None:
        return
    try:
        original = event.data.get("original")
    except KeyError:
        # No "original" field, so do nothing.
        return

    # Set the "uppercase" field.
    print(f"Uppercasing {event.params['pushId']}: {original}")
    upper = original.upper()
    event.data.reference.update({"uppercase": upper})
main.py

"Büyük harfli yap" işlevi, Cloud Firestore'a yazıldığında yürütülerek dinlenecek belgeyi 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 geri çağırmayı tetikler.

Node.js'de, Cloud Firestore etkinlikleri gibi etkinlik odaklı 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. HTTP işlevinin URL'si için firebase emulators:start komutu çıkışı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, HTTP işlevlerinizin başarıyla çalıştığını belirten yeni günlükler görürsünüz:

      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. Üretimde dağıtım 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ıp yürütü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 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 olmasını sağlayan "büyük harfli yap" işlevini 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.

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:

• Cloud Functions'ın kullanım alanları hakkında bilgi edinin.
• Cloud Functions codelab'ini deneyin.
• GitHub'da kod örneklerini inceleyin ve çalıştırın