fix(env): dev:adb 真机包默认注入 .env.local 的开发接口地址(新增 VITE_API_BASE_OVERRIDE,发布包仍强制生产)

This commit is contained in:
liufumingren 2026-09-25 01:36:52 +08:00
parent 7820b29d6e
commit dd3eb8319e
5 changed files with 84 additions and 7 deletions

View File

@ -1,5 +1,7 @@
# 环境变量模板:复制本文件为 .env.local 并填写真实值(.env.local 不提交 git)
# 详见 config/README.md
# 仅开发环境生效:生产构建(electron/Android 打包)固定使用 https://qimen.wms.gztbyc.com,见 env.js
# 生效范围:① npm run dev:h5(dev server) ② npm run dev:adb(真机调试,脚本会把下面的地址注入为 VITE_API_BASE_OVERRIDE)
# 发布构建(electron/Android 打包)固定使用 https://qimen.wms.gztbyc.com,见 env.js
# 注意:不要把 VITE_API_BASE_OVERRIDE 写进 .env* 文件,它只能由命令行显式注入(防止测试地址进发布包)
VITE_API_BASE_URL=http://your-server-ip:6060
VITE_IMG_URL=https://your-img-domain.com

View File

@ -17,13 +17,28 @@
`deploy.json` 字段说明:android 段(APK 发布,`android:pack` 打包后自动 scp 上传)与 windows 段(exe 发布,`build:exe` 打包后自动 scp 上传),每段含 host(服务器 IP)、port(SSH 端口)、user(SSH 用户)、keyPath(SSH 私钥路径)、remoteDir(服务器上传目录:APK 与散单项目同为 worker_station,exe 为 worker_station_windows)、downloadUrlPrefix(下载 URL 前缀)、latestJsonName(latest.json 文件名)。跳过上传:`-NoUpload`(APK)/ `--no-upload`(exe)。
## 真机调试(dev:adb)的接口地址
`npm run build:app` 是 **Vite 生产构建**,`env.js` 里 `import.meta.env.PROD` 为真 → 默认固定指向生产域名 `https://qimen.wms.gztbyc.com`。所以**直接跑 `npm run dev:adb` 装到真机的包连的是生产库**(脚本名里的 dev 只指"改代码自动重编重装"的调试闭环,不是环境)。
`npm run dev:adb` 现在会读 `.env.local` 的 `VITE_API_BASE_URL`,通过命令行环境变量 `VITE_API_BASE_OVERRIDE` 注入编译:
| 命令 | 接口地址 |
|---|---|
| `npm run dev:adb` | 默认注入 `.env.local` 的地址(未配置 `.env.local` 时退回生产域名) |
| `npm run dev:adb -- --prod-api` | 不注入,产出与发布包一致的生产环境包 |
| `npm run dev:adb -- --api=http://192.168.1.10:6060` | 使用指定地址 |
> ⚠️ `VITE_API_BASE_OVERRIDE` 是"显式注入才生效"的开关,**不要写进 `.env*` 文件**:写进文件会让发布包也带上测试地址(会被 `scripts/build-apk.cjs` 的产物校验中止)。
> 现场确认某台设备连的是哪个后端:打包页标题 / 退件页「拆包工作台」3 秒内连点 5 次,诊断面板首行会显示 `版本` 与 `接口`。
## 根目录其他配置
| 文件 | 说明 | git |
|---|---|---|
| `.env` / `.env.electron` | Vite 构建目标(web/electron),无敏感信息 | ✅ 提交 |
| `.env.example` | 环境变量模板(接口地址等),复制为 `.env.local` 填写 | ✅ 提交 |
| `.env.local` | 本地开发环境变量(含内网测试接口地址,勿提交;**仅 dev 生效**,生产构建固定走 `https://qimen.wms.gztbyc.com`,见 `env.js`) | ❌ 不提交(匹配 `*.local`) |
| `.env.local` | 本地开发环境变量(含内网测试接口地址,勿提交)。生效范围:`npm run dev:h5`(dev server)与 `npm run dev:adb`(真机调试脚本会把 `VITE_API_BASE_URL` 注入为 `VITE_API_BASE_OVERRIDE` 参与编译);**发布构建固定走 `https://qimen.wms.gztbyc.com`**,见 `env.js` | ❌ 不提交(匹配 `*.local`) |
| `env.js` | 前端环境模块(读 Vite 环境变量,不写死敏感地址) | ✅ 提交 |
| `electron-builder.config.cjs` | exe 打包配置(无敏感) | ✅ 提交 |

14
env.js
View File

@ -2,9 +2,17 @@
// 避免构建机上残留的 .env.local 测试地址被带进生产包
const PROD_API_BASE = 'https://qimen.wms.gztbyc.com'
// 构建期「显式」指定的接口地址(真机调试用):
// 只有从命令行环境变量注入 VITE_API_BASE_OVERRIDE 才生效——该变量不写入任何 .env 文件,
// 所以即使构建机上存在带开发地址的 .env.local,生产打包也不会被它影响(见 scripts/build-apk.cjs 的地址校验)。
// 注入方:npm run dev:adb(默认取 .env.local 的地址,可用 --prod-api 关闭)。
const overrideApiBase = import.meta.env.VITE_API_BASE_OVERRIDE || ''
// 开发环境地址走 Vite 环境变量(见 .env.example / .env.local,敏感地址勿提交 git)
export const BASE_URL = import.meta.env.PROD
? PROD_API_BASE
: import.meta.env.VITE_API_BASE_URL || '' // 接口根地址,开发时由 .env.local 注入
export const BASE_URL = overrideApiBase
? overrideApiBase
: import.meta.env.PROD
? PROD_API_BASE
: import.meta.env.VITE_API_BASE_URL || '' // 接口根地址,开发时由 .env.local 注入
export const API_URL = `${BASE_URL}/system` // 后台接口域名
export const IMG_URL = import.meta.env.VITE_IMG_URL || 'https://ye4s.file.gzxunren.com' // 全局网络图片地址变量,css背景图片地址变量在uni.scss

View File

@ -61,6 +61,9 @@ if (
env: {
NODE_ENV: 'production',
VITE_API_BASE_URL: PROD_API_BASE,
// 显式关闭真机调试(dev:adb)的地址覆盖,避免本机 shell 里残留的
// VITE_API_BASE_OVERRIDE 把测试地址带进发布包
VITE_API_BASE_OVERRIDE: '',
},
})
) {

View File

@ -8,6 +8,13 @@
* npm run dev:adb # 自动选唯一设备
* npm run dev:adb -- --no-launch # 重装后不自动启动应用
* npm run dev:adb -- --adb=adb路径 # 自定义 adb 路径
* npm run dev:adb -- --prod-api # 不注入开发地址,产出与发布包一致的生产环境包
* npm run dev:adb -- --api=http://192.168.1.10:6060 # 指定接口地址
*
* 接口地址(重要):build:app 是 Vite 生产构建,env.js 默认会固定指向生产域名
* (见 env.js 的 PROD_API_BASE)。本脚本默认把 .env.local 里的 VITE_API_BASE_URL
* 通过 VITE_API_BASE_OVERRIDE 注入编译,避免真机调试打到生产库;
* 该变量不写入任何 .env 文件,因此不会影响正式发布包。
*
* 变更监听范围:
* src/(uni-app 前端资源)
@ -72,7 +79,46 @@ const WATCH_EXTS = new Set([
'.vue', '.js', '.ts', '.json', '.scss', '.css', '.cjs', '.ps1', '.xml', '.java', '.png', '.jpg', '.jpeg', '.md',
])
// ---------- 接口环境(真机调试选地址)----------
/** 读取 .env.local 里指定键的值(文件不存在/未配置时返回空) */
function readEnvLocal(key) {
try {
const text = fs.readFileSync(path.join(ROOT, '.env.local'), 'utf-8')
for (const line of text.split(/\r?\n/)) {
const matched = line.match(/^\s*([A-Za-z0-9_]+)\s*=\s*(.*)$/)
if (matched && matched[1] === key) {
return matched[2].trim().replace(/^["']|["']$/g, '')
}
}
} catch (e) {
// 忽略:文件缺失视为未配置
}
return ''
}
/** 解析本次真机包的接口地址(返回空字符串 = 不注入,沿用构建默认即生产域名) */
function resolveApiTarget() {
if (process.argv.includes('--prod-api')) {
return { base: '', note: '--prod-api 指定,与发布包一致' }
}
const argApi = process.argv.find((a) => a.startsWith('--api='))
if (argApi) {
return { base: argApi.slice('--api='.length), note: '命令行 --api 指定' }
}
const dev = readEnvLocal('VITE_API_BASE_URL')
if (dev) {
return { base: dev, note: '.env.local 的 VITE_API_BASE_URL' }
}
return { base: '', note: '未配置 .env.local,沿用构建默认(生产域名)' }
}
const API_TARGET = resolveApiTarget()
const BUILD_ENV = API_TARGET.base ? { VITE_API_BASE_OVERRIDE: API_TARGET.base } : {}
const log = (msg) => console.log(`[dev-adb] ${msg}`)
// 启动即声明本次真机包的接口地址(长驻 watch 中每次构建还会再打一次)
log(`接口地址 = ${API_TARGET.base || 'https://qimen.wms.gztbyc.com(生产)'} 〔${API_TARGET.note}〕`)
const run = (cmd, args, opts = {}) => {
// Windows 下通过 shell 执行,自动解析 npm.cmd / 全路径 exe
const res = spawnSync(cmd, args, {
@ -208,8 +254,11 @@ let buildFinishedAt = 0
async function buildAndInstall(serial, trigger) {
const t0 = Date.now()
log(`开始构建(触发: ${trigger})`)
// 1. uni-app 编译 App 资源
if (!run('npm', ['run', 'build:app'])) {
log(
`接口地址 = ${API_TARGET.base || 'https://qimen.wms.gztbyc.com(生产)'} 〔${API_TARGET.note}〕`
)
// 1. uni-app 编译 App 资源(注入开发地址,避免真机调试打到生产库)
if (!run('npm', ['run', 'build:app'], { env: BUILD_ENV })) {
log('✗ build:app 失败,跳过安装')
return false
}