hot-update.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782
  1. import config from "@/utils/config";
  2. /**
  3. * 旧版本使用过的持久化锁 key,仅用于启动时清理遗留值。
  4. * 当前版本的互斥状态由模块内 hotUpdatePromise 管理,不会跨进程形成死锁。
  5. */
  6. export const HOT_UPDATE_LOCK_KEY = "__APP_WGT_HOT_UPDATE_RUNNING__";
  7. export const HOT_UPDATE_FALLBACK_APP_CHECK_EVENT =
  8. "__APP_WGT_HOT_UPDATE_FALLBACK_APP_CHECK__";
  9. const HOT_UPDATE_FALLBACK_PENDING_KEY =
  10. "__APP_WGT_HOT_UPDATE_FALLBACK_PENDING__";
  11. /**
  12. * 页面 onShow、App onShow 和路由切换可能在很短时间内连续触发。
  13. * 默认三十秒只向服务端检查一次;显式传入 forceCheck 时可用于用户手动检查。
  14. */
  15. export const HOT_UPDATE_CHECK_INTERVAL = 30 * 1000;
  16. let hotUpdatePromise = null;
  17. let lastCheckStartedAt = 0;
  18. /**
  19. * 当用户点击“稍后再说”时,我们把当前版本记下来。
  20. *
  21. * 这样做的原因:
  22. * 1. 热更新会在冷启动、回到前台和页面显示时检查。
  23. * 2. 如果用户已经明确拒绝了某个版本,后续页面切换继续弹同一个版本,体验会比较差。
  24. * 3. 只记录“被跳过的目标版本”,新版本来了仍然会重新提示。
  25. */
  26. const HOT_UPDATE_SKIP_VERSION_KEY = "__APP_WGT_HOT_UPDATE_SKIP_VERSION__";
  27. /**
  28. * 这里单独声明接口地址,而不是直接写死在 uni.request 里。
  29. *
  30. * 这样做的原因:
  31. * 1. 现有项目已经有 config 环境配置,说明项目本身就是按环境切换接口域名的。
  32. * 2. 热更新检查应该沿用现有配置习惯,避免你上线后再去改很多地方。
  33. * 3. 这个路径是本次方案“约定”的服务端接口,你可以直接让后端按这个接口实现,
  34. * 也可以只改这里一处,把路径替换成你们实际的地址。
  35. */
  36. const HOT_UPDATE_API_URL =
  37. config.default.apiUrl + config.default.apiUrlSuffix + "/rq/iot-app/newWgt";
  38. const APP_UPGRADE_API_URL =
  39. config.default.apiUrl + config.default.apiUrlSuffix + "/rq/iot-app/new";
  40. /**
  41. * 读取当前进程的热更新运行状态。
  42. *
  43. * 对页面组件的意义:
  44. * 旧的整包升级逻辑挂在页面里,页面 mounted 时如果发现热更新还在跑,
  45. * 就应该先让路,避免同时弹两个升级框。
  46. */
  47. export const isHotUpdateRunning = () => {
  48. return Boolean(hotUpdatePromise);
  49. };
  50. /**
  51. * 旧版本把运行锁写进了持久化 storage。如果 App 在下载或安装过程中被系统
  52. * 强杀,这个值不会进入 finally 清理,后续每次启动都会永久跳过更新。
  53. * 新实现使用模块内 Promise 作为进程锁;这里仅清理由旧版本遗留的死锁。
  54. */
  55. const clearLegacyHotUpdateLock = () => {
  56. if (uni.getStorageSync(HOT_UPDATE_LOCK_KEY)) {
  57. uni.removeStorageSync(HOT_UPDATE_LOCK_KEY);
  58. }
  59. };
  60. /**
  61. * 整包回退事件可能早于 upgrade 组件创建。额外保存一次待处理标记,组件挂载后
  62. * 仍能消费它,避免事件丢失。
  63. */
  64. export const consumePendingAppUpgradeCheck = () => {
  65. const pending = uni.getStorageSync(HOT_UPDATE_FALLBACK_PENDING_KEY) === "1";
  66. if (pending) {
  67. uni.removeStorageSync(HOT_UPDATE_FALLBACK_PENDING_KEY);
  68. }
  69. return pending;
  70. };
  71. /**
  72. * 等待 plus 对象可用。
  73. *
  74. * 为什么即便在 APP-PLUS 里也还要做这一步:
  75. * 1. 你要求热更新接在启动阶段,启动阶段最容易踩到“plus 尚未完全就绪”的时序问题。
  76. * 2. 现有 App.vue 的 onLaunch 里已经直接用了 plus.globalEvent,这说明项目默认运行在 App-Plus 环境。
  77. * 3. 但热更新比普通日志更敏感,因为它要马上调用 plus.runtime.getProperty / install / restart,
  78. * 所以这里显式兜底一次,会比“直接假设 plus 一定存在”更稳。
  79. *
  80. * 成功分支:
  81. * - plus 已就绪,resolve,继续后续热更新流程。
  82. *
  83. * 失败分支:
  84. * - 理论上这里没有主动 reject,超时场景也继续等待;
  85. * 如果 plus 始终不可用,后续逻辑不会开始,也就不会影响原有启动逻辑。
  86. */
  87. const waitForPlusReady = () => {
  88. return new Promise((resolve) => {
  89. if (typeof plus !== "undefined") {
  90. resolve();
  91. return;
  92. }
  93. document.addEventListener(
  94. "plusready",
  95. () => {
  96. resolve();
  97. },
  98. { once: true }
  99. );
  100. });
  101. };
  102. /**
  103. * 使用 plus.runtime.getProperty 读取当前资源包信息。
  104. *
  105. * 这是这次方案里最关键的一步,也是你特别强调不能替换掉的地方。
  106. *
  107. * 为什么必须用它:
  108. * 1. 你要做的是 .wgt 资源热更新,比较的是“当前资源包版本”和“服务端资源包版本”。
  109. * 2. plus.runtime.getProperty(plus.runtime.appid) 返回的是当前应用资源信息,
  110. * 其中 wgtinfo.version 才是最贴近“资源版本”的值。
  111. * 3. plus.runtime.version 更偏运行时/客户端信息,uni.getSystemInfo 也不是这个场景最合适的来源,
  112. * 所以这里严格按你的要求使用 getProperty。
  113. *
  114. * 输出:
  115. * - resolve(wgtInfo)
  116. * 其中最常用的字段包括:
  117. * - appid: 当前应用的 DCloud appid
  118. * - version: 当前资源版本
  119. * - name: 当前应用名称
  120. */
  121. export const getCurrentWgtInfo = () => {
  122. return new Promise((resolve, reject) => {
  123. try {
  124. plus.runtime.getProperty(plus.runtime.appid, (wgtInfo) => {
  125. if (!wgtInfo || !wgtInfo.version) {
  126. reject(new Error("未能获取当前应用资源版本信息"));
  127. return;
  128. }
  129. resolve(wgtInfo);
  130. });
  131. } catch (error) {
  132. reject(error);
  133. }
  134. });
  135. };
  136. /**
  137. * 一个简单的版本比较函数。
  138. *
  139. * 为什么这里仍然保留本地比较,而不是完全信任服务端的 update 字段:
  140. * 1. 服务端当然应该负责判断版本,但客户端再做一次兜底,可以避免后端配置错误导致重复更新。
  141. * 2. 这对“启动期自动更新”尤其重要,因为一旦后端误配,用户会在每次启动都被弹框打扰。
  142. *
  143. * 比较规则:
  144. * - a > b 返回 1
  145. * - a = b 返回 0
  146. * - a < b 返回 -1
  147. */
  148. const compareVersion = (a = "", b = "") => {
  149. const aList = String(a)
  150. .split(".")
  151. .map((item) => Number(item || 0));
  152. const bList = String(b)
  153. .split(".")
  154. .map((item) => Number(item || 0));
  155. const length = Math.max(aList.length, bList.length);
  156. for (let i = 0; i < length; i += 1) {
  157. const aNum = aList[i] || 0;
  158. const bNum = bList[i] || 0;
  159. if (aNum > bNum) return 1;
  160. if (aNum < bNum) return -1;
  161. }
  162. return 0;
  163. };
  164. /**
  165. * 判断服务端返回的地址是否真的是 .wgt 文件。
  166. *
  167. * 这里额外去掉 query/hash,是为了兼容这类地址:
  168. * - https://example.com/app/update.wgt?sign=xxx
  169. * - https://example.com/app/update.wgt#download
  170. */
  171. const isWgtPackageUrl = (url = "") => {
  172. const normalizedUrl = String(url)
  173. .trim()
  174. .split("#")[0]
  175. .split("?")[0]
  176. .toLowerCase();
  177. return normalizedUrl.endsWith(".wgt");
  178. };
  179. const isApkPackageUrl = (url = "") => {
  180. const normalizedUrl = String(url)
  181. .trim()
  182. .split("#")[0]
  183. .split("?")[0]
  184. .toLowerCase();
  185. return normalizedUrl.endsWith(".apk");
  186. };
  187. /**
  188. * 启动时先检查整包更新。只有 Android 端存在比当前原生版本更新的 APK 时,
  189. * 才中止 WGT 流程并通知原有整包升级组件。
  190. */
  191. const requestAppUpgradeInfo = () => {
  192. return new Promise((resolve, reject) => {
  193. uni.request({
  194. url: APP_UPGRADE_API_URL,
  195. method: "GET",
  196. header: {
  197. "Content-Type": "application/json",
  198. "tenant-id": "1",
  199. },
  200. timeout: 10000,
  201. success: (response) => {
  202. if (response.statusCode !== 200) {
  203. reject(
  204. new Error(
  205. `整包更新检查接口请求失败,HTTP 状态码:${response.statusCode}`
  206. )
  207. );
  208. return;
  209. }
  210. resolve(response.data || {});
  211. },
  212. fail: (error) => {
  213. reject(new Error(error?.errMsg || "整包更新检查接口请求失败"));
  214. },
  215. });
  216. });
  217. };
  218. const shouldPrioritizeAppUpgrade = (response, currentAppVersion) => {
  219. const data = response?.code === 0 ? response?.data : null;
  220. if (!data?.appVersion || !isApkPackageUrl(data.url)) {
  221. return false;
  222. }
  223. return compareVersion(data.appVersion, currentAppVersion) > 0;
  224. };
  225. /**
  226. * 请求服务端检查是否存在新的 .wgt 资源包。
  227. *
  228. * 为什么这里直接使用 uni.request,而不是复用现有 utils/request.js:
  229. * 1. 现有 request 封装默认会带 token、tenant-id、loading、401 刷新令牌等业务逻辑。
  230. * 2. 热更新检查发生在 App 启动最早阶段,不应该依赖登录态,也不应该因为 token 过期影响更新检查。
  231. * 3. 启动期代码越“去业务化”,越不容易被后续鉴权改造牵连。
  232. *
  233. * 请求参数说明:
  234. * - appid: 用来确保服务端下发的是当前应用对应的更新包。
  235. * - version: 当前资源版本,服务端据此判断是否需要更新。
  236. * - platform: 当前平台,便于服务端做 Android / iOS 区分。
  237. * - name: 可选,便于后端日志排查。
  238. *
  239. * 服务端返回格式约定:
  240. * {
  241. * code: 0,
  242. * data: {
  243. * update: true,
  244. * packageType: "wgt",
  245. * version: "1.3.6",
  246. * wgtUrl: "https://example.com/app/1.3.6/update.wgt",
  247. * note: "1. 修复巡检表单保存异常\\n2. 优化首页加载速度",
  248. * force: false
  249. * },
  250. * message: "success"
  251. * }
  252. *
  253. * 字段用途:
  254. * - code: 业务状态码,0 表示接口业务成功。
  255. * - data.update: 服务端是否认为当前客户端需要更新。
  256. * - data.packageType: 更新类型。这里约定 wgt 表示资源热更新,native 表示整包更新。
  257. * - data.version: 服务端最新资源版本。
  258. * - data.wgtUrl: .wgt 下载地址。
  259. * - data.note: 更新说明,弹窗里给用户看。
  260. * - data.force: 是否强制更新。true 时不展示取消按钮。
  261. * - message: 服务端通用提示。
  262. */
  263. const requestHotUpdateInfo = () => {
  264. console.log("11", 11);
  265. return new Promise((resolve, reject) => {
  266. uni.request({
  267. url: HOT_UPDATE_API_URL,
  268. method: "GET",
  269. header: {
  270. "Content-Type": "application/json",
  271. "tenant-id": "1",
  272. },
  273. timeout: 10000,
  274. success: (response) => {
  275. if (response.statusCode !== 200) {
  276. reject(
  277. new Error(
  278. `热更新检查接口请求失败,HTTP 状态码:${response.statusCode}`
  279. )
  280. );
  281. return;
  282. }
  283. resolve(response.data || {});
  284. },
  285. fail: (error) => {
  286. reject(
  287. new Error(
  288. error?.errMsg || "热更新检查接口请求失败,请检查网络或服务端状态"
  289. )
  290. );
  291. },
  292. complete: () => {
  293. /**
  294. * 这里故意不做 UI 处理,只保留 complete 生命周期位置。
  295. *
  296. * 原因:
  297. * 启动期的检查更新是“后台检查”,不是用户手动点按钮触发的请求。
  298. * 如果这里也弹 loading,会和现有登录页/首页首屏体验打架。
  299. */
  300. },
  301. });
  302. });
  303. };
  304. /**
  305. * 规范化服务端返回,统一后续分支判断。
  306. *
  307. * 为什么要单独做这一层:
  308. * 1. 启动流程最怕到处写 if/else,后面维护时很难看出到底在哪个条件提前返回。
  309. * 2. 统一成“shouldUpdate + reason + payload”的结构,后面 orchestration 会清晰很多。
  310. *
  311. * 成功输出示例:
  312. * {
  313. * shouldUpdate: true,
  314. * reason: "has-update",
  315. * payload: { ...服务端 data... }
  316. * }
  317. */
  318. const normalizeUpdateResult = (response, currentVersion) => {
  319. console.log("response", response);
  320. const code = response?.code;
  321. const message = response?.message || response?.msg || "";
  322. const data = response?.data || {};
  323. if (code !== 0) {
  324. return {
  325. shouldUpdate: false,
  326. reason: "server-error",
  327. message: message || "热更新接口返回了业务错误",
  328. };
  329. }
  330. // if (!data.update) {
  331. // return {
  332. // shouldUpdate: false,
  333. // reason: "no-update",
  334. // message: "服务端确认当前版本无需更新",
  335. // };
  336. // }
  337. // if (data.packageType && data.packageType !== "wgt") {
  338. // return {
  339. // shouldUpdate: false,
  340. // reason: "not-wgt",
  341. // message: `服务端返回的是 ${data.packageType} 更新,不属于本次 .wgt 热更新流程`,
  342. // payload: data,
  343. // };
  344. // }
  345. if (data.wgtUrl && !isWgtPackageUrl(data.wgtUrl)) {
  346. return {
  347. shouldUpdate: false,
  348. reason: "fallback-app-check-version",
  349. message:
  350. "服务端返回的 wgtUrl 不是 .wgt 文件地址,回退到原有整包升级检查流程",
  351. payload: data,
  352. };
  353. }
  354. if (!data.version || !data.wgtUrl) {
  355. return {
  356. shouldUpdate: false,
  357. reason: "invalid-data",
  358. message: "服务端返回缺少 version 或 wgtUrl,无法继续热更新",
  359. };
  360. }
  361. if (compareVersion(data.version, currentVersion) <= 0) {
  362. return {
  363. shouldUpdate: false,
  364. reason: "not-newer",
  365. message: "服务端返回的版本不高于当前版本,跳过本次热更新",
  366. payload: data,
  367. };
  368. }
  369. const skippedVersion = uni.getStorageSync(HOT_UPDATE_SKIP_VERSION_KEY);
  370. if (!data.force && skippedVersion === data.version) {
  371. return {
  372. shouldUpdate: false,
  373. reason: "skipped-same-version",
  374. message: "用户之前已经跳过该版本,本次启动不再重复提示",
  375. payload: data,
  376. };
  377. }
  378. return {
  379. shouldUpdate: true,
  380. reason: "has-update",
  381. payload: data,
  382. };
  383. };
  384. /**
  385. * 组装展示给用户的更新文案。
  386. *
  387. * 这里没有引入 i18n,也没有复用页面组件里的 UI。
  388. *
  389. * 原因:
  390. * 1. 热更新发生在 App 启动阶段,应该尽量减少对页面层、全局实例、组件状态的依赖。
  391. * 2. 现有项目的旧升级逻辑是在组件里拿 $t,这条链路不适合直接照搬到启动期。
  392. * 3. 启动期用系统级的 uni.showModal 更稳,也更符合“最小侵入式改造”。
  393. */
  394. const buildUpdateContent = (payload) => {
  395. const note = payload.note
  396. ? String(payload.note)
  397. : "修复已知问题,优化使用体验";
  398. const content = [`发现新的资源版本:${payload.version}`, "", note];
  399. if (payload.force) {
  400. content.push("", "该更新为强制更新,请完成安装后继续使用。");
  401. }
  402. return content.join("\n");
  403. };
  404. /**
  405. * 提示用户是否开始热更新。
  406. *
  407. * 成功分支:
  408. * - 用户点击确认,resolve(true),继续下载。
  409. *
  410. * 失败/取消分支:
  411. * - 非强更时,用户点击取消,记录本次跳过的版本,resolve(false)。
  412. * - 强更时,没有取消按钮,只能确认。
  413. */
  414. const confirmHotUpdate = (payload) => {
  415. return new Promise((resolve) => {
  416. uni.showModal({
  417. title: payload.force ? "发现重要更新" : "发现新版本",
  418. content: buildUpdateContent(payload),
  419. showCancel: !payload.force,
  420. confirmText: "立即更新",
  421. cancelText: "稍后再说",
  422. success: (result) => {
  423. if (result.confirm) {
  424. uni.removeStorageSync(HOT_UPDATE_SKIP_VERSION_KEY);
  425. resolve(true);
  426. return;
  427. }
  428. if (!payload.force && result.cancel) {
  429. uni.setStorageSync(HOT_UPDATE_SKIP_VERSION_KEY, payload.version);
  430. }
  431. resolve(false);
  432. },
  433. fail: () => {
  434. resolve(false);
  435. },
  436. });
  437. });
  438. };
  439. /**
  440. * 下载 .wgt 文件。
  441. *
  442. * 为什么这里要单独拆出来:
  443. * 1. 下载是一个明显独立的异步阶段,最需要看清楚成功和失败分支。
  444. * 2. 下载是启动期流程里耗时较长的一步,单独封装后更方便控制提示方式。
  445. *
  446. * 用户可见表现:
  447. * - 下载中:顶部展示固定 loading 提示,不展示实时百分比。
  448. * - 下载成功:loading 自动关闭,进入安装阶段。
  449. * - 下载失败:loading 关闭,并在上层统一提示“热更新失败”。
  450. *
  451. * 输出:
  452. * - resolve(tempFilePath) 返回下载到本地后的临时文件路径。
  453. */
  454. const downloadWgtPackage = (wgtUrl) => {
  455. console.log("wgtUrl :>> ", wgtUrl);
  456. return new Promise((resolve, reject) => {
  457. uni.showLoading({
  458. title: "下载更新中",
  459. mask: true,
  460. });
  461. uni.downloadFile({
  462. url: wgtUrl,
  463. timeout: 600000,
  464. success: (response) => {
  465. if (response.statusCode === 200 && response.tempFilePath) {
  466. resolve(response.tempFilePath);
  467. return;
  468. }
  469. reject(
  470. new Error(
  471. `热更新包下载失败,HTTP 状态码:${response.statusCode || "unknown"}`
  472. )
  473. );
  474. },
  475. fail: (error) => {
  476. reject(new Error(error?.errMsg || "热更新包下载失败"));
  477. },
  478. complete: () => {
  479. uni.hideLoading();
  480. },
  481. });
  482. });
  483. };
  484. /**
  485. * 安装下载完成后的 .wgt 包。
  486. *
  487. * 为什么安装时要带 appid:
  488. * 1. 官方文档说明可以传入 appid 做校验。
  489. * 2. 这可以避免服务端配置错误时,把不属于当前应用的资源包安装进来。
  490. *
  491. * 为什么 force 设为 false:
  492. * 1. force=true 会跳过版本校验,风险更高。
  493. * 2. 现在我们已经在服务端和客户端各做了一层版本判断,没有必要强制覆盖旧包。
  494. */
  495. const installWgtPackage = (filePath, appid) => {
  496. return new Promise((resolve, reject) => {
  497. try {
  498. plus.runtime.install(
  499. filePath,
  500. {
  501. appid,
  502. force: false,
  503. },
  504. () => {
  505. resolve();
  506. },
  507. (error) => {
  508. reject(
  509. new Error(
  510. error?.message || `热更新安装失败,错误码:${error?.code || ""}`
  511. )
  512. );
  513. }
  514. );
  515. } catch (error) {
  516. reject(error);
  517. }
  518. });
  519. };
  520. /**
  521. * 安装完成后提示用户并重启应用。
  522. *
  523. * 为什么这里显式调用 plus.runtime.restart:
  524. * 1. .wgt 安装完成只是把新资源放到了运行环境,想让用户真正跑到新代码,还需要重启应用。
  525. * 2. 这一步和旧的页面级整包升级不同,旧逻辑 Android 是直接安装 apk。
  526. * 3. 热更新的目标是“尽快让新前端资源生效”,因此安装完成后立即重启是最直接的方案。
  527. *
  528. * 运行锁现在是进程内 Promise;应用重启会自然释放,不再依赖持久化 storage 清锁。
  529. */
  530. const restartAppAfterInstall = (targetVersion) => {
  531. return new Promise((resolve) => {
  532. uni.showModal({
  533. title: "更新完成",
  534. content: `资源版本 ${targetVersion} 已安装完成,点击确定后将立即重启应用使更新生效。`,
  535. showCancel: false,
  536. success: () => {
  537. plus.runtime.restart();
  538. resolve();
  539. },
  540. fail: () => {
  541. /**
  542. * 即便弹窗失败,我们也仍然执行重启。
  543. *
  544. * 原因:
  545. * - 到这里说明安装已经完成。
  546. * - 如果不重启,用户还会继续运行旧资源,和“安装成功”的状态不一致。
  547. */
  548. plus.runtime.restart();
  549. resolve();
  550. },
  551. });
  552. });
  553. };
  554. /**
  555. * 统一展示“热更新失败”提示。
  556. *
  557. * 为什么不把所有失败都提示给用户:
  558. * 1. 启动阶段的“检查接口失败 / 无网络”很常见,如果每次启动都弹错,会严重影响体验。
  559. * 2. 所以我们只对“用户已经明确点击开始更新之后”的失败给出弹窗提示。
  560. * 3. 纯检查阶段失败,记录日志后继续进入原有流程即可。
  561. */
  562. const showHotUpdateError = (error, title = "更新失败") => {
  563. uni.showModal({
  564. title,
  565. content: error?.message || "热更新执行失败,请稍后重试",
  566. showCancel: false,
  567. });
  568. };
  569. /**
  570. * 内部热更新执行流程,由公开入口负责并发合并和调用频率控制。
  571. *
  572. * 这是你后续在 App.vue onLaunch 里真正调用的函数。
  573. *
  574. * 整体执行顺序:
  575. * 1. 等待 plus 就绪
  576. * 2. Android 端先检查是否存在新的 APK
  577. * 3. 没有 APK 更新时获取当前资源版本
  578. * 4. 请求服务端检查 WGT 更新
  579. * 5. 判断是否存在新的 .wgt 包
  580. * 6. 提示用户确认
  581. * 7. 下载 .wgt
  582. * 8. 安装 .wgt
  583. * 9. 重启应用
  584. *
  585. * 返回值:
  586. * - Promise<{ status: string, ... }>
  587. * 主要用于日志或后续扩展,目前 App.vue 不需要依赖它的返回值。
  588. */
  589. const executeWgtHotUpdate = async () => {
  590. // #ifdef APP-PLUS
  591. let currentStage = "prepare";
  592. let finalResult = null;
  593. try {
  594. currentStage = "plus-ready";
  595. await waitForPlusReady();
  596. if (uni.getSystemInfoSync().platform === "android") {
  597. currentStage = "request-app-upgrade";
  598. try {
  599. const appUpgradeResponse = await requestAppUpgradeInfo();
  600. if (
  601. shouldPrioritizeAppUpgrade(
  602. appUpgradeResponse,
  603. plus.runtime.version
  604. )
  605. ) {
  606. finalResult = {
  607. status: "fallback-app-check-version",
  608. message: "检测到新的 APK,优先执行整包更新",
  609. data: appUpgradeResponse.data,
  610. };
  611. return finalResult;
  612. }
  613. } catch (error) {
  614. // APK 检查失败时不阻断原有 WGT 更新能力。
  615. console.warn("[hot-update] APK 更新检查失败,继续检查 WGT", error);
  616. }
  617. }
  618. currentStage = "read-local-version";
  619. const wgtInfo = await getCurrentWgtInfo();
  620. currentStage = "request-server";
  621. const response = await requestHotUpdateInfo();
  622. const updateResult = normalizeUpdateResult(response, wgtInfo.version);
  623. if (!updateResult.shouldUpdate) {
  624. finalResult = {
  625. status: updateResult.reason,
  626. message: updateResult.message,
  627. data: updateResult.payload || null,
  628. };
  629. return finalResult;
  630. }
  631. currentStage = "confirm";
  632. const confirmed = await confirmHotUpdate(updateResult.payload);
  633. if (!confirmed) {
  634. finalResult = {
  635. status: "cancelled",
  636. message: "用户取消本次热更新",
  637. };
  638. return finalResult;
  639. }
  640. currentStage = "download";
  641. const filePath = await downloadWgtPackage(updateResult.payload.wgtUrl);
  642. currentStage = "install";
  643. await installWgtPackage(filePath, wgtInfo.appid);
  644. currentStage = "restart";
  645. await restartAppAfterInstall(updateResult.payload.version);
  646. finalResult = {
  647. status: "restarted",
  648. message: "热更新安装完成,应用已触发重启",
  649. };
  650. return finalResult;
  651. } catch (error) {
  652. console.error("[hot-update] 执行失败:", currentStage, error);
  653. if (currentStage === "download") {
  654. showHotUpdateError(error, "下载失败");
  655. } else if (currentStage === "install" || currentStage === "restart") {
  656. showHotUpdateError(error, "安装失败");
  657. } else {
  658. /**
  659. * 检查阶段失败只打日志,不主动打扰用户。
  660. *
  661. * 为什么这么处理:
  662. * - 当前项目 onLaunch 里还有数据库初始化、url scheme 参数接收等逻辑。
  663. * - 热更新检查只是“加分项”,不应该因为检查失败阻断原有启动流程。
  664. * - 这样最符合“最小侵入式改造”的目标。
  665. */
  666. }
  667. finalResult = {
  668. status: "error",
  669. stage: currentStage,
  670. error,
  671. };
  672. return finalResult;
  673. } finally {
  674. if (finalResult?.status === "fallback-app-check-version") {
  675. uni.setStorageSync(HOT_UPDATE_FALLBACK_PENDING_KEY, "1");
  676. uni.$emit(HOT_UPDATE_FALLBACK_APP_CHECK_EVENT, finalResult);
  677. }
  678. }
  679. // #endif
  680. return {
  681. status: "skip-non-app-plus",
  682. message: "当前不是 APP-PLUS 环境,跳过 .wgt 热更新检查",
  683. };
  684. };
  685. /**
  686. * 在任意页面均可调用的热更新入口。
  687. *
  688. * - 同一时刻只执行一个检查/下载/安装流程。
  689. * - 自动触发默认受三十秒检查间隔限制。
  690. * - 用户主动点击“检查更新”时传 { forceCheck: true } 可忽略时间间隔。
  691. */
  692. export const runWgtHotUpdate = ({ forceCheck = false } = {}) => {
  693. // #ifdef APP-PLUS
  694. clearLegacyHotUpdateLock();
  695. if (hotUpdatePromise) {
  696. return hotUpdatePromise;
  697. }
  698. const now = Date.now();
  699. if (!forceCheck && now - lastCheckStartedAt < HOT_UPDATE_CHECK_INTERVAL) {
  700. return Promise.resolve({
  701. status: "throttled",
  702. message: "距离上次热更新检查时间较短,跳过重复检查",
  703. });
  704. }
  705. lastCheckStartedAt = now;
  706. hotUpdatePromise = executeWgtHotUpdate().finally(() => {
  707. hotUpdatePromise = null;
  708. });
  709. return hotUpdatePromise;
  710. // #endif
  711. return Promise.resolve({
  712. status: "skip-non-app-plus",
  713. message: "当前不是 APP-PLUS 环境,跳过 .wgt 热更新检查",
  714. });
  715. };