บ่อยครั้งคุณจะต้องกำหนดค่าเพิ่มเติมสำหรับฟังก์ชันต่างๆ เช่น คีย์ API ของบุคคลที่สามหรือการตั้งค่าที่ปรับแต่งได้ Firebase SDK สำหรับ Cloud Functions เสนอการกำหนดค่าสภาพแวดล้อมในตัวเพื่อให้จัดเก็บและดึงข้อมูลประเภทนี้สำหรับโปรเจ็กต์ของคุณได้ง่ายขึ้น
โดยเลือกได้จาก 3 ตัวเลือกต่อไปนี้
- การกําหนดค่าที่มีพารามิเตอร์ (แนะนําสําหรับสถานการณ์ส่วนใหญ่) โดยวิธีนี้จะมีการกำหนดค่าสภาพแวดล้อมที่มีการจัดประเภทอย่างเข้มงวดพร้อมด้วยพารามิเตอร์ที่ได้รับการตรวจสอบ ณ เวลาที่ทำให้ใช้งานได้ ซึ่งจะป้องกันข้อผิดพลาดและทำให้การแก้ไขข้อบกพร่องง่ายขึ้น
- การกำหนดค่าตามไฟล์ของตัวแปรสภาพแวดล้อม ด้วยวิธีนี้ คุณจะสร้างไฟล์ dotenv ขึ้นมาด้วยตนเองสำหรับการโหลดตัวแปรสภาพแวดล้อม
- การกำหนดค่าสภาพแวดล้อมรันไทม์ด้วย Firebase CLI และ
functions.config
(Cloud Functions (รุ่นที่ 1) เท่านั้น)
สําหรับ Use Case ส่วนใหญ่ เราขอแนะนําให้ใช้การกําหนดค่าที่เป็นพารามิเตอร์ วิธีนี้ทำให้ค่าการกำหนดค่าพร้อมใช้งานทั้งในรันไทม์และเวลาติดตั้งใช้งาน และระบบจะบล็อกการติดตั้งใช้งานจนกว่าพารามิเตอร์ทั้งหมดมีค่าที่ถูกต้อง ในทางกลับกัน การกำหนดค่าที่มีตัวแปรสภาพแวดล้อมไม่พร้อมใช้งานในเวลาทำให้ใช้งานได้
การกำหนดค่าที่มีพารามิเตอร์
Cloud Functions for Firebase จะมีอินเทอร์เฟซสำหรับการกำหนดพารามิเตอร์การกำหนดค่าอย่างชัดเจนภายในฐานของโค้ด ค่าของพารามิเตอร์เหล่านี้จะใช้ได้ทั้งในระหว่างการติดตั้งใช้งานฟังก์ชัน เมื่อตั้งค่าตัวเลือกการติดตั้งใช้งานและรันไทม์ และระหว่างการดำเนินการ ซึ่งหมายความว่า CLI จะบล็อกการทำให้ใช้งานได้ เว้นแต่พารามิเตอร์ทั้งหมดมีค่าที่ถูกต้อง
หากต้องการกำหนดพารามิเตอร์ในโค้ด ให้ทำตามรูปแบบนี้
const functions = require('firebase-functions');
const { defineInt, defineString } = require('firebase-functions/params');
// Define some parameters
const minInstancesConfig = defineInt('HELLO_WORLD_MININSTANCES');
const welcomeMessage = defineString('WELCOME_MESSAGE');
// To use configured parameters inside the config for a function, provide them
// directly. To use them at runtime, call .value() on them.
export const helloWorld = functions.runWith({ minInstances: minInstancesConfig}).https.onRequest(
(req, res) => {
res.send(`${welcomeMessage.value()}! I am a function.`);
}
);
เมื่อทำให้ฟังก์ชันที่มีตัวแปรการกำหนดค่าเป็นพารามิเตอร์ใช้งานได้ Firebase CLI จะพยายามโหลดค่าจากไฟล์ .env ในเครื่องก่อน หากไม่มีอยู่ในไฟล์เหล่านั้นและไม่ได้ตั้งค่า default
ไว้ CLI จะแสดงข้อความแจ้งสำหรับค่าระหว่างการทำให้ใช้งานได้ จากนั้นบันทึกค่าลงในไฟล์ .env
ชื่อ .env.<project_ID>
ในไดเรกทอรี functions/
โดยอัตโนมัติ
$ firebase deploy
i functions: preparing codebase default for deployment
? Enter a string value for ENVIRONMENT: prod
i functions: Writing new parameter values to disk: .env.projectId
…
$ firebase deploy
i functions: Loaded environment variables from .env.projectId
การเพิ่มไฟล์ .env.<project_ID>
ที่สร้างขึ้นไปยังการควบคุมเวอร์ชันอาจมีประโยชน์ ทั้งนี้ขึ้นอยู่กับเวิร์กโฟลว์การพัฒนาของคุณ
กำหนดค่าลักษณะการทำงาน CLI
คุณกำหนดค่าพารามิเตอร์ได้ด้วยออบเจ็กต์ Options
ที่ควบคุมวิธีที่ CLI จะแสดงค่าต่างๆ ตัวอย่างต่อไปนี้กำหนดตัวเลือกต่างๆ เพื่อตรวจสอบรูปแบบของหมายเลขโทรศัพท์ มอบตัวเลือกการเลือกง่ายๆ และป้อนข้อมูลตัวเลือกตัวเลือกโดยอัตโนมัติจากโปรเจ็กต์ Firebase
const { defineString } = require('firebase-functions/params');
const welcomeMessage = defineString('WELCOME_MESSAGE', {default: 'Hello World',
description: 'The greeting that is returned to the caller of this function'});
const onlyPhoneNumbers = defineString('PHONE_NUMBER', {input: {text:
{validationRegex: /\d{3}-\d{3}-\d{4}/, validationErrorMessage: "Please enter
a phone number in the format XXX-YYY-ZZZZ"}}});
const selectedOption = defineString('PARITY', {input: {select: {options:
[{value: "odd"}, {value: "even"}]}}})
const storageBucket = defineString('BUCKET', {input: {resource: {type:
"storage.googleapis.com/Bucket"}}, description: "This will automatically
populate the selector field with the deploying Cloud Project’s
storage buckets"})
ประเภทพารามิเตอร์
การกำหนดค่าที่มีพารามิเตอร์ทำให้สามารถพิมพ์ค่าพารามิเตอร์ได้อย่างถูกต้อง และรองรับข้อมูลลับจาก Secret Manager ของ Cloud ด้วย ประเภทที่รองรับ ได้แก่
- ข้อมูลลับ
- สตริง
- บูลีน
- จำนวนเต็ม
- ทศนิยม
ค่าและนิพจน์พารามิเตอร์
Firebase จะประเมินพารามิเตอร์ทั้งในขณะที่ติดตั้งใช้งานและขณะที่ฟังก์ชันกำลังทำงาน เนื่องจากสภาพแวดล้อมแบบคู่เหล่านี้ คุณจึงต้องระมัดระวังเป็นพิเศษเมื่อเปรียบเทียบค่าพารามิเตอร์ และเมื่อใช้ค่าเหล่านี้เพื่อตั้งค่าตัวเลือกรันไทม์สำหรับฟังก์ชัน
หากต้องการส่งพารามิเตอร์ไปยังฟังก์ชันเป็นตัวเลือกรันไทม์ ให้ส่งพารามิเตอร์โดยตรงดังนี้
const functions = require('firebase-functions');
const { defineInt} = require('firebase-functions/params');
const minInstancesConfig = defineInt('HELLO\_WORLD\_MININSTANCES');
export const helloWorld = functions.runWith({ minInstances: minInstancesConfig}).https.onRequest(
(req, res) => {
//…
นอกจากนี้ หากคุณต้องการเปรียบเทียบกับพารามิเตอร์เพื่อให้ทราบว่าควรเลือกตัวเลือกใด คุณจะต้องใช้การเปรียบเทียบในตัวแทนการตรวจสอบค่า ดังนี้
const functions = require('firebase-functions');
const { defineBool } = require('firebase-functions/params');
const environment = params.defineString(‘ENVIRONMENT’, {default: ‘dev’});
// use built-in comparators
const minInstancesConfig =environment.equals('PRODUCTION').thenElse(10, 1);
export const helloWorld = functions.runWith({ minInstances: minInstancesConfig}).https.onRequest(
(req, res) => {
//…
คุณจะเข้าถึงพารามิเตอร์และนิพจน์พารามิเตอร์ที่ใช้ขณะรันไทม์เท่านั้นได้ด้วยฟังก์ชัน value
ดังนี้
const functions = require('firebase-functions');
const { defineString } = require('firebase-functions/params');
const welcomeMessage = defineString('WELCOME_MESSAGE');
// To use configured parameters inside the config for a function, provide them
// directly. To use them at runtime, call .value() on them.
export const helloWorld = functions.https.onRequest(
(req, res) => {
res.send(`${welcomeMessage.value()}! I am a function.`);
}
);
พารามิเตอร์ในตัว
Cloud Functions SDK มีพารามิเตอร์ที่กำหนดไว้ล่วงหน้า 3 รายการซึ่งพร้อมใช้งานจากแพ็กเกจย่อย firebase-functions/params
ดังนี้
projectID
— โปรเจ็กต์ระบบคลาวด์ที่ฟังก์ชันทำงานอยู่databaseURL
— URL ของอินสแตนซ์ Realtime Database ที่เชื่อมโยงกับฟังก์ชัน (หากเปิดใช้ในโปรเจ็กต์ Firebase)storageBucket
— ที่เก็บข้อมูล Cloud Storage ที่เชื่อมโยงกับฟังก์ชัน (หากเปิดใช้ในโปรเจ็กต์ Firebase)
ฟังก์ชันเหล่านี้เหมือนกับพารามิเตอร์สตริงที่ผู้ใช้กำหนดในทุกๆ ด้าน ยกเว้นเนื่องจาก Firebase CLI เป็นค่าของพารามิเตอร์เหล่านี้เสมอ ระบบจึงจะไม่แจ้งเตือนค่าในการทำให้ใช้งานได้หรือบันทึกลงในไฟล์ .env
พารามิเตอร์ลับ
พารามิเตอร์ประเภท Secret
ที่กำหนดโดยใช้ defineSecret()
แสดงถึงพารามิเตอร์สตริงที่มีค่าที่จัดเก็บไว้ใน Secret Manager ของ Cloud แทนที่จะตรวจสอบไฟล์ .env
ในเครื่องและเขียนค่าใหม่ลงในไฟล์หากไม่มี พารามิเตอร์ลับจะตรวจสอบการมีอยู่ใน Secret Manager ของ Cloud และแจ้งเตือนค่าของข้อมูลลับใหม่แบบอินเทอร์แอกทีฟในระหว่างการทำให้ใช้งานได้
พารามิเตอร์ลับที่กำหนดด้วยวิธีนี้ต้องเชื่อมโยงกับแต่ละฟังก์ชันที่ควรมีสิทธิ์เข้าถึง
const functions = require('firebase-functions');
const { defineSecret } = require('firebase-functions/params');
const discordApiKey = defineSecret('DISCORD_API_KEY');
export const postToDiscord = functions.runWith({ secrets: [discordApiKey] }).https.onRequest(
(req, res) => {
const apiKey = discordApiKey.value();
//…
เนื่องจากค่าของข้อมูลลับจะถูกซ่อนไว้จนกว่าจะมีการเรียกใช้ฟังก์ชัน คุณจึงไม่สามารถใช้ค่าเหล่านี้ขณะที่กำหนดค่าฟังก์ชันได้
ตัวแปรสภาพแวดล้อม
Cloud Functions for Firebase รองรับรูปแบบไฟล์ dotenv สำหรับการโหลดตัวแปรสภาพแวดล้อมการโหลดที่ระบุในไฟล์ .env
ไปยังรันไทม์ของแอปพลิเคชัน เมื่อทำให้ใช้งานได้แล้ว คุณจะอ่านตัวแปรสภาพแวดล้อมผ่านอินเทอร์เฟซ process.env
ได้
หากต้องการกำหนดค่าสภาพแวดล้อมด้วยวิธีนี้ ให้สร้างไฟล์ .env
ในโปรเจ็กต์ เพิ่มตัวแปรที่ต้องการ และทำให้ใช้งานได้ตามขั้นตอนต่อไปนี้
สร้างไฟล์
.env
ในไดเรกทอรีfunctions/
ดังนี้# Directory layout: # my-project/ # firebase.json # functions/ # .env # package.json # index.js
เปิดไฟล์
.env
เพื่อแก้ไข แล้วเพิ่มคีย์ที่ต้องการ เช่นPLANET=Earth AUDIENCE=Humans
ทำให้ฟังก์ชันใช้งานได้และยืนยันว่าโหลดตัวแปรสภาพแวดล้อมแล้ว
firebase deploy --only functions # ... # i functions: Loaded environment variables from .env. # ...
เมื่อทำให้ตัวแปรสภาพแวดล้อมที่กำหนดเองใช้งานได้แล้ว โค้ดฟังก์ชันจะเข้าถึงตัวแปรได้ด้วยไวยากรณ์ process.env
ดังนี้
// Responds with "Hello Earth and Humans"
exports.hello = functions.https.onRequest((request, response) => {
response.send(`Hello ${process.env.PLANET} and ${process.env.AUDIENCE}`);
});
การทำให้ตัวแปรสภาพแวดล้อมหลายชุดใช้งานได้
หากต้องการตัวแปรสภาพแวดล้อมชุดอื่นสำหรับโปรเจ็กต์ Firebase (เช่น การทดลองใช้กับเวอร์ชันที่ใช้งานจริง) ให้สร้างไฟล์ .env.<project or
alias>
แล้วเขียนตัวแปรสภาพแวดล้อมเฉพาะโปรเจ็กต์ไว้ที่นั่น ตัวแปรสภาพแวดล้อมจากไฟล์ .env
และไฟล์ .env
เฉพาะโปรเจ็กต์ (หากมี) จะรวมอยู่ในฟังก์ชันที่ทำให้ใช้งานได้ทั้งหมด
ตัวอย่างเช่น โปรเจ็กต์อาจรวมไฟล์ 3 ไฟล์นี้ซึ่งมีค่าที่แตกต่างกันเล็กน้อยสำหรับการพัฒนาและเวอร์ชันที่ใช้งานจริง
.env
|
.env.dev
|
.env.prod
|
PLANET=โลก
AUDIENCE=มนุษย์ |
กลุ่มเป้าหมาย=มนุษย์ระดับนักพัฒนาซอฟต์แวร์ | กลุ่มเป้าหมาย=มนุษย์ที่โฆษณ |
ด้วยค่าในไฟล์ที่แยกต่างหากเหล่านี้ ชุดตัวแปรสภาพแวดล้อมที่ติดตั้งใช้งานฟังก์ชันของคุณจะแตกต่างกันไปตามโปรเจ็กต์เป้าหมาย ดังนี้
$ firebase use dev
$ firebase deploy --only functions
i functions: Loaded environment variables from .env, .env.dev.
# Deploys functions with following user-defined environment variables:
# PLANET=Earth
# AUDIENCE=Dev Humans
$ firebase use prod
$ firebase deploy --only functions
i functions: Loaded environment variables from .env, .env.prod.
# Deploys functions with following user-defined environment variables:
# PLANET=Earth
# AUDIENCE=Prod Humans
ตัวแปรสภาพแวดล้อมที่สงวนไว้
คีย์ตัวแปรสภาพแวดล้อมบางรายการสงวนไว้สำหรับการใช้งานภายใน อย่าใช้คีย์ใดๆ ต่อไปนี้ในไฟล์ .env
- คีย์ทั้งหมดที่ขึ้นต้นด้วย X_GOOGLE_
- คีย์ทั้งหมดเริ่มต้น EXT_
- คีย์ทั้งหมดที่ขึ้นต้นด้วย FIREBASE_
- คีย์จากรายการต่อไปนี้
- CLOUD_RUNTIME_CONFIG
- ENTRY_POINT
- GCP_PROJECT
- GCLOUD_PROJECT
- GOOGLE_CLOUD_PROJECT
- FUNCTION_TRIGGER_TYPE
- FUNCTION_NAME
- FUNCTION_MEMORY_MB
- FUNCTION_TIMEOUT_SEC
- FUNCTION_IDENTITY
- FUNCTION_REGION
- FUNCTION_TARGET
- FUNCTION_SIGNATURE_TYPE
- K_SERVICE
- K_REVISION
- PORT
- K_CONFIGURATION
จัดเก็บและเข้าถึงข้อมูลการกำหนดค่าที่มีความละเอียดอ่อน
ตัวแปรสภาพแวดล้อมที่จัดเก็บไว้ในไฟล์ .env
สามารถใช้สำหรับการกำหนดค่าฟังก์ชันได้ แต่คุณไม่ควรพิจารณาว่าตัวแปรเหล่านี้เป็นวิธีที่ปลอดภัยในการจัดเก็บข้อมูลที่ละเอียดอ่อน เช่น ข้อมูลเข้าสู่ระบบฐานข้อมูลหรือคีย์ API การดำเนินการนี้มีความสำคัญอย่างยิ่งหากคุณตรวจสอบไฟล์ .env
ในการควบคุมแหล่งที่มา
Cloud Functions for Firebase จะผสานรวมกับ Secret Manager ของ Google Cloud เพื่อช่วยให้คุณจัดเก็บข้อมูลการกำหนดค่าที่มีความละเอียดอ่อนได้ บริการที่เข้ารหัสนี้จะจัดเก็บค่าของการกำหนดค่าไว้อย่างปลอดภัย ในขณะเดียวกันก็ยังอนุญาตให้ฟังก์ชันต่างๆ เข้าถึงได้โดยง่ายเมื่อจำเป็น
สร้างและใช้ข้อมูลลับ
หากต้องการสร้างข้อมูลลับ ให้ใช้ Firebase CLI
หากต้องการสร้างและใช้ข้อมูลลับ ให้ทำดังนี้
เรียกใช้คำสั่งต่อไปนี้จากรูทของไดเรกทอรีโปรเจ็กต์ในเครื่อง
firebase functions:secrets:set SECRET_NAME
ป้อนค่า SECRET_NAME
CLI จะแสดงข้อความดำเนินการสำเร็จและเตือนว่าคุณต้องทำให้ฟังก์ชันใช้งานได้เพื่อให้การเปลี่ยนแปลงมีผล
ก่อนทำให้ใช้งานได้ โปรดตรวจสอบว่าโค้ดฟังก์ชันอนุญาตให้ฟังก์ชันเข้าถึงข้อมูลลับโดยใช้พารามิเตอร์
runWith
ดังนี้exports.processPayment = functions // Make the secret available to this function .runWith({ secrets: ["SECRET_NAME"] }) .onCall((data, context) => { const myBillingService = initializeBillingService( // reference the secret value process.env.SECRET_NAME ); // Process the payment });
ทำให้ Cloud Function ใช้งานได้:
firebase deploy --only functions
ตอนนี้คุณจะเข้าถึงได้เช่นเดียวกับตัวแปรสภาพแวดล้อมอื่นๆ
ในทางกลับกัน หากฟังก์ชันอื่นที่ไม่ได้ระบุข้อมูลลับใน runWith
พยายามเข้าถึงข้อมูลลับ ฟังก์ชันดังกล่าวจะได้รับค่าที่ไม่ได้กำหนดไว้ดังนี้
exports.anotherEndpoint = functions.https.onRequest((request, response) => {
response.send(`The secret API key is ${process.env.SECRET_NAME}`);
// responds with "The secret API key is undefined" because the `runWith` parameter is missing
});
เมื่อทำให้ฟังก์ชันใช้งานได้แล้ว ฟังก์ชันดังกล่าวจะมีสิทธิ์เข้าถึงค่าข้อมูลลับ เฉพาะฟังก์ชันที่มีข้อมูลลับเฉพาะในพารามิเตอร์ runWith
เท่านั้นที่จะมีสิทธิ์เข้าถึงข้อมูลลับนั้นเป็นตัวแปรสภาพแวดล้อม วิธีนี้จะช่วยให้มั่นใจได้ว่าค่าข้อมูลลับจะพร้อมใช้งานเมื่อจำเป็นเท่านั้นและลดความเสี่ยงที่จะเกิดการรั่วไหลของข้อมูลลับโดยไม่ตั้งใจ
การจัดการข้อมูลลับ
ใช้ Firebase CLI เพื่อจัดการข้อมูลลับ ขณะจัดการข้อมูลลับด้วยวิธีนี้ โปรดอย่าลืมว่าการเปลี่ยนแปลง CLI บางรายการกำหนดให้คุณต้องแก้ไขและ/หรือทำให้ฟังก์ชันที่เกี่ยวข้องใช้งานได้อีกครั้ง กล่าวอย่างเจาะจงคือ
- เมื่อใดก็ตามที่คุณกำหนดค่าใหม่สำหรับข้อมูลลับ คุณต้องทำให้ฟังก์ชันทั้งหมดที่อ้างอิงข้อมูลลับนั้นใช้งานได้อีกครั้งเพื่อให้รับค่าล่าสุดได้
- หากลบข้อมูลลับ ให้ตรวจสอบว่าฟังก์ชันที่ทำให้ใช้งานได้แล้วไม่ได้อ้างอิงข้อมูลลับนั้น ฟังก์ชันที่ใช้ค่าข้อมูลลับที่ถูกลบจะล้มเหลวโดยไม่มีการแจ้งเตือน
สรุปคำสั่ง Firebase CLI สำหรับการจัดการข้อมูลลับมีดังนี้
# Change the value of an existing secret firebase functions:secrets:set SECRET_NAME # View the value of a secret functions:secrets:access SECRET_NAME # Destroy a secret functions:secrets:destroy SECRET_NAME # View all secret versions and their state functions:secrets:get SECRET_NAME # Automatically clean up all secrets that aren't referenced by any of your functions functions:secrets:prune
สำหรับคำสั่ง access
และ destroy
คุณระบุพารามิเตอร์เวอร์ชันที่ไม่บังคับเพื่อจัดการเวอร์ชันเฉพาะได้ เช่น
functions:secrets:access SECRET_NAME[@VERSION]
สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการดำเนินการเหล่านี้ ให้ส่ง -h
ด้วยคำสั่งเพื่อดูความช่วยเหลือเกี่ยวกับ CLI
ระบบเรียกเก็บเงินจากข้อมูลลับอย่างไร
Secret Manager อนุญาตversionsข้อมูลลับที่ใช้งานอยู่ 6 เวอร์ชันโดยไม่มีค่าใช้จ่าย ซึ่งหมายความว่าคุณมีข้อมูลลับ 6 รายการต่อเดือนในโปรเจ็กต์ Firebase โดยไม่มีค่าใช้จ่าย
โดยค่าเริ่มต้น Firebase CLI จะพยายามทำลายเวอร์ชันลับที่ไม่ได้ใช้โดยอัตโนมัติตามความเหมาะสม เช่น เมื่อคุณทำให้ฟังก์ชันใช้งานได้ด้วยข้อมูลลับเวอร์ชันใหม่ นอกจากนี้ คุณยังล้างข้อมูลลับที่ไม่ได้ใช้อย่างสม่ำเสมอได้โดยใช้ functions:secrets:destroy
และ functions:secrets:prune
Secret Manager อนุญาตให้มีการเข้าถึงรายเดือนที่ยังไม่ได้เรียกเก็บเงิน 10,000 รายการซึ่งเป็นความลับ อินสแตนซ์ของฟังก์ชันจะอ่านเฉพาะข้อมูลลับที่ระบุไว้ในพารามิเตอร์ runWith
ทุกครั้งที่ Cold Start หากคุณมีอินสแตนซ์ของฟังก์ชันจำนวนมากที่อ่านข้อมูลลับจำนวนมาก โปรเจ็กต์อาจเกินขีดจำกัดนี้ ซึ่งในตอนนั้นคุณจะถูกเรียกเก็บเงิน $0.03 ต่อการดำเนินการเข้าถึง 10,000 ครั้ง
ดูข้อมูลเพิ่มเติมได้ที่ราคาของ Secret Manager
การรองรับโปรแกรมจำลอง
การกำหนดค่าสภาพแวดล้อมที่มี dotenv ออกแบบมาเพื่อทำงานร่วมกับโปรแกรมจำลอง Cloud Functions ในเครื่อง
เมื่อใช้โปรแกรมจำลอง Cloud Functions ในเครื่อง คุณจะลบล้างตัวแปรสภาพแวดล้อมสำหรับโปรเจ็กต์ได้โดยการตั้งค่าไฟล์ .env.local
เนื้อหาของ .env.local
จะมีความสำคัญเหนือกว่า .env
และไฟล์ .env
เฉพาะโปรเจ็กต์
ตัวอย่างเช่น โปรเจ็กต์อาจรวมไฟล์ 3 ไฟล์นี้ที่มีค่าต่างกันเล็กน้อยสำหรับการพัฒนาและการทดสอบในเครื่อง
.env
|
.env.dev
|
.env.local
|
PLANET=โลก
AUDIENCE=มนุษย์ |
กลุ่มเป้าหมาย=มนุษย์ระดับนักพัฒนาซอฟต์แวร์ | AUDIENCE=มนุษย์ในท้องถิ่น |
เมื่อเริ่มต้นในบริบทในเครื่อง โปรแกรมจำลองจะโหลดตัวแปรสภาพแวดล้อมตามที่แสดงไว้
$ firebase emulators:start
i emulators: Starting emulators: functions
# Starts emulator with following environment variables:
# PLANET=Earth
# AUDIENCE=Local Humans
ข้อมูลลับและข้อมูลเข้าสู่ระบบในโปรแกรมจำลอง Cloud Functions
โปรแกรมจำลอง Cloud Functions รองรับการใช้ข้อมูลลับเพื่อจัดเก็บและเข้าถึงข้อมูลการกำหนดค่าที่มีความละเอียดอ่อน โดยค่าเริ่มต้น โปรแกรมจำลองจะพยายามเข้าถึงข้อมูลลับเวอร์ชันที่ใช้งานจริงโดยใช้ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน ในบางสถานการณ์ เช่น สภาพแวดล้อม CI โปรแกรมจำลองอาจเข้าถึงค่าลับไม่สำเร็จเนื่องจากข้อจำกัดด้านสิทธิ์
คุณลบล้างค่าข้อมูลลับได้โดยการตั้งค่าไฟล์ .secret.local
เช่นเดียวกับการรองรับโปรแกรมจำลอง Cloud Functions สำหรับตัวแปรสภาพแวดล้อม ซึ่งช่วยให้คุณทดสอบฟังก์ชันในเครื่องได้โดยง่าย โดยเฉพาะอย่างยิ่งหากคุณไม่มีสิทธิ์เข้าถึงค่าข้อมูลลับ
การย้ายข้อมูลจากการกำหนดค่าสภาพแวดล้อม
หากใช้การกำหนดค่าสภาพแวดล้อมกับ functions.config
อยู่ คุณจะย้ายข้อมูลการกำหนดค่าที่มีอยู่เป็นตัวแปรสภาพแวดล้อมได้ (ในรูปแบบ dotenv)
Firebase CLI มีคำสั่งการส่งออกที่เป็นเอาต์พุตการกำหนดค่าของชื่อแทนหรือโปรเจ็กต์แต่ละรายการที่แสดงอยู่ในไฟล์ .firebaserc
ของไดเรกทอรี (ในตัวอย่างด้านล่างคือ local
, dev
และ prod
) ในรูปแบบไฟล์ .env
หากต้องการย้ายข้อมูล ให้ส่งออกการกำหนดค่าสภาพแวดล้อมที่มีอยู่โดยใช้คำสั่ง firebase functions:config:export
:
firebase functions:config:export i Importing configs from projects: [project-0, project-1] ⚠ The following configs keys could not be exported as environment variables: ⚠ project-0 (dev): 1foo.a => 1FOO\_A (Key 1FOO\_A must start with an uppercase ASCII letter or underscore, and then consist of uppercase ASCII letters, digits, and underscores.) Enter a PREFIX to rename invalid environment variable keys: CONFIG\_ ✔ Wrote functions/.env.prod ✔ Wrote functions/.env.dev ✔ Wrote functions/.env.local ✔ Wrote functions/.env
โปรดทราบว่าในบางกรณี ระบบจะแจ้งให้คุณป้อนคำนำหน้าเพื่อเปลี่ยนชื่อคีย์ตัวแปรสภาพแวดล้อมที่ส่งออก ทั้งนี้เนื่องจากการกำหนดค่าบางรายการอาจเปลี่ยนรูปแบบไม่ได้โดยอัตโนมัติเนื่องจากอาจไม่ถูกต้องหรืออาจเป็นคีย์ตัวแปรสภาพแวดล้อมที่สำรองไว้
เราขอแนะนำให้คุณตรวจสอบเนื้อหาของไฟล์ .env
ที่สร้างขึ้นอย่างละเอียดก่อนทำให้ฟังก์ชันใช้งานได้ หรือตรวจสอบไฟล์ .env
ในการควบคุมแหล่งที่มา หากมีค่าใดมีความละเอียดอ่อนและไม่ควรรั่วไหล ให้นำค่าเหล่านั้นออกจากไฟล์ .env
และจัดเก็บไว้อย่างปลอดภัยใน Secret Manager แทน
นอกจากนี้คุณจะต้องอัปเดตโค้ดฟังก์ชันด้วย ตอนนี้ฟังก์ชันที่ใช้ functions.config
จะต้องใช้ process.env
แทน ดังที่แสดงในอัปเกรดเป็นรุ่นที่ 2
การกำหนดค่าสภาพแวดล้อม
ก่อนที่จะเปิดตัวการรองรับตัวแปรสภาพแวดล้อมใน firebase-functions
v3.18.0
เราขอแนะนำให้ใช้ functions.config()
สำหรับการกำหนดค่าสภาพแวดล้อม ถึงแม้วิธีการนี้จะยังใช้ได้อยู่ แต่เราขอแนะนำว่าโปรเจ็กต์ใหม่ทั้งหมดจะใช้ตัวแปรสภาพแวดล้อมแทน เนื่องจากมีการใช้งานที่ง่ายกว่าและปรับปรุงการถ่ายโอนได้ของโค้ด
ตั้งค่าการกำหนดค่าสภาพแวดล้อมด้วย CLI
หากต้องการจัดเก็บข้อมูลสภาพแวดล้อม คุณใช้คำสั่ง firebase functions:config:set
ใน Firebase CLI ได้
คุณสามารถเนมสเปซแต่ละคีย์ได้โดยใช้จุดเพื่อจัดกลุ่มการกำหนดค่าที่เกี่ยวข้องไว้ด้วยกัน โปรดทราบว่าป้อนอักขระตัวพิมพ์เล็กในคีย์เท่านั้น ไม่อนุญาตให้ใช้ตัวพิมพ์ใหญ่
เช่น หากต้องการจัดเก็บรหัสไคลเอ็นต์และคีย์ API สำหรับ "บริการบางรายการ" คุณอาจเรียกใช้
firebase functions:config:set someservice.key="THE API KEY" someservice.id="THE CLIENT ID"
เรียกข้อมูลการกำหนดค่าสภาพแวดล้อมปัจจุบัน
หากต้องการตรวจสอบข้อมูลที่จัดเก็บไว้ในการกำหนดค่าสภาพแวดล้อมสำหรับโปรเจ็กต์ของคุณในปัจจุบัน ให้ใช้ firebase functions:config:get
ซึ่งเอาต์พุตของ JSON จะมีลักษณะดังนี้
{
"someservice": {
"key":"THE API KEY",
"id":"THE CLIENT ID"
}
}
ฟังก์ชันนี้จะอิงตาม API การกำหนดค่ารันไทม์ของ Google Cloud
ใช้ functions.config
เพื่อเข้าถึงการกำหนดค่าสภาพแวดล้อมในฟังก์ชัน
การกำหนดค่าบางอย่างจะมีอยู่ภายใต้เนมสเปซ firebase
ที่สงวนไว้โดยอัตโนมัติ การกำหนดค่าสภาพแวดล้อมจะพร้อมให้ใช้งานภายในฟังก์ชันที่ทำงานอยู่ผ่าน functions.config()
หากต้องการใช้การกำหนดค่าข้างต้น โค้ดของคุณอาจมีลักษณะดังนี้
const functions = require('firebase-functions');
const request = require('request-promise');
exports.userCreated = functions.database.ref('/users/{id}').onWrite(event => {
let email = event.data.child('email').val();
return request({
url: 'https://someservice.com/api/some/call',
headers: {
'X-Client-ID': functions.config().someservice.id,
'Authorization': `Bearer ${functions.config().someservice.key}`
},
body: {email: email}
});
});
ใช้การกำหนดค่าสภาพแวดล้อมเพื่อเริ่มต้นโมดูล
โมดูลโหนดบางรายการพร้อมใช้งานโดยไม่มีการกำหนดค่าใดๆ โมดูลอื่นๆ จำเป็นต้องมีการกำหนดค่าเพิ่มเติม เพื่อให้เริ่มต้นได้อย่างถูกต้อง เราขอแนะนำให้เก็บการกำหนดค่านี้ในตัวแปรการกำหนดค่าสภาพแวดล้อมแทนฮาร์ดโค้ด วิธีนี้จะช่วยให้โค้ดของคุณพกพาสะดวกยิ่งขึ้น ซึ่งช่วยให้คุณโอเพนซอร์สแอปพลิเคชันหรือสลับระหว่างเวอร์ชันที่ใช้งานจริงและเวอร์ชันทดลองใช้ได้อย่างง่ายดาย
ตัวอย่างเช่น หากต้องการใช้โมดูล Slack Node SDK คุณอาจเขียนดังนี้
const functions = require('firebase-functions');
const IncomingWebhook = require('@slack/client').IncomingWebhook;
const webhook = new IncomingWebhook(functions.config().slack.url);
ก่อนทำให้ใช้งานได้ ให้ตั้งค่าตัวแปรการกำหนดค่าสภาพแวดล้อม slack.url
ดังนี้
firebase functions:config:set slack.url=https://hooks.slack.com/services/XXX
คำสั่งสภาพแวดล้อมเพิ่มเติม
firebase functions:config:unset key1 key2
นำคีย์ที่ระบุออกจากการกำหนดค่าfirebase functions:config:clone --from <fromProject>
จะโคลนสภาพแวดล้อมของโปรเจ็กต์อื่นในโปรเจ็กต์ที่ใช้งานอยู่ในปัจจุบัน
ตัวแปรสภาพแวดล้อมที่มีการป้อนข้อมูลโดยอัตโนมัติ
มีตัวแปรสภาพแวดล้อมที่ระบบสร้างขึ้นโดยอัตโนมัติในรันไทม์ของฟังก์ชันและในฟังก์ชันที่จำลองภายในเครื่อง ซึ่งรวมถึงข้อมูลที่สร้างโดย Google Cloud และตัวแปรสภาพแวดล้อมเฉพาะ Firebase
process.env.FIREBASE_CONFIG
: ระบุข้อมูลการกำหนดค่าโปรเจ็กต์ Firebase ต่อไปนี้
{
databaseURL: 'https://databaseName.firebaseio.com',
storageBucket: 'projectId.appspot.com',
projectId: 'projectId'
}
ระบบจะใช้การกำหนดค่านี้โดยอัตโนมัติเมื่อคุณเริ่มต้น Firebase Admin SDK โดยไม่มีอาร์กิวเมนต์ ถ้าคุณเขียนฟังก์ชันใน JavaScript ให้เริ่มต้นแบบนี้
const admin = require('firebase-admin');
admin.initializeApp();
หากคุณกำลังเขียนฟังก์ชันใน TypeScript ให้เริ่มต้นดังนี้
import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';
import 'firebase-functions';
admin.initializeApp();
หากต้องการเริ่มต้น Admin SDK ด้วยการกำหนดค่าโปรเจ็กต์เริ่มต้นโดยใช้ข้อมูลเข้าสู่ระบบของบัญชีบริการ คุณจะโหลดข้อมูลเข้าสู่ระบบจากไฟล์แล้วเพิ่มลงใน FIREBASE_CONFIG
ได้ดังนี้
serviceAccount = require('./serviceAccount.json');
const adminConfig = JSON.parse(process.env.FIREBASE_CONFIG);
adminConfig.credential = admin.credential.cert(serviceAccount);
admin.initializeApp(adminConfig);