61 lines
5.0 KiB
Markdown
61 lines
5.0 KiB
Markdown
# config 目录统一说明
|
|
|
|
本目录存放项目配置文件。**含敏感信息的配置一律不提交 git,配套的 `*.example.*` 模板提交**,新克隆后按模板复制填写即可。
|
|
|
|
## 本目录
|
|
|
|
| 文件 | 说明 | git |
|
|
|---|---|---|
|
|
| `android.json` | Android 离线打包本地配置(包名、签名密码、AppKey 等) | ❌ 不提交(敏感) |
|
|
| `android.example.json` | 上述配置的模板,首次使用复制为 `android.json` | ✅ 提交 |
|
|
| `deploy.json` | 发布配置(服务器 IP/账号/SSH 密钥路径/上传目录,分 android/windows 两段) | ❌ 不提交 |
|
|
| `deploy.example.json` | 发布配置模板,首次使用复制为 `deploy.json` | ✅ 提交 |
|
|
|
|
`android.json` 字段说明:appId(uni-app appid)、appKey(dev.dcloud.net.cn 申请)、appName(应用名)、packageName(Android 包名)、abis(CPU 架构)、icon/splash(图标启动图路径,相对项目根)、wwwSource(可选:指定 App 资源目录,留空则自动用 dist/build/app 或 unpackage/resources)、signing(keystore 路径/密码)。
|
|
|
|
> ⚠️ **appKey 必须与 appId 严格匹配**,留空或填其他应用的 key 时,APK 启动会白屏提示“未配置appkey或配置错误”(5+ Runtime 启动校验)。本应用与散单项目共用包名/签名/appid(`__UNI__900BDC1`),因此直接复用散单已申请的离线打包 Key,无需再申请。若日后更换 appid/证书/包名,需到 https://dev.dcloud.net.cn → 应用详情 → Android → 离线打包 Key 管理重新申请(需填包名与证书 SHA-256 指纹)。
|
|
|
|
`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` | 本地开发环境变量(含内网测试接口地址,勿提交)。生效范围:`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 打包配置(无敏感) | ✅ 提交 |
|
|
|
|
## 其他敏感/忽略位置
|
|
|
|
| 位置 | 说明 |
|
|
|---|---|
|
|
| `android-offline/keystore/` | 签名密钥文件,整个目录不提交 |
|
|
| `android-offline/HBuilder-Integrate-AS/` | **已提交 git(保证发布基座一致)**。工程内不写死任何密码:包名/版本/签名/应用名/appid/appKey 均由 `simpleDemo/build.gradle` 在构建时动态读取 `config/android.json` 与 `package.json`;仅排除 `local.properties`、`.gradle/`、`build/` 等本地产物 |
|
|
| `release/`、`dist/` | 打包产物,不提交 |
|
|
| `info/basicinfo.txt` | 曾含接口返回的账号/IP 数据,已删除;注意 git 历史中仍存在,如有需要可清理历史 |
|
|
|
|
## 新机器初始化清单
|
|
|
|
1. `cp config/android.example.json config/android.json` 并填写(签名密钥放入 `android-offline/keystore/`)
|
|
2. `cp config/deploy.example.json config/deploy.json` 并填写(仅发布 APK 时需要)
|
|
3. `cp .env.example .env.local` 并填写接口地址
|
|
3. `npm install`
|
|
4. 打包:`npm run build:apk`(Android 一键打包+发布,或拆分为 `npm run build:app` + `npm run android:pack`)、`npm run build:exe`(Windows,发布到 worker_station_windows)
|