kbone-多端统一开发工具（小程序）

kbone 是一个致力于微信小程序和 Web 端同构的解决方案。

简介

微信小程序的底层模型和 Web 端不同，我们想直接把 Web 端的代码挪到小程序环境内执行是不可能的。kbone 的诞生就是为了解决这个问题，它实现了一个适配器，在适配层里模拟出了浏览器环境，让 Web 端的代码可以不做什么改动便可运行在小程序里。

这里有个简单的代码片段 ：https://developers.weixin.qq.com/s/R9Hm0Qm67Acd ，可以使用开发者工具打开看看效果。

因为 kbone 是通过提供适配器的方式来实现同构，所以它的优势很明显：

• 大部分流行的前端框架都能够在 kbone 上运行，比如 Vue、React、Preact 等。
• 支持更为完整的前端框架特性，因为 kbone 不会对框架底层进行删改（比如 Vue 中的 v-html 指令、Vue-router 插件）。
• 提供了常用的 dom/bom 接口，让用户代码无需做太大改动便可从 Web 端迁移到小程序端。
• 在小程序端运行时，仍然可以使用小程序本身的特性（比如像 live-player 内置组件、分包功能）。
• 提供了一些 Dom 扩展接口，让一些无法完美兼容到小程序端的接口也有替代使用方案（比如 getComputedStyle 接口）。

使用

为了可以让开发者可以更自由地进行项目的搭建，以下提供了三种方式，任选其一即可：

使用 kbone-cli 快速开发

对于新项目，可以使用 kbone-cli 来创建项目，首先安装 kbone-cli:

npm install -g kbone-cli

创建项目：

kbone init my-app

进入项目，按照 README.md 的指引进行开发：

// 开发小程序端
npm run mp

// 开发 Web 端
npm run web

// 构建 Web 端
npm run build

PS：项目基于 webpack 构建，关于 webpack 方面的配置可以点此查看 ，而关于小程序构建相关的详细配置细节可以参考此文档 。

使用模板快速开发

除了使用 kbone-cli 外，也可以直接将现有模板 clone 下来，然后在模板基础上进行开发改造：

• Vue 项目模板 
• React 项目模板 
• kbone-ui 项目模板 
• Preact 项目模板 
• Omi 项目模板 

项目 clone 下来后，按照项目中 README.md 的指引进行开发。

手动配置开发

此方案基于 webpack 构建实现，如果你不想要使用官方提供的模板，想要更灵活地搭建自己的项目，又或者是想对已有的项目进行改造，则需要自己补充对应配置来实现 kbone 项目的构建。

一般需要补充两个配置：

• 构建到小程序代码的 webpack 配置 
• 使用 webpack 构建中使用到的特殊插件 mp-webpack-plugin 配置 

点此可以查看 具体配置方式和操作流程。

kbone-ui

kbone-ui  是一个能同时支持 小程序(kbone) 和 vue 框架开发的多端 UI 库。

• 即可以基于 kbone 同时开发小程序和 H5，也可以单独使用开发 H5 应用。
• 支持以 Vue 语法来支持 H5 端和小程序端运行
• 对齐 微信weui  样式组件

文档

更为详细的说明和指引，可点击查看文档 。

PS：如果文档无法访问，可尝试访问备份文档镜像 。

社区

此方案虽然将整个 Web 端框架包含进来并提供了适配层，但是也不是银弹，无法满足所有场景，具体限制可参考问题文档 。使用相关问题可在 #Kbone社区  发帖。如果还遇到其他问题，可在 issue  中反馈。

选择

业内其实已经出现了很多关于同构的解决方案了，每个方案都有自己的优劣，不存在能够完美解决所有问题的方案。kbone 也一样，它的优势在上面提到过，而它的不足也是它的实现原理带来的。kbone 是使用一定的性能损耗来换取更为全面的 Web 端特性支持。

所以关于性能方面，如果你对小程序的性能特别苛刻，建议直接使用原生小程序开发；如果你的页面节点数量特别多（通常在 1000 节点以上），同时还要保证在节点数无限上涨时仍然有稳定的渲染性能的话，可以尝试一下业内采用静态模板转译的方案；其他情况就可以直接采用 kbone 了。

基本结构

首先，我们来看下一个基本的 kbone 项目的目录结构（这里的 todo 是基于 Vue 的示例，kbone 也有 React，Preact，Omi 等版本，详情可移步 kbone github）。

因为 kbone 是为了解决 小程序 与 Web 端的问题，所以每个目录下的配置都会有两份（小程序 与 Web 端各一份）

入口

不管是 小程序 端还是 Web 端，都需要入口文件。在 src/index 目录下，main.js 为 Web 端用主入口，main.mp.js 则为 小程序 端用主入口。

当然，Web 端会比 小程序 多一个入口页面，即 index.html（位于根目录下）。

下面两段代码分别是 小程序端 入口与 Web 端入口的代码，可以看到 小程序端的入口代码封装在 createApp 函数里面（这里固定即可），内部会比 Web 端多一个创建 app 节点的操作，其他的基本就是一致的。

// 小程序端入口
import Vue from 'vue'
import todo from './todo.vue'

export default function createApp() {
  // 创建app节点用于绑定
  const container = document.createElement('div')
  container.id = 'app'
  document.body.appendChild(container)

  return new Vue({
    el: '#app',
    render: h => h(todo)
  })
}

// web端入口
import Vue from 'vue'
import todo from './todo.vue'

new Vue({
  el: '#app',
  render: h => h(todo)
})

todo.vue

在上面的入口图可以看到，源码目录中，除了入口文件分开之前，页面文件就是共用的了，这里直接使用 Vue 的写法即可，不用做特殊的适应。

配置

写完代码之后，我们要怎么跑项目呢？这时，配置就派上用场啦。

Web 端配置为正常的 Vue 配置，小程序端配置与 Web 端配置的唯一不同就是需要引入 mp-webpack-plugin 插件来将 Vue 组件转化为小程序代码。

构建代码

接着，我们需要构建代码，让代码可以运行到各自的运行环境中去。构建完成后，生产代码会位于 dist 目录中。

// 构建 web 端代码
// 目标代码在 dist/web
npm run build

// 构建小程序端代码
// 目标代码在 dist/mp
npm run mp

小程序端 的构建会比 Web 端的构建多一个步骤，就是 npm 构建。

进入 dist/mp 目录，执行 npm install 安装依赖，用开发者工具将 dist/mp 目录作为小程序项目导入之后，点击工具栏下的 构建 npm，即可预览效果。

效果

最后，我们来看一下 todo 的效果。kbone 初体验，done~

todo 代码可到 kbone/demo13 自提。