npm包&全局数据共享&分包
使用npm包
目前,小程序中已经支持使用 npm 安装第三方包,从而来提高小程序的开发效率。但是,在小程序中使用 npm 包有如下 3 个限制:
- 不支持依赖于 Node.js 内置库的包
- 不支持依赖于浏览器内置对象的包
- 不支持依赖于 C++ 插件的包
总结:虽然 npm 上的包有千千万,但是能供小程序使用的包却“为数不多”。
Vant Weapp
Vant Weapp 是有赞前端团队开源的一套小程序 UI 组件库,助力开发者快速搭建小程序应用。它所使用的是 MIT 开源许可协议,对商业使用比较友好。
官方文档地址 https://youzan.github.io/vant-weapp
使用 Vant 组件库
先在当前界面打开终端,生成package.json
npm init -y or yarn init --yes
根据官方提供的快速上手教程安装 Vant 库
https://youzan.github.io/vant-weapp/#/quickstart#an-zhuang
安装完 Vant 组件库之后,可以在 app.json 的 usingComponents 节点中引入需要的组件,即可在 wxml 中直接使用组件
"usingComponents": {
"van-button": "@vant/weapp/button/index"
}
// 页面的 .wxml 结构
<vant-utton type="primary">按钮</van-button>
定制全局主题样式
Vant Weapp 使用 CSS 变量来实现定制主题。 关于 CSS 变量的基本用法,请参考 MDN 文档:
https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_custom_properties
在 app.wxss 中,写入 CSS 变量,即可对全局生效:
page {
<!-- 设置vant-button的危险按钮的样式 -->
--button-danger-background-color: #c00000;
--button-danger-border-color: #d60000;
}
API Promise化
基于回调函数的异步 API 的缺点
默认情况下,小程序官方提供的异步 API 都是基于回调函数实现的,例如,网络请求的 API 需要按照如下的方式调用,缺点:容易造成回调地狱的问题,代码的可读性、维护性差
wx.request({
url: '',
method: '',
data: {},
success: () => {},
fail: () => {},
complete: () => {}
})
API Promise 化
API Promise化,指的是通过额外的配置,将官方提供的、基于回调函数的异步 API,升级改造为基于 Promise 的异步 API,从而提高代码的可读性、维护性,避免回调地狱的问题。
在小程序中,实现 API Promise 化主要依赖于 miniprogram-api-promise 这个第三方的 npm 包。它的安装和使用步骤如下:
npm install --save miniprogram-api-promise@1.0.4
# 安装后记得重新构建 npm
// 在 app.js,只需调用一次 promisefyAll 方法,即可实现异步 API 的 promise 化
import { promisifyAll } from 'minoprogram-api-promise'
const wxp = wx.p = {}
promisifyAll(wx, wxp)
// 页面的 .wxml
<van-button type="danger" bind:tap="getInfo">vant按钮</van-button>
// 页面的 .js,定义对应的 tap 事件处理函数
async getInfo() {
const { data: res } = await wx.p.reqeust({
method: 'GET',
url: 'https://www.escook.cn/api/get',
data: { name: 'zs', age: 20 }
})
console.log(res)
}
全局数据共享
全局数据共享(又叫做:状态管理)是为了解决组件之间数据共享的问题。
开发中常用的全局数据共享方案有:Vuex、Redux、MobX 等。
在小程序中,可使用 mobx-miniprogram 配合 mobx-miniprogram-bindings 实现全局数据共享。其中:
- mobx-miniprogram 用来创建 Store 实例对象
- mobx-miniprogram-bindings 用来把 Store 中的共享数据或方法,绑定到组件或页面中使用
MobX
安装Mobx
npm install --save mobx-miniprogram@4.13.2 mobx-miniprogram-bindings@1.2.1
注意:MobX 相关的包安装完毕之后,记得删除 miniprogram_npm 目录后,重新构建 npm。
创建 Store 实例
// 根目录下的 store 目录下的 store.js
import { action, observable } from 'mobx-miniprogram'
export const store = observable({
// 数据字段
numA: 1,
numB: 2,
// 计算属性
get sum() {
return this.numA + this.numB
},
// actions 函数
updateNumA: action(function(step) {
this.numA += step
}),
// 可以用箭头函数,但会改变 this 的指向,无法获得numB
updateNumB: action(function(step) {
this.numB += step
})
})
在页面上使用store
导入store
// 再页面的 .js 文件中
import { createStoreBindings } from 'mobx-miniprogram-bindings'
import { store } from '../../store/store'
Page({
// 生命周期函数--监听页面加载
onLoad(options) {
// 给this添加个属性 storeBindings
// 并将指定的数据、方法绑定到当前页面的Page对象(this)上
this.storeBindings = createStoreBindings(this, {
store, // 仓库对象
// 想改用别的变量名可以用对象的形式挂载
// 指定的数据字段和计算属性会被挂载到 this.data 上
fields: ['numA', 'numB', 'sum'], // 仓库对象中的数据字段和计算属性
// 指定的action函数会被挂载到 this 上
actions: ['updateNumA', 'unpdateNumB'] // 仓库的action函数
})
},
// 生命周期函数--监听页面卸载
onUnload() {
// 销毁该属性
this.storeBindings.destroyStoreBindings()
},
})
使用Store
// wxml 中
<view>
<van-button type="danger" bind:tap="num1Add" data-count="1">让第一个数+1</van-button>
<van-button type="danger" bind:tap="num2Add" data-count="{{1}}">让第二个数+1</van-button>
<view>{{numA}} + {{numB}} = {{sum}}</view>
</view>
// 页面 js 中
num1Add(e) {
// e.taget.dataset的属性默认是字符串,需要转成Number
// 可以在传参是用 {{num}} 的形式,这样 num 就是Number
this.updateNumA(+e.target.dataset.count)
},
num2Add(e) {
this.updateNumB(e.target.dataset.count)
},
在组件中使用store
// 在组件的 js 中
import { storeBindingsBehavior } from 'mobx-miniprogram-bindings'
import { store } from '../../store/store'
Component({
// 通过 storeBindingsBehavior 实现自动绑定
behaviors: [storeBindingsBehavior],
storeBindings: {
store,
// 用数组也行,想改用别的变量名就用对象
//fields: ['numA'],
fields: {
numA: () => store.numA, // 绑定字段的第一种方式
numB: (store) => store.numB, // 绑定字段的第二张方式
sum: 'num'
},
// actions: ['updateNumA']
actions: {
updateNumA: 'updateNumA'
}
},
methods: {
num1Add(e) {
this.updateNumA(e.target.dataset.count)
}
}
// 组件的 wxml 中
<view>
<van-button type="danger" bind:tap="num1Add" data-count="{{1}}">让第一个数+1</van-button>
<view>{{numA}} + {{numB}} = {{sum}}</view>
</view>
分包
分包指的是把一个完整的小程序项目,按照需求划分为不同的子包,在构建时打包成不同的分包,用户在使用时按需进行加载。
对小程序进行分包的好处主要有以下两点:
- 可以优化小程序首次启动的下载时间:用户使用小程序时不需要一次性下载,可以根据加载的页面下载部分包
- 在多团队共同开发时可以更好的解耦协作
基础概念
分包前后项目的构成
分包前,小程序项目中所有的页面和资源都被打包到了一起,导致整个项目体积过大,影响小程序首次启动的下载时间。
分包后,小程序项目由 1 个主包 + 多个分包组成:
- 主包:一般只包含项目的启动页面或 TabBar 页面、以及所有分包都需要用到的一些公共资源
- 分包:只包含和当前分包有关的页面和私有资源
分包的加载规则和体积限制
在小程序启动时,默认会下载主包并启动主包内页面
- tabBar 页面需要放到主包中
当用户进入分包内某个页面时,客户端会把对应分包下载下来,下载完成后再进行展示
- 非 tabBar 页面可以按照功能的不同,划分为不同的分包之后,进行按需下载
目前,小程序分包的大小有以下两个限制:
- 整个小程序所有分包大小不超过 16M(主包 + 所有分包)
- 单个分包/主包大小不能超过 2M
- 注:这个限制是2021年的,现在可能变了,实际限制要看帮助文档
使用方法
配置方法
打包原则
- 小程序会按 subpackages 的配置进行分包,subpackages 之外的目录将被打包到主包中
- 主包也可以有自己的 pages(即最外层的 pages 字段)
- tabBar 页面必须在主包内
- 分包之间不能互相嵌套
引用原则
- 主包无法引用分包内的私有资源
- 分包之间不能相互引用私有资源
- 分包可以引用主包内的公共资源
独立分包
独立分包本质上也是分包,只不过它比较特殊,可以独立于主包和其他分包而单独运行。
独立分包和普通分包的区别
最主要的区别:是否依赖于主包才能运行
- 普通分包必须依赖于主包才能运行
- 独立分包可以在不下载主包的情况下,独立运行
独立分包的应用场景
开发者可以按需,将某些具有一定功能独立性的页面配置到独立分包中。原因如下:
- 当小程序从普通的分包页面启动时,需要首先下载主包
- 而独立分包不依赖主包即可运行,可以很大程度上提升分包页面的启动速度
注意:一个小程序中可以有多个独立分包。
配置方法
引用原则
独立分包和普通分包以及主包之间,是相互隔绝的,不能相互引用彼此的资源!例如:
- 主包无法引用独立分包内的私有资源
- 独立分包之间,不能相互引用私有资源
- 独立分包和普通分包之间,不能相互引用私有资源
- 特别注意:独立分包中不能引用主包内的公共资源
分包预下载
分包预下载指的是:在进入小程序的某个页面时,由框架自动预下载可能需要的分包,从而提升进入后续分包页面时的启动速度。
注意:同一个分包中的页面享有共同的预下载大小限额 2M
预下载分包的行为,会在进入指定的页面时触发。在 app.json 中,使用 preloadRule 节点定义分包的预下载规则,示例代码如下:
自定义tabBar
自定义 tabBar 分为 3 大步骤,分别是:
- 配置信息
- 添加 tabBar 代码文件
- 编写 tabBar 代码
详细步骤,可以参考小程序官方给出的文档:
https://developers.weixin.qq.com/miniprogram/dev/framework/ability/custom-tabbar.html