{"componentChunkName":"component---src-templates-best-practice-detail-tsx","path":"/best-practice/2020-03-10-serverless-env","result":{"data":{"currentBlog":{"id":"a91ae766-b090-5f4d-891f-3332b7d58e00","frontmatter":{"thumbnail":"https://img.serverlesscloud.cn/20191230/1577673977066-16ef85f25ee1af09.jpg","authors":["yugasun"],"categories":["best-practice"],"date":"2020-03-10T00:00:00.000Z","title":"Serverless 多环境配置方案探索","description":"业务开发完了，如何管理不同环境的配置呢？","authorslink":["https://github.com/yugasun"],"translators":null,"translatorslink":null,"tags":["Serverless","管理环境"],"keywords":"Serverless 多环境配置,Serverless 管理环境,Serverless配置方案","outdated":true},"wordCount":{"words":241,"sentences":54,"paragraphs":54},"fileAbsolutePath":"/opt/build/repo/content/best-practice/2020-03-10-serverless-env.md","fields":{"slug":"/best-practice/2020-03-10-serverless-env/","keywords":["koa","nodejs","python","serverless","云函数","serverless","dotenv","yml","配置","release"]},"html":"

相信读完前面几篇有关 Serverless Component 文章的小伙伴已经体验到，它给我们开发带来的遍历。但是实际我们的日常开发项目中，并不仅仅只是单纯地一个项目部署那么简单，我们的敏捷开发流程中，还有开发、联调、测试、预发布、正式环境等关键词。那么有小伙伴就有疑惑了，我的业务开发完了，如何管理不同环境的配置呢？比如测试环境的数据库配置和正式环境的如何切换？于是抛转引入，写了此篇文章，来跟大家一起学习和探讨。

\n

读完本篇将你将了解到：

\n
    \n
  1. Serverless Component 部署原理
    2. \n
  2. dotenv 模块的基本使用
    3. \n
  3. 如何基于 dotenv 来切换多环境配置
    4. \n
  4. 如何在 serverless.yml 提炼通用配置
    5. \n
\n

Serverless Component

\n
\n

理论指导实践

\n
\n

在介绍方法之前，这里需要先对 Serverless Component 部署原理做个简单介绍。当我们在 serverless.yml 文件中配置好项目，执行 sls --debug 命令后，究竟发生了什么？

\n

核心步骤如下：

\n
1. 初始化 context：包括分析component依赖树，通过 dotenv 注入环境变量等。\n2. 安装依赖组件模块：不同于 `npm install`, serverless component 会将 `component` 指定的 npm 模块下载并解压放到 `~/.serverless/components/registry/npm/@serverless/xxx@x.x.x` 中。\n3. 执行组件模块的 `default` 函数：这个 default 函数就是开发者提供的部署逻辑代码，比如将打包压缩好的代码上传到cos，然后部署到scf。
\n

本篇只需要关心第一步的环境变量注入就好。

\n

可以发现，Serverless Framework 部署命令默认会帮我们注入 .env 文件中的环境变量到部署流程中，这也是为什么我们在使用腾讯云的组件时，需要创建一个内容如下的 .env 文件：

\n\n \n 复制代码\n \n \n
TENCENT_SECRET_ID=xxx\nTENCENT_SECRET_KEY=xxx
\n
\n

注意：当然腾讯云的组件都是支持扫码一键登录的，如果你不想配置 .env 文件。是不是很炫酷 ~

\n
\n

基于此，我们就可以利用 .env 文件做很多事了。 比如在 serverless.yml 中可以通过 ${env.xxx} 方式来获取注入的环境变量。

\n

dotenv 模块

\n
\n

Dotenv 是一个能够通过 .env 文件将环境变量注入到 process.env 的模块。

\n
\n

具体使用很简单，先安装 npm install dotenv --save，然后在你的项目入口文件中引入即可：

\n\n \n 复制代码\n \n \n
require(\"dotenv\").config();
\n

管理多环境配置

\n

说了这么多，终于到了本篇的正题。这里以 tencent-koa 组件为例，我们先初始化我们的项目：

\n\n \n 复制代码\n \n \n
# 此命令会将指定包含 `serverless.yml` 的 github 目录作为项目模板，拷贝到本地\n$ serverless create --template-url https://github.com/yugasun/tencent-serverless-demo/tree/master/serverless-env\n\n# 安装依赖\n$ cd severless-env && npm install
\n

然后新建两个配置文件，分别为：

\n\n \n 复制代码\n \n \n
# .env.test 文件内容\nUSER_NAME=yugasun_test\nUSER_EMAIL=yugasun_test@163.com\n\n# .env.release 文件内容\nUSER_NAME=yugasun_release\nUSER_EMAIL=yugasun_release@163.com
\n

然后新建入口文件 app.js：

\n {\n ctx.body = {\n name: process.env.USER_NAME,\n email: process.env.USER_EMAIL\n };\n});\n\napp.use(router.allowedMethods()).use(router.routes());\n\n// don't forget to export!\nmodule.exports = app;`, `45184057015223280000`)\"\n >\n \n 复制代码\n \n \n
const dotenv = require(\"dotenv\");\nconst Koa = require(\"koa\");\nconst KoaRouter = require(\"koa-router\");\n\nconst { CODE_ENV } = process.env;\ndotenv.config({\n  path: `${__dirname}/.env.${CODE_ENV}`\n});\n\nconst app = new Koa();\nconst router = new KoaRouter();\n\nrouter.get(\"/\", async ctx => {\n  ctx.body = {\n    name: process.env.USER_NAME,\n    email: process.env.USER_EMAIL\n  };\n});\n\napp.use(router.allowedMethods()).use(router.routes());\n\n// don't forget to export!\nmodule.exports = app;
\n

这是一个简单的 demo，通过云函数注入的环境变量 CODE_ENV，来读取不同的 .env.xxx 配置，从而实现不同环境的配置切换，核心代码就是:

\n\n \n 复制代码\n \n \n
const { CODE_ENV } = process.env;\ndotenv.config({\n  path: `${__dirname}/.env.${CODE_ENV}`\n});
\n
\n

备注：这里 dotenv 的 config 函数是可以指定 path 为目标 .env 文件路径。

\n
\n

所以只需要给云函数配置一个环境变量 CODE_ENV 就可以了，接下来我们来编写 serverless.yml 文件：

\n\n \n 复制代码\n \n \n
# 当前运行环境\nCODE_ENV: test\n\nMyExpress:\n  component: \"@serverless/tencent-koa\"\n  inputs:\n    region: ap-guangzhou\n    functionName: express-function\n    code: ./\n    functionConf:\n      timeout: 10\n      memorySize: 128\n      environment:\n        variables:\n          CODE_ENV: ${CODE_ENV}\n    apigatewayConf:\n      protocols:\n        - http\n        - https\n      environment: ${CODE_ENV}
\n

相信大家都知道可以通过 functionConf.environment.variables 来配置环境变量。\n这里不仅配置了云函数的环境变量，同时也配置了 apigatewayConf.environment，以此来区分 API 网关的测试和发布环境。

\n
\n

小技巧：可以在 yml 文件的顶端定义公共变量 CODE_ENV，然后通过 ${CODE_ENV} 的方式引用变量。

\n
\n

然后执行部署命令 sls --debug，部署成功后访问创建成功的 url 链接，就可以看到配置的环境变量结果了：

\n\n \n 复制代码\n \n \n
{\n  \"name\": \"yugasun_test\",\n  \"email\": \"yugasun_test@163.com\"\n}
\n

当我们开发完，需要部署到发布环境，只需要修改 serverless.yml 中的 CODE_ENV 值为 release，然后重新部署就行。

\n

配置优化 1

\n

细心的小伙伴会发现：部署成功的云函数，虽然可以成功地读取不同环境配置，但是每次部署都会将 .env.test 和 .env.release 两份配置文件同时上传。有时我们并不想暴露生产环境的配置在测试环境，因此需要每次部署时，只上传对应配置文件。要做到这一点，只需要在 serverless.yml 配置文件中新增 exclude 和 incldue 配置:

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

这里先通过 exclude 配置忽略所有配置文件，然后通过 include 来包含指定的配置文件。之所以这么做，是因为我们指定了 code 字段为 ./ - 项目根目录 ，因此会默认上传项目根目录的所有文件。

\n

配置优化 2

\n

当然也可以将 serverless.yml 中的任何固定参数写到 .env 文件中，比如这里的 CODE_ENV 变量，然后通过 ${env.CODE_ENV} 引用即可。比如我们将 CODE_ENV 写入到 .env 中：

\n\n \n 复制代码\n \n \n
CODE_ENV=release
\n

然后修改 serverless.yml 配置：

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

需要说明的是 .env 文件有个缺点，就是无法定义对象和数组。但是对于私密的配置，还是放到 .env 中比较合适，这样就可以基于文件去忽略部署。

\n

配置优化 3

\n

当需要将同一份业务代码部署到不同的地区，但是函数参数配置和 API 网关配置都是一致时，如何配置呢？这里一样可以提炼出通用配置，如下：

\n\n \n 复制代码\n \n \n
# global config\nCODE_ENV: release\n\n# function config\nFUNC_CONF:\n  name: express-function\n  memorySize: 128\n  timeout: 10\n  environment:\n    variables:\n      CODE_ENV: ${CODE_ENV}\n\n# apigw config\nAPI_CONF:\n  protocols:\n    - http\n    - https\n  environment: ${CODE_ENV}\n\n# guangzhou service\nMyExpressGZ:\n  component: \"@serverless/tencent-koa\"\n  inputs:\n    region: ap-guangzhou\n    functionName: ${FUNC_CONF.name}\n    code: ./\n    exclude:\n      - .env.release\n      - .env.test\n    include:\n      - .env.${CODE_ENV}\n    functionConf: ${FUNC_CONF}\n    apigatewayConf: ${API_CONF}\n\n# beijing service\nMyExpressBJ:\n  component: \"@serverless/tencent-koa\"\n  inputs:\n    region: ap-beijing\n    functionName: ${FUNC_CONF.name}\n    code: ./\n    exclude:\n      - .env.release\n      - .env.test\n    include:\n      - .env.${CODE_ENV}\n    functionConf: ${FUNC_CONF}\n    apigatewayConf: ${API_CONF}
\n

如何选择配置方案

\n

本文介绍了两种方案：

\n
    \n
  1. 通过 .env 配置
    2. \n
  2. 通过在 serverless.yml 中定义变量
    3. \n
\n

他们都可以定义全局变量，那么在实际开发中如何去抉择使用呢？

\n
\n

注意：serverless.yml 定义的变量，或者 .env 中自动注入的变量，只有在执行 sls --debug 命令后，才能够获取到。实际部署成功的代码，是需要通过 dotenv 模块来指定 .env 文件来手动加载注入的。当然如果你也可以通过解析 serverless.yml 文件来获取需要的变量也是可以的。

\n
\n

通常我会将跟 执行部署时的配置 放到 serverless.yml 中，将 业务相关的配置 放到 .env 文件中。当然，这里只是个人建议，具体如何去配置还是要看个人使用习惯。

\n

其他语言

\n

虽然本文只是讲述了如何在 Nodejs 项目中管理多环境配置，但是其他语言基本都实现了 dotenv 模块，所以此方法是通用的，比如 Python 的 python-dotenv 模块，使用起来基本差不多：

\n\n \n 复制代码\n \n \n
# settings.py\nfrom dotenv import load_dotenv\nfrom pathlib import Path  # python3 only\nenv_path = Path('.') / '.env.test'\nload_dotenv(dotenv_path=env_path)
\n

总结

\n

本篇涉及到所有源码都维护在开源项目 tencent-serverless-demo 中 serverless-env

\n

全文到这里就结束了，当然这只是本人在日常开发中总结的经验而已，如果你有更好的实践方式，欢迎一起为 Serverless 开源社区做贡献。

\n
\n
\n
\n
\n

传送门：

\n\n
\n

欢迎访问：Serverless 中文网，您可以在 最佳实践 里体验更多关于 Serverless 应用的开发！

","tableOfContents":""},"previousBlog":{"id":"1f1b1317-32a1-50c4-a77f-df648ee9128f","frontmatter":{"thumbnail":"https://img.serverlesscloud.cn/2020511/1589207418152-ZalNtxgQAC_small.jpg","authors":["Anycodes"],"categories":["best-practice"],"date":"2020-03-12T00:00:00.000Z","title":"让 Serverless 为你的头像增加点装饰","description":"无论是国庆还是新年，经常会有一个平台为我们提供一个生成头像的小工具，本文手把手教你实现头像加装饰的工具","authorslink":["https://zhuanlan.zhihu.com/ServerlessGo"],"translators":null,"translatorslink":null,"tags":["Serverless","图像处理"],"keywords":"Serverless 多环境配置,Serverless 管理环境,Serverless配置方案","outdated":true},"wordCount":{"words":106,"sentences":29,"paragraphs":29},"fileAbsolutePath":"/opt/build/repo/content/best-practice/2020-03-12-avatar-decoration.md","fields":{"slug":"/best-practice/2020-03-12-avatar-decoration/","keywords":["go","java","python","serverless","website","云函数","mui","pic","base","shape"]}},"nextBlog":{"id":"d45150eb-b890-55be-b616-dc19cf459c38","frontmatter":{"thumbnail":"https://img.serverlesscloud.cn/202034/1583323516946-v2-1a569e74722930de772e470209db3c05_1200x500.jpg","authors":["Anycodes"],"categories":["guides-and-tutorials","user-stories"],"date":"2020-03-03T00:00:00.000Z","title":"Serverless 组件开发尝试：全局变量组件和单独部署组件","description":"为了方便，我开发了这样的 Component","authorslink":["https://www.zhihu.com/people/liuyu-43-97"],"translators":null,"translatorslink":null,"tags":["Serverless","Component"],"keywords":"Serverless 全局变量组件,Serverless 单独部署组件,Serverless Component","outdated":true},"wordCount":{"words":212,"sentences":34,"paragraphs":33},"fileAbsolutePath":"/opt/build/repo/content/blog/2020-03-03-global-Component.md","fields":{"slug":"/blog/2020-03-03-global-Component/","keywords":["go","koa","serverless","website","云函数","serverless","website","tencent","mysql"]}}},"pageContext":{"isCreatedByStatefulCreatePages":false,"blogId":"a91ae766-b090-5f4d-891f-3332b7d58e00","previousBlogId":"1f1b1317-32a1-50c4-a77f-df648ee9128f","nextBlogId":"d45150eb-b890-55be-b616-dc19cf459c38"}}}