Serverless 多環境配置方案探索-有解無憂

相信讀完前面幾篇有關 Serverless Component 文章的小伙伴已經體驗到，它給我們開發帶來的遍歷，但是實際我們的日常開發專案中，并不僅僅只是單純地一個專案部署那么簡單，我們的敏捷開發流程中，還有開發、聯調、測驗、預發布、正式環境等關鍵詞，那么有小伙伴就有疑惑了，我的業務開發完了，如何管理不同環境的配置呢？比如測驗環境的資料庫配置和正式環境的如何切換？于是拋轉引入，寫了此篇文章，來跟大家一起學習和探討，

讀完本篇將你將了解到：

Serverless Component 部署原理
dotenv 模塊的基本使用
如何基于 dotenv 來切換多環境配置
如何在 serverless.yml 提煉通用配置

Serverless Component

理論指導實踐

在介紹方法之前，這里需要先對 Serverless Component 部署原理做個簡單介紹，當我們在 serverless.yml 檔案中配置好專案，執行 sls --debug 命令后，究竟發生了什么？

核心步驟如下：

1. 初始化 context：包括分析component依賴樹，通過 dotenv 注入環境變數等，
2. 安裝依賴組件模塊：不同于 `npm install`, serverless component 會將 `component` 指定的 npm 模塊下載并解壓放到 `~/.serverless/components/registry/npm/@serverless/[email protected]` 中，
3. 執行組件模塊的 `default` 函式：這個 default 函式就是開發者提供的部署邏輯代碼，比如將打包壓縮好的代碼上傳到cos，然后部署到scf，

本篇只需要關心第一步的環境變數注入就好，

可以發現，Serverless Framework 部署命令默認會幫我們注入 .env 檔案中的環境變數到部署流程中，這也是為什么我們在使用騰訊云的組件時，需要創建一個內容如下的 .env 檔案：

TENCENT_SECRET_ID=xxx
TENCENT_SECRET_KEY=xxx

注意：當然騰訊云的組件都是支持掃碼一鍵登錄的，如果你不想配置 .env 檔案，是不是很炫酷 ~

基于此，我們就可以利用 .env 檔案做很多事了，比如在 serverless.yml 中可以通過 ${env.xxx} 方式來獲取注入的環境變數，

dotenv 模塊

Dotenv 是一個能夠通過 .env 檔案將環境變數注入到 process.env 的模塊，

具體使用很簡單，先安裝 npm install dotenv --save，然后在你的專案入口檔案中引入即可：

require("dotenv").config();

管理多環境配置

說了這么多，終于到了本篇的正題，這里以 tencent-koa 組件為例，我們先初始化我們的專案：

# 此命令會將指定包含 `serverless.yml` 的 github 目錄作為專案模板，拷貝到本地
$ serverless create --template-url https://github.com/yugasun/tencent-serverless-demo/tree/master/serverless-env

# 安裝依賴
$ cd severless-env && npm install

然后新建兩個組態檔，分別為：

# .env.test 檔案內容
USER_NAME=yugasun_test
[email protected]

# .env.release 檔案內容
USER_NAME=yugasun_release
[email protected]

然后新建入口檔案 app.js：

const dotenv = require("dotenv");
const Koa = require("koa");
const KoaRouter = require("koa-router");

const { CODE_ENV } = process.env;
dotenv.config({
  path: `${__dirname}/.env.${CODE_ENV}`
});

const app = new Koa();
const router = new KoaRouter();

router.get("/", async ctx => {
  ctx.body = {
    name: process.env.USER_NAME,
    email: process.env.USER_EMAIL
  };
});

app.use(router.allowedMethods()).use(router.routes());

// don't forget to export!
module.exports = app;

這是一個簡單的 demo，通過云函式注入的環境變數 CODE_ENV，來讀取不同的 .env.xxx 配置，從而實作不同環境的配置切換，核心代碼就是:

const { CODE_ENV } = process.env;
dotenv.config({
  path: `${__dirname}/.env.${CODE_ENV}`
});

備注：這里 dotenv 的 config 函式是可以指定 path 為目標 .env 檔案路徑，

所以只需要給云函式配置一個環境變數 CODE_ENV 就可以了，接下來我們來撰寫 serverless.yml 檔案：

# 當前運行環境
CODE_ENV: test

MyExpress:
  component: "@serverless/tencent-koa"
  inputs:
    region: ap-guangzhou
    functionName: express-function
    code: ./
    functionConf:
      timeout: 10
      memorySize: 128
      environment:
        variables:
          CODE_ENV: ${CODE_ENV}
    apigatewayConf:
      protocols:
        - http
        - https
      environment: ${CODE_ENV}

相信大家都知道可以通過 functionConf.environment.variables 來配置環境變數，
這里不僅配置了云函式的環境變數，同時也配置了 apigatewayConf.environment，以此來區分 API 網關的測驗和發布環境，

小技巧：可以在 yml 檔案的頂端定義公共變數 CODE_ENV，然后通過 ${CODE_ENV} 的方式參考變數，

然后執行部署命令 sls --debug，部署成功后訪問創建成功的 url 鏈接，就可以看到配置的環境變數結果了：

{
  "name": "yugasun_test",
  "email": "[email protected]"
}

當我們開發完，需要部署到發布環境，只需要修改 serverless.yml 中的 CODE_ENV 值為 release，然后重新部署就行，

配置優化 1

細心的小伙伴會發現：部署成功的云函式，雖然可以成功地讀取不同環境配置，但是每次部署都會將 .env.test 和 .env.release 兩份組態檔同時上傳，有時我們并不想暴露生產環境的配置在測驗環境，因此需要每次部署時，只上傳對應組態檔，要做到這一點，只需要在 serverless.yml 組態檔中新增 exclude 和 incldue 配置:

CODE_ENV: release

MyExpress:
  component: "@serverless/tencent-koa"
  inputs:
    region: ap-guangzhou
    functionName: express-function
    code: ./
    exclude:
      - .env.release
      - .env.test
    include:
      - .env.${CODE_ENV}
    functionConf:
      timeout: 10
      memorySize: 128
      environment:
        variables:
          CODE_ENV: ${CODE_ENV}
    apigatewayConf:
      protocols:
        - http
        - https
      environment: ${CODE_ENV}

這里先通過 exclude 配置忽略所有組態檔，然后通過 include 來包含指定的組態檔，之所以這么做，是因為我們指定了 code 欄位為 ./ - 專案根目錄 ，因此會默認上傳專案根目錄的所有檔案，

配置優化 2

當然也可以將 serverless.yml 中的任何固定引數寫到 .env 檔案中，比如這里的 CODE_ENV 變數，然后通過 ${env.CODE_ENV} 參考即可，比如我們將 CODE_ENV 寫入到 .env 中：

CODE_ENV=release

然后修改 serverless.yml 配置：

MyExpress:
  component: "@serverless/tencent-koa"
  inputs:
    region: ap-guangzhou
    functionName: express-function
    code: ./
    exclude:
      - .env.release
      - .env.test
    include:
      - .env.${env.CODE_ENV}
    functionConf:
      timeout: 10
      memorySize: 128
      environment:
        variables:
          CODE_ENV: ${env.CODE_ENV}
    apigatewayConf:
      protocols:
        - http
        - https
      environment: ${env.CODE_ENV}

需要說明的是 .env 檔案有個缺點，就是無法定義物件和陣列，但是對于私密的配置，還是放到 .env 中比較合適，這樣就可以基于檔案去忽略部署，

配置優化 3

當需要將同一份業務代碼部署到不同的地區，但是函式引數配置和 API 網關配置都是一致時，如何配置呢？這里一樣可以提煉出通用配置，如下：

# global config
CODE_ENV: release

# function config
FUNC_CONF:
  name: express-function
  memorySize: 128
  timeout: 10
  environment:
    variables:
      CODE_ENV: ${CODE_ENV}

# apigw config
API_CONF:
  protocols:
    - http
    - https
  environment: ${CODE_ENV}

# guangzhou service
MyExpressGZ:
  component: "@serverless/tencent-koa"
  inputs:
    region: ap-guangzhou
    functionName: ${FUNC_CONF.name}
    code: ./
    exclude:
      - .env.release
      - .env.test
    include:
      - .env.${CODE_ENV}
    functionConf: ${FUNC_CONF}
    apigatewayConf: ${API_CONF}

# beijing service
MyExpressBJ:
  component: "@serverless/tencent-koa"
  inputs:
    region: ap-beijing
    functionName: ${FUNC_CONF.name}
    code: ./
    exclude:
      - .env.release
      - .env.test
    include:
      - .env.${CODE_ENV}
    functionConf: ${FUNC_CONF}
    apigatewayConf: ${API_CONF}

如何選擇配置方案

本文介紹了兩種方案：

通過 .env 配置
通過在 serverless.yml 中定義變數

他們都可以定義全域變數，那么在實際開發中如何去抉擇使用呢？

注意：serverless.yml 定義的變數，或者 .env 中自動注入的變數，只有在執行 sls --debug 命令后，才能夠獲取到，實際部署成功的代碼，是需要通過 dotenv 模塊來指定 .env 檔案來手動加載注入的，當然如果你也可以通過決議 serverless.yml 檔案來獲取需要的變數也是可以的，

通常我會將跟 執行部署時的配置 放到 serverless.yml 中，將 業務相關的配置 放到 .env 檔案中，當然，這里只是個人建議，具體如何去配置還是要看個人使用習慣，

其他語言

雖然本文只是講述了如何在 Nodejs 專案中管理多環境配置，但是其他語言基本都實作了 dotenv 模塊，所以此方法是通用的，比如 Python 的 python-dotenv 模塊，使用起來基本差不多：

# settings.py
from dotenv import load_dotenv
from pathlib import Path  # python3 only
env_path = Path('.') / '.env.test'
load_dotenv(dotenv_path=env_path)

總結

本篇涉及到所有原始碼都維護在開源專案 tencent-serverless-demo 中 serverless-env

全文到這里就結束了，當然這只是本人在日常開發中總結的經驗而已，如果你有更好的實踐方式，歡迎一起為 Serverless 開源社區做貢獻，

傳送門：

GitHub: github.com/serverless

官網：serverless.com

歡迎訪問：Serverless 中文網，您可以在最佳實踐里體驗更多關于 Serverless 應用的開發！

推薦閱讀：《Serverless 架構：從原理、設計到專案實戰》

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/33928.html

標籤：其他

上一篇：unity踩過的音頻坑

下一篇：大贏家上下分充值的游戲