Định cấu hình môi trường của bạn

Thông thường, bạn sẽ cần cấu hình bổ sung cho các chức năng của mình, chẳng hạn như khóa API của bên thứ ba hoặc cài đặt có thể điều chỉnh. SDK Firebase cho Chức năng đám mây cung cấp cấu hình môi trường tích hợp để giúp bạn dễ dàng lưu trữ và truy xuất loại dữ liệu này cho dự án của mình.

Bạn có thể chọn giữa cấu hình dựa trên tệp của các biến môi trường (được khuyến nghị) hoặc cấu hình môi trường thời gian chạy với Firebase CLI và functions.config . Cả hai cách tiếp cận đều được mô tả trong hướng dẫn này.

Các biến môi trường

Chức năng đám mây cho Firebase hỗ trợ định dạng tệp dotenv để tải các biến môi trường được chỉ định trong tệp .env vào thời gian chạy ứng dụng của bạn. Sau khi triển khai, các biến môi trường có thể được đọc thông qua giao diện process.env .

Để định cấu hình môi trường của bạn theo cách này, hãy tạo tệp .env trong dự án của bạn, thêm các biến mong muốn và triển khai:

  1. Tạo tệp .env trong thư mục functions/ của bạn:

    # Directory layout:
    #   my-project/
    #     firebase.json
    #     functions/
    #       .env
    #       package.json
    #       index.js
    
  2. Mở tệp .env để chỉnh sửa và thêm các khóa mong muốn. Ví dụ:

    PLANET=Earth
    AUDIENCE=Humans
    
  3. Triển khai các hàm và xác minh rằng các biến môi trường đã được tải:

    firebase deploy --only functions
    # ...
    # i functions: Loaded environment variables from .env.
    # ...
    

Khi các biến môi trường tùy chỉnh của bạn được triển khai, mã hàm của bạn có thể truy cập chúng bằng cú pháp 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}`);
});

Triển khai nhiều bộ biến môi trường

Nếu bạn cần một tập hợp các biến môi trường thay thế cho các dự án Firebase của mình (chẳng hạn như giai đoạn và sản xuất), hãy tạo .env. <project or alias > tệp .env. <project or alias > và ghi các biến môi trường dành riêng cho dự án của bạn vào đó. Các biến môi trường từ .env và tệp .env dành riêng cho dự án (nếu chúng tồn tại) sẽ được đưa vào tất cả các hàm đã triển khai.

Ví dụ: một dự án có thể bao gồm ba tệp này chứa các giá trị hơi khác nhau để phát triển và sản xuất:

.env .env.dev .env.prod
PLANET = Trái đất

AUDIENCE = Con người

AUDIENCE = Dev Humans AUDIENCE = Con người sản xuất

Với các giá trị trong các tệp riêng biệt đó, tập hợp các biến môi trường được triển khai với các hàm của bạn sẽ khác nhau tùy thuộc vào dự án mục tiêu của bạn:

$ 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

Các biến môi trường dành riêng

Một số khóa biến môi trường được dành riêng để sử dụng nội bộ. Không sử dụng bất kỳ khóa nào sau đây trong tệp .env của bạn:

  • Tất cả các khóa bắt đầu bằng X_GOOGLE_
  • Tất cả các phím bắt đầu từ EXT_
  • Tất cả các khóa bắt đầu bằng FIREBASE_
  • Bất kỳ khóa nào từ danh sách sau:
  • CLOUD_RUNTIME_CONFIG
  • ENTRY_POINT
  • GCP_PROJECT
  • GCLOUD_PROJECT
  • GOOGLE_CLOUD_PROJECT
  • FUNCTION_TRIGGER_TYPE
  • TÊN CHỨC NĂNG
  • FUNCTION_MEMORY_MB
  • FUNCTION_TIMEOUT_SEC
  • FUNCTION_IDENTITY
  • FUNCTION_REGION
  • FUNCTION_TARGET
  • FUNCTION_SIGNATURE_TYPE
  • K_SERVICE
  • K_REVISION
  • HẢI CẢNG
  • K_CONFIGURATION

Lưu trữ và truy cập thông tin cấu hình nhạy cảm

Các biến môi trường được lưu trữ trong tệp .env có thể được sử dụng để cấu hình hàm, nhưng bạn không nên coi chúng là một cách an toàn để lưu trữ thông tin nhạy cảm như thông tin đăng nhập cơ sở dữ liệu hoặc khóa API. Điều này đặc biệt quan trọng nếu bạn kiểm tra các tệp .env của mình trong kiểm soát nguồn.

Để giúp bạn lưu trữ thông tin cấu hình nhạy cảm, Chức năng đám mây cho Firebase tích hợp với Trình quản lý bí mật đám mây của Google. Dịch vụ được mã hóa này lưu trữ các giá trị cấu hình một cách an toàn, trong khi vẫn cho phép dễ dàng truy cập từ các chức năng của bạn khi cần.

Tạo và sử dụng bí mật

Để tạo bí mật, hãy sử dụng Firebase CLI.

Để tạo và sử dụng bí mật:

  1. Từ thư mục gốc của thư mục dự án cục bộ của bạn, hãy chạy lệnh sau:

    firebase functions:secrets:set SECRET_NAME

  2. Nhập giá trị cho SECRET_NAME .

    CLI lặp lại thông báo thành công và cảnh báo rằng bạn phải triển khai các chức năng để thay đổi có hiệu lực.

  3. Trước khi triển khai, hãy đảm bảo mã hàm của bạn cho phép hàm truy cập bí mật bằng tham số 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
      });
  4. Triển khai các chức năng đám mây:

    firebase deploy --only functions

Bây giờ bạn sẽ có thể truy cập nó giống như bất kỳ biến môi trường nào khác. Ngược lại, nếu một hàm khác không chỉ định bí mật trong runWith cố gắng truy cập bí mật, nó sẽ nhận một giá trị không xác định:

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
});

Khi chức năng của bạn được triển khai, nó sẽ có quyền truy cập vào giá trị bí mật. Chỉ các hàm đặc biệt bao gồm một bí mật trong tham số runWith của chúng mới có quyền truy cập vào bí mật đó dưới dạng một biến môi trường. Điều này giúp bạn đảm bảo rằng các giá trị bí mật chỉ có sẵn khi chúng cần, giảm nguy cơ vô tình làm rò rỉ bí mật.

Quản lý bí mật

Sử dụng Firebase CLI để quản lý bí mật của bạn. Trong khi quản lý bí mật theo cách này, hãy nhớ rằng một số thay đổi CLI yêu cầu bạn sửa đổi và / hoặc triển khai lại các chức năng liên quan. Đặc biệt:

  • Bất cứ khi nào bạn đặt một giá trị mới cho một bí mật, bạn phải triển khai lại tất cả các hàm tham chiếu đến bí mật đó để chúng nhận giá trị mới nhất.
  • Nếu bạn xóa một bí mật, hãy đảm bảo rằng không có chức năng nào đã triển khai của bạn tham chiếu đến bí mật đó. Các hàm sử dụng giá trị bí mật đã bị xóa sẽ không hoạt động.

Dưới đây là tóm tắt về các lệnh Firebase CLI để quản lý bí mật:

# 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

Đối với các lệnh accessdestroy , bạn có thể cung cấp tham số phiên bản tùy chọn để quản lý một phiên bản cụ thể. Ví dụ:

functions:secrets:access SECRET_NAME[@VERSION]

Để biết thêm thông tin về các thao tác này, hãy chuyển -h bằng lệnh để xem trợ giúp CLI.

Bí mật được lập hóa đơn như thế nào

Secret Manager cho phép 6 phiên bản bí mật hoạt động miễn phí. Điều này có nghĩa là bạn có thể có 6 bí mật mỗi tháng trong một dự án Firebase miễn phí.

Theo mặc định, Firebase CLI cố gắng tự động hủy các phiên bản bí mật không được sử dụng nếu thích hợp, chẳng hạn như khi bạn triển khai các chức năng với phiên bản bí mật mới. Ngoài ra, bạn có thể chủ động dọn dẹp những bí mật không dùng đến bằng cách sử dụng functions:secrets:destroyfunctions:secrets:prune .

Trình quản lý bí mật cho phép 10.000 hoạt động truy cập hàng tháng không được lập hóa đơn một cách bí mật. Các cá thể hàm chỉ đọc các bí mật được chỉ định trong tham số runWith của chúng mỗi khi chúng khởi động nguội. Nếu bạn có nhiều phiên bản chức năng đọc nhiều bí mật, dự án của bạn có thể vượt quá mức cho phép này, lúc đó bạn sẽ bị tính phí 0,03 đô la cho mỗi 10.000 thao tác truy cập.

Để biết thêm thông tin, hãy xem Giá của Trình quản lý bí mật .

Hỗ trợ giả lập

Cấu hình môi trường với dotenv được thiết kế để tương tác với trình giả lập Chức năng đám mây cục bộ.

Khi sử dụng trình giả lập Cloud Functions cục bộ, bạn có thể ghi đè các biến môi trường cho dự án của mình bằng cách thiết lập tệp .env.local . Nội dung của .env.local được ưu tiên hơn .env và tệp .env dành riêng cho dự án.

Ví dụ: một dự án có thể bao gồm ba tệp này chứa các giá trị hơi khác nhau để phát triển và thử nghiệm cục bộ:

.env .env.dev .env.local
PLANET = Trái đất

AUDIENCE = Con người

AUDIENCE = Dev Humans AUDIENCE = Con người địa phương

Khi bắt đầu trong ngữ cảnh cục bộ, trình giả lập sẽ tải các biến môi trường như được hiển thị:

  $ firebase emulators:start
  i  emulators: Starting emulators: functions
  # Starts emulator with following environment variables:
  #  PLANET=Earth
  #  AUDIENCE=Local Humans

Bí mật và thông tin đăng nhập trong trình giả lập Chức năng đám mây

Trình giả lập Chức năng đám mây hỗ trợ sử dụng bí mật để lưu trữ và truy cập thông tin cấu hình nhạy cảm . Theo mặc định, trình giả lập sẽ cố gắng truy cập bí mật sản xuất của bạn bằng thông tin đăng nhập mặc định của ứng dụng. Trong một số tình huống nhất định như môi trường CI, trình giả lập có thể không truy cập được các giá trị bí mật do các hạn chế về quyền.

Tương tự như hỗ trợ giả lập Cloud Functions cho các biến môi trường, bạn có thể ghi đè các giá trị bí mật bằng cách thiết lập tệp .secret.local . Điều này giúp bạn dễ dàng kiểm tra các chức năng của mình cục bộ, đặc biệt nếu bạn không có quyền truy cập vào giá trị bí mật.

Di chuyển từ cấu hình môi trường

Nếu bạn đang sử dụng cấu hình môi trường với functions.config , bạn có thể di chuyển cấu hình hiện có của mình dưới dạng các biến môi trường (ở định dạng dotenv ). Firebase CLI cung cấp lệnh xuất kết xuất cấu hình của từng bí danh hoặc dự án được liệt kê trong tệp .firebaserc của thư mục của bạn (trong ví dụ dưới đây là tệp local , nhà phát triển và prod ) dưới .env dev

Để di chuyển, hãy xuất các cấu hình môi trường hiện có của bạn bằng cách sử dụng các 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

Lưu ý rằng, trong một số trường hợp, bạn sẽ được nhắc nhập tiền tố để đổi tên các khóa biến môi trường đã xuất. Điều này là do không phải tất cả các cấu hình đều có thể được tự động chuyển đổi vì chúng có thể không hợp lệ hoặc có thể là khóa biến môi trường dành riêng .

Chúng tôi khuyên bạn nên xem xét cẩn thận nội dung của các tệp .env tạo trước khi bạn triển khai các chức năng của mình hoặc kiểm tra các tệp .env trong kiểm soát nguồn. Nếu bất kỳ giá trị nào nhạy cảm và không nên bị rò rỉ, hãy xóa chúng khỏi tệp .env của bạn và lưu trữ chúng an toàn trong Trình quản lý bí mật .

Bạn cũng sẽ cần cập nhật mã chức năng của mình. Bất kỳ hàm nào sử dụng functions.config bây giờ sẽ cần sử dụng process.env thay thế, như được hiển thị trong các biến Môi trường .

Cấu hình môi trường

Trước khi hỗ trợ biến môi trường được phát hành trong firebase-functions v3.18.0 , sử dụng functions.config() là phương pháp được khuyến nghị cho cấu hình môi trường. Phương pháp này vẫn được hỗ trợ, nhưng chúng tôi khuyên tất cả các dự án mới nên sử dụng các biến môi trường để thay thế, vì chúng dễ sử dụng hơn và cải thiện tính di động của mã của bạn.

Đặt cấu hình môi trường với CLI

Để lưu trữ dữ liệu môi trường, bạn có thể sử dụng lệnh firebase functions:config:set trong Firebase CLI . Mỗi khóa có thể được định vị trí bằng cách sử dụng các dấu chấm để nhóm cấu hình liên quan lại với nhau. Hãy nhớ rằng chỉ các ký tự viết thường được chấp nhận trong các khóa ; các ký tự viết hoa không được phép.

Ví dụ: để lưu trữ ID ứng dụng khách và khóa API cho "Một số dịch vụ", bạn có thể chạy:

firebase functions:config:set someservice.key="THE API KEY" someservice.id="THE CLIENT ID"

Truy xuất cấu hình môi trường hiện tại

Để kiểm tra những gì hiện được lưu trữ trong cấu hình môi trường cho dự án của bạn, bạn có thể sử dụng firebase functions:config:get . Nó sẽ xuất ra JSON giống như sau:

{
  "someservice": {
    "key":"THE API KEY",
    "id":"THE CLIENT ID"
  }
}

Chức năng này dựa trên API cấu hình thời gian chạy trên đám mây của Google .

Sử dụng functions.config để truy cập cấu hình môi trường trong một hàm

Một số cấu hình được cung cấp tự động trong không gian tên firebase dành riêng. Cấu hình môi trường được tạo sẵn bên trong hàm đang chạy của bạn thông qua functions.config() . Để sử dụng cấu hình ở trên, mã của bạn có thể trông giống như sau:

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}
  });
});

Sử dụng cấu hình môi trường để khởi tạo mô-đun

Một số mô-đun Node đã sẵn sàng mà không cần bất kỳ cấu hình nào. Các mô-đun khác cần cấu hình thêm để khởi tạo chính xác. Chúng tôi khuyên bạn nên lưu trữ cấu hình này trong các biến cấu hình môi trường thay vì mã hóa cứng. Điều này giúp bạn giữ cho mã của mình linh hoạt hơn nhiều, cho phép bạn mở nguồn ứng dụng của mình hoặc dễ dàng chuyển đổi giữa các phiên bản sản xuất và phiên bản dàn dựng.

Ví dụ: để sử dụng mô-đun Slack Node SDK , bạn có thể viết như sau:

const functions = require('firebase-functions');
const IncomingWebhook = require('@slack/client').IncomingWebhook;
const webhook = new IncomingWebhook(functions.config().slack.url);

Trước khi triển khai, hãy đặt biến cấu hình môi trường slack.url :

firebase functions:config:set slack.url=https://hooks.slack.com/services/XXX

Lệnh môi trường bổ sung

  • firebase functions:config:unset key1 key2 xóa các khóa được chỉ định khỏi cấu hình
  • firebase functions:config:clone --from <fromProject> sao chép môi trường của dự án khác vào dự án hiện đang hoạt động.

Các biến môi trường được điền tự động

Có các biến môi trường được tự động điền trong thời gian chạy hàm và trong các hàm được mô phỏng cục bộ. Chúng bao gồm những biến do Google Cloud điền vào , cũng như biến môi trường cụ thể của Firebase:

process.env.FIREBASE_CONFIG : Cung cấp thông tin cấu hình dự án Firebase sau:

{
  databaseURL: 'https://databaseName.firebaseio.com',
  storageBucket: 'projectId.appspot.com',
  projectId: 'projectId'
}

Cấu hình này được áp dụng tự động khi bạn khởi chạy SDK quản trị Firebase mà không có đối số. Nếu bạn đang viết các hàm bằng JavaScript, hãy khởi tạo như sau:

const admin = require('firebase-admin');
admin.initializeApp();

Nếu bạn đang viết các hàm trong TypeScript, hãy khởi tạo như sau:

import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';
import 'firebase-functions';
admin.initializeApp();

Nếu bạn cần khởi tạo SDK quản trị với cấu hình dự án mặc định bằng thông tin đăng nhập tài khoản dịch vụ, bạn có thể tải thông tin đăng nhập từ tệp và thêm chúng vào FIREBASE_CONFIG như sau:

serviceAccount = require('./serviceAccount.json');

const adminConfig = JSON.parse(process.env.FIREBASE_CONFIG);
adminConfig.credential = admin.credential.cert(serviceAccount);
admin.initializeApp(adminConfig);