uni-pushy-client

简介

Uni-pushy 的客户端 sdk。零依赖实现 uni-app 的热更新。非常容易集成。后续开放自定义处理更新逻辑~

快速上手

安装

npm i @limm/uni-pushy-client

使用

${app/src/utils/pushy/index.js}

import Pushy from '@limm/uni-pushy-client'

export default new Pushy({
  // 项目id
  projectId: 'c187ac54ddcdef8fdba2558c30da62e5',
  // 更新地址
  updateUrl: 'https://api.uni-pushy.yoouu.cn',
  // 主题色
  mainColor: '722ed1',
  // logo
  logo: '/static/images/update/ic_ar.png',
  // 是否打开检查更新
  update: true,
})

constructor(options)

projectId 项目 id 默认: '' uni-pushy-admin 创建的项目 id
updateUrl 默认: '' uni-pushy-server 部署可访问的地址
mainColor 项目 id 默认: 'FF5B78'
logo 弹窗图标 url / 相当于项目根目录（cli 创建的项目为 src）默认: ''
update 是否打开检查更新默认：true
返回：更新对象

检查更新 - getUpdate()

const res = await pushy.getUpdate()

pushy.getUpdate() : Promise

该方法只会 resolve，参数为包装过后的结果对象

statusCode 状态码，执行该方法之后的结果主要根据状态码进行判断
- 251 需要更新原生版本附带 data、response
- 252 需要更新 wgt 版本附带：message、data、 response
- 253 暂无更新附带：message、response
- 254 请求成功，但接口响应返回失败附带： message， response
- 451 更新被关闭，用户手动配置关闭了附带： message
- 452 用户未配置更新地址附带： message
- 453 无项目 ID 或项目 ID 不正确附带： message
- 473 正在检查更新附带： message
- 474 正在静默更新附带： message
- 475 已经静默更新完成，需要重启 App 生效附带： message
- 500 请求失败附带： message、error
- 505 占位，应该不会返回这个
message 信息描述
data native 或者 wgt 包信息
response 原生响应对象
error 原生错误对象

获取信息 - getInfo()

const res = await pushy.getInfo()

pushy.getInfo() : Promise

该方法只会 resolve，返回属性

const res = {
  //
  appid: '__UNI__70FC0DB',
  // 原生（基座） 版本名
  nativeVersion: '1.3.0',
  // 原生（基座） 版本号
  nativeVersionCode: 130,
  // wgt 版本名
  wgtVersion: '1.3.0',
  // wgt 版本号
  wgtVersionCode: 130,
  // uni.getSystemInfoSync() 返回一致
  systemInfo: {
    errMsg: 'getSystemInfoSync:ok',
    brand: 'OPPO',
    model: 'PCLM10',
    pixelRatio: 3,
    screenWidth: 360,
    screenHeight: 640,
    windowWidth: 360,
    windowHeight: 640,
    statusBarHeight: 24,
    language: 'zh-CN',
    system: '7.1.2',
    version: '1.9.9.80492',
    fontSizeSetting: '',
    platform: 'android',
    SDKVersion: '',
    windowTop: 0,
    windowBottom: 0,
    safeArea: {
      left: 0,
      right: 360,
      top: 24,
      bottom: 640,
      width: 360,
      height: 616,
    },
    safeAreaInsets: {
      top: 24,
      right: 0,
      bottom: 0,
      left: 0,
    },
    uuid: '865166023573440',
  },
  // 个人配置
  _config: {
    projectId: '',
    update: true,
    updateUrl: 'http://10.0.0.3:8081',
    log: false,
    mainColor: '722ed1',
    logo: '/static/images/update/ic_ar.png',
  },
  // 生效的配置
  _workSetting: {
    updateUrl: 'http://10.0.0.3:8081',
    log: false,
    mainColor: '722ed1',
    logo: '/static/images/update/ic_ar.png',
  },
}

最佳实践

全局只创建一个 Pushy 对象，之后 App 的更新都使用该对象来完成。例如我们的项目：

${app/src/utils/pushy/index

import config from '@/config/index'
import Pushy from '@limm/uni-pushy-client'

export default new Pushy({
  // 项目id
  projectId: config.get('UPDATE_PROJECT_ID'),
  // 更新地址
  updateUrl: config.get('UPDATE_BASE_API'),
  // 是否打开log
  log: config.get('UPDATE_DEBUG'),
  // 主题色
  mainColor: '722ed1',
  // logo
  logo: '/static/images/update/ic_ar.png',
})

在 App.vue 的 onLaunch 中检查更新一次即可。就是这么简单。

${app/src/App.vue

// #ifdef APP-PLUS
import pushy from '@/utils/pushy/index'
// #endif

export default {
  onLaunch: function () {
    console.log('App Launch')
    // #ifdef APP-PLUS
    // 锁定屏幕
    plus.screen.lockOrientation('portrait-primary')
    // 检查更新
    pushy.getUpdate()
    // #endif
  },

  onShow: function () {
    console.log('App Show')
  },

  onHide: function () {
    console.log('App Hide')
  },
}

如果有更新就会弹出更新框了，当然这是后台配置的。

发布订阅

wip

更新类型

静默更新

用户无感知，自动在后台下载更新安装，下次启动 app 显示新版本。

强制更新

用户感知，打开 app，或者检查更新直接下载安装，安装完成后提示用户，软重启之后生效。

普通更新

用户感知，打开 app，或者检查更新需要用户同意更新后，下载更新自动安装，安装完成后提示用户，软重启之后生效。

cryptopeng / uni-pushy-client