คุณสามารถปรับใช้ ลบ และแก้ไขฟังก์ชันได้โดยใช้คำสั่ง Firebase CLI หรือโดยการตั้งค่าตัวเลือกรันไทม์ในซอร์สโค้ดของฟังก์ชัน
ปรับใช้ฟังก์ชัน
หากต้องการปรับใช้ฟังก์ชัน ให้รันคำสั่ง Firebase CLI นี้:
firebase deploy --only functions
ตามค่าเริ่มต้น Firebase CLI จะปรับใช้ฟังก์ชันทั้งหมดภายในแหล่งที่มาของคุณพร้อมกัน หากโปรเจ็กต์ของคุณมีมากกว่า 5 ฟังก์ชัน เราขอแนะนำให้คุณใช้แฟล็ก --only
พร้อมชื่อฟังก์ชันเฉพาะเพื่อปรับใช้เฉพาะฟังก์ชันที่คุณได้แก้ไข การปรับใช้ฟังก์ชันเฉพาะด้วย วิธีนี้จะช่วยเร่งกระบวนการปรับใช้และช่วยให้คุณหลีกเลี่ยงโควต้าการปรับใช้ ตัวอย่างเช่น:
firebase deploy --only functions:addMessage,functions:makeUppercase
เมื่อปรับใช้ฟังก์ชันจำนวนมาก คุณอาจเกินโควต้ามาตรฐานและได้รับข้อความแสดงข้อผิดพลาด HTTP 429 หรือ 500 เพื่อแก้ไขปัญหานี้ ให้ปรับใช้ฟังก์ชันในกลุ่มไม่เกิน 10 ตัว
ดู การอ้างอิง Firebase CLI สำหรับรายการคำสั่งทั้งหมดที่มี
ตามค่าเริ่มต้น Firebase CLI จะค้นหาซอร์สโค้ดใน functions/
โฟลเดอร์ หากต้องการ คุณสามารถ จัดระเบียบฟังก์ชัน ในโค้ดเบสหรือไฟล์หลายชุดได้
ลบฟังก์ชัน
คุณสามารถลบฟังก์ชันที่ใช้งานก่อนหน้านี้ได้ด้วยวิธีเหล่านี้:
- อย่างชัดเจน ใน Firebase CLI พร้อม
functions:delete
- อย่างชัดเจน ใน Google Cloud Console
- โดยปริยาย โดยการลบฟังก์ชันออกจากแหล่งที่มาก่อนที่จะปรับใช้
การดำเนินการลบทั้งหมดจะแจ้งให้คุณยืนยันก่อนที่จะลบฟังก์ชันออกจากการใช้งานจริง
การลบฟังก์ชันที่ชัดเจนใน Firebase CLI รองรับอาร์กิวเมนต์หลายรายการรวมถึงกลุ่มฟังก์ชัน และช่วยให้คุณระบุฟังก์ชันที่ทำงานในภูมิภาคใดภูมิภาคหนึ่งได้ นอกจากนี้ คุณยังสามารถแทนที่พร้อมท์การยืนยันได้
# Delete all functions that match the specified name in all regions. firebase functions:delete myFunction
# Delete a specified function running in a specific region. firebase functions:delete myFunction --region us-east-1
# Delete more than one function firebase functions:delete myFunction myOtherFunction
# Delete a specified functions group. firebase functions:delete groupA
# Bypass the confirmation prompt. firebase functions:delete myFunction --force
ด้วยการลบฟังก์ชันโดยนัย การ firebase deploy
วิเคราะห์แหล่งที่มาของคุณและลบฟังก์ชันใดๆ ที่ถูกลบออกจากไฟล์ออกจากการใช้งานจริง
แก้ไขชื่อฟังก์ชัน ภูมิภาค หรือทริกเกอร์
หากคุณกำลังเปลี่ยนชื่อหรือเปลี่ยนภูมิภาคหรือทริกเกอร์สำหรับฟังก์ชันที่จัดการปริมาณการใช้งานจริง ให้ทำตามขั้นตอนในส่วนนี้เพื่อหลีกเลี่ยงการสูญเสียเหตุการณ์ระหว่างการแก้ไข ก่อนที่คุณจะทำตามขั้นตอนเหล่านี้ ขั้นแรกตรวจสอบให้แน่ใจว่าฟังก์ชันของคุณเป็น idempotent เนื่องจากฟังก์ชันทั้งเวอร์ชันใหม่และเวอร์ชันเก่าจะทำงานพร้อมกันระหว่างการเปลี่ยนแปลง
เปลี่ยนชื่อฟังก์ชัน
หากต้องการเปลี่ยนชื่อฟังก์ชัน ให้สร้างเวอร์ชันที่เปลี่ยนชื่อใหม่ของฟังก์ชันในแหล่งที่มาของคุณ จากนั้นเรียกใช้คำสั่งการปรับใช้สองคำสั่งแยกกัน คำสั่งแรกปรับใช้ฟังก์ชันที่ตั้งชื่อใหม่ และคำสั่งที่สองจะลบเวอร์ชันที่ใช้งานก่อนหน้านี้ ตัวอย่างเช่น หากคุณมีฟังก์ชัน Node.js ชื่อ webhook
ที่คุณต้องการเปลี่ยนเป็น webhookNew
ให้แก้ไขโค้ดดังนี้:
// before
const functions = require('firebase-functions');
exports.webhook = functions.https.onRequest((req, res) => {
res.send("Hello");
});
// after
const functions = require('firebase-functions');
exports.webhookNew = functions.https.onRequest((req, res) => {
res.send("Hello");
});
จากนั้นรันคำสั่งต่อไปนี้เพื่อปรับใช้ฟังก์ชันใหม่:
# Deploy new function called webhookNew firebase deploy --only functions:webhookNew # Wait until deployment is done; now both webhookNew and webhook are running # Delete webhook firebase functions:delete webhook
เปลี่ยนภูมิภาคหรือภูมิภาคของฟังก์ชัน
หากคุณกำลังเปลี่ยน ภูมิภาค ที่ระบุสำหรับฟังก์ชันที่จัดการปริมาณการใช้งานจริง คุณสามารถป้องกันการสูญเสียเหตุการณ์ได้โดยทำตามขั้นตอนเหล่านี้ตามลำดับ:
- เปลี่ยนชื่อฟังก์ชัน และเปลี่ยนภูมิภาคหรือภูมิภาคตามต้องการ
- ปรับใช้ฟังก์ชันที่เปลี่ยนชื่อ ซึ่งส่งผลให้มีการเรียกใช้โค้ดเดียวกันชั่วคราวในทั้งสองชุดของภูมิภาค
- ลบฟังก์ชั่นก่อนหน้า
ตัวอย่างเช่น หากคุณมีฟังก์ชันที่เรียกว่า webhook
ซึ่งขณะนี้อยู่ในขอบเขตฟังก์ชันเริ่มต้นของ us-central1
และคุณต้องการย้ายไปยัง asia-northeast1
คุณต้องแก้ไขซอร์สโค้ดของคุณก่อนเพื่อเปลี่ยนชื่อฟังก์ชันและแก้ไขขอบเขต .
// before
const functions = require('firebase-functions');
exports.webhook = functions
.https.onRequest((req, res) => {
res.send("Hello");
});
// after
const functions = require('firebase-functions');
exports.webhookAsia = functions
.region('asia-northeast1')
.https.onRequest((req, res) => {
res.send("Hello");
});
จากนั้นปรับใช้โดยการรัน:
firebase deploy --only functions:webhookAsia
ขณะนี้มีสองฟังก์ชันที่เหมือนกันที่ทำงานอยู่: webhook
ทำงานใน us-central1
และ webhookAsia
ทำงานใน asia-northeast1
จากนั้นลบ webhook
:
firebase functions:delete webhook
ขณะนี้มีเพียงฟังก์ชันเดียวเท่านั้น - webhookAsia
ซึ่งทำงานใน asia-northeast1
เปลี่ยนประเภททริกเกอร์ของฟังก์ชัน
เมื่อคุณพัฒนา Cloud Functions สำหรับการปรับใช้ Firebase เมื่อเวลาผ่านไป คุณอาจต้องเปลี่ยนประเภททริกเกอร์ของฟังก์ชันด้วยเหตุผลหลายประการ ตัวอย่างเช่น คุณอาจต้องการเปลี่ยนจากเหตุการณ์ Firebase Realtime Database หรือ Cloud Firestore ประเภทหนึ่งไปเป็นประเภทอื่น
ไม่สามารถเปลี่ยนประเภทเหตุการณ์ของฟังก์ชันโดยเพียงแค่เปลี่ยนซอร์สโค้ดและเรียกใช้ firebase deploy
ใช้ เพื่อหลีกเลี่ยงข้อผิดพลาด ให้เปลี่ยนประเภททริกเกอร์ของฟังก์ชันตามขั้นตอนนี้:
- แก้ไขซอร์สโค้ดเพื่อรวมฟังก์ชันใหม่เข้ากับประเภททริกเกอร์ที่ต้องการ
- ปรับใช้ฟังก์ชัน ซึ่งส่งผลให้มีการเรียกใช้ฟังก์ชันทั้งเก่าและใหม่เป็นการชั่วคราว
- ลบฟังก์ชันเก่าออกจากการผลิตอย่างชัดเจนโดยใช้ Firebase CLI
ตัวอย่างเช่น หากคุณมีฟังก์ชัน Node.js ชื่อ objectChanged
ซึ่งมีประเภทเหตุการณ์ onChange
แบบเดิม และคุณต้องการเปลี่ยนเป็น onFinalize
ก่อนอื่นให้เปลี่ยนชื่อฟังก์ชันและแก้ไขให้มีประเภทเหตุการณ์ onFinalize
// before
const functions = require('firebase-functions');
exports.objectChanged = functions.storage.object().onChange((object) => {
return console.log('File name is: ', object.name);
});
// after
const functions = require('firebase-functions');
exports.objectFinalized = functions.storage.object().onFinalize((object) => {
return console.log('File name is: ', object.name);
});
จากนั้นรันคำสั่งต่อไปนี้เพื่อสร้างฟังก์ชันใหม่ก่อน ก่อนที่จะลบฟังก์ชันเก่า:
# Create new function objectFinalized firebase deploy --only functions:objectFinalized # Wait until deployment is done; now both objectChanged and objectFinalized are running # Delete objectChanged firebase functions:delete objectChanged
ตั้งค่าตัวเลือกรันไทม์
ฟังก์ชันคลาวด์สำหรับ Firebase ให้คุณเลือกตัวเลือกรันไทม์ เช่น เวอร์ชันรันไทม์ Node.js และการหมดเวลาต่อฟังก์ชัน การจัดสรรหน่วยความจำ และอินสแตนซ์ฟังก์ชันขั้นต่ำ/สูงสุด
ตามแนวทางปฏิบัติที่ดีที่สุด ควรตั้งค่าตัวเลือกเหล่านี้ (ยกเว้นเวอร์ชัน Node.js) บนออบเจ็กต์การกำหนดค่าภายในโค้ดฟังก์ชัน ออบเจ็กต์ RuntimeOptions
นี้เป็นแหล่งที่มาของความจริงสำหรับตัวเลือกรันไทม์ของฟังก์ชัน และจะลบล้างตัวเลือกที่ตั้งค่าด้วยวิธีอื่นใด (เช่น ผ่านคอนโซล Google Cloud หรือ gcloud CLI)
หากขั้นตอนการพัฒนาของคุณเกี่ยวข้องกับการตั้งค่าตัวเลือกรันไทม์ด้วยตนเองผ่านคอนโซล Google Cloud หรือ gcloud CLI และคุณ ไม่ ต้องการให้ค่าเหล่านี้ถูกแทนที่ในการปรับใช้แต่ละครั้ง ให้ตั้งค่าตัวเลือก preserveExternalChanges
เป็น true
เมื่อตั้งค่าตัวเลือกนี้เป็น true
Firebase จะรวมตัวเลือกรันไทม์ที่ตั้งไว้ในโค้ดของคุณเข้ากับการตั้งค่าเวอร์ชันที่ใช้งานอยู่ในปัจจุบันของฟังก์ชันของคุณตามลำดับความสำคัญต่อไปนี้:
- ตัวเลือกถูกตั้งค่าไว้ในรหัสฟังก์ชัน: แทนที่การเปลี่ยนแปลงภายนอก
- ตัวเลือกถูกตั้งค่าเป็น
RESET_VALUE
ในรหัสฟังก์ชัน: แทนที่การเปลี่ยนแปลงภายนอกด้วยค่าเริ่มต้น - ตัวเลือกไม่ได้ถูกกำหนดไว้ในโค้ดฟังก์ชัน แต่ถูกกำหนดไว้ในฟังก์ชันที่ใช้งานอยู่ในปัจจุบัน: ใช้ตัวเลือกที่ระบุในฟังก์ชันที่ปรับใช้
ไม่แนะนำ ให้ใช้ตัวเลือก preserveExternalChanges: true
ในสถานการณ์ส่วนใหญ่ เนื่องจากโค้ดของคุณจะไม่เป็นแหล่งความจริงทั้งหมดสำหรับตัวเลือกรันไทม์สำหรับฟังก์ชันของคุณอีกต่อไป หากคุณใช้งาน ให้ตรวจสอบคอนโซล Google Cloud หรือใช้ gcloud CLI เพื่อดูการกำหนดค่าทั้งหมดของฟังก์ชัน
ตั้งค่าเวอร์ชัน Node.js
Firebase SDK สำหรับฟังก์ชันคลาวด์อนุญาตให้เลือกรันไทม์ Node.js ได้ คุณสามารถเลือกที่จะรันฟังก์ชันทั้งหมดในโปรเจ็กต์เฉพาะบนสภาพแวดล้อมรันไทม์ที่สอดคล้องกับเวอร์ชัน Node.js ที่รองรับเหล่านี้:
- Node.js 20 (ดูตัวอย่าง)
- โหนด js 18
- โหนด js16
- โหนด js 14
วิธีตั้งค่าเวอร์ชัน Node.js:
คุณสามารถตั้งค่าเวอร์ชันในช่อง engines
ในไฟล์ package.json
ที่สร้างขึ้นในไดเร็กทอรี functions/
ของคุณระหว่างการกำหนดค่าเริ่มต้น ตัวอย่างเช่น หากต้องการใช้เฉพาะเวอร์ชัน 18 ให้แก้ไขบรรทัดนี้ใน package.json
:
"engines": {"node": "18"}
หากคุณใช้ Yarn package manager หรือมีข้อกำหนดเฉพาะอื่นๆ สำหรับ engines
จิ้น คุณสามารถตั้งค่ารันไทม์สำหรับ Firebase SDK สำหรับ Cloud Functions ใน firebase.json
แทนได้:
{
"functions": {
"runtime": "nodejs18" // or nodejs14, nodejs16 or nodejs20
}
}
CLI ใช้ค่าที่ตั้งไว้ใน firebase.json
เทียบกับค่าหรือช่วงใดๆ ที่คุณตั้งแยกต่างหากใน package.json
อัปเกรดรันไทม์ Node.js ของคุณ
หากต้องการอัปเกรดรันไทม์ Node.js ของคุณ:
- ตรวจสอบให้แน่ใจว่าโปรเจ็กต์ของคุณอยู่ใน แผนการกำหนดราคา Blaze
- ตรวจสอบให้แน่ใจว่าคุณใช้ Firebase CLI v11.18.0 หรือใหม่กว่า
- เปลี่ยนค่า
engines
ในไฟล์package.json
ที่สร้างขึ้นในไดเร็กทอรีfunctions/
ของคุณระหว่างการกำหนดค่าเริ่มต้น ตัวอย่างเช่น หากคุณกำลังอัพเกรดจากเวอร์ชัน 16 เป็นเวอร์ชัน 18 รายการควรมีลักษณะดังนี้:"engines": {"node": "18"}
- หรือเลือกทดสอบการเปลี่ยนแปลงของคุณโดยใช้ Firebase Local Emulator Suite
- ปรับใช้ฟังก์ชันทั้งหมดอีกครั้ง
ควบคุมพฤติกรรมการปรับขนาด
ตามค่าเริ่มต้น ฟังก์ชันคลาวด์สำหรับ Firebase จะปรับขนาดจำนวนอินสแตนซ์ที่ทำงานอยู่ตามจำนวนคำขอที่เข้ามา ซึ่งอาจลดขนาดลงเหลืออินสแตนซ์เป็นศูนย์ในช่วงเวลาที่การรับส่งข้อมูลลดลง อย่างไรก็ตาม หากแอปของคุณต้องการเวลาแฝงที่ลดลงและคุณต้องการจำกัดจำนวนการเริ่มเย็น คุณสามารถเปลี่ยนการทำงานเริ่มต้นนี้ได้โดยการระบุจำนวนอินสแตนซ์คอนเทนเนอร์ขั้นต่ำที่จะรักษาความอบอุ่นและพร้อมที่จะให้บริการคำขอ
ในทำนองเดียวกัน คุณสามารถตั้งค่าจำนวนสูงสุดเพื่อจำกัดขนาดของอินสแตนซ์เพื่อตอบสนองคำขอที่เข้ามาได้ ใช้การตั้งค่านี้เป็นวิธีควบคุมค่าใช้จ่ายของคุณหรือเพื่อจำกัดจำนวนการเชื่อมต่อไปยังบริการสนับสนุน เช่น ฐานข้อมูล
ลดจำนวนการสตาร์ทขณะเย็น
หากต้องการตั้งค่าจำนวนอินสแตนซ์ขั้นต่ำสำหรับฟังก์ชันในซอร์สโค้ด ให้ใช้เมธอด runWith
เมธอดนี้ยอมรับออบเจ็กต์ JSON ที่สอดคล้องกับอินเทอร์เฟ RuntimeOptions
ซึ่งกำหนดค่าสำหรับ minInstances
ตัวอย่างเช่น ฟังก์ชันนี้ตั้งค่าอินสแตนซ์อย่างน้อย 5 รายการเพื่อรักษาความอบอุ่น:
exports.getAutocompleteResponse = functions
.runWith({
// Keep 5 instances warm for this latency-critical function
minInstances: 5,
})
.https.onCall((data, context) => {
// Autocomplete a user's search term
});
ต่อไปนี้เป็นสิ่งที่ควรพิจารณาเมื่อตั้งค่าสำหรับ minInstances
:
- หาก Cloud Functions for Firebase ปรับขนาดแอปของคุณให้สูงกว่าการตั้งค่า
minInstances
คุณจะพบกับ Cold Start สำหรับแต่ละอินสแตนซ์ที่อยู่เหนือเกณฑ์ดังกล่าว - การสตาร์ทเย็นมีผลกระทบร้ายแรงที่สุดกับแอปที่มีการรับส่งข้อมูลที่แหลมคม หากแอปของคุณมีการรับส่งข้อมูลที่รวดเร็วและคุณตั้งค่า
minInstances
สูงพอที่จะลดการเริ่มขณะเย็นในการเข้าชมแต่ละครั้งที่เพิ่มขึ้น คุณจะเห็นเวลาในการตอบสนองลดลงอย่างมาก สำหรับแอปที่มีการรับส่งข้อมูลคงที่ การสตาร์ทขณะเย็นไม่น่าจะส่งผลกระทบอย่างรุนแรงต่อประสิทธิภาพการทำงาน การตั้งค่าอินสแตนซ์ขั้นต่ำอาจเหมาะสมสำหรับสภาพแวดล้อมการใช้งานจริง แต่โดยทั่วไปควรหลีกเลี่ยงในสภาพแวดล้อมการทดสอบ หากต้องการปรับขนาดเป็นศูนย์ในโปรเจ็กต์ทดสอบของคุณแต่ยังคงลดการเริ่มเย็นในโปรเจ็กต์การผลิตของคุณ คุณสามารถตั้งค่า
minInstances
ตามตัวแปรสภาพแวดล้อมFIREBASE_CONFIG
:// Get Firebase project id from `FIREBASE_CONFIG` environment variable const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId; exports.renderProfilePage = functions .runWith({ // Keep 5 instances warm for this latency-critical function // in production only. Default to 0 for test projects. minInstances: envProjectId === "my-production-project" ? 5 : 0, }) .https.onRequest((req, res) => { // render some html });
จำกัดจำนวนอินสแตนซ์สูงสุดสำหรับฟังก์ชัน
หากต้องการตั้งค่าอินสแตนซ์สูงสุดในซอร์สโค้ดของฟังก์ชัน ให้ใช้เมธอด runWith
เมธอดนี้ยอมรับออบเจ็กต์ JSON ที่สอดคล้องกับอินเทอร์เฟซ RuntimeOptions
ซึ่งกำหนดค่าสำหรับ maxInstances
ตัวอย่างเช่น ฟังก์ชันนี้กำหนดขีดจำกัดไว้ที่ 100 อินสแตนซ์เพื่อไม่ให้ล้นฐานข้อมูลดั้งเดิมสมมุติ:
exports.mirrorOrdersToLegacyDatabase = functions
.runWith({
// Legacy database only supports 100 simultaneous connections
maxInstances: 100,
})
.firestore.document("orders/{orderId}")
.onWrite((change, context) => {
// Connect to legacy database
});
หากฟังก์ชัน HTTP ได้รับการปรับขนาดจนถึงขีดจำกัด maxInstances
คำขอใหม่จะถูกจัดคิวเป็นเวลา 30 วินาที จากนั้นจะถูกปฏิเสธด้วยโค้ดตอบกลับที่ 429 Too Many Requests
หากไม่มีอินสแตนซ์ที่พร้อมใช้งานภายในเวลานั้น
หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับแนวทางปฏิบัติที่ดีที่สุดสำหรับการใช้การตั้งค่าอินสแตนซ์สูงสุด โปรดดู แนวทางปฏิบัติที่ดีที่สุดสำหรับการใช้ maxInstances
ตั้งค่าการหมดเวลาและการจัดสรรหน่วยความจำ
ในบางกรณี ฟังก์ชันของคุณอาจมีข้อกำหนดพิเศษสำหรับค่าการหมดเวลาที่ยาวนานหรือการจัดสรรหน่วยความจำจำนวนมาก คุณสามารถตั้งค่าเหล่านี้ได้ใน Google Cloud Console หรือในซอร์สโค้ดของฟังก์ชัน (Firebase เท่านั้น)
หากต้องการตั้งค่าการจัดสรรหน่วยความจำและการหมดเวลาในซอร์สโค้ดของฟังก์ชัน ให้ใช้พารามิเตอร์ runWith
ที่แนะนำใน Firebase SDK สำหรับ Cloud Functions 2.0.0 ตัวเลือกรันไทม์นี้ยอมรับออบเจ็กต์ JSON ที่สอดคล้องกับอินเทอร์เฟ RuntimeOptions
ซึ่งกำหนดค่าสำหรับ timeoutSeconds
และ memory
ตัวอย่างเช่น ฟังก์ชันการจัดเก็บข้อมูลนี้ใช้หน่วยความจำ 1GB และหมดเวลาหลังจาก 300 วินาที:
exports.convertLargeFile = functions
.runWith({
// Ensure the function has enough memory and time
// to process large files
timeoutSeconds: 300,
memory: "1GB",
})
.storage.object()
.onFinalize((object) => {
// Do some complicated things that take a lot of memory and time
});
ค่าสูงสุดสำหรับ timeoutSeconds
คือ 540
หรือ 9 นาที จำนวนหน่วยความจำที่มอบให้กับฟังก์ชันจะสอดคล้องกับ CPU ที่จัดสรรให้กับฟังก์ชัน ดังรายละเอียดในรายการค่าที่ถูกต้องสำหรับ memory
นี้:
-
128MB
— 200MHz -
256MB
— 400MHz -
512MB
— 800MHz -
1GB
— 1.4GHz -
2GB
— 2.4 กิกะเฮิร์ตซ์ -
4GB
— 4.8GHz -
8GB
— 4.8GHz
วิธีตั้งค่าการจัดสรรหน่วยความจำและการหมดเวลาใน Google Cloud Console:
- ใน Google Google Cloud Console ให้เลือก Cloud Functions จากเมนูด้านซ้าย
- เลือกฟังก์ชันโดยคลิกที่ชื่อในรายการฟังก์ชัน
- คลิกไอคอน แก้ไข ในเมนูด้านบน
- เลือกการจัดสรรหน่วยความจำจากเมนูแบบเลื่อนลงที่มีข้อความว่า Memory allowanceed
- คลิก เพิ่มเติม เพื่อแสดงตัวเลือกขั้นสูง และป้อนจำนวนวินาทีในกล่องข้อความ หมดเวลา
- คลิก บันทึก เพื่ออัพเดตฟังก์ชัน