微信小程序 npm包、全局数据共享、分包

阅读原文时间：2023年07月08日阅读：1

【黑马程序员前端微信小程序开发教程，微信小程序从基础到发布全流程_企业级商城实战(含uni-app项目多端部署)】 https://www.bilibili.com/video/BV1834y1676P/?p=91&share_source=copy_web&vd_source=03c1dc52eeb3747825ecad0412c18ab1

npm包

目前，小程序中已经支持使用 npm 安装第三方包，从而来提高小程序的开发效率。但是，在小程序中使用npm 包有如下 3 个限制：

① 不支持依赖于 Node.js 内置库的包

② 不支持依赖于浏览器内置对象的包

③ 不支持依赖于 C++ 插件的包

总结：虽然 npm 上的包有千千万，但是能供小程序使用的包却“为数不多”。

1. 什么是 Vant Weapp

Vant Weapp 是有赞前端团队开源的一套小程序 UI 组件库，助力开发者快速搭建小程序应用。它所使用的是

MIT 开源许可协议，对商业使用比较友好。

官方文档地址 https://youzan.github.io/vant-weapp

找到微信小程序：Vant组件库演示

2. 安装 Vant 组件库

在小程序项目中，安装 Vant 组件库主要分为如下 3 步：

① 通过 npm 安装（建议指定版本为@1.3.3）

② 构建 npm 包

③ 修改 app.json

详细的操作步骤，大家可以参考 Vant 官方提供的快速上手教程：

https://youzan.github.io/vant-weapp/#/quickstart#an-zhuang

步骤一：

话说没下Node.js和npm的记得下载，在cmd里执行 npm-v 出现版本号说明没问题了

(以前想学angular的时候下过node.js,后来abandon了，但是node.js就留下了，看来，做事情哪怕abandon了也不是完全没有收获。比如收获了费劲脑汁的安装经验)

在文件的空白区域，右击在外部终端窗口打开，打不开的可以换成在内建终端中打开

初始化npm init -y,初始化一个包管理文件，叫package.json

安装vant,需要指定版本号 npm i @vant/weapp@1.3.3 -S --production

（然后我就报错了，后面我是使用管理员权限打开powershell,进入到目录里，再次执行，成功）

步骤二：跟着vant的文档走

https://youzan.github.io/vant-weapp/#/quickstart#an-zhuang

黑马的视频有点老了是旧版的，所以不要跟着视频走

目前的时间是2023/06/08

步骤三：构建 npm

打开微信开发者工具，点击工具 -> 构建 npm，构建完成后，即可引入组件。

(在本地设置里找不到npm选项的原因：目前版本不需要手动选择NPM模块了只需要npm init 之后在工具中构建即可,就是已经自动勾选了)

3. 使用 Vant 组件

安装完 Vant 组件库之后，可以在 app.json 的 usingComponents 节点中引入需要的组件，即可在 wxml 中直接使用组件。需要啥就去官网扒拉就行

4. 定制全局主题样式

Vant Weapp 使用 CSS 变量来实现定制主题。关于 CSS 变量的基本用法，请参考 MDN 文档：

https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_custom_properties

html{
--main-redcolor:#C00000;
}
.box1,.box2{
background-color:var(--main-redcolor)
}
.box3{
color:var(--main-redcolor)
}

5. 定制全局主题样式

在 app.wxss 中，写入 CSS 变量，即可对全局生效：

所有可用的颜色变量，请参考 Vant 官方提供的配置文件：

https://github.com/youzan/vant-weapp/blob/dev/packages/common/style/var.less

在github上，记得使用魔法

/*app.wxss*/
page{
/*这个改的是type为danger的button*/
    --button-danger-background-color:#C00000;
    --button-danger-border-color:#D60000;

    /* 从vant官方把less文件抄过来，然后
    进行小改造
    @button-primary-background-color:@green
    @button-primary-border-color:@green
     */
     /*这个改的是type为primary的button*/
     --button-primary-background-color:#13A7A0;
     --button-primary-border-color:#15B4AA;
}

1. 基于回调函数的异步 API 的缺点

默认情况下，小程序官方提供的异步 API 都是基于回调函数实现的，例如，网络请求的 API 需要按照如下的方式调用：

wx.request({
        url: 'url',
    method:'',
        data:{},
        success:()=>{},//请求成功的回调函数
        fail:()=>{},//请求失败的回调函数
    complete:()=>{},//请求完成的回调函数
      }),

缺点：容易造成回调地狱的问题，代码的可读性、维护性差

2. 什么是 API Promise 化

API Promise化，指的是通过额外的配置，将官方提供的、基于回调函数的异步 API，升级改造为基于Promise 的异步 API，从而提高代码的可读性、维护性，避免回调地狱的问题。

3. 实现 API Promise 化

在小程序中，实现 API Promise 化主要依赖于 miniprogram-api-promise 这个第三方的 npm 包。它的安装和使用步骤如下：

还是管理员 powershell 进目录 npm install --save miniprogram-api-promise@1.0.4

miniprogram_npm文件夹删除后，直接npm构建就行。

不删的话又可能报错，比如我。

//在小程序入口文件中(app.js)，只需调用一次 promisifyAll(）方法,
//即可实现异步API的 Promise 化
//注意这个和js的app)({})同级，不要放进去了。
import {promisifyAll } from 'miniprogram-api-promise'
const wxp = wx.p = {}
//promisify all wx's api
promisifyAll(wx,wxp)

4. 调用 Promise 化之后的异步 API

某页面的wxjs文件,在Page({})里面

async getInfo(){
        const{data: res }= await wx.p.request({
          url: 'https://applet-base-api-t.itheima.net/api/get',
          method:'GET',
          data:{
              name:'zs',
              age:20
          }
        })
        console.log(res)
    },

全局数据共享

全局数据共享（又叫做：状态管理）是为了解决组件之间数据共享的问题。

开发中常用的全局数据共享方案有：Vuex、Redux、MobX 等

在小程序中，可使用 mobx-miniprogram 配合 mobx-miniprogram-bindings 实现全局数据共享。其中：

mobx-miniprogram 用来创建 Store 实例对象
mobx-miniprogram-bindings 用来把 Store 中的共享数据或方法，绑定到组件或页面中使用

1. 安装 MobX 相关的包

在项目中运行如下的命令，安装 MobX 相关的包：

npm install --save mobx-miniprogram@4.13.2 mobx-miniprogram-bindings@1.2.1

注意：MobX 相关的包安装完毕之后，记得删除 miniprogram_npm 目录后，重新构建 npm

2. 创建 MobX 的 Store 实例

store/store.js

//在这个js文件中，专门用来创建Store 的实例对象
import {observable,action} from 'mobx-miniprogram'

export const store = observable({
//数据字段
numA:1,
numB:2,
//计算属性
get sum(){
    return this.numA + this.numB
},
//actions方法 用来修改store中的数据
updateNumA:action(function(step){
    this.numA +=step
}),
updateNumB:action(function(step){
    this.numB +=step
}),
})

3. 将 Store 中的成员绑定到页面中

页面的js

import {createStoreBindings}from 'mobx-miniprogram-bindings'
import {store} from '../../store/store'

Page({
  /**
   * 生命周期函数--监听页面加载
   */
  onLoad: function (options) {
   this.storeBindings = createStoreBindings(
       this,{
           store,
           fields:['numA','numB','sum'],
           actions:['updateNum1']
       })
  },
  /**
   * 生命周期函数--监听页面卸载
   */
  onUnload: function () {
    this.storeBindings.destroyStoreBindings()
  },
})

4. 在页面上使用 Store 中的成员

//wxml
<view>
{{numA}}+{{numB}} = {{sum}}
</view>
<van-button type="primary" bindtap="btnHandler1"
data-step="{{1}}"
>A+1</van-button>

<van-button type="danger" bindtap="btnHandler1"
data-step="{{-1}}"
>A-1</van-button>

//js
 btnHandler1(e){
    this.updateNumA(e.target.dataset.step)
},

5. 将 Store 中的成员绑定到组件中

import {storeBindingsBehavior} from 'mobx-miniprogram-bindings'
import {store} from '../../store/store'

// components/numbers/numbers.js
Component({
    //通过 storeBindingsBehavior来实现自动绑定
    behaviors:[storeBindingsBehavior],
    storeBindings:{
        //指定要绑定的store
        store,
        //指定要绑定的字段数据
        fields:{
            // 绑定字段的第一种方式
            numA:()=> store.numA,
            // 绑定字段的第二种方式
            numB:(store)=> store.numB,
            // 绑定字段的第三种方式
            // 第三种更简单
            sum:'sum'
        },
        // 指定要绑定的方法
        actions:{
            updateNumB:'updateNumB'
        }
    },
})

6. 在组件中使用 Store 中的成员

//wxml
<view>
{{numA}}+{{numB}} = {{sum}}
</view>
<van-button type="primary" bindtap="btnHandler2"
data-step="{{1}}"
>B+1</van-button>

<van-button type="danger" bindtap="btnHandler2"
data-step="{{-1}}"
>B-1</van-button>

//js
   methods: {
        btnHandler2(e){
            this.updateNumB(e.target.dataset.step)
        },
    }

分包

1. 什么是分包

分包指的是把一个完整的小程序项目，按照需求划分为不同的子包，在构建时打包成不同的分包，用户在使用

时按需进行加载

2. 分包的好处

对小程序进行分包的好处主要有以下两点：

可以优化小程序首次启动的下载时间
在多团队共同开发时可以更好的解耦协作

3. 分包前项目的构成

分包前，小程序项目中所有的页面和资源都被打包到了一起，导致整个项目体积过大，影响小程序首次启动的

下载时间。

小程序项目：所有页面（tabBar页面和其他页面）、公共资源（图片，wxjs,wxs,wxss….）

4. 分包后项目的构成

分包后，小程序项目由 1 个主包 + 多个分包组成：

主包：一般只包含项目的启动页面或 TabBar 页面、以及所有分包都需要用到的一些公共资源
分包：只包含和当前分包有关的页面和私有资源

5. 分包的加载规则

① 在小程序启动时，默认会下载主包并启动主包内页面

tabBar 页面需要放到主包中

② 当用户进入分包内某个页面时，客户端会把对应分包下载下来，下载完成后再进行展示

非 tabBar 页面可以按照功能的不同，划分为不同的分包之后，进行按需下载

6. 分包的体积限制

目前，小程序分包的大小有以下两个限制：

整个小程序所有分包大小不超过 16M（主包 + 所有分包）
单个分包/主包大小不能超过 2M

1. 配置方法

小程序的目录结构：app.js,app.json,app.wxss,pages,packageA,packageB,utils

pages 全局所有的界面
packageA 第一个分包里面有pages文件夹，pages里面有当前分包有关的页面和私有资源
packageB 第二个分包里面有pages文件夹，pages里面有当前分包有关的页面和私有资源

在app.json subpackages节点中

"subpackages": [
      {
          "root": "packageA",
          "pages": [
              "pages/cat/cat",
              "pages/dog/dog"
          ]
      },
      {
        "root": "packageB",
        "name": "pack2",
        "pages": [
            "pages/apple/apple",
            "pages/banana/banana"
        ]
      }
  ],

2. 打包原则

① 小程序会按 subpackages 的配置进行分包，subpackages 之外的目录将被打包到主包中

② 主包也可以有自己的 pages（即最外层的 pages 字段）

③ tabBar 页面必须在主包内

④ 分包之间不能互相嵌套

3. 引用原则

① 主包无法引用分包内的私有资源

② 分包之间不能相互引用私有资源

③ 分包可以引用主包内的公共资源

1. 什么是独立分包

独立分包本质上也是分包，只不过它比较特殊，可以独立于主包和其他分包而单独运行。

2. 独立分包和普通分包的区别

最主要的区别：是否依赖于主包才能运行

普通分包必须依赖于主包才能运行
独立分包可以在不下载主包的情况下，独立运行

3. 独立分包的应用场景

开发者可以按需，将某些具有一定功能独立性的页面配置到独立分包中。原因如下：

当小程序从普通的分包页面启动时，需要首先下载主包
而独立分包不依赖主包即可运行，可以很大程度上提升分包页面的启动速度

注意：一个小程序中可以有多个独立分包。

4. 独立分包的配置方法

"subpackages": [
      {
        "root": "packageB",
        "name": "pack2",
        "pages": [
            "pages/apple/apple",
            "pages/banana/banana"
        ],
        "independent": true
      }
  ],

5. 引用原则

独立分包和普通分包以及主包之间，是相互隔绝的，不能相互引用彼此的资源！例如：

① 主包无法引用独立分包内的私有资源

② 独立分包之间，不能相互引用私有资源

③ 独立分包和普通分包之间，不能相互引用私有资源

④ 特别注意：独立分包中不能引用主包内的公共资源

1. 什么是分包预下载

分包预下载指的是：在进入小程序的某个页面时，由框架自动预下载可能需要的分包，从而提升进入后续分包页面时的启动速度

2. 配置分包的预下载

预下载分包的行为，会在进入指定的页面时触发。在 app.json 中，使用 preloadRule 节点定义分包的预下载规则，

app.json

"preloadRule": {   分包预下载的规则

    "pages/contact/contact":{ 触发分包预下载的页面路径

        "network": "all", 指定网络模式下进行预下载，默认为wifi
        "packages": ["pkgA"] 预分包，可以通过name 或者root指定
    }
},

3. 分包预下载的限制

同一个分包中的页面享有共同的预下载大小限额 2M

自定义 tabBar

① 配置信息

② 添加 tabBar 代码文件

③ 编写 tabBar 代码

详细步骤，可以参考小程序官方给出的文档：

https://developers.weixin.qq.com/miniprogram/dev/framework/ability/custom-tabbar.html

custom-tab-bar/index.wxml

<!--custom-tab-bar/index.wxml-->
<van-tabbar active="{{ active }}" bind:change="onChange">
    <van-tabbar-item wx:for="{{ list }}" wx:key="index"
    info="{{item.info ? item.info : ''}}">
    <image
      slot="icon"
      src="{{ item.iconPath}}"
      mode="aspectFit"
      style="width: 25px; height: 25px;"
    />
    <image
      slot="icon-active"
      src="{{ item.selectedIconPath}}"
      mode="aspectFit"
      style="width: 25px; height: 25px;"
    />
{{item.text}}
</van-tabbar-item>
</van-tabbar>

custom-tab-bar/index.js

// custom-tab-bar/index.js
import {storeBindingsBehavior} from 'mobx-miniprogram-bindings'
import {store} from '../store/store'

Component({
    //通过 storeBindingsBehavior来实现自动绑定
    behaviors:[storeBindingsBehavior],
    storeBindings:{
        //指定要绑定的store
        store,
        //指定要绑定的字段数据
        fields:{
            active:'active',
            sum:'sum'
        },
        // 指定要绑定的方法
        actions:{
            updateActive:'updateActiveTabBarIndex'
        }
    },

    options:{
        styleIsolation:'shared'
    },
    /**
     * 组件的属性列表
     */
    properties: {

    },

    /**
     * 组件的初始数据
     */
    data: {
        list: [
            {
              "pagePath": "/pages/home/home",
              "text": "首页",
              "iconPath": "/images/tabs/home.png",
              "selectedIconPath": "/images/tabs/home-active.png",
              "info": 3
            },
            {
              "pagePath": "/pages/message/message",
              "text": "消息",
              "iconPath": "/images/tabs/message.png",
              "selectedIconPath": "/images/tabs/message-active.png"
            },
            {
              "pagePath": "/pages/contact/contact",
              "text": "联系我们",
              "iconPath": "/images/tabs/contact.png",
              "selectedIconPath": "/images/tabs/contact-active.png"
            }
          ]
    },
   observers:{
    "sum":function(sum){
        this.setData({
            'list[0].info':sum
        })
    }
   },
    /**
     * 组件的方法列表
     */
    methods: {
        onChange(event) {
            this.updateActive(event.detail)
            wx.switchTab({
              url: this.data.list[event.detail].pagePath,
            })
          },

    }
})