wechat-miniprogram / kbone

# 进阶用法

因为 Web 端和小程序端的差异性，此文档提供了一些进阶用法、优化方式和开发建议。

# 环境判断

对于开发者来说，可能需要针对不同端做一些特殊的逻辑，因此也就需要一个方法来判断区分不同的环境。kbone 推荐的做法是通过 webpack 注入一个环境变量：

// webpack.mp.config.js
module.exports = {
    plugins: [
        new webpack.DefinePlugin({
            'process.env.isMiniprogram': true,
        }),
        // ... other options
    ],
    // ... other options
}
1
2
3
4
5
6
7
8
9
10

后续在业务代码中，就可以通过 process.env.isMiniprogram 来判断是否在小程序环境：

if (process.env.isMiniprogram) {
    console.log('in miniprogram')
} else {
    console.log('in web')
}
1
2
3
4
5

# 多页开发

对于多页面的应用，在 Web 端可以直接通过 a 标签或者 location 对象进行跳转，但是在小程序中则行不通；同时 Web 端的页面 url 实现和小程序页面路由也是完全不一样的，因此对于多页开发最大的难点在于如何进行页面跳转。

  1. 修改 webpack 配置

对于多页应用，此处和 Web 端一致，有多少个页面就需要配置多少个入口文件。如下例子，这个应用中包含 page1、page2 和 page2 三个页面：

// webpack.mp.config.js
module.exports = {
    entry: {
        page1: path.resolve(__dirname, '../src/page1/main.mp.js'),
        page2: path.resolve(__dirname, '../src/page2/main.mp.js'),
        page3: path.resolve(__dirname, '../src/page3/main.mp.js'),
    },
    // ... other options
}
1
2
3
4
5
6
7
8
9
  1. 修改 webpack 插件配置

mp-webpack-plugin 这个插件的配置同样需要调整，需要开发者提供各个页面对应的 url 给 kbone。

module.exports = {
    origin: 'https://test.miniprogram.com',
    entry: '/page1',
    router: {
        page1: ['/(home|page1)?', '/test/(home|page1)'],
        page2: ['/test/page2/:id'],
        page3: ['/test/page3/:id'],
    },
    // ... other options
}
1
2
3
4
5
6
7
8
9
10

其中 origin 即 window.location.origin 字段，使用 kbone 的应用所有页面必须同源，不同源的页面禁止访问。entry 页面表示这个应用的入口 url。router 配置则是各个页面对应的 url，可以看到每个页面可能不止对应一个 url，而且这里的 url 支持参数配置。

有了以上几个配置后，就可以在 kbone 内使用 a 标签或者 location 对象进行跳转。kbone 会将要跳转的 url 进行解析，然后根据配置中的 origin 和 router 查找出对应的页面，然后拼出页面在小程序中的路由，最后通过小程序 API 进行跳转（利用 wx.redirectTo 等方法）。

PS：通过多页可以支持使用小程序 tabBar，还可以使用小程序分包与预下载机制，更多详细配置信息可以点此查看。

PS：具体例子可参考 demo5 (opens new window) 和 demo7 (opens new window)

# 使用小程序内置组件

需要明确的是，如果没有特殊需求的话，请尽量使用 html 标签来编写代码，使用内置组件时请按需使用。这是因为绝大部分内置组件外层都会被包裹一层自定义组件，如果自定义组件的实例数量达到一定量级的话，理论上是会对性能造成一定程度的影响，所以对于 view、text、image 等会被频繁使用的内置组件，如果没有特殊需求的话请直接使用 div、span、img 等 html 标签替代。

部分内置组件可以直接使用 html 标签替换，比如 input 组件可以使用 input 标签替换。目前已支持的可替换组件列表：

  • <input /> --> input 组件
  • <input type="radio" /> --> radio 组件
  • <input type="checkbox" /> --> checkbox 组件
  • <textarea></textarea> --> textarea 组件
  • <img /> --> image 组件
  • <video></video> --> video 组件
  • <canvas></canvas> --> canvas 组件

其他内置组件在 html 中没有标签可替换，那就需要使用 wx- 前缀，基本用法如下：

<!-- wx- 前缀用法 -->
<wx-picker mode="region" @change="onChange">选择城市</wx-picker>
<wx-button open-type="share" @click="onClickShare">分享</wx-button>
1
2
3

使用 wx- 前缀创建的内置组件，其对应的 dom 节点标签名统一是 WX-COMPONENT，dom 节点的 behavior 属性表示要渲染的组件名。

2.x 版本：基于基础库 2.11.2 的 virtual host 特性实现，除了 view 组件外会保留 0.x 版本的渲染方式，其他组件渲染模式和普通 div 标签无异，不会像 0.x 版本和 1.x 版本那样追加额外的包裹容器。如果基础库低于 2.11.2，则会自动降级到 1.x 渲染模式。

1.x 版本：内置组件的子组件会被包裹在一层自定义组件里面，因此内置组件和子组件之间会隔着一层容器，该容器会追加 h5-virtual 到 class 上（除了 view、cover-view 和 scroll-view 外，因为这些组件需要保留子组件的结构，所以沿用 0.x 版本的渲染方式）。如若需要，可以使用 generate.renderVersion 和 generate.elementVersion 配置来指定安装 1.x 版本。

0.x 版本：在 0.x 版本中，绝大部分内置组件在渲染时会在外面多包装一层自定义组件，可以近似认为内置组件和其父级节点中间会多一层 div 容器，所以会对部分样式有影响。这个 div 容器会追加一个名为 h5-小写标签名 的 class，以便对其做特殊处理。另外如果是用 wx- 前缀创建的内置组件，会在容器上追加的 class 是 h5-wx-component，为了更方便进行识别，这种情况会再在容器上额外追加 wx-组件名 的 class。

生成的结构大致如下：

<!-- 源码 -->
<div>
    <canvas>
        <div></div>
        <div></div>
    </canvas>
    <wx-map>
        <div></div>
        <div></div>
    </wx-map>
    <wx-scroll-view>
        <div></div>
        <div></div>
    </wx-scroll-view>
</div>

<!-- 2.x 版本生成的结构 -->
<view>
    <canvas class="h5-canvas wx-canvas wx-comp-canvas">
        <cover-view></cover-view>
        <cover-view></cover-view>
    </canvas>
    <map class="h5-wx-component wx-map wx-comp-map">
        <view></view>
        <view></view>
    </map>
    <scroll-view class="h5-wx-component wx-scroll-view wx-comp-scroll-view">
        <view></view>
        <view></view>
    </scroll-view>
</view>

<!-- 1.x 版本生成的结构 -->
<view>
    <!-- 可替换标签内置组件会追加“h5-小写标签名”的 class -->
    <canvas class="h5-canvas">
        <element class="h5-virtual">
            <cover-view></cover-view>
            <cover-view></cover-view>
        </element>
    </canvas>
    <!-- wx- 前缀创建的内置组件会追加“wx-组件名”的 class -->
    <map class="h5-wx-component wx-map">
        <element class="h5-virtual">
            <cover-view></cover-view>
            <cover-view></cover-view>
        </element>
    </map>
    <!-- scroll-view 沿用 0.x 版本结构 -->
    <element class="h5-wx-component wx-scroll-view">
        <scroll-view class="wx-comp-scroll-view">
            <view></view>
            <view></view>
        </scroll-view>
    </element>
</view>

<!-- 0.x 版本生成的结构 -->
<view>
    <!-- 可替换标签内置组件外包层会追加“h5-小写标签名”的 class -->
    <element class="h5-canvas">
        <!-- 可替换标签内置组件会追加“wx-comp-小写标签名”的 class -->
        <canvas class="wx-comp-canvas">
            <cover-view></cover-view>
            <cover-view></cover-view>
        </canvas>
    </element>
    <!-- wx- 前缀创建的内置组件外包层会追加“h5-wx-component”和“wx-组件名”的 class -->
    <element class="h5-wx-component wx-map">
        <!-- wx- 前缀创建的内置组件会追加“wx-comp-组件名”的 class -->
        <map class="wx-comp-map">
            <cover-view></cover-view>
            <cover-view></cover-view>
        </map>
    </element>
    <!-- 同 wx-map -->
    <element class="h5-wx-component wx-scroll-view">
        <scroll-view class="wx-comp-scroll-view">
            <view></view>
            <view></view>
        </scroll-view>
    </element>
</view>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

PS：如上所述，button 标签和 form 标签都不会被渲染成内置组件，如若需要请使用 wx- 前缀。

PS：text 组件内不支持包含 text 组件，如若需要请使用 span 标签。

PS：因为自定义组件的限制，movable-area/movable-view、swiper/swiper-item、picker-view/picker-view-column 这三组组件必须作为父子存在才能使用。比如 swiper 组件和 swiper-item 必须作为父子组件才能使用，如：

<wx-swiper>
    <wx-swiper-item>A</wx-swiper-item>
    <wx-swiper-item>B</wx-swiper-item>
    <wx-swiper-item>C</wx-swiper-item>
</wx-swiper>
1
2
3
4
5

PS：默认 canvas 内置组件的 touch 事件为通用事件的 Touch 对象，而不是 CanvasTouch 对象，如果需要用到 CanvasTouch 对象的话可以改成监听 canvastouchstart、canvastouchmove、canvastouchend 和 canvastouchcancel 事件。

PS：原生组件的表现在小程序中表现会和 web 端标签有些不一样，具体可参考原生组件说明文档 (opens new window)。

PS：原生组件下的子节点，div、span 等标签会被渲染成 cover-view，img 会被渲染成 cover-image，如若需要在原生组件下使用 button 内置组件请使用 wx-button。

PS：某些 Web 框架（如 react）会强行将节点属性值转成字符串类型。对于普通类型数组（如 wx-picker 组件的 value 属性），字符串化会变成,连接，kbone 会自动做解析，开发者无需处理；对于对象数组（如 wx-picker 组件的 range 属性），如遇到被自动转成字符串的情况，开发者需要将此对象数组转成 json 串传入。

PS：某些框架对于布尔值的属性会进行丢弃，不会执行 setAttribute 操作，对于这种情况可以使用有值的字符串和 'false' 字符串来代替 true 和 false，也可以通过手动调用 setAttribute 或者按照下述批量设置节点属性方法来设置属性。

PS：具体例子可参考 demo3 (opens new window)

# 使用小程序自定义组件

需要明确的是，如果可以使用 Web 端组件技术实现的话请尽量使用 Web 端技术（如 vue、react 组件），使用自定义组件请按需使用。这是因为自定义组件外层会被包裹上 kbone 的自定义组件，而当自定义组件的实例数量达到一定量级的话，理论上是会对性能造成一定程度的影响。

要在 kbone 中使用自定义组件，需要将所有自定义组件和其依赖放到一个固定的目录，这个目录可以自己拟定，假设这个目录为 src/custom-components：

  1. 修改 webpack 插件配置

在 mp-webpack-plugin 这个插件的配置中的 generate 字段内补充 wxCustomComponent，其中 root 是组件根目录，即上面提到的目录：src/custom-component，usingComponents 则用来配置要用到的自定义组件。

module.exports = {
    generate: {
        wxCustomComponent: {
            root: path.join(__dirname, '../src/custom-components'),
            usingComponents: {
                'comp-a': 'comp-a/index',
                'comp-b': {
                    path: 'comp-b/index',
                    props: ['propa', 'propb'],
                    propsVal: ['', 'default value'],
                    events: ['someevent'],
                },
            },
        },
    },
    // ... other options
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

usingComponents 里的声明和小程序页面的 usingComponents 字段类似。键为组件名，值可以为组件相对 root 字段的路径，也可以是一个配置对象。这个配置对象的 path 为组件相对路径，props 表示要这个组件会被用到的 properties，propsVal 表示对应属性的默认值，events 表示这个组件会被监听到的事件。

PS：如果不传属性默认值，那么属性默认会传 null 值。

  1. 将自定义组件放入组件根目录

下面以 comp-b 组件为例：

<!-- comp-b.wxml -->
<view>comp-b</view>
<view>propa: {{propa}} -- propb: {{propb}}</view>
<button bindtap="onTap">click me</button>
<slot></slot>
1
2
3
4
5
// comp-b.js
Component({
    properties: {
        propa: {type: String, value: ''},
        propb: {type: String, value: ''},
    },
    methods: {
        onTap() {
            this.triggerEvent('someevent')
        },
    },
})
1
2
3
4
5
6
7
8
9
10
11
12
  1. 使用自定义组件

假设使用 vue 技术，然后下面同样以 comp-b 组件为例：

<template>
    <div>
        <comp-b :propa="propa" :propb="propb" @someevent="onEvent">
            <div>comp-b slot</div>
        </comp-b>
    </div>
</template>
<script>
export default {
    data() {
        return {propa: 'propa-value', propb: 'propb-value'}
    },
    methods: {
        onEvent(evt) {
            console.log('someevent', evt)
        },
    },
}
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

PS：如果使用 react 等其他框架其实和 vue 同理，因为它们的底层都是调用 document.createElement 来创建节点。当在 webpack 插件配置声明了这个自定义组件的情况下，在调用 document.createElement 创建该节点时会被转换成创建 WX-CUSTOM-COMPONENT 标签。

PS：具体例子可参考 demo10 (opens new window)

# 批量设置节点属性

在一些 Web 框架中，设置布尔值相关的一些属性，比如 video 节点的 controls 属性，在小程序环境中默认为 true，如果想要设置成 false 会发现无论如何都设置不上去，除非手动调用节点的 setAttribute 方法。这是因为这些 Web 框架可能会对一些值为 false 的属性进行 removeAttribute 操作，导致 kbone 认为这个属性没有被设置转而使用默认值；但是当开发者设置 'false' 字符串（空串或者数值 0 也会被当成真值处理）的时候，这些 Web 框架又会认为是 true，然后将值转为属性名来处理，比如 controls="" 会被转成 controls="controls"。所以当默认值为 true 的情况，就会发现怎么也无法将其置为 false。

这种情况开发者手动调用 setAttribute 操作即可解决，但是为了可以更方便地应对这种情况，kbone 提供了一种特殊的属性 kbone-attribute-map，支持批量设置属性，同时可以绕过 Web 框架的属性设置检查：

<!-- 以 vue 为例 -->
<video :kbone-attribute-map="{controls: false}"></video>
1
2

kbone 在检测到通过 setAttribute 设置 kbone-attribute-map 属性时，会将对象的所有 key 取出来进行一遍 setAttribute 操作；如果存在上一次设置的 kbone-attribute-map 旧值时，会将旧值中存在但是新值中不存在的 key 进行 removeAttribute 操作。

另外有些 Web 框架不支持属性值为对象，这种情况也可以将该值转成 json 串来使用：

this.kboneAttributeMap = JSON.stringify({controls: false})
1
<!-- 以 vue 为例 -->
<video :kbone-attribute-map="kboneAttributeMap"></video>
1
2

# 批量设置事件监听器

和批量设置节点属性原因类似，在一些 Web 框架中会过滤掉自定义事件，导致监听节点事件必须通过手动调用节点的 addEventListener 来设置事件监听器。

这种情况开发者手动调用 addEventListener/removeEventListener 操作即可解决，但是为了可以更方便地为了应对这种情况，kbone 提供了一种特殊的属性 kbone-event-map，支持批量设置事件监听器，同时可以绕过 Web 框架的事件监听检查：

<!-- 以 vue 为例 -->
<wx-picker-view :kbone-event-map="{change: () => log('change')}"></wx-picker-view>
1
2

kbone 在检测到通过 setAttribute 设置 kbone-event-map 属性时，会将对象的所有 key 取出来进行一遍 addEventListener 操作；如果存在上一次设置的 kbone-event-map 旧值时，则会在进行新值 addEventListener 操作之前将旧值中的 key 进行 removeEventListener 操作。

另外有些 Web 框架不支持属性值为对象，这种情况也可以将该值转成 json 串来使用，注意这里转成 json 串的时候，原本的 js 函数用一个字符串代替，然后 kbone 会以该字符串作为属性从 window 对象中取出值作为事件监听器函数使用：

const pickerViewChangeTs = +new Date()
window[pickerViewChangeTs] = evt => console.log('change')
this.state.eventMap = JSON.stringify({
    change: pickerViewChangeTs,
})
1
2
3
4
5
<!-- 以 react 为例 -->
<wx-picker-view kbone-event-map={this.state.eventMap}></wx-picker-view>
1
2

PS：kbone 不会自动做 removeEventListener 操作，需要开发者手动移除。开发者可以传一个空对象或空串来表示移除上一次通过此方法添加的事件监听器。

# 使用 rem

kbone 没有支持 rpx，取而代之的是可以使用更为传统的 rem 进行开发。使用流程如下：

  1. 修改 webpack 插件配置

在 mp-webpack-plugin 这个插件的配置中的 global 字段内补充 rem 配置。

module.exports = {
    global: {
        rem: true,
    },
    // ... other options
}
1
2
3
4
5
6
  1. 在业务代码里就可以设置 html 的 font-size 样式了，比如如下方式：
window.onload = function() {
    if (process.env.isMiniprogram) {
        // 小程序
        document.documentElement.style.fontSize = wx.getSystemInfoSync().screenWidth / 16 + 'px'
    } else {
        // Web 端
        document.documentElement.style.fontSize = document.documentElement.getBoundingClientRect().width / 16 + 'px'
    }
}
1
2
3
4
5
6
7
8
9
  1. 在业务代码的样式里使用 rem。
.content {
    width: 10rem;
}
1
2
3

PS：这个特性只在基础库 2.9.0 及以上版本支持。

# 自定义 app.js 和 app.wxss

在开发过程中，可能需要监听 app 的生命周期，这就需要开发者自定义 app.js。

  1. 修改 webpack 配置

首先需要在 webpack 配置中补上 app.js 的构建入口，比如下面代码的 miniprogram-app 入口：

// webpack.mp.config.js
module.exports = {
    entry: {
        'miniprogram-app': path.resolve(__dirname, '../src/app.js'),

        page1: path.resolve(__dirname, '../src/page1/main.mp.js'),
        page2: path.resolve(__dirname, '../src/page2/main.mp.js'),
    },
    // ... other options
}
1
2
3
4
5
6
7
8
9
10
  1. 修改 webpack 插件配置

在 webpack 配置补完入口，还需要在 mp-webpack-plugin 这个插件的配置中补充说明，不然 kbone 会将 miniprgram-app 入口作为页面处理。

module.exports = {
    generate: {
        appEntry: 'miniprogram-app',
    },
    // ... other options
}
1
2
3
4
5
6

如上，将 webpack 构建中的入口名称设置在插件配置的 generate.app 字段上，那么构建时 kbone 会将这个入口的构建作为 app.js 处理。

  1. 补充 src/app.js
// 自定义 app.wxss
import './app.css'

App({
    onLaunch(options) {},
    onShow(options) {
        // 获取当前页面实例
        const pages = getCurrentPages() || []
        const currentPage = pages[pages.length - 1]

        // 获取当前页面的 window 对象和 document 对象
        if (currentPage) {
            console.log(currentPage.window)
            console.log(currentPage.document)
        }
    },
    onHide() {},
    onError(err) {},
    onPageNotFound(options) {},
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

PS：app.js 不属于任何页面，所以没有标准的 window/document 对象，所有依赖这两个对象实现的代码在这里无法被直接使用。不过开发者可以通过 generate.appEntryInject 字段注入 js 代码来修改 window/document 对象。

PS：具体例子可参考 demo5 (opens new window)

# 扩展 dom/bom 对象和 API

kbone 能够满足大多数常见的开发场景，但是当遇到当前 dom/bom 接口不能满足的情况时，kbone 也提供了一系列 API 来扩展 dom/bom 对象和接口。

这里需要注意的是，下述所有对于 dom/bom 对象的扩展都是针对所有页面的，也就是说有一个页面对其进行了扩展，所有页面都会生效，因此在使用扩展时建议做好处理标志，然后判断是否已经被扩展过。

  • 使用 window.$$extend 对 dom/bom 对象追加属性/方法

举个例子，假设需要对 window.location 对象追加一个属性 testStr 和一个方法 testFunc，可以编写如下代码：

window.$$extend('window.location', {
    testStr: 'I am location',
    testFunc() {
        return `Hello, ${this.testStr}`
    },
})
1
2
3
4
5
6

这样便可以通过 window.location.testStr 获取新追加的属性，同时可以通过 window.location.testFunc() 调用新追加的方法。

  • 使用 window.$$getPrototype 获取 dom/bom 对象的原型

如果遇到追加属性和追加方法都无法满足需求的情况下，可以获取到对应对象的原型进行操作：

const locationPrototype = window.$$getPrototype('window.location')
1

如上例子，locationPrototype 便是 window.location 对象的原型。

  • 对 dom/bom 对象方法追加前置/后置处理

除了上述的给对象新增和覆盖方法，还可以对已有的方法进行前置/后置处理。

前置处理即表示此方法会在执行原始方法之前执行，后置处理则是在之后执行。前置处理方法接收到的参数和原始方法接收到的参数一致，后置处理方法接收到的参数则是原始方法执行后返回的结果。下面给一个简单的例子：

const beforeAspect = function(...args) {
    // 在执行 window.location.testFunc 前被调用，args 为调用该方法时传入的参数
}
const afterAspect = function(res) {
    // 在执行 window.location.testFunc 后被调用，res 为该方法返回结果
}
window.$$addAspect('window.location.testFunc.before', beforeAspect)
window.$$addAspect('window.location.testFunc.after', afterAspect)

window.location.testFunc('abc', 123) // 会执行 beforeAspect，再调用 testFunc，最后再执行 afterAspect
1
2
3
4
5
6
7
8
9
10

PS：具体 API 可参考 dom/bom 扩展 API 文档。

# 事件系统扩展

kbone 里节点事件没有直接复用小程序的捕获冒泡事件体系，原因在于：

  • 小程序事件和 Web 事件不完全对齐，比如 input 事件在小程序里是不冒泡的。
  • 小程序自定义组件是基于 Web Components 的概念设计的，对于跨自定义组件的情况，无法准确获取事件的源节点。

故在 kbone 里的节点事件是在源节点里监听到后，就直接在 kbone 仿造出的 dom 树中进行捕获冒泡。此处使用的事件绑定方式均采用 bindxxx 的方式，故在小程序中最初监听到的事件一定是在源节点监听到的。比如用户触摸屏幕后，会触发 touchstart 事件，在节点 a 上监听到 touchstart 事件后，后续监听到同一行为触发的 touchstart 均会被抛弃，后续的捕获冒泡阶段会在仿造 dom 树中进行。

目前除了内置组件特有的事件外（比如图片的 load 事件），普通节点只有 touchstart、touchmove、touchend、touchcancel 和 tap 会被监听，其中 tap 会被转化为 click 事件来触发。

因为此处事件监听方式默认是 bindxxx，但是对于一些特殊场景可能需要使用小程序的 capture-bind:xxx（比如无法在源节点监听到事件的场景）、catchxxx（比如需要阻止触摸引起滚动的场景） 和动画事件的情况，对于此可以使用特殊节点 wx-capture、wx-catch 和 wx-animation：

<!-- 使用小程序原生方式监听 capture 事件 -->
<wx-capture @touchstart="onCaptureTouchStart" @click="onCaptureClick"></wx-capture>
<!-- 使用小程序原生方式监听 catch 事件 -->
<wx-catch @click="onCaptureClick"></wx-catch>
<!-- 监听动画事件 -->
<wx-animation :animation="animation" @animationstart="onAnimationStart" @transitionend="onTransitionEnd"></wx-animation>
1
2
3
4
5
6

其中 wx-capture 和 wx-catch 节点上面绑定的 touchstart、touchmove、touchend、touchcancel 和 tap 五个事件会被使用 capture-bind:xxx 和 catchxxx 的方式监听，脱离了 kbone 的事件捕获冒泡体系，所以只会在此节点单独触发。

PS：这三种特殊节点的内部实现和内置组件一致，故书写方式和样式处理均可参考内置组件的使用方案。

PS：wx-animation 支持 animation 属性。

# 跨页面通信和跨页面数据共享

在 kbone 中，每个页面拥有独立的 window 对象，页面与页面间是相互隔离的，为此需要一个跨页面通信和跨页面数据共享的方式。

  1. 在页面中订阅广播消息
// 页面1
window.$$subscribe('hello', data => {
    console.log('receive a msg: ', data)
})
1
2
3
4
  1. 在其他页面中发布广播消息
// 页面2
window.$$publish('hello', 'I am june')
1
2

在订阅了此消息的页面则会输出 receive a msg: I am june。

PS：如果需要取消订阅消息，可以使用 window.$$unsubscribe 接口进行取消。

PS：页面关闭后，会取消该页面所有的订阅。

如果需要跨页面数据进行共享，可以使用 window.$$global 对象，所有页面的 window.$$global 均会指向同一个对象：

// 页面1
window.$$global.name = 'june'

// 页面2
console.log(window.$$global.name) // 输出 june
1
2
3
4
5

PS：具体 API 可参考 dom/bom 扩展 API 文档。

PS：具体例子可参考 demo22 (opens new window)

# 页面渲染完成之前的加载视图

kbone 对于复杂页面可能会存在较长的页面渲染时间，这种时候页面通常会处于白屏阶段，开发者无法进行操控。因此 kbone 提供了一种方式来处理这个渲染阶段：

  1. 创建一个用于放置加载视图的目录

命名和路径不做要求，我们此处将其命名为 loading-view，放置在项目的 src 下。

  1. 在该目录创建一个小程序自定义组件

该自定义组件即会作为 kbone 渲染阶段展示在页面中的加载视图，命名默认为 index，开发者也可以通过其他配置来调整这个命名。

└─ src
   └─ loading-view // 加载视图目录
      ├─ index.js
      ├─ index.wxss
      ├─ index.wxml
      └─ index.json
1
2
3
4
5
6
  1. 修改 webpack 插件配置
module.exports = {
    global: {
        loadingView: path.join(__dirname, '../src/loading-view'), // 加载视图所在的目录，kbone 会默认取该目录下名为 index 的组件
    },
    // ... other options
}
1
2
3
4
5
6

该加载视图的大小会被设置成和屏幕一样，且使用 fixed 定位。开发者可以在此自定义组件中实现需要展示的内容/逻辑。在页面渲染完成后，页面会覆盖在这个加载视图上面，直到页面 onReady 钩子触发后一段时间，才会销毁加载视图。

作为加载视图的自定义组件可以接收到 pageName 参数，表示当前所在的页面名称：

Component({
    properties: {
        pageName: {
            type: String,
            value: '',
        },
    },

    attached() {
        console.log('page name: ', this.data.pageName)
    },
})
1
2
3
4
5
6
7
8
9
10
11
12

PS：更多详细配置可以点此查看

PS：具体例子可参考 demo3 (opens new window)

# 使用 Worker 和 SharedWorker

默认 window.Worker/window.SharedWorker 值为 undefined，如果要使用 window.Worker/window.SharedWorker 则需要按以下步骤操作：

  1. 修改 webpack 配置

因为小程序要求所有 worker 文件放在一个目录，所以需要修改 worker 文件的生成目录，以下以使用 worker-loader 为例：

// webpack.mp.config.js
module.exports = {
    module: {
        rules: [{
            test: /sharedWorker\.js$/,
            use: [{
                loader: 'worker-loader',
                options: {
                    name: 'workers/[hash].worker.js',
                },
            }, 'babel-loader'],
        }, {
            test: /worker\.js$/,
            use: [{
                loader: 'worker-loader',
                options: {
                    name: 'workers/[hash].worker.js',
                },
            }, 'babel-loader'],
        }],
    },
    // ... other options
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

例子中同时包含了 Worker 和 SharedWorker，根据配置将其构建到 common/workers 中。

PS：需要注意的是，官方提供的 demo 输出目标是 common，所以配置 workers/xxx.js 会输出到小程序目录的 common/workers/xxx.js 下。

  1. 修改 webpack 插件配置

配置 generate.worker 为 true。这样在构建时，worker 文件所在目录下的所有 js 文件都会被特殊处理，而不会被作为页面依赖生成。

module.exports = {
    generate: {
		worker: true,
    },
    // ... other options
}
1
2
3
4
5
6

PS：此配置项也可以是个字符串，如果配置字符串则表示会将该字符串代表的目录作为 worker 文件所在目录。配置为 true 的话则会取 common/workers

  1. 编写 js 代码
// 这里以使用 worker-loader 为例
import MyWorker from '../worker/worker'

const worker = new MyWorker()
worker.onmessage = evt => console.log(evt.data)
worker.postMessage({a: 123})
1
2
3
4
5
6

受限于小程序 worker 的实现，有以下几点要注意：

  • Worker/SharedWorker 不支持 data url 和 options 参数。
  • 小程序 worker 并发限制为 1 个，所以 Worker 只能有一个实例，要创建新 Worker 时必须先销毁旧的 Worker 实例；同一个 url 的 SharedWorker 可以被重复创建，但是创建不同 url 的 SharedWorker 时，需要先销毁旧的 SharedWorker 实例。
  • Worker 里可以访问 navigator/location 对象的只读属性，但是不支持使用 XMLHttpRequest 对象。
  • 页面卸载时，会自动销毁该页面创建的所有 Worker/SharedWorker 实例。
  • 更多限制可查看小程序官方 worker 文档 (opens new window)。

小程序的 worker 提供了真正的多线程能力，如果不需要此能力只是需要兼容接口的话，开发者也可以使用扩展 dom/bom 对象和 API 的方式来自行实现兼容接口。

PS：具体例子可参考 demo25 (opens new window)

# 云开发

云开发是小程序官方提供的一种云端能力使用方案，在 kbone 中使用云开发能力可按以下步骤进行即可。

假设下述例子的目录结构如下：

├─ build
│  ├─ miniprogram.config.js // mp-webpack-plugin 配置
│  └─ webpack.mp.config.js // 小程序端构建配置
│ 
├─ src // 源码目录
├─ cloudfunctions // 云函数源码目录
│ 
└─ dist
   └─ mp // 生成小程序项目
      ├─ miniprogram // 小程序根目录
      ├─ cloudfunctions // 云函数根目录
      └─ project.config.json
1
2
3
4
5
6
7
8
9
10
11
12

其中 dist/mp 目录是我们需要生成的目录，对比普通的 kbone 项目主要调整点有三个：

  1. 创建云函数目录

即上述目录结构中的 /cloudfunctions，这个目录在构建中要被完整拷贝到 /dist/mp/cloudfunctions 下.

  1. 修改 webpack 配置

调整小程序代码输出路径，即 output.path 配置，下述例子是将原本的 /dist/mp/common 调整为 /dist/mp/miniprogram/common。

同时引入了 copy-webpack-plugin 插件，将云函数目录拷贝到小程序项目下。

// webpack.mp.config.js
const CopyPlugin = require('copy-webpack-plugin')

module.exports = {
    output: {
        path: path.resolve(__dirname, '../dist/mp/miniprogram/common'), // 放到小程序代码目录中的 common 目录下
        // ... other options
    },
    plugins: [
        // other plugins
        new CopyPlugin([{from: path.join(__dirname, '../cloudfunctions'), to: path.join(__dirname, '../dist/mp/cloudfunctions')}]),
    ],
    // ... other options
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
  1. 修改 webpack 插件配置

调整 project.config.json 的生成目录路径，让其生成到小程序代码输出目录的上一级，即 /dist/mp 目录。

同时还需要补充 miniprogramRoot 和 cloudfunctionRoot 两项配置到 project.config.json 中。

module.exports = {
    generate: {
		projectConfig: path.join(__dirname, '../dist/mp'),
    },
    projectConfig: {
		miniprogramRoot: 'miniprogram/', // 小程序根目录
		cloudfunctionRoot: 'cloudfunctions/', // 云函数根目录
	},
    // ... other options
}
1
2
3
4
5
6
7
8
9
10

后续按照正常方式进行构建即可。构建完成后的操作和原生的云开发模式一样，具体可参考官方提供的云开发文档 (opens new window)。

PS：具体例子可参考 demo19 (opens new window)

# ui 库

在小程序里默认支持了内置组件，如果需要使用 weui 组件库 (opens new window)的话，可以将 generate.worker 设为 true：

module.exports = {
    generate: {
        weui: true,
    },
}
1
2
3
4
5

此配置会以扩展库（不会占用小程序代码体积）的方式引入 weui 组件库，然后以第三方小程序自定义组件的方式提供开发者使用。因为每个 weui 组件在使用时都会被外包一层自定义组件，建议按需使用，在不必要用到 weui 组件时使用 div/span/img 等 Web 标签代替。

weui 组件使用方式和内置组件类似：

<mp-navigation-bar :show="true">
    <!-- 如果存在 slot 节点，需要将 slot 设置在 div 上，同时该 div 必须位于 weui 组件下的第一层节点 -->
    <div slot="center">我是标题</div>
</mp-navigation-bar>
1
2
3
4

同时，为了方便开发者同构到 Web 端，提供了基于 Web Components 技术实现的 kbone-ui 库，里面包含了内置组件和 weui 组件库的实现，具体用法参考此文档。

# 静态 h5 页面/ jQuery 支持

# html 处理

对于一些已有的 h5 页面，往往是以 index.html + index.css + index.js 这样的传统组合出现。如果需要改造成 kbone 页面，则采取 webpack 构建，创建一个入口 js 引入 index.css 和 index.js 即可，而 index.html 则需要转成 js 代码才可被 kbone 使用。

为此，可使用 html-to-js-loader 将 index.html 转化为 js 代码。假设 index.html 代码如下：

<!-- index.html -->
<div id="app">
    <div class="cnt"></div>
    <button onclick="console.log('123')"></button>
    <ul>
        <!-- 这是一段注释 -->
        <li>item1</li>
        <li>item2</li>
        <li>item3</li>
    </ul>
</div>
1
2
3
4
5
6
7
8
9
10
11

那么使用时在入口 js 中补充如下代码即可：

const getDom = require('html-to-js-loader!./index.html')

document.body.appendChild(getDom())
1
2
3

这样 index.html 里的 html 结构会被转成调用 dom 接口的 js 代码，被添加到 document.body 下面。

# js 处理

对于已有的 js 代码，可能用到了一些 kbone 未支持的接口，此时使用 kbone 提供的扩展能力进行前置补充即可。但是对于 js 中直接使用全局变量的情况，则需要另作处理，假设 index.js 代码如下：

// index.js
abc = function () {
    console.log('abc')
}

abc()
1
2
3
4
5
6

这里 abc 在其他运行环境中会被挂在 window/global 上，但是小程序环境中则会报错，因此在入口 js 中引入 index.js 时，可使用 html-to-js-loader：

require('replace-global-var-loader!./index.js')
1

那么 index.js 的代码在被引入后会在非标准全局变量外面追加 window[''] 这样的内容，确保是从 widnow 下读取该变量：

// index.js
window['abc'] = function () {
    console.log('abc')
}

window['abc']()
1
2
3
4
5
6

# jQuery 支持

jQuery 目前并不完全支持，主要原因在于某些接口在小程序环境下 kbone 无法提供支持（比如同步的 getComputedStyle 等），但是在大部分 h5 场景下，jQuery 仍然能够使用，不过仍然需要做一些前置兼容以免 jQuery 初始化报错：

const kbone = require('kbone-tool')
kbone.jquery.compat() // 要先于 jQuery 引入调用

const $ = require('./jquery-3.6.0')
1
2
3
4

kbone-tool 中提供了一下前置兼容逻辑，在引入 jQuery 之前调用一次即可。

PS：具体例子可参考 demo31 (opens new window)

← 原理 →