跳过主要内容

如何自定义Capacitor的构建脚本CLI

了解如何使用CapacitorCLI来自定义您的构建脚本,实现高效的部署和针对各个平台的定制更新。

如何自定义Capacitor的构建脚本CLI

Capacitor CLI让您自定义应用程序的iOS、Android和Web平台的构建过程。通过调整构建脚本,您可以:

  • 加速更新: 立即推送更改,无需等待应用商店延迟。
  • 控制部署: 回滚更新或针对特定用户组。
  • 加强安全性: 使用加密保护更新。
  • 优化构建: 根据平台的需求调整设置。

快速概览:

  • 配置文件: 使用 capacitor.config.json 和 package.json 管理构建设置
  • 自定义脚本: 为自动化添加预构建和后构建任务
  • 构建钩子: 在构建过程的特定阶段运行 code
  • 环境变量: 使用文件简化环境特定的构建 .env __CAPGO_KEEP_0__

CapgoCapgo 自动更新,版本跟踪和全球性能优化。继续阅读,了解如何设置和自定义您的构建脚本以实现最高效率。

介绍 Capacitor 配置

Capacitor Framework Documentation Website

Default Build Process in Capacitor

Understanding how Capacitor handles its default build process is crucial if you want to customize it effectively. Below, we’ll break down the Capacitor CLI’s build process and its key configuration files.

标准构建步骤

Capacitor uses a step-by-step process to transform your web app into platform-specific builds. Here’s what happens during the default build process:

阶段 简介 输出
Web Build 使用框架工具编译 web 资产 优化的 web 包
复制资产 移动 web 资产到本机平台文件夹 平台特定的资产目录
本机构建 运行平台特定的构建命令 可部署的二进制文件
验证 检查构建完整性和依赖项 构建状态和警告

主要配置文件

Two key configuration files shape how Capacitor handles your builds:

capacitor.config.json
This is the core configuration file for your Capacitor project. It sets important parameters for your builds:

{
  "appId": "com.example.app",
  "appName": "MyApp",
  "webDir": "dist",
  "bundledWebRuntime": false,
  "plugins": {
    "SplashScreen": {
      "launchShowDuration": 3000
    }
  }
}
  • appId: 为您的应用程序生成一个唯一标识符。
  • appName: 为您的应用程序指定名称。
  • webDir: Specifies where Capacitor should look for the web assets (e.g., dist).
  • plugins: 允许您配置插件特定的设置,例如SplashScreen选项。

package.json
该文件包含构建脚本和依赖项,影响构建过程:

{
  "scripts": {
    "build": "npm run build:web && cap sync",
    "build:web": "vite build",
    "cap:build": "cap build"
  }
}
  • The webDir 设置 capacitor.config.json tells Capacitor where to locate your compiled web assets for inclusion in the native builds.
  • 在本机构建中包含编译的 Web 资产的位置。 capacitor.config.json修改 cap sync 后,您需要运行

以确保您的本机项目已更新。

接下来,我们将探索如何修改这些设置以进一步定制您的构建。

You can tweak Capacitor’s default build process to better suit your project needs. Here’s how:

您可以通过编辑

来调整 capacitor.config.json 的默认构建过程以更好地适应您的项目需求。以下是示例配置:

{
  "appId": "com.example.app",
  "webDir": "www",
  "server": {
    "hostname": "localhost",
    "androidScheme": "https",
    "iosScheme": "https",
    "allowNavigation": ["*.example.com"]
  },
  "android": {
    "buildOptions": {
      "keystorePath": "release.keystore",
      "keystorePassword": "mypassword",
      "keystoreAlias": "release",
      "keystoreAliasPassword": "mypassword"
    }
  },
  "ios": {
    "scheme": "App",
    "automaticProvisioning": true
  }
}

以下是您可以修改的关键设置:

  • webDir: 指定编译后的 Web 资产所在位置。
  • server: 配置开发服务器,包括主机名和导航权限。
  • android/ios: 允许平台特定的构建设置,例如 Android 的.keystore详细信息或 iOS 的分发选项。

Creating NPM Scripts

To streamline your workflow, add custom NPM scripts to your package.json 文件中。以下是一个示例:

{
  "scripts": {
    "prebuild": "node ./scripts/prepare-env.js",
    "build": "npm run build:web && cap sync",
    "build:web": "vite build",
    "build:ios": "cap build ios --release",
    "build:android": "cap build android --release",
    "postbuild": "node ./scripts/notify-completion.js"
  }
}
  • prebuild 和 postbuildcontext:
  • build:platform: 使用这些任务,如设置环境或在构建完成时发送通知。

: 平台特定的命令,用于构建 Android 或 iOS 应用程序。

您可以通过添加构建钩子来进一步自动化构建过程。

为了获得更高级别的控制,使用构建钩子来执行自定义code,在构建过程的特定点执行。以下是一个示例设置在 capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'com.example.app',
  plugins: {
    CapacitorHooks: {
      beforeBuild: async () => {
        console.log('Running pre-build tasks...');
        // Add your pre-build tasks here
      },
      afterBuild: async () => {
        console.log('Running post-build tasks...');
        // Add your post-build tasks here
      }
    }
  }
};

export default config;

使用构建钩子,您可以:

  • 在构建开始之前验证要求
  • 在过程中转换资产
  • 在关键点触发通知
  • 自动更新版本号
  • 顺畅地运行自动化测试

这种方法为您提供了更大的灵活性和控制整个构建生命周期的能力。

高级构建定制

当处理更大的项目时,精细调整您的构建过程确实会带来很大的不同。以下是如何有效地处理环境特定的构建和平台定制的方法。

环境变量

通过创建单独的设置环境变量 .env 针对每个环境的文件:

  • .env.development
  • .env.staging
  • .env.production

然后,配置您的构建脚本以加载适合环境的文件:

import { defineConfig } from '@capacitor/cli';

export default defineConfig({
  ios: {
    buildConfig: {
      environment: process.env.BUILD_ENV || 'development',
      configurations: {
        development: {
          signing: {
            debug: true,
            automaticProvisioning: true
          }
        },
        production: {
          signing: {
            release: true,
            provisioningProfile: 'dist/profile.mobileprovision'
          }
        }
      }
    }
  }
});

您还可以根据平台的具体要求调整这些设置。

平台特定构建

要为 Android 和 iOS 自定义构建,请使用以下结构:

const platformConfig = {
  android: {
    buildType: process.env.BUILD_TYPE || 'debug',
    keystoreConfig: {
      path: process.env.KEYSTORE_PATH,
      password: process.env.KEYSTORE_PASSWORD,
      alias: process.env.KEYSTORE_ALIAS
    }
  },
  ios: {
    scheme: process.env.APP_SCHEME || 'App',
    xcodePreferences: {
      automaticSigning: false,
      developmentTeam: process.env.DEVELOPMENT_TEAM
    }
  }
};

这些配置使您能够为每个平台定制构建,确保更顺畅的部署。

功能 Android iOS
调试符号 ProGuard 映射文件 dSYM 文件
构建变体 debug,发布,阶段 debug,发布
Code 签名 Keystore 管理 分发配置文件
资源管理 res/drawable 优化 资源目录

优化构建的附加提示包括:

  • 使用部分更新来节省部署时间
  • 设置错误跟踪以快速识别问题
  • 创建渠道系统进行beta测试版本
  • 启用端到端加密以实现安全的分发

与像Capgo这样的工具配对进行分析和安全更新时,这些技术可以让您更好地控制您的部署过程 [1].

构建脚本问题与解决方案

当与自定义构建配置一起工作时,快速解决错误对于保持构建过程顺畅至关重要

修复常见错误

许多构建脚本问题源于环境设置或依赖问题。以下是如何解决一些常见问题的方法

缺少环境变量

如果您遇到以下错误:

error: Cannot find environment configuration for BUILD_ENV

您可以通过在项目根目录中创建一个 .env.local 文件来解决它。以下是一个示例:

BUILD_ENV=development
CAPACITOR_PLATFORM=ios
BUILD_TYPE=debug

平台特定构建失败

针对Android签名错误,使用以下命令:

npx cap build android --keystorePassword=$KEYSTORE_PASSWORD --keystoreAlias=$KEYSTORE_ALIAS

针对iOS分发配置文件问题,尝试以下命令:

npx cap build ios --configuration=release --type=development
错误类型 常见原因 解决方案
签名配置 缺少keystore详细信息 设置 KEYSTORE_PATH 和凭据
构建环境 未定义变量 创建平台特定的 .env 文件
依赖项 版本不匹配 更新 package.json 并同步

修复后,请确保您的更改是稳固的,通过运行全面构建测试来验证。

测试构建脚本

一旦错误得到解决,使用以下步骤验证您的构建脚本:

  • 自动验证: 运行关键命令以确认构建过程如预期工作。
npm run build
npx cap sync
npx cap copy
  • 环境验证: 在开始构建之前检查缺失的环境变量。
const requiredVars = ['BUILD_ENV', 'KEYSTORE_PATH'];
requiredVars.forEach(varName => {
  if (!process.env[varName]) {
    throw new Error(`Missing required env var: ${varName}`);
  }
});
  • Build Script Debugging: 在构建过程中捕获潜在问题的详细脚本。
{
  "scripts": {
    "build:debug": "NODE_ENV=development npx cap build --verbose",
    "build:release": "NODE_ENV=production npx cap build --verbose"
  }
}

测试时的额外提示:

  • 使用 Docker 容器来隔离构建。
  • 在开始过程之前验证配置文件。
  • 使用多个 Node.js 版本进行测试。
  • 确认满足平台特定要求。
  • 关注构建性能以寻找改进的可能。

Capgo 构建功能

Capgo实时更新控制台界面

Capgo将构建脚本推向了新的高度,通过自动部署,提高效率并简化流程。

快速应用更新

Capgo的更新性能令人印象深刻:

  • 95%的活跃用户 在24小时内接收更新。
  • 82%的成功率 全球更新交付。
  • API的平均响应时间为 434ms全球范围内.

该平台使用部分更新,这意味着只有更改会下载。这种方法减少了带宽使用量并加快了更新过程。另外,整个构建过程都是完全自动化的,节省了时间和精力。

构建自动化

Capgo 与主要的CI/CD平台无缝集成,提供多种集成功能:

CI/CD平台 集成功能 好处
GitHub 动作 自动化构建、部署触发器 持续部署
GitLab CI 管道自动化、版本控制 流程化工作流
Jenkins 自定义工作流程,构建钩子 适合企业级

设置自动构建通常需要约 300 美元/月, 这比传统解决方案的 6,000 美元/年.

安全标准

Capgo

  • 优先考虑安全性,使用包括以下内容的强大框架:
  • 更新包的端到端加密。
  • 遵守苹果和谷歌的指南。

版本控制功能

  • 即时回滚选项
  • 部署版本跟踪
  • 阶段性发布的更新频道管理

此安全框架经过了数百个企业应用的严格测试。对于需要额外安全保障的团队,Capgo还提供了自主托管的解决方案,支持可自定义的配置。

Capgo的频道系统使得更新分发变得灵活。开发者可以针对特定用户组发布不同的版本,适合测试版发布或逐步发布。

概要

构建步骤概述

自定义构建脚本允许通过构建钩子、环境变量和平台特定命令来实现自动化和一致的部署。这些过程为通过Capgo实现的部署改进奠定了基础。

Capgo优势

Capgo简化了部署,成功部署了超过2,350万次更新,覆盖了750个生产应用 [1]。它的部分更新系统减少了带宽使用量和部署时间。

该平台提供快速更新、全球性能优化、端到端加密以确保安全性,以及灵活的基于通道的分发系统。这一设置支持目标更新、beta测试以及遵守应用商店指南,同时保持强大的安全框架。

继续阅读《如何自定义Capacitor脚本CLI》

如果您正在使用 《如何自定义Capacitor脚本CLI》 将__CAPGO_KEEP_0__与__CAPGO_KEEP_0__ CI/CD 将Capgo CI/CD 用于Capgo CI/CD 用于Capgo Native Builds 用于Capgo Native Builds 用于Capgo Integrations 用于Capgo Integrations CI/CD 集成 CI/CD 集成的实现细节在此 GitHub 动作集成 GitHub 动作集成的实现细节在此

实时更新 Capacitor 应用

When a web-layer bug is live, ship the fix through Capgo instead of waiting days for app store approval. Users get the update in the background while native changes stay in the normal review path.

当 web 层 bug 活跃时,通过 __CAPGO_KEEP_0__ 将修复推送到应用,而不是等待应用商店批准几天。用户在后台接收更新,而原生变化仍在正常审查路径中。

上下文:Capgo营销网站。角色:支持描述段落或元描述。见于组件 GetStarted.astro。保留Capgo产品/品牌和开发者术语的原始形式。消息键 `instant_updates_for_capacitor_apps_description` (Capacitor 应用实时更新描述)。

最新博客文章

Capgo 为您提供创建真正专业的移动应用所需的最佳见解。