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 ilgili iki işlevi oluşturma, test etme ve dağıtma adımlarıyla çalışan bu eğiticiyle çalışmayı deneyin:

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

İşlevleri içeren tam örnek kodu 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 arka plan tetikleyicilerinin Firebase Local Emulator Suite üzerinden kapsamlı şekilde test edilebildiğinden bu örnek için Cloud Firestore ve HTTP tetiklenen işlevleri seçtik. 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 tetikleyici türleri, bu sayfada açıklanmayan araç kümeleri kullanılarak etkileşimli bir şekilde test edilebilir.

Bu eğiticinin aşağıdaki bölümlerinde örneği oluşturmak, 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 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ı) Projeniz için Google Analytics'i kurun. Bu sayede, aşağıdaki Firebase ürünlerinden herhangi birini kullanırken optimum deneyim elde edebilirsiniz:

   Firebase Crashlytics Firebase Cloud Messaging

   Firebase uygulama içi mesajlaşma Firebase Remote Config

   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çin ve ardından 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 projesini kullanıyorsanız Firebase 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'ı ayarlama

Projenizi ilk kullanıma hazırlayın

Cloud Functions için Firebase SDK'sını başlattığınızda bağımlılıklar ve minimum düzeyde ö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ğiticinin amaçları için 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'ın kimliğini doğrulamak için firebase login komutunu çalıştırın.
2. Firebase proje dizininize gidin.
3. firebase init firestore çalıştır. Bu eğitimde, Firestore kuralları ve dizin dosyaları istendiğinde varsayılan değerleri kabul edebilirsiniz. Bu projede henüz Cloud Firestore'u 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 çalıştır. CLI, mevcut bir kod tabanı seçmenizi veya yeni bir kod tabanı oluşturup adlandırmanızı ister. Yeni başlayan aşamasında, varsayılan konumda tek bir kod tabanı yeterli olacaktır. Daha sonra uygulamanız genişledikçe işlevleri kod tabanlarında düzenlemek isteyebilirsiniz.

5. KSA, 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 İşlevleri Yazma bölümüne 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 bu seçeneği reddedebilirsiniz.

Bu komutlar başarıyla tamamlandıktan sonra proje yapınız şu şekilde 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 aktarın ve bir uygulamayı başlatın

Kurulum görevlerini tamamladıktan sonra kaynak dizini açabilir ve aşağıdaki bölümlerde açıklandığı şekilde kod eklemeye başlayabilirsiniz. Bu örnek için projenizin Cloud Functions ve Yönetici SDK'sı modüllerini içe aktarması gerekir. Kaynak dosyanıza aşağıdakine benzer 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ılabileceği bir admin uygulama örneğini başlatır. Admin SDK desteğinin mevcut olduğu her yerde (FCM, Authentication ve Firebase Realtime Database'de olduğu gibi) Cloud Functions'ı kullanarak Firebase'i entegre etmek için etkili bir yol sunar.

Firebase CLI, projenizi ilk kullanıma hazırladığınızda Firebase Admin SDK'yı ve Cloud Functions için Firebase SDK'sını 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 ekleme

"Mesaj ekle" işlevi için kaynak dosyanıza şu satırları 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 iletilen istek ve yanıt nesneleriyle sonuçlanır.

HTTP işlevleri eşzamanlıdır (çağrılanabilir 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 yolunun 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 harf oluştur" işlevi, Cloud Firestore'a yazıldığında yürütülür ve dinlenecek belgeyi tanımlar. Performansı artırmak için mümkün olduğunca ayrıntı vermeye dikkat edin.

Ayraçlar (ör. {documentId}), geri çağırmada kendi eşleşen verilerinin gösterildiği "parametreler" ve joker karakterlerle çevrilidir. Cloud Firestore, yeni mesajlar eklendiğinde geri çağırma işlemini tetikler.

Node.js'de, Cloud Firestore etkinlikleri gibi etkinliğe dayalı işlevler eşzamansızdır. Geri çağırma işlevi bir null, nesne veya Promise döndürmelidir. Hiçbir şey döndürmezseniz işlev zaman aşımına uğrayarak hata sinyali verir ve işlem yeniden denenir. Senkronizasyon, Eşzamansız ve Vaatler başlıklı bölüme bakın.

İşlevlerinizin yürütülmesini emüle etme

Firebase Local Emulator Suite sayesinde uygulamaları Firebase projesine dağıtmak yerine yerel makinenizde derleyip test edebilirsiniz. Geliştirme sırasında yerel test yapılması önemle tavsiye edilir. Bunun nedenlerinden biri, üretim ortamında (örneğin, sonsuz döngü) potansiyel olarak maliyet doğurabilecek kodlama hatalarının riskini azaltmasıdı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 makinenizdeki farklı bir bağlantı noktasında barındırılıyor olabilir. Emulator Suite kullanıcı arayüzünü açmak için tarayıcınıza bu URL'yi girin.

2. HTTP işlevinin URL'si için firebase emulators:start komutunun çıkışını kontrol edin. http://localhost:5001/MY_PROJECT/us-central1/addMessage ile benzerdir ancak şu noktaları fark etmez:

   1. MY_PROJECT, proje kimliğinizle değiştirilecek.
   2. Bağlantı noktası, yerel makinenizde farklı olabilir.

3. ?text=uppercaseme sorgu dizesini, işlevin URL'sinin sonuna ekleyin. Şuna benzer bir görünümde olacaktır: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme. İsteğe bağlı olarak, "büyük harf" mesajını özel bir mesajla değiştirebilirsiniz.

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

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

   1. Günlükler sekmesinde, HTTP işlevlerinizin başarılı bir şekilde çalıştığını gösteren yeni günlükler göreceksiniz:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

   2. Firestore sekmesinde, orijinal mesajınızın yanı sıra iletinizin büyük harfli versiyonunu da içeren bir doküman görürsünüz (aslında "büyük harf" ise "BÜYÜK HARF" gösterilir).

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

İşlevleriniz emülatörde istediğiniz gibi çalıştığında bunları dağıtma, test etme ve üretim ortamında çalıştırmaya geçebilirsiniz. Üretim aşamasında 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ı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ıktan sonra Firebase CLI, tüm HTTP işlevi uç noktaları için URL'yi oluşturur. Terminalinizde şuna benzer bir satır görürsünüz:

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

   URL, HTTP işlevinin bölgesinin yanı sıra proje kimliğinizi de içerir. 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 yetkilendirilemiyor" 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üp metin dizesinin depolandığı veritabanı konumundaki Firebase konsoluna yönlendirir. Bu yazma etkinliği, dizenin büyük harfli sürümünü yazan "make largecase" işlevini tetikler.

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

Üretimde, çalıştırılacak minimum ve maksimum örnek sayılarını belirleyerek 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 belgede, Cloud Functions için işlevleri yönetme ve Cloud Functions tarafından desteklenen tüm etkinlik türlerini yönetme hakkında daha fazla bilgi edinebilirsiniz.

Cloud Functions hakkında daha fazla bilgi edinmek için şunları da 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