Vite 打包 H5 如何注入版本号

日常维护 H5 时,你可能有一个诉求,在 H5 发布时带上版本号。这样发现报错时,版本号可以辅助你排查错误;上线优化措施时,版本号可以辅助你观测性能......

本文我会告诉你 Vite 如何在 H5 注入版本号。

拳打 H5,脚踢小程序。我是「小霖家的混江龙」,关注我,带你了解更多实用的 H5、小程序武学。

注入版本号的流程

注入版本号主要分为三个步骤:

  1. 从命令行读取版本号
  2. 插入版本号到 HTML
  3. 上报版本号给监控 SDK

为了方便演示这三个流程,我用 Vite 新建一个 Demo 项目。出于习惯,我这里直接选择了 React,你也可以选择 Vue。

注入版本号时,你只需要关心 vite.config.js。

从命令行读取版本号

Windows、Linux 和 Mac 系统,在命令行设置临时环境变量的写法不同,你可以在安装 cross-env 这个开发依赖。它可以让你在不同系统使用相同方式注入环境变量(比如版本号)。

安装依赖后,你可以运行如下命令。它的作用是往 process-env 里注入变量 H5_VERSION,并执行打包。

bash 复制代码
npx cross-env H5_VERSION=0.0.1 npm run build

你可以直接在 vite.config.js 中打印读取到的版本号:

js 复制代码
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

console.log('H5_VERSION is ', process.env.H5_VERSION)

// https://vite.dev/config/
export default defineConfig({
  plugins: [react()],
})

可以看到,当运行 build 命令时,在 vite.config.js 内部已经读取到了 H5_VERSION。

下面,你需要把版本号插入到 HTML 中。

插入版本号到 HTML

你可以使用一个 vite 官方插件钩子函数 transformIndexHtml 编写一个插件,它可以替换 HTML 的内容,也可以插入 js 脚本。

插件代码如下,transformIndexHtml 函数返回了一个对象,对象包括 html 和 tag 两个属性。不难看出,这个对象的意思就是,在 head 标签靠前的位置插入一个 script 标签,标签内容是 window.$H5_VERSION="0.0.1"。

js 复制代码
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

function injectVersion () {
  return {
    name: 'inject-version',
    transformIndexHtml(html) {
      return {
        html,
        tags: [
          {
            injectTo: 'head-prepend',
            tag: 'script',
            children: `window.$H5_VERSION = "${process.env.H5_VERSION}"`
          }
        ]
      }
    }
  }
}

export default defineConfig({
  plugins: [react(), injectVersion()],
})

你可以再次启动打包,就能看到 dist 的产物中已经有了插入版本号的脚本。

上报版本号给监控 SDK

因为版本号脚本在 head 标签最顶层,会最早执行,所以你之后在 HTML、React 中都可以用 window.$H5_VERSION 获取版本号。

现在,你要做的就是把版本号上传到监控平台。

以阿里云的错误监控 ARMS 为例,你可以在它初始化 SDK 时给 release 取值 window.$H5_VERSION。

html 复制代码
<!DOCTYPE html>
<html>
  <!-- ... 省略 -->
  <body>
    <script>
      !(function (c, b, d, a) {
        c[a] || (c[a] = {})
        c[a].config = {
          pid: 'xxx',
          appType: 'web',
          // ARMS 配置应用版本号
          release: window.$H5_VERSION,
          sendResource: true,
          enableLinkTrace: true,
          behavior: true,
          useFmp: true,
          enableSPA: true,
        }
        // ... 省略
      })(window, document, 'xxx.js', '__bl')
    </script>
    <!-- ...省略 -->
  </body>
</html>

总结

本文介绍了 Vite 如何在 H5 注入版本号。主要包括从命令行读取版本号、插入版本号到 HTML、上报版本号给监控 SDK 三个步骤。

拳打 H5,脚踢小程序。我是「小霖家的混江龙」,关注我,带你了解更多实用的 H5、小程序武学。

相关推荐
Mh3 小时前
我是如何设计品牌站组件库的?
前端·css·设计模式
程序员大阳4 小时前
副队长Vue3教程(2)--Vite 搭建 Vue 项目,认识目录结构
前端·javascript·vue.js·vite·创建项目·目录结构·项目结构
濮水大叔4 小时前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js
SoaringHeart5 小时前
Flutter最佳实践:用 flutter_html 渲染富文本
前端·flutter
Flynt6 小时前
Chrome给AI编程助手塞了203篇前端规范,我拆包实测:检索0.77秒是真快,扫描器有点挑食
前端·chrome·ai编程
北城笑笑7 小时前
Vue 110 ,若依SSE流式接口限次空500排查与解决
前端·javascript·vue.js·后端·vue
程序员韩星7 小时前
OpenAI 兼容接口返回 404,先查请求地址,再查模型名
前端·人工智能·http
Patrick_Wilson7 小时前
构建通过了,为什么有些浏览器还会白屏?
前端·javascript·浏览器
其实防守也摸鱼8 小时前
用 Claude Code 重构遗留系统:从评估到落地的完整指南
前端·网络·人工智能·chrome·安全·重构
七仔啊8 小时前
CNC计算机数控加工模拟器
前端