uni-app和Node.js实现app更新功能

业务背景

uniapp 打包 iosandroid 之后,有时候紧急修复或修改 ui,还需要走应用市场审核,往往审核时间就需要几天,如果是有bug需要升级就会很着急,有热更之后,可以避免应用市场长时间审核,用户很快就能收到更新。

整体思路:

要在uni-app中实现app更新功能,并使用Node.js作为后端服务,可以按照以下思路和步骤进行:

1、后端服务

  • 使用Express创建一个简单的Web服务器。
  • 提供两个API接口:
    • /checkForUpdate/:version 用于检查是否有新版本。
    • /downloadApp/:version 用于下载app。

2、uni-app前端

  • 在页面加载时调用checkForUpdate方法检查是否有新版本。
  • 如果有新版本,弹出提示框询问用户是否要更新。
  • 如果用户选择更新,则下载新版本文件并下载安装过程。

步骤一 创建Node.js后端服务

1、安装必要依赖:

  • 安装 express 或其他 Node.js web 框架来做后端服务。
  • 安装 cors 用于处理跨域请求。
npm install express cors

2、创建一个简单的后端服务:

  • 在项目根目录下创建一个名为 public 的文件夹,并在其中创建一个名为 apps 的文件夹用于存放要更新的 App
  • 将app打包好的app命名为:appx.x.x.wgtapp更新文件放到 apps 文件夹中。
  • 在项目根目录下创建一个名为 server.js 的文件,并写入以下代码:

// app更新
const express = require('express'); // 导入 Express 模块
const cors = require('cors'); // 导入 CORS 模块,用于处理跨域请求
const fs = require('node:fs'); // node内置模块,用于文件系统操作。
const path = require('node:path');//node内置模块,用于处理文件路径。

const app = express(); // 创建 Express 应用实例。

app.use(cors()); // 使用 CORS 中间件解决跨越请求。

// 配置静态文件服务,使得/public路径下的文件可以直接访问,如果没有请手动创建。
app.use('/public', express.static(path.join(__dirname, 'public')));

// 存放app版本的文件夹,如果没有请手动创建。
const appDir = path.join(__dirname, 'public/apps');

// 服务器的地址 类似于:http://localhost:3000
let serverAddress = ''

/**
 * 根据客户端提供的版本号检查是否有新版本。
 */
app.get('/checkForUpdate/:version', async (req, res) => {

  // uniapp当前版本号
  const appCurrentVersion = req.params.version
  // uniapp最新版本号
  let appLatestVersion = ''

  try {
    // 读取存放app目录下的所有文件
    const files = fs.readdirSync(appDir);

    // 过滤出以app开头的文件
    const appFiles = files.filter(file => path.basename(file).startsWith('app'));

    // 对文件列表进行排序,按照版本号从小到大排序
    const sortedFiles = appFiles.sort((a, b) => {
      const aParts = a.split('.').map(Number);
      const bParts = b.split('.').map(Number);

      for (let i = 0; i < Math.max(aParts.length, bParts.length); i++) {
        if (aParts[i] > bParts[i]) return 1;
        if (aParts[i] < bParts[i]) return -1;
      }

      return 0;
    });

    // 数组中最后一项版本就是最大最新的版本
    appLatestVersion = sortedFiles.pop()

    // 再对当前文件进行处理 ,将 app1.0.3.wgt => '1.0.3'
    appLatestVersion = appLatestVersion.replace(/^app/, '').replace(/\.wgt$/, '')

  } catch (error) {
    throw new Error('Error reading public directory:' + error)
  }

  // 如果请求的版本小于最新版本,则提供下载链接
  if (appLatestVersion > appCurrentVersion) {
    res.send({
      version: appLatestVersion, // 当前最新版本
      url: `${serverAddress}/downloadApp/${appLatestVersion}`, // 更新下载地址
      update: true, // 是否更新
      mandatoryUpdate:true // 强制更新
    })
  } else {
    res.send({
      version: '',
      url: '',
      update: false,
      mandatoryUpdate:false
    })
  }
})

/**
 * 提供文件下载
 */
app.get('/downloadApp/:version', async (req, res) => {
  // 要下载的 app 版本号
  const version = req.params.version
  const appName = `app${version}.wgt`
  // app 存放路径
  const appFilePath = `${appDir}/${appName}`

  // 检查文件是否存在
  fs.stat(appFilePath, (err, stats) => {
    if (err) {
      throw new Error(`未找到 app${version}版本下载地址`)
    }

    // 设置响应头
    // 指示浏览器以下载的方式处理文件,并设置文件名。
    res.setHeader('Content-Disposition', `attachment; filename=${appName}`);
    // 表示文件类型未知或二进制文件。
    res.setHeader('Content-Type', 'application/octet-stream');

    // 创建文件流
    const fileStream = fs.createReadStream(appFilePath);

    // 当文件流结束时,关闭响应
    fileStream.on('end', () => {
      console.log('File download completed.');
    });

    // 如果发生错误,处理错误
    fileStream.on('error', (error) => {
      throw new Error('Error downloading the file.:' + error)
    });

    // 将文件流管道发送到客户端
    fileStream.pipe(res);
  });
})

const port = 3000; // 设置应用监听的端口号
// 启动服务器并监听端口
const server = app.listen(port, () => {
  // 获取服务器绑定的地址信息
  const addressInfo = server.address();
  const host = addressInfo.address === '::' ? 'localhost' : addressInfo.address;
  const port = addressInfo.port;
  serverAddress = `http://${host}:${port}`
  console.log(`Server is running at http://${host}:${port}`);
});

3. 启动后端服务

打开终端,进入到项目根目录,执行以下命令:

node server.js

步骤二 创建uni-app前端应用

1、创建uni-app项目

打开HBuilderX 选择菜单栏上的 [文件] -> [新建] -> [项目] 创建一个新的uni-app项目。

WX20240818-204702.png

2、实现检查更新逻辑

打开项目根目录下的pages/index/index.vue文件,新增checkForUpdate方法,并在onLoad生命周期中调用该方法。

<template>
    <text class="title" style="text-align: center;">
        当前app资源版本为:{{appWgtVersion}}
    </text>
</template>

<script setup>
import { ref } from 'vue'
import { onLoad } from '@dcloudio/uni-app'
const appWgtVersion = ref('')

// 在页面加载时调用checkForUpdate方法检查是否有新版本。
onLoad(() => {
    checkForUpdate()
})

/**
 * 检查是否需要更新app
 */
function checkForUpdate() {
    // 只在 app 中才会执行以下代码
    // #ifdef APP-PLUS
    // 获取手机系统信息
    const systemInfo = uni.getSystemInfoSync()
    // 获取到 app 资源包版本
    appWgtVersion.value = systemInfo.appWgtVersion
    // 向 Node.js 后端发送请求检查是否需要更新
    uni.request({
        url: 'http://192.168.43.245:3000/checkForUpdate/' + appWgtVersion.value,
        success: (res) => {
            console.log('request-res', res);
            if (res.data && res.data.update) {
                uni.showModal({
                    title: '新版本发布',
                    content: '检查到当前有新版本,需要更新吗?',
                    showCancel: true,
                    confirmText: '立即更新',
                    cancelText: '暂不更新',
                    // 接口调用成功
                    success: (modalRes) => {
                        if (modalRes.confirm) {
                            // 立即更新app操作
                            uni.showLoading({
                                title: '正在下载'
                            })
                            console.log('res.data.url',res.data.url);
                            // 开始下载任务
                            const downloadTask = uni.downloadFile({
                                url: res.data.url,
                                success: (downloadRes) => {
                                    if (downloadRes.statusCode === 200) {
                                        uni.showLoading({
                                            title: '正在安装更新...'
                                        });
                                        plus.runtime.install(downloadRes.tempFilePath, {
                                            force: true
                                        }, () => {
                                            console.log('install success...');
                                            uni.hideLoading()
                                            plus.runtime.restart();
                                        }, (e) => {
                                            console.log('install fail...', e);
                                            uni.hideLoading()
                                            uni.showToast({
                                                title: '安装失败:' + JSON.stringify(e),
                                                icon: 'fail',
                                                duration: 1500
                                            });
                                        });
                                        setTimeout(() => {
                                            uni.hideLoading();
                                            uni.showToast({
                                                title: '安装成功!',
                                                icon: 'none'
                                            });
                                        }, 3000);
                                    }
                                },
                                // 接口调用失败
                                fail: (fail) => {
                                    console.log('网络错误,下载失败!', fail);
                                    uni.hideLoading();
                                },
                                // 接口调用结束
                                complete: () => {
                                    console.log('----------------Complete----------------:', downloadTask)
                                    downloadTask.offProgressUpdate(); //取消监听加载进度
                                }
                            });
                            //监听下载进度
                            downloadTask.onProgressUpdate(res => {
                                // console.log('下载进度百分比:' + res.progress); // 下载进度百分比
                                // console.log('已经下载的数据长度:' + res.totalBytesWritten); // 已经下载的数据长度,单位 Bytes
                                // console.log('预期需要下载的数据总长度:' + res.totalBytesExpectedToWrite); // 预期需要下载的数据总长度,单位 Bytes
                            });
                        } else {
                            // 暂不更新app操作
                            // 如果是你的发布需要强制更新的话,不更新app可以直接退出 APP 不让使用
                            if(res.data.mandatoryUpdate){
                                if (systemInfo.platform === 'android') {
                                    // 安卓退出app
                                    plus.runtime.quit();
                                } else {
                                    // 判断为ios的手机,退出App
                                    plus.ios.import("UIApplication").sharedApplication().performSelector("exit");
                                }
                            }
                        }
                    }
                });
            }
        },
        fail: (fail) => {
            console.log('检查更新请求失败!', fail);
        }
    });
    // #endif
}
</script>

3、制作应用wgt包

1、打开项目根目录下的manifest.json配置文件,在基础设置中将应用版本名称设置为1.0.2

WX20240818-215321.png

2、选择菜单栏上的 [发行] -> [原生App-制作应用wgt包]

WX20240818-223458.png

3、将打包好的wgt包更名为app1.0.2.wgt

后端是按照这个命名规范来进行升级的,所以我们按照这个规范来。

WX20240818-223735.png

4、将打包好的app1.0.2.wgt包放在后端服务器的/public/apps文件夹中。

4、测试app更新功能

1、打开项目根目录下的manifest.json配置文件,在基础设置中将应用版本名称设置为1.0.0,只要低于服务器中的版本即可。

2、运行app到手机

运行到手机后,页面会弹出更新提示框

点击“立即更新”按钮

app会自动下载并安装更新,安装更新后的app后,会自动启动并运行。

3.gif
点击“稍后更新”按钮

在App非强制更新的情况下则关闭更新提示框

2.gif
点击“稍后更新”按钮

在App强制更新的情况下则退出App

1.gif

注意事项

  • 确保Node.js后端服务和uni-app前端应用在同一网络环境中运行。
  • 测试时,请确保文件路径和URL正确无误。

以上步骤提供了一个基本的uni-app和Node.js实现app更新功能的示例。你可以根据具体需求进行调整和扩展。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容