跳过主要内容

现代应用的环境配置

Master environment configuration for Capacitor and Electron apps. Compare 12-factor, runtime config, and secret management patterns

现代应用的环境配置

您已经发布了版本,签署了本机二进制文件,并正常启动了生产发布。然后,支持人员报告说用户无法完成购买。崩溃日志看起来与之无关,所以您花了几个小时来追踪请求、插件初始化和最近的JavaScript更改。最终原因是由于在紧急生产构建中留下了一个测试API URL

这不是一种常见的失败 环境配置 是将部署特定的设置,例如API端点、特性标志、数据库凭据和第三方密钥,分离到应用code之外的学科。在Capacitor和Electron应用中,分离变得更加困难,因为Web资产被打包在原生容器中,因此配置错误可以成为一个签名的艺术品,而不是一个可以在服务器上改变的值。

更深层的问题是 配置漂移,开发、测试和生产环境之间的渐进分离。开发人员更新一个文件,发布工程师改变一个CI变量,移动构建保留一个旧值在其捆绑包中。应用程序仍然编译,但环境不再代表同一个系统。了解__CAPGO_KEEP_0__应用程序之间的区别的团队 .env 可以避免一些明显的错误,但漂移需要一个运营模型,而不是仅仅更好的文件命名约定。 differences between development and production in Capacitor apps 目录

为什么环境配置会破坏生产应用程序

漂移始于无害的异常

环境配置为什么会破坏生产应用

最昂贵的配置错误很少像配置错误那样看起来。一个错误的 API 基础 URL 可以表现为身份验证失败、空白账户屏幕、支付错误或原生插件崩溃。到时发生意外的工程师处理构建管道时,原始错误可能已经被几个提交和成功的商店提交掩盖。

混合应用程序有一个特定的故障模式。 Capacitor 编译了一个 Web 应用程序,并将其资产放在了 iOS 或 Android 项目中。 Electron 将渲染器和主进程 code 打包到桌面应用程序中。如果在构建期间解析了一个端点或特性标志,结果值将随着 artifact 一起传递。稍后改变它通常意味着产生一个新的捆绑包、重新签名并通过适当的频道分发。

漂移始于无害的异常

配置漂移从合理的捷径开始:

  • 一个本地覆盖: 一个开发人员硬编码一个测试端点来解锁一个特性并忘记删除它。
  • 一个单独的管道变量: CI 使用一个与仓库文档配置不符的生产值。
  • A 原生设置: Android、iOS 和 Electron 接收不同的插件标识符或回调设置。
  • 一个未文档的标志: 运维直接在部署系统中更改一个特性标志,而 staging 继续使用旧的行为。

每个选择都可以独立工作。问题出在没有人能回答哪个值是权威的,哪个环境拥有它,以及它最后更改的时间。

实践规则: 如果一个配置值可以独立于应用逻辑改变,应将其视为部署输入,而不是源代码 code。

一个 staging 环境应该足够接近生产环境,以暴露集成问题,同时仍使用隔离的端点、凭证和数据。当环境发生漂移时,staging 就不再是一个有用的演练。一个发布可以通过一套假设通过每个测试,而在另一套假设下立即失败。

构建时配置创建了一个发布瓶颈

构建时配置仍然有用。公共编译时值、平台特定的标识符和由原生工具所需的设置通常需要在应用被打包之前存在。问题是使用构建时注入的值来改变运维可能需要更改的值。

假设一个生产环境API转移到一个新的端点。使用传统的Capacitor工作流程,团队会改变值,构建Web资产,同步本机项目,签署应用程序,并通过平台的发布过程分发它。Electron团队面临着类似的周期,当改变的值属于打包应用程序内部时。

这种工作流程适用于有意的产品发布。然而,对于紧急配置修正,它是一个糟糕的反应。二进制文件可能是健康的,JavaScript可能是未变的,而一个单独的字符串却会强制执行完整的交付周期。

更安全的设计分离了三个层次:

  1. 应用程序逻辑应该在所有环境中保持一致。
  2. 环境配置选择端点、标志和非敏感的运行时行为。
  3. 机密材料属于受控存储中,仅在必要时才注入。

这种分离使漂移变得可见。它还给团队提供了一个明确的答案:当生产环境表现出不同行为时,比较配置输入,而不是指责code。

比较四种主要配置模式

没有一种配置模式适合所有混合应用的部分。 一个后端可以在启动时读取进程环境变量,而一个Capacitor渲染器可能没有传统的服务器进程。 Electron在主进程和渲染器之间添加了另一个界限。 选择正确的模式取决于值是否为公共值、敏感值、在发布后是否可变或由本机构建工具所需。

模式一:12-Factor环境变量

12-Factor模型将配置视为环境特定的输入,而不是硬编码的应用状态。 这对服务器进程、容器和CI任务来说是自然的。 服务可以在启动时读取其值并在多个部署中使用相同的工件。

客户端应用程序会使模型变得复杂。 浏览器JavaScript引用值最终必须可用给客户端,因此它不应仅因为通过环境变量传递而被视为机密。 公开API源或特性标志可以使用构建时替换,但具有有意义特权的凭据不应在可逆客户端包中传递。

对于Capacitor和Electron,这种模式适用于 构建编排和公共配置,而不是保护机密。它具有低概念负荷,但在存在另一个传递层的情况下,运行时可变性有限。

模式二:按环境构建

团队通常维护开发、测试和生产构建配置文件。每个配置文件选择自己的端点、应用程序标识符、原生服务文件和功能标志。这种方法易于解释并且与平台要求兼容。

其弱点是 artifact 分歧。三个构建可能包含不同的行为,不仅仅是不同的设置,尤其是在条件编译或平台特定脚本进入管道时。每次配置更改都会创建另一个构建,并可能触发签名、认证、商店处理或手动发布协调。

回滚也与 artifact 分发相关。您可以回滚到较旧的二进制文件,但用户可能已经安装了不同的版本,回滚路径取决于分发渠道。

模式三:运行时配置

运行时配置将可变值从原生 artifact 中移出。应用程序在启动时检索配置文档或读取本地缓存文档,这些文档之前已交付。这样一来,团队就可以更正端点和标志而不改变应用程序 code。

这种方法的权衡是新的启动依赖。如果远程配置服务不可用,应用程序需要一个安全缓存、一个有界超时和一个已知的回退策略。回退策略绝不能指向错误的环境。验证文档的schema、验证其来源并记录应用程序应用的配置版本。

对于混合应用程序,这通常是非机密值的最灵活模式。它确实需要小心的离线行为,因为移动用户可以在没有网络连接的情况下启动应用程序。

模式四:专用密钥管理

像 HashiCorp Vault 和 AWS 秘密管理器这样的平台是为了控制敏感的后端材料而设计的。它们支持访问策略、审计跟踪、加密和轮换工作流。因此,它们适合于可以在不向用户暴露凭据的情况下对秘密存储进行身份验证的服务器端服务。

它们并不能解决客户端机密问题。一个传递给移动或桌面客户端的机密通常可以被设备的所有者检查。客户端应用程序应该只接收安全可披露的值,而保留在后端的特权操作。

模式 构建复杂度 需要重新提交的存储 回滚速度 最佳选择
12 因子变量 对于服务器来说是低的,对于混合构建来说是中等的 通常适用于打包的客户端值 一般 后端服务和公共构建输入
按环境构建 随环境数量增加而提高 是,值发生变化时 较慢至一般 小团队,发布频率较低
运行时配置 一般 不需要兼容的Web层变化 带有版本号的负载快 可变的端点,标志和客户端行为
敏感信息管理平台 中等到高 不适用于后端仅限的密钥 适用于服务器消费者 后端凭证

团队正在开发一个应用,偶尔发布,可以从环境构建和严格验证开始。一个快速增长的团队,需要并行的生产和测试环境,需要一个运行时层来减少 artifact 分歧。一个高频率的团队应该结合不可变的应用程序包,运行时配置和一个后端凭证管理器。 Capacitor 的特性标志实现指南 适合在运行时层中使用,前提是标志被限定,审计,并且安全地暴露给客户端。

安全性和 CI/CD 的影响你不能忽视

配置值并不是因为来自 CI 就自动安全的。 一旦值进入客户端包,原生资源,Electron 档案,日志文件,崩溃报告,或者设备备份,假设有权访问该 artifact 的人可能会检查它。

公共标识符和客户端设置与密钥不同。一个仅仅用来识别一个应用的移动 API 密钥,如果提供者期望它在包中,并且限制了它的使用,可能是可以接受的。一个数据库凭证,签名密钥,特权令牌,或者不受限制的服务凭证,在同一个地方是不安全的。 OWASP SAMM 建议分离职责,或者加密生产密钥,防止未受保护的密钥进入仓库,管理它们的生命周期,而不是等待事故发生。

A CI/CD pipeline安全风险的三个阶段示意图,涉及硬编码的机密信息。

管道泄露配置

CI/CD系统在平凡的方式上失败。一个shell命令打印一个扩展的变量,一个失败的构建包含一个机密信息在异常中,或者一个调试步骤存档一个环境的备份。一个 .env.production 文件也可能进入版本控制,因为一个仓库继承了一个不完整的 .gitignore.

使用一个安全的存储器来存储敏感的值,并且限制管道的权限。构建任务应该只接收到它所需要的值,日志应该掩盖它们。检查生成的JavaScript,原生资源,Electron存档,以及源码映射是否包含意外的包含。一个校验和或签名在一个远程传递的配置载荷中可以帮助检测篡改,但是它不能将一个可见的客户端值转换成一个机密。

处理分析或其他敏感数据的团队可以使用一个独立的资源,如ELECTE的 AI分析安全白皮书 当审查更广泛的数据保护责任时,它可以补充,而不是替代,应用程序特定的配置控制。

安全性必须与发布速度共存

生产环境的安全模式是由控制存储、在传输和存储过程中进行加密、最小特权访问和轮换来控制的。对于一个可变的公共端点,安全模式是不同的。端点可以通过一个带有版本号的运行时文档来传递,验证使用前,限制使得一个错误的值无法关闭。

不要将特权凭证放入 Capacitor 或 Electron code 中以避免后端的回程。不要依赖于混淆、压缩或一个隐藏的渲染变量。这些技术使得随意检查变得更加困难,但它们并没有改变客户端设备的信任模型。

一个实用的管道将责任分开:

  • 源代码管理: 提交配置方案和安全的示例,而不是存活的机密。
  • 构建阶段: 只注入生产 artifact 所需的值,并防止机密在日志中扩散。
  • 交付阶段: 通过一个经过身份验证、可观察的通道应用环境特定的运行时捆绑。
  • 轮换阶段: 在一个定义的时间表上,撤销和替换后端凭证,并为紧急失效提供一个事件路径。

The Capacitor CI/CD secret management practices 在使用 __CAPGO_KEEP_0__ 的团队中,CI/CD secret management practices 最有用的时候是配对使用明确的清单。对于每个变量,记录它是否为公共变量还是敏感变量,谁拥有它,哪些环境使用它,以及是否需要原生重建。

在 Capacitor 和 Electron 中实现环境配置

可维护的设置从一个配置契约开始,而不是一堆框架特定的条件语句。将安全的环境输入保存在可预测的文件中,通过构建系统加载它们,并通过小型类型服务向应用程序 code exposing。

可工作的仓库布局如下:

.env
.env.staging
.env.production
.env.example
src/config/
  schema.ts
  config-service.ts
capacitor.config.ts
electron/
  main.ts
  preload.ts

只有 .env.example 属于源代码控制。其他文件应该被忽略,CI 应该为每个目标提供值。这些文件可以包含公共端点和特性标志,但敏感的后端凭证应该保存在专用密钥存储中,并且永远不应成为客户端包的一部分。

定义并验证一个契约

使用 Vite,客户端暴露的变量通常使用前缀。该前缀是一个可见性信号,而不是安全边界。 VITE_ 在应用程序启动时调用。缺少的值应该产生明确的错误,而不是选择本地端点。这个单一决策可以防止生产路由错误的 bug 类型。

// src/config/schema.ts
export type AppConfig = {
  apiBaseUrl: string
  enableNewCheckout: boolean
  environment: 'development' | 'staging' | 'production'
}

function required(name: string, value: string | undefined): string {
  if (!value) {
    throw new Error(`Missing required configuration: ${name}`)
  }
  return value
}

export function loadConfig(): AppConfig {
  const environment = required('VITE_APP_ENV', import.meta.env.VITE_APP_ENV)

  if (!['development', 'staging', 'production'].includes(environment)) {
    throw new Error(`Unsupported environment: ${environment}`)
  }

  return {
    apiBaseUrl: required('VITE_API_BASE_URL', import.meta.env.VITE_API_BASE_URL),
    enableNewCheckout: import.meta.env.VITE_ENABLE_NEW_CHECKOUT === 'true',
    environment: environment as AppConfig['environment'],
  }
}

__CAPGO_KEEP_0__ loadConfig() __CAPGO_KEEP_0__

对于本地工作,Vite可以根据其模式选择合适的文件。一个阶段构建可以使用 .env.staging,而生产构建使用 .env.production。CI任务应该明确设置模式,而不是继承开发人员在本地使用的任何内容。

Capacitor 本地配置

本地项目通常需要环境特定的标识符、服务文件或插件设置。将这些值保存在 capacitor.config.ts中,但避免将私密凭据放在那里。

// capacitor.config.ts
import type { CapacitorConfig } from '@capacitor/cli'

const isProduction = process.env.APP_ENV === 'production'

const config: CapacitorConfig = {
  appId: isProduction ? 'com.example.app' : 'com.example.app.staging',
  appName: isProduction ? 'Example' : 'Example Staging',
  webDir: 'dist',
  plugins: {
    PushNotifications: {
      presentationOptions: ['badge', 'sound', 'alert'],
    },
  },
}

export default config

Firebase 文件、推送通知证书和平台标识符应该由本地构建管道选择并存储在适当的访问控制下。生产应用程序不应重用阶段服务凭据,因为两种构建都发生编译。

本地环境设置指南 Capacitor 可以帮助团队标准化本地模式,但存储库仍然需要明确的契约和CI验证。

Electron需要一个进程边界

Electron的渲染器不是Node.js主进程。对于一个加固的应用程序, process.env 可能在主进程中可用,但在渲染器中不可用或意外不可用。只通过预加载桥传递安全配置。

// electron/main.ts
import { app, BrowserWindow } from 'electron'
import path from 'node:path'

function createWindow() {
  const window = new BrowserWindow({
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
      nodeIntegration: false,
    },
  })

  const safeConfig = {
    apiBaseUrl: process.env.API_BASE_URL,
    environment: process.env.APP_ENV,
  }

  window.webContents.on('did-finish-load', () => {
    window.webContents.send('app-config', safeConfig)
  })

  return window
}

app.whenReady().then(createWindow)
// electron/preload.ts
import { contextBridge, ipcRenderer } from 'electron'

contextBridge.exposeInMainWorld('appConfig', {
  get: () => new Promise((resolve) => {
    ipcRenderer.once('app-config', (_event, config) => resolve(config))
  }),
})

在渲染器中再次验证该对象。桥应该只暴露公共运行时值,而不是机密存储令牌或特权文件系统能力。

Aspect Capacitor Capacitor
Electron 主配置边界 原生项目和捆绑的Web资产
主进程、预加载和渲染器 安全客户端值 公共端点和标志
通过预加载传递的公共端点和标志 避免将它们打包到应用程序中 避免将它们打包到存档中
常见错误 原生同步后,构建值过时 process.env 不可用在渲染器中
运行时更新路径 已签名的Web包或远程配置 已签名的Web包或受控应用程序更新

最常见的实现错误是假设 .env 文件自动私有。 一个打包器可以将它们的值包含在生成的JavaScript中,而一个打包步骤可以包含文件本身。 检查最终的工件,而不是源树。

Simplifying Targeted Updates and Rollbacks with Capgo

即使是有条不紊的构建时间设置也会留下一个硬操作性差距。如果一个公共端点在发布后发生变化,原生应用程序可能仍然包含旧值。重新生成并分发一个新的二进制文件是过度的,当所需的更改只影响Web层时。

Capgo的实时更新模型填补了这一差距 目标频道 用于开发、测试和生产等发布级别的频道。团队可以将已签名的JavaScript、CSS、配置或资产包发布到匹配受影响环境的频道。应用程序在下一次启动时将应用兼容的更新,而原生shell仍然安装在那里。

展示Capgo平台中传统应用配置工作流程与即时更新和回滚的对比图。

考虑一下生产API端点突然发生了变化。团队可以更新配置源、构建Web包并将其发布到生产频道,而不必等待原生商店的发布。重要的边界仍然存在:这种方法不会绕过原生code的平台规则,也不会使秘密变成可以发布的内容。它确实减少了修复兼容Web层配置所需的时间。

频道使环境的拥有权变得明确

频道应该映射到环境,而不是映射到个人开发者的偏好。开发测试者接收开发内容,测试用户接收测试内容,生产用户只接收生产批准的包。CI可以在对应的构建和验证步骤之后发布适当的包。

回滚同样重要。如果新配置指向一个不健康的服务,发布操作员应该能够选择之前已知的良好包装以便于该频道。版本历史、部署防护栏和设备级别的报告有助于团队确定问题是否广泛或仅限于某个发布段。

结果是更清晰的推广路径:

  1. 在开发中构建和验证包装。
  2. 将相同的测试内容推广到测试环境。
  3. 批准生产频道更新。
  4. 监控采用和失败。
  5. 如果配置行为不正确,则回滚频道。

该过程减少了为每个端点更正而创建紧急本机构建的诱惑。该 Capgo 版本控制和回滚工作流 尤其适用于需要环境特定发布而不失去可追溯历史的团队。

您的环境配置审计清单

在每次重大发布之前和任何管道更改之后运行此审计。

  • 检查构建产物: 确认没有敏感信息出现在提交的文件、生成的 JavaScript、原生资源、源映射或 Electron 框架中。
  • 分离环境: 验证开发、测试和生产环境使用不同的端点、标识符和授权密钥。
  • 保护输入: 检查每个 .env 变体被忽略,而 .env.example 文档所需的模式。
  • 审查 CI: 确认管道从受控存储中注入值,而不是依赖开发人员的本地机器。
  • 测试恢复: 验证运行时配置在缺少必需值时快速失败,并且可以回滚到兼容的更新而不需要重建原生 shell。

环境配置审计清单

只有当有人能够识别出每个生产配置值的所有者、来源、范围和回滚程序时,审计才算完成。


Capgo 为 CapacitorJS 和 Electron 应用程序提供了签名的实时更新,包括针对性的通道和版本回滚,适用于兼容的 JavaScript、CSS、配置和资产更改。如果您的团队想减少重建周期,同时控制环境更新,请访问 Capgo 并与您的现有 CI/CD 流程进行评估。

Capacitor 应用的实时更新

当 web 层面的 bug 活跃时,通过 Capgo 发送修复而不是等待几天的 app 商店审批。用户在后台接收更新,而本地的改变仍然在正常的审批路径中。

人工支持从 Martin

立即开始

最新博客文章

Capgo 给您需要创建真正专业的移动应用的最佳见解。