关闭文章
Vue 2 + Docker + config.js + envsubst 实现运行时动态获取容器环境变量

Vue 2 + Docker + config.js + envsubst 实现运行时动态获取容器环境变量

2025-03-29
envsubstDockerVue

背景

在使用 Vue CLI 的 Vue 2 项目中,通常通过 process.env 引用前端环境变量。但在 Docker 容器化部署时:

  • 环境变量在构建时就被固定,无法在运行时动态修改。
  • 多环境(测试 / 生产) & 多区域(项目)部署时,无法灵活切换变量。

为了解决这个问题,计划使用 config.js + envsubst,在容器启动时生成配置,让不同环境复用同一个镜像,而无需重新构建前端。config.js 会被浏览器下载,只能放公开配置,不能放密码、令牌或私钥。

1. 方案核心

  • 环境变量:VUE_APP_PAY_BRAND。
  • 构建阶段:Vue 代码不会在 ENV 写死环境变量,而是通过 "config.js" 读取环境变量。
  • 运行阶段:
    • 通过 "envsubst" 替换 "config.js" 里的 "VUE_APP_PAY_BRAND",根据 "docker run "传入的环境变量动态设置值。
    • 不同环境 & 不同区域 使用 相同的 Docker 镜像,但运行时加载不同的 "VUE_APP_PAY_BRAND" 值。

2. 创建 public/config.js

在 "public/config.js" 里写入:

JavaScript
window.APP_CONFIG = {
  VUE_APP_PAY_BRAND: "${VUE_APP_PAY_BRAND}", // 运行时 `envsubst` 会替换这里的值
};

这里的 "VUE_APP_PAY_BRAND" 只是一个占位符,不会在构建时被 Webpack 解析,而是在容器运行时被替换。

并在 html 文件导入"config.js"

HTML
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
    <meta name="renderer" content="webkit" />
    <meta
      name="viewport"
      content="width=device-width, initial-scale=1"
    />
    <title><%= webpackConfig.name %></title>
 
    <!-- 在 Vue 代码运行前加载 config.js -->
    <script src="/config.js"></script>
  </head>
  <body>
    <div id="app"></div>
  </body>
</html>

3. 修改 Vue 代码,读取 config.js

在 main.js 或 axios 配置中,读取 window.APP_CONFIG:

JavaScript
const PAY_BRAND = window.APP_CONFIG?.VUE_APP_PAY_BRAND;
 
if (!["Tic", "Yere", "Otg"].includes(PAY_BRAND)) {
  throw new Error("运行时品牌配置缺失或无效");
}
 
export default PAY_BRAND;

这样,构建时不会写死 VUE_APP_PAY_BRAND,运行时由 config.js 提供品牌值,无需重新构建镜像。缺少配置时直接报错,避免文件加载失败却悄悄使用默认品牌;脚本地址示例按部署在域名根路径编写,放在子路径时需同步调整。

4. 修改 Dockerfile

不同项目的 Dockerfile 和 Nginx 配置有所不同,需要按实际静态目录调整。这里沿用原项目的 /data/statics/payment-admin,manage.conf 的站点根目录也必须指向它。模板只需可读,不需要 777 权限;运行用户需要能写入输出目录。

dockerfile
# 基础镜像
FROM nginx:1.26.2
 
# 复制静态文件
COPY dist /data/statics/payment-admin
 
# 复制前端 `config.js` 文件(使用占位符)
COPY public/config.js /usr/share/nginx/html/config.js
 
# 复制配置文件
COPY nginx.conf /etc/nginx/nginx.conf
 
# 删除默认配置
RUN rm -f /etc/nginx/conf.d/default.conf
 
# 复制配置文件
COPY manage.conf /etc/nginx/conf.d/manage.conf
 
RUN chmod 0644 /usr/share/nginx/html/config.js
 
# 暴露端口
EXPOSE 80
 
# 启动命令,运行时替换占位符
CMD ["/bin/sh", "-c", "set -eu; case \"${VUE_APP_PAY_BRAND:-}\" in Tic|Yere|Otg) ;; *) printf '%s\\n' 'Invalid VUE_APP_PAY_BRAND' >&2; exit 1 ;; esac; umask 022; envsubst '${VUE_APP_PAY_BRAND}' < /usr/share/nginx/html/config.js > /data/statics/payment-admin/config.js.tmp; chmod 0644 /data/statics/payment-admin/config.js.tmp; mv /data/statics/payment-admin/config.js.tmp /data/statics/payment-admin/config.js; exec nginx -g 'daemon off;'"]

envsubst 只做文本替换,不会转义 JavaScript 字符串,所以这里先把品牌限制为 Tic、Yere、Otg,再只替换这一项变量。配置不合法就停止启动;先写临时文件、成功后再替换目标,避免留下半份配置。

nginx:1.26.2 是原项目使用的版本,部署时应按兼容性选择仍受维护的固定版本。还需在 manage.conf 中让 /config.js 返回 Cache-Control: no-store,文件缺失时返回 404,而不是回退到首页;有 CDN 或 Service Worker 时,也要检查它们的缓存规则。

5.使用 Docker 在应用平台(Jenkins) 构建镜像

在 Jenkinsfile 里,可以这样构建:

shell
  docker build -t my-vue-app .

6. 运行时动态注入 "VUE_APP_PAY_BRAND"

测试环境

shell
  docker run -e VUE_APP_PAY_BRAND=Tic -p 8080:80 my-vue-app

生产环境(不同地区)

shell
  # -Tic
  docker run -e VUE_APP_PAY_BRAND=Tic -p 8080:80 my-vue-app
 
  # -Yere
  docker run -e VUE_APP_PAY_BRAND=Yere -p 8081:80 my-vue-app
 
  # -Otg
  docker run -e VUE_APP_PAY_BRAND=Otg -p 8082:80 my-vue-app

不同区域 用的是同一个 Docker 镜像,但 "VUE_APP_PAY_BRAND" 不同。不需要为每个区域重新构建镜像,只需修改 docker run 时的环境变量。

7. Kubernetes 部署

如果使用 Kubernetes,可以在 Deployment.yaml 里注入环境变量:

YAML
containers:
  - name: my-vue-app
    image: my-vue-app:latest
    env:
      - name: VUE_APP_PAY_BRAND
        value: "Yere"

这里只展示 containers 片段,仍需放进完整的 Deployment;更新变量后要重建 Pod,让启动命令重新生成配置。最后,在容器里检查 VUE_APP_PAY_BRAND。下面保留的是 Tic 容器的输出示例,使用上面的 Kubernetes 配置时,对应值应为 Yere:

shell
# env
HOSTNAME=9978357d47a9
HOME=/root
PKG_RELEASE=1~bookworm
DYNPKG_RELEASE=2~bookworm
TERM=xterm
NGINX_VERSION=1.26.2
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
NJS_VERSION=0.8.5
NJS_RELEASE=1~bookworm
VUE_APP_PAY_BRAND=Tic
PWD=/

容器启动时,config.js 里的 VUE_APP_PAY_BRAND 会被替换。找到环境变量后,还要在浏览器里确认实际下载的配置已经是对应品牌,而不是占位符或缓存的旧文件。修改变量后需要重新创建或启动容器,已经打开的网页也要重新加载。

AI 智能概括

 介绍 Vue 2 容器部署中用 envsubst 在启动时生成 config.js、由 window.APP_CONFIG 读取公开配置的方案,让不同环境复用同一镜像。配置需校验并处理缓存;变量变更后需重新创建或启动容器,Kubernetes 中需重建 Pod,网页也要重新加载,并非运行中热更新。

Powered by AI
发布于 2025-03-29