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

2. nesil 1. nesil

Cloud Functions'ı kullanmaya başlamak için şu eğiticiyi inceleyin: Bu eğitim, gerekli kurulum görevlerinden başlar ve ürün oluşturma, test etme, ve ilgili iki işlevi dağıtmanız gerekir:

• "Mesaj ekleyin" metin değeri kabul eden bir URL sunan ve bunu yazan işlev Cloud Firestore'a entegre edebilirsiniz.
• "Büyük harf yap" Cloud Firestore'da yazma ve dönüştürme işlemini tetikleyen işlev büyük harfe çevirebilirsiniz.

İşlevleri içeren tam örnek kodu aşağıda bulabilirsiniz:

Node.js

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

Python

# 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

Bunun için Cloud Firestore ve HTTP tetiklenen işlevleri seçtik bu arka plan tetikleyiciler ayrıntılı şekilde test edilebildiğinden Firebase Local Emulator Suite kullanın. Bu araç seti Realtime Database, Cloud Storage ve PubSub, Auth ve HTTP çağrılabilir tetikleyicileri. Diğer arka plan tetikleyici türleri Remote Config ve TestLab tetikleyicileri gibi etkileşimli bir şekilde test etmek için, bu sayfada açıklandığından emin olun.

Not: Herhangi bir Firebase projesinde işlevleri emüle edebilirsiniz ancak dağıtmak için işlevleri, projeniz Blaze fiyatlandırma planı kapsamında olmalıdır. Görüntüleyin Cloud Functions fiyatlandırması.

Bu eğiticinin aşağıdaki bölümlerinde, derleme için gereken adımlar ayrıntılı olarak açıklanmıştır: ve örneği dağıtabilirsiniz.

Firebase Projesi oluşturma

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

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

   • Yeni proje oluşturmak için istediğiniz proje adını girin. Ayrıca isteğe bağlı olarak proje adının altında gösterilen proje kimliğini düzenleyin.

     Firebase, Firebase projeniz için benzersiz bir kimlik oluşturur bir etiket veya ad gibi düşünebilirsiniz. Bu proje kimliğini düzenlemek isterseniz Firebase sizin için kaynak sağladıktan sonra değiştirilemeyeceğinden, şimdi bunu hemen yapın. belirler. Ziyaret edin: Firebase Projelerini Anlayarak Firebase'in proje kimliğini nasıl kullandığı hakkında bilgi edinin.

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ğıdakileri yapabilirsiniz: kullanarak en iyi deneyime sahip olmanız gerekir:

   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ı veya yeni bir hesap oluşturun.

   Yeni bir hesap oluşturuyorsanız Analytics raporlama konumu, ardından kabul edin ve Google Analytics şartlarını öğreneceğiz.

   Google Analytics'i istediğiniz zaman Entegrasyonlar Proje ayarları sekmesinin altında bulunur.

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

Firebase, Firebase projeniz için kaynakları otomatik olarak sağlar. Zaman İşlem tamamlandığında Firebase'inizin genel bakış sayfasına yönlendirilirsiniz projesindeki adımları uygulayın.

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

Node.js

İşlev yazmak için bir Node.js ortamına ihtiyacınız vardır, Firebase CLI'ı kullanarak işlevleri dağıtabilirsiniz. Cloud Functions çalışma zamanı. Node.js ve npm'yi yüklemek için Düğüm Sürüm Yöneticisi önerilir.

Önemli: Cloud Functions ve Firebase CLI, Node.js'yi tam olarak destekler. sürüm 22 için önizleme düzeyi desteğine sahip olan bu sürüm 18 ve 20'dir. Sürüm 14 ve 16 sürüm artık desteklenmemektedir ve 2025'in başlarında kullanımdan kaldırılacaktır (kullanımdan kaldırılan bu sürümlere sahip dağıtım şu anda devre dışı bırakılmıştır). Görüntüleyin Şunun için çalışma zamanı seçeneklerini ayarlayın: Node.js'nin bu sürümleri için sunulan destek hakkında önemli bilgiler sağlar.

Node.js ve npm yüklendikten sonra, Firebase CLI'ı yükleyin tercih ettiğiniz yöntemle yapabilirsiniz. CLI'yı npm üzerinden yüklemek için şunu kullanın:

npm install -g firebase-tools

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

Birçok durumda yeni özellikler ve hata düzeltmeleri yalnızca Firebase CLI'ın en son sürümü ve firebase-functions SDK'sı. Bu nedenle sık sık Bu komutlarla hem Firebase CLI'yı hem de SDK'yı güncelleyin Firebase projenizin functions klasöründe:

npm install firebase-functions@latest firebase-admin@latest --save
npm install -g firebase-tools

Python

Python ortamına ihtiyacınız olacak fonksiyon yazmak gibi Firebase CLI'ı kullanarak işlevleri dağıtabilirsiniz. Cloud Functions çalışma zamanı. Şunları yapmak için venv kullanmanızı öneririz: ve bağımlılıkları birazdan irdeleyeceğiz. Python sürümleri 3.10 ve 3.11 desteklenir.

Python'u yükledikten sonra Firebase CLI'ı yükleyin tercih ettiğiniz yöntemle yapabilirsiniz.

Birçok durumda yeni özellikler ve hata düzeltmeleri yalnızca Firebase CLI'ın en son sürümü ve firebase-functions SDK'sı. Bu nedenle sık sık Firebase CLI'yı ve SDK'yı güncelleyin. Firebase projenizin functions klasöründe bulabilirsiniz.

Projenizi ilk kullanıma hazırlayın

Cloud Functions için Firebase SDK'sını başlattığınızda boş bir proje oluşturursunuz ve minimum düzeyde örnek kod içeren bir sayfa örneğidir. Şu durumda: Node.js kullanarak Fonksiyon oluşturmak için TypeScript veya JavaScript kullanın. Bu Sözleşme'nin amaçları doğrultusunda, 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 vefirebase login Firebase CLI.
2. Firebase proje dizininize gidin.
3. firebase init firestore çalıştır. Bu eğitim için varsayılan ayarı kabul edebilirsiniz değerlerine sahip etiketleri kullanır. Kullanmadıysanız Bu projede henüz Cloud Firestore'u kullanmadıysanız açıklandığı gibi Firestore için bir başlangıç modu ve konum seçmeniz gerekir: Cloud Firestore'u kullanmaya başlayın.
4. firebase init functions çalıştır. CLI, sizden mevcut bir kod tabanı veya ilk kullanıma hazırlayıp yeni bir ad verin. Bu işe yeni başlıyorsanız varsayılan konumda tek bir kod tabanı yeterlidir. daha sonra, uygulamanız büyüdükçe işlevleri kod tabanlarında düzenlemek istiyorsanız.

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. Şu dilde yazmak için: TypeScript için TypeScript ile İşlevleri Yazma konusuna bakın.

6. CLI, size bağımlılıkları yükleme seçeneği sunar. Bu güvenli Bağımlılıkları başka bir şekilde yönetmek istiyorsanız reddetmeyi tercih edebilirsiniz.

Bu komutlar başarıyla tamamlandıktan sonra proje yapınız bu:

Node.js

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

Node.js için, başlatma sırasında oluşturulan package.json dosyası önemli bir anahtar: "engines": {"node": "18"}. Bu, fonksiyonları yazma ve dağıtma. Şunları yapabilirsiniz: desteklenen diğer sürümleri seçin.

Python

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çın ve şu sayfada açıklandığı şekilde kodu eklemeye başlayın: bu bölümde bulabilirsiniz. Bu örnek için, projenizin Cloud Functions ve Yönetici SDK'sı modülleri içerir. Çizgi ekleyin örneğin, kaynak dosyanıza ekleyin:

Node.js

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

Python

# 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ın. Yönetici SDK'sı desteğinin mevcut olduğu her yerde, FCM, Authentication ve Firebase Realtime Database için ise Cloud Functions'ı kullanarak Firebase'i entegre etmenin etkili bir yoludur.

Firebase CLI, otomatik olarak ilk kullanıma hazırladığınızda Firebase Admin SDK'sını ve Firebase SDK for Cloud Functions modüllerini yükler akılda kalıcı bir yolunu sunar. Üçüncü taraf kitaplıkları ekleme hakkında daha fazla bilgi inceleyebilirsiniz. Örneğin, Bağımlılıkları ele alın.

"Mesaj ekle"yi ekleyin işlev

"Mesaj ekleyin" seçeneği için fonksiyonunu kullanmak için aşağıdaki satırları kaynak dosyanıza ekleyin:

Node.js

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

Python

@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 ekleyin" fonksiyonu bir HTTP uç noktasıdır. Uç noktaya yapılan tüm istekler Bu sonuç, platformunuzun istek işleyicisi (onRequest() veya on_request).

HTTP işlevleri eşzamanlıdır ( çağrılanabilir işlevler) içermesi gerekir. Bu nedenle, ve Cloud Firestore kullanarak işleri erteleyin. "Mesaj ekleyin" HTTP işlevi, HTTP uç noktasına bir metin değeri iletir ve bunu /messages/:documentId/original yolunu izleyin.

"Büyük harf yap"ı ekleme işlev

"Büyük harf yap" seçeneği için fonksiyonunu kullanmak için aşağıdaki satırları kaynak dosyanıza ekleyin:

Node.js

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

Python

@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 yap" işlevi, Cloud Firestore'un şuna yazıldığında yürütülür: belgenin tanımlanması. Performans nedeniyle, olabildiğince ayrıntı vermeye çalışın.

"Parametreler" ve "parametreler" etrafında şekillenen parantezler (örneğin, {documentId}) joker karakterler geri aramada, eşleştirilen verilerini gösteren Cloud Firestore, aşağıdaki gibi geri çağırmasına olanak tanır.

Dikkat: İşlevin sonuç, fonksiyonu yeniden tetikleyerek sonsuz bir döngü oluşturur. Mesela bir fonksiyon yazma işlemiyle sona eren belirli bir Cloud Firestore belgesine yazma tarafından tetiklenen yönlendireceğim. Ayrıca, fonksiyonları idempotent olarak bilinir, aynı sonucu vermelidirler.

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

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

İlgili içeriği oluşturmak için kullanılan Firebase Local Emulator Suite Böylece, uygulamaları doğrudan müşterilerinize dağıtmak yerine yerel makinenizde Firebase projesi olabilir. Geliştirme sırasında yerel test yapılması önemle tavsiye edilir. ortaya çıkabilecek kodlama hatalarının riskini azalttığı için Bir üretim ortamında (örneğin, sonsuz döngü) maliyete neden olabilir.

İşlevlerinizi emüle etmek için:

1. firebase emulators:start komutunu çalıştırın ve URL'nin çıkışını kontrol edin gösteren bir e-posta alırsınız. Varsayılan olarak localhost:4000 ancak farklı bir yerde barındırılıyor olabilir bağlantı noktası ekleyin. Emulator Suite kullanıcı arayüzü.

2. firebase emulators:start çıkışını kontrol edin komutu bir örneğidir. Şuna benzer olacaktır: http://localhost:5001/MY_PROJECT/us-central1/addMessage, aşağıdakiler hariç:

   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. Aşağıdaki gibi görünecektir: http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme İsterseniz "büyük harf" mesajını değiştirebilirsiniz. özele dönüştür mesajını alırsınız.

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, verilerinizin günlük olarak kaydedildiğini HTTP işlevleriniz başarıyla çalıştırıldı:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

   2. Firestore sekmesinde, orijinal kodunuzu içeren bir doküman hem de mesajınızın büyük harfli versiyonunu (kullanılmışsa orijinalinde "büyük harf" ise "BÜYÜK HARF" ifadesini görürsünüz).

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

İşlevleriniz emülatörde istediğiniz gibi çalışmaya başladıktan sonra ve üretim ortamında dağıtmayı, test etmeyi ve çalıştırmayı içerir. Unutmamanız gereken noktalar projenizin üretimde dağıtılacağı Blaze fiyatlandırma planı kapsamında olmalıdır. Görüntüleyin Cloud Functions fiyatlandırması.

Eğiticiyi tamamlamak için işlevlerinizi dağıtıp yürütün oluşturabilirsiniz.

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. Terminalinizde şuna benzer bir satır görürsünüz:

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

   URL, proje kimliğinizi ve HTTP için bir bölgeyi içerir işlevini kullanın. Bu konuda endişelenmenize gerek olmasa da, bazı üretim HTTP işlevleri için bir konum Ağ gecikmesini en aza indirin.

   "Şuna erişim yetkilendirilemiyor: " projenizin takma adını kontrol etmeyi deneyin.

2. CLI'nin URL çıkışını kullanarak bir metin sorgusu parametresi ekleyin, ve bir tarayıcıda açın:

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

   İşlev, tarayıcıyı çalıştırır ve şuraya yönlendirir: Veritabanı konumundaki Firebase konsolu metin dizesinin depolandığı yer. Bu yazma etkinliği, "büyük harf yap" işlemini tetikler büyük harfli alan yazan bir fonksiyon dizesinin sürümü için de geçerlidir.

İşlevleri dağıtıp yürüttükten sonra şunları yapabilirsiniz: Google Cloud Console'da günlükleri görüntüleyebilirsiniz. İşlevleri silmeniz gerekiyorsa Firebase CLI'ı kullanın.

Üretimde, fonksiyonların performansını ve kontrolünü optimize etmek isteyebilirsiniz. minimum ve maksimum örnek sayısını ayarlayarak otomatik maliyetleri artırır. Görüntüleyin Ölçeklendirme davranışını kontrol etme bu çalışma zamanı seçenekleri hakkında daha fazla bilgi edinin.

Not: İşlevlerin Firebase CLI'dan dağıtılması hız sınırlarına tabidir. Firebase CLI dağıtımı için kota sınırları başlıklı makaleyi inceleyin.

Sonraki adımlar

Bu dokümanlarda, Yeşil Ofis web sitesinde Cloud Functions için işlevleri yönetme Ayrıca paydaşların Cloud Functions tarafından desteklenen tüm etkinlik türlerini işleyin.

Cloud Functions hakkında daha fazla bilgi edinmek için şunları da yapabilir:

• 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