小程序项目框架迁移实践
【搜狐技术产品】,第一时间技术干货
本文简单介绍了小程序以及小程序框架(mpvue、uni-app
) 的基本原理,并介绍了一个大型的 mpvue
小程序项目向 uni-app
框架迁移的方案与实践。
项目背景
拼房帝是搜狐焦点旗下的房产类小程序,为用户提供购房工具和服务。项目自 2018 年立项开发,至今已有三年多时间,目前仍保持高频的开发和迭代。
项目启动开发时,可选择的小程序框架较少,mpvue
创新性地将Vue
开发体验带入小程序开发,很大程度上提升了小程序开发效率,mpvue
在当时看来算是一个不错的选择。但是,随着项目的不断迭代,功能的不断增加,目前小程序原生页面就有 190 余个,项目越来越庞大和臃肿,小程序的性能问题也就越来越突出,如何提升开发效率、提升性能和用户体验,成为我们面临的问题。
mpvue
框架发展较早,后期处于无人维护状态,无法及时跟进小程序的技术更新,底层设计也存在一定缺陷。所以我们就考虑是否可以将拼房帝小程序项目框架进行迁移。考虑到迁移成本,我们就将目光放在了同是采用类Vue
语法的跨端框架——uni-app
。uni-app
和mpvue
语法基本一致,迁移成本相对较低。
我们应该在充分调研、充分论证之后,再去决定是否应该进行框架迁移工作。因此,了解小程序以及小程序框架的基本原理是很有必要的。下面我们就来介绍一下小程序的技术架构,及 mpvue
、uni-app
两个框架的基本原理,以及为什么 uni-app
优于 mpvue
。
小程序架构
双线程架构
小程序采用的是双线程架构。小程序的运行环境分成渲染层和逻辑层,其中WXML
模板和WXSS
样式工作在渲染层JS
工作在逻辑层。小程序的渲染层和逻辑层分别由两个线程管理:渲染层使用WebView
线程进行渲染;逻辑层采用JS
引擎执行JS
脚本。两个线程的通信必须通过Native
层。
逻辑层和视图层之间的基本工作方式为:数据变更通过setData
驱动视图更新;视图层交互触发事件,然后触发逻辑层的事件响应函数,函数中修改数据再次触发视图更新,如下图所示。
数据驱动
小程序采用类似Vue
的数据驱动机制进行页面的渲染与更新。在渲染层,宿主环境会把WXML
转化成相应的JS
对象,在逻辑层发生数据变更的时候,通过宿主环境提供的setData
方法将数据从逻辑层传递到渲染层,再经过对比前后差异,把差异应用在原来的DOM
树上,进而渲染出正确的UI
界面,如下图所示。
小程序框架基本原理
小程序定义了类似Vue
的语法(WXML、WXSS、WXS
),虽然学习起来成本并不高,但是其开发体验和效率仍然饱受诟病。为了提升开发效率,满足跨端能力,衍生出很多小程序框架,比较流行的有:WePy
、mpvue
、uni-app
、Taro
等,这些小程序框架使我们可以直接使用 Vue
\ React
语法开发,大大提升开发效率。
虽然各框架的具体实现不一样,采用的开发语言不一样,但是大体讲,小程序框架所做的工作无非就是两个阶段的处理:编译阶段、运行阶段。
由于不支持WXML
节点的动态创建和删除,因此无法像Vue
、React
那样直接根据虚拟DOM
的更新操作DOM
更新视图,因此必须在编译阶段将其他DSL
(Vue
、React
)转换为WXML
模板文件。此外,还需进行JS
转译、样式转译、框架runtime
注入等工作。
对于运行阶段,小程序框架会引入一个自己的runtime
。页面中除了有一个小程序页面实例之外,还会创建一个框架自身的页面实例与之映射,因此需要将框架页面实例和小程序页面实例关联,包括数据的关联、事件的关联、生命周期的关联等。
简单来说,这些框架的基本思路就是:
- 编译阶段:将其他
DSL
转换为符合小程序语法的WXML
、WXSS
、JS
、JSON
; - 运行阶段:数据、事件、生命周期等部分的处理和对接;
mpvue 框架原理
介绍
❝
mpvue
是一个使用
Vue
开发小程序的前端框架。本质上,
mpvue
就是 fork 了一份
vuejs/vue@2.4.1
的代码,保留了
Vue
核心能力,添加了小程序平台的支持。框架基于
Vue
核心,修改了
Vue
的
runtime
和
compiler
的实现,使其可以运行在小程序环境中,从而为小程序开发引入了整套
Vue
开发体验。
现在再来讲mpvue
可能显得有点过时,新项目的技术选型也基本不会再采用mpvue
开发。但是,小程序框架思想是相通的,并且mpvue
是出现最早的小程序框架之一,uni-app
、Taro
等框架的实现也参考了mpvue
的部分思想。
Vue
本身就将平台相关API
抽离,在src/platforms
文件夹下实现不同平台的适配。mpvue
的思路就是增加新的平台层支持。具体在源码中的表现就是:在Vue
源码的platforms
文件夹下面增加了mp
目录,在里面实现了complier
(编译时)和runtime
(运行时)支持。
下面这张图展示了mpvue
框架的基本原理。在Vue
的基础上,mpvue
主要做了以下改造:
- 编译阶段:修改
vue-template-compiler
,将Vue
代码转换为符合小程序语法规范的WXML
、WXSS
; - 运行阶段:初始化
Vue
组件实例的同时,初始化小程序页面实例;组件 patch 更新阶段,不再直接操作DOM
,而是调用小程序页面实例的setData
方法将视图更新;此外,还包括生命周期的处理、事件的处理等,下面会详细讲解。
编译阶段
在编译阶段,mpvue
所做的工作主要是将Vue
模板编译为符合小程序语法的WXML
模板。这部分工作主要由mpvue-loader
完成。所做的工作主要有:标签映射、指令转换、组件支持、事件绑定、样式转译等。
mpvue-loader
是vue-loader
的一个扩展延伸版,类似于超集的关系,除了vue-loader
本身所具备的能力之外,它还会产出小程序所需要的文件结构和模块内容。mpvue-loader
的大致原理就是,从单文件组件(SFC
)中提取出AST
,然后改造AST
,最后再将AST
转译为小程序模板代码。
运行阶段
双实例
mpvue
将Vue
运行时引入至小程序运行环境。Vue
负责维护数据模型和虚拟DOM
,小程序负责视图层展示,所有业务逻辑收敛到Vue
中,Vue
数据变更后再同步到小程序视图。
运行阶段,一个页面中同时包含 Vue实例 与小程序 Page实例 。那么这两个实例是如何协作,如何运行的呢?
若想让Vue
工作于小程序环境,我们需要解决以下三个核心问题:
- 如何将
Vue
中的数据状态同步至小程序视图? - 小程序页面触发某个生命周期钩子的时候,如何调用
Vue
中对应的生命周期函数? - 小程序页面触发某个事件的时候,如何调用
Vue
中对应的事件响应函数?
带着以上疑问,阅读mpvue
源码,可以梳理出其大致运行原理,如下图所示。
首先,入口是Vue
实例的初始化;在Vue
组件mount
之前,初始化小程序页面实例,小程序页面实例中包含页面data
、一个函数handleProxy
、以及注册所有的小程序页面生命周期钩子;
小程序触发onLoad
生命周期,此时将Vue
页面实例和小程序页面实例进行关联,同时通过callHook
方法调用Vue
组件中对应的生命周期函数;小程序触发onReady
时,这时才会真正执行Vue
组件的mount
;
然后执行render
函数,生成 vnode
,这是Vue
自己维护的一份小程序页面节点的虚拟DOM
;然后执行patch
进行页面的渲染,不同于 web 环境的是,小程序环境无法直接操作DOM
,需要采用setData API
间接渲染,mpvue
中将相应逻辑写在了updateDataToMP
方法里;以上就是mpvue
页面初始化的一个流程。
当小程序页面触发某一个生命周期时,小程序页面实例会调用callHook
方法,callHook
方法则会去 Vue
实例vm
中找到对应的回调函数。当用户交互触发某一个事件时,都会调用 handleProxy
方法,而 handleProxy
方法会调用Vue
实例上的$handleProxyWithVue
方法,$handleProxyWithVue
方法底层则会去找到对用的Vue
组件实例以及对应的回调函数,最终执行该事件对应的回调函数。
从上述流程可以看出,mpvue
运行阶段所做的主要工作其实就是将Vue
实例与小程序Page
实例建立关联,主要包括:
- 数据同步机制,
Vue
实例中数据变更能同步至小程序页面; - 事件代理机制,页面中触发的事件能调用
Vue
中对应的事件函数; - 生命周期关联,能在小程序生命周期中调用
Vue
中设置的页面生命周期函数;
生命周期关联
小程序页面触发某个生命周期的时候,如何调用Vue
中对应的生命周期函数?其实思路比较简单。主要是在小程序Page
实例化时,将小程序所有的页面生命周期hook
进行注册。当触发相应 hook
时,统一都调用 callHook
方法,callHook
方法则是遍历并调用 Vue
实例vm
及其子组件vm
中绑定的相应的hook
函数。
mpvue
中支持在页面子组件中注册小程序页面生命周期,正是因为callHook
方法中会对子组件遍历并递归调用。下面是callHook
方法源码:
function callHook(vm, hook, params) {
let handlers = vm.$options[hook]
if (hook === 'onError' && handlers) {
handlers = [handlers]
} else if (hook === 'onPageNotFound' && handlers) {
handlers = [handlers]
}
let ret
if (handlers) {
for (let i = 0, j = handlers.length; i < j; i++) {
try {
ret = handlers[i].call(vm, params)
} catch (e) {
handleError(e, vm, `${hook} hook`)
}
}
}
if (vm._hasHookEvent) {
vm.$emit('hook:' + hook)
}
// for child
if (vm.$children.length) {
vm.$children.forEach(v => callHook(v, hook, params))
}
return ret
}
事件代理机制
上面我们说过,Vue
并不做视图渲染,视图仍然由小程序自己渲染。此时的情况是:事件响应函数存在于Vue
中,事件触发却在小程序节点上,二者并无联系,却又必须做到通过触发小程序节点事件准确调用到对应的Vue
事件函数。
mpvue
的采用方案是事件代理机制。具体讲:所有在小程序标签上的事件响应函数,都统一到一个特定的事件代理函数,在函数内通过当前标签上下文信息映射到与之对应的Vue
实例中的事件函数。
小程序视图触发事件后,会将event
对象通知到 Page
实例,那么我们只需要将视图层中所有的事件都代理到handleProxy
这个方法中,然后再靠这个方法从Vue
的实例树上找到对应的vm
和handler
做事件处理。为了实现这一目的,在编译阶段对模版进行处理时,除了要将事件监听方法转换为handleProxy
以外,还需要通过data-
属性在元素上标记对应的组件compid
和节点nodeid
,用于标记当前层级信息,如下所示:
数据更新机制
Vue
视图层渲染由render
方法完成,根据内存中维护着的一份虚拟DOM
,调用宿主环境(浏览器)提供的DOM API
进行视图渲染。而小程序没有提供相关API
,只能通过页面实例上的setData API
与视图层进行通信。因此mpvue
对Vue
的patch
的基础上,额外调用了updateDataToMP
方法,最终通过setData
进行视图更新。updateDataToMP
函数源码如下:
JavaScript
function updateDataToMP () {
const page = getPage(this)
if (!page) {
return
}
const data = formatVmData(this)
throttleSetData(page.setData.bind(page), data)
}
根据以上分析,我们可以发现,即使只有一个组件状态值的改变,都会将整个页面数据通过setData
接口传递至视图层,这显然是不合理的,这也是mpvue
设计上的一个缺陷。虽然后期mpvue
的版本中对 setData
传递数据增加了diff
处理,但是仍然存在一些问题,可以参考社区中的讨论。
另外,mpvue
对setData
接口的调用做了节流处理,虽然一定程度上避免了频繁setData
调用的性能问题,但也意味着延迟了用户交互时的响应,这一点也不是很合理。
uni-app 框架分析
介绍
❝
uni-app
是一个使用
Vue
开发所有前端应用的框架,开发者编写一套代码,可发布到
iOS、
Android、
Web(响应式)、以及各种小程序、快应用等多个平台。
uni-app
是DCloud
公司开发的跨端框架,有专人维护,具有很强的跨端能力和完善的生态。
uni-app
在初期借鉴了mpvue
,早期版本实现原理和mpvue
基本一致。mpvue
的实现,总的来说是将Vue
实例和小程序页面实例简单粗暴地做了关联,以达到使用Vue
开发小程序的目的。mpvue
的思路是很好的,但是mpvue
并没有做深入优化,性能一般。同时,由于mpvue
后续基本处于无人维护状态,因此无法跟上小程序的技术更新(比如自定义组件、分享朋友圈等功能)。uni-app
则在mpvue
的基础上,做了很多的性能优化,也有团队一直在维护。因此新项目基本不推荐采用mpvue
开发了,更推荐采用uni-app
。
uni-app
框架比mpvue
框架为什么性能更优? 主要有一下三点:
- 基于小程序自定义组件实现
Vue.js
的组件化开发; Vue
层取消vnode
对比;- 更彻底的
diff
计算,setData()
通讯数据量更少;
小程序自定义组件
mpvue
诞生之初,小程序尚不支持自定义组件,无法进行组件化开发;mpvue
为解决这个问题,创造性的将用户编写的Vue
组件,编译为WXML
中的模板(template
),这样变相实现了组件化开发能力,提高代码复用性,这在当时的技术条件下是很不错的方案。但这也导致Vue
组件中的数据会被编译为Page
中的数据,对组件进行数据更新也会基于路径映射调用Page.setData
。特别是组件较多、数据量交大的页面中,每个组件的局部更新都会引发页面级别的全局更新,产生极大的性能开销。
后来推出的自定义组件,其支持组件级别的局部更新。组件级别的数据更新,相比页面全局更新,有大幅性能提升。另外,mpvue
在Vue
层进行的vnode
对比及数据diff
计算不彻底,也会消耗部分性能。基于这些原因,uniapp
抛弃了以template
的方式实现组件,采用小程序自定义组件,从而实现了数据的组件级别更新,性能更优。
setData 优化
setData
是小程序开发中使用最频繁的接口,也是最容易引发性能问题的接口。小程序的视图层目前使用 WebView
作为渲染载体,而逻辑层是由独立的JavascriptCore
作为运行环境。
在架构上,WebView
和JavascriptCore
都是独立的模块,并不具备数据直接共享的通道。当前,视图层和逻辑层的数据传输,实际上通过两边提供的evaluateJavascript
所实现。即用户传输的数据,需要将其转换为字符串形式传递,同时把转换后的数据内容拼接成一份JS
脚本,再通过执行JS
脚本的形式传递到两边独立环境。而evaluateJavascript
的执行会受很多方面的影响,数据到达视图层并不是实时的。总之,setData
的调用是昂贵的。
mpvue
的实现比较粗糙,数据更新是全量更新,组件中一个属性的改变,整个组件树的数据都将传递给setData
。而uniapp
会将数据进行diff
,然后通过setData
进行路径级别的更新,例如:
JavaScript
this.setData({
'array[0].text':'changed data'
})
通过setData
的优化,相较于mpvue
,uniapp
可以极大减少视图层和逻辑层的数据传输,能够明显提升应用的运行时性能。
与 mpvue 的对比
维度 | mpvue | uni-app |
是否支持自定义组件 | 否 | 是 |
setData 更新量级 | 全量传递,性能差 | diff 后路径级别更新,性能更优 |
子组件是否支持页面生命周期 | 是 | 否 |
对 Vue 语法支持程度 | 基本支持 | 支持更多语法如 filter、复杂 JS 表达式等 |
维护状态 | 无人维护 | 官方团队维护 |
社区生态 | 弱 | 丰富 |
跨端能力 | 小程序 | 小程序、H5、iOS、Android |
框架迁移方案
通过上面两个章节的分析可以看出,目前uni-app
在各个方面均优于mpvue
。考虑到我们项目的实际情况,认为框架迁移很有必要。
uni-app
与mpvue
,都是用Vue
语法开发小程序的框架。从语法支持度来讲,mpvue
是uni-app
的子集,所以理想情况下,mpvue
迁移uni-app
只需修改工程配置,不用改业务代码可直接变为uni-app
项目,但这也只是在理想情况下。
工程配置及文件迁移
理想情况下,mpvue
项目转换为uni-app
项目只需要做以下工作:
- 初始化一个
uni-app
项目; - 将
mpvue
项目src目录内的文件拷贝到uni-app
项目; - 建立页面配置,根据原项目的
app.json
或者main.js
内的页面配置填写pages.json
的内容,并删除原来的页面配置; - 修改页面文件名称,删除每个页面的
main.js
和main.json
文件,并将页面名称修改为main.vue
; - 静态资源拷贝,将原项目static目录拷贝到
uni-app
项目,查找页面和组件内对资源的引用,检查并修正路径; webpack
自定义工程配置迁移;- 安装依赖,运行项目;
为简化上述方案中繁琐的文件迁移、项目配置工作,我们开发了一款npm
命令行工具mpvue-to-uniapp
,将上述方案中大部分工作程序化,可通过命令行直接转换。
- 安装
mpvue-to-uniapp
转换工具:
Bash
npm install mpvue-to-uniapp -g
- 进入
mpvue
项目目录,执行转换命令:
Bash
m2u
webpack
自定义工程配置迁移;项目中通常会自定义一些webpack
配置,比如:alias
、DefinePlugin
、CopyWebpackPlugin
等,需要在项目根目录下vue.config.js
文件中配置。参考:https://uniapp.dcloud.io/collocation/vue-config;- 安装依赖,运行项目;
解决 uni-app 子组件不支持小程序页面生命周期问题
mpvue
和uni-app
框架对小程序页面生命周期(onLoad
、onUnload
、onShow
、onHide
、onPullDownRefresh
、onReachBottom
、onPageScroll
)的支持不同:mpvue
支持在子组件中使用小程序页面生命周期钩子,但是uni-app
框架不支持,参考uniapp
组件生命周期文档。mpvue
中,组件中可以使用所有小程序页面生命周期(其中onShow
在页面初始化时不会执行,但是在页面触发onShow
时仍然会执行,比如小程序前后台切换时 )。uni-app
中子组件不支持小程序页面生命周期。至于为什么uni-app
子组件不支持小程序页面生命周期,其实只是设计理念不同而已。
因此,如果你的项目中,在子组件中使用了小程序的页面生命周期,那么就需要考虑如何处理两个框架生命周期不一致的问题。而我们的项目中,存在大量的子组件使用页面生命周期的情况,所以如果调整组件逻辑,代码改动成本非常高。那么有没有办法让uni-app
框架的子组件中支持小程序页面生命周期?下面是我们的一种方案。
全局mixin
以下逻辑,在子组件mounted
时将组件中的页面生命周期挂载至其根页面组件,在beforeDestroy
时再卸载。
JavaScript
import Vue from 'vue'
// 需要处理的页面生命周期
const PAGE_LIFECYCLE_HOOKS = [
// 'onReady', uni-app 已支持
'onLoad',
'onUnload',
'onShow',
'onHide',
'onPullDownRefresh',
'onReachBottom',
'onPageScroll'
]
// 在子组件 mounted 时挂载页面生命周期挂载至其页面组件,在beforeDestroy 时再卸载
// PS:子组件 mixins 中的钩子函数,已经被挂载至 options,因此不需要额外处理
Vue.mixin({
mounted() {
if (this.$mp && this.$mp.component) {
const pageRoot = this.$root
for (let hook of PAGE_LIFECYCLE_HOOKS) {
if (this.$options[hook]) {
const callbacks = this.$options[hook].map(item => {
let cb = item.bind(this)
cb._uid = this._uid
return cb
})
// onShow、onLoad 特殊处理,直接执行一次
if (['onShow', 'onLoad'].includes(hook)) {
callbacks.forEach(func => func())
}
if (pageRoot.$options[hook]) {
pageRoot.$options[hook].push(...callbacks)
} else {
pageRoot.$options[hook] = callbacks
}
}
}
}
},
beforeDestroy() {
if (this.$mp && this.$mp.component) {
const pageRoot = this.$root
for (let hook of PAGE_LIFECYCLE_HOOKS) {
if (Array.isArray(pageRoot.$options[hook])) {
pageRoot.$options[hook] = pageRoot.$options[hook].filter(item => item._uid !== this._uid)
}
}
}
},
onLoad() {},
onUnload() {},
onShow() {},
onHide() {},
onPullDownRefresh() {},
onReachBottom() {},
onPageScroll() {},
})
此方案可以解决两个框架生命周期不一致的问题,让uni-app
中子组件支持小程序页面生命周期。通过我们目前多个项目的实践来看,目前没有发现什么副作用。
其他需要注意的细节
在我们项目框架迁移过程中,还是发现些许uni-app
和mpvue
语法上存在的差异。可以大概划分为以下三类。
由于组件实现方式的不同导致的问题
uni-app
组件中使用wx.createSelectorQuery API
需要加上绑定this;- 在父组件中使用
wx.createSelectorQuery
无法子组件中的节点; - 小程序
wx.selectComponent
接口在子组件中无法获得插件组件实例对象,需要将第三方插件放在页面组件中; uni-app
组件中,wx.createCanvasContext
需要绑定this;
对 Vue 语法支持程度不同
uni-app
对语法要求比较严格,例如组件prop
声明与传递的格式必须一致,否则无效;uni-app
中,组件prop
为引用类型时,修改prop
对象属性不会响应式更新视图;uni-app
不支持v-bind
指令;
框架自身差异
- 检查项目中是否有使用
mpvue
命名空间下的属性和方法,替换为uni
; - 由于
mpvue
和uni-app
都对小程序原生事件做了一层代理和封装,因此需要检查事件参数是否一致,例如:e.mp.touches[0]
; uni-app this.$root.$mp.appOptions
对象不存在,修改为从wx.getLaunchOptionsSync()
接口该对象;- 如果项目使用了
mpvue
的跨端能力,那么需要将mpvue
中的if else
语句判断,调整为uni-app
中的条件编译; uni-app
中关于代码目录有一定规范和约定,公共组件必须放在src/components
目录,分包 A 不能引用分包 B 的组件;而在mpvue
中,对组件位置没有要求,webpack
会分析依赖并将公共模块打包至主包,因此需要根据组件的引用合理调整组件目录
总结
根据上述方案,经过两周时间的开发和测试,我们顺利完成了拼房帝小程序的框架迁移工作。我们获得以下收益:
- 显著提升程序性能,交互更流畅,有效提升用户体验;
- 降低程序运行时内存占用,向下兼容更多低端机型;
- 有效提升开发时编译速度,提升开发效率;
大家可用通过以下两个视频直观感受一下。
优化前
https://www.zhihu.com/video/1477695529212059648
优化后
https://www.zhihu.com/video/1477695556713213952
最后,欢迎大家体验和使用拼房帝小程序,希望可以为买房路上的您提供一些便利和服务。
参考文献
- 小程序开发指南
- 小程序文档:运行时性能
- 小程序文档:小程序自定义组件
- 使用Vue.js开发小程序:开源框架mpvue解析
- mpvue:在渲染时使用新的diff算法来减少Vue组件更新引起的Page.setData的实际更新量
- 全新重构,uni-app实现端性能翻倍
- 小程序的当下和未来可能 | 崔红保在GMTC 深圳站演讲内容整理
- 跨端开发框架深度横评之2020版
【搜狐技术产品】,第一时间技术干货
2024最新激活全家桶教程,稳定运行到2099年,请移步至置顶文章:https://sigusoft.com/99576.html
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。 文章由激活谷谷主-小谷整理,转载请注明出处:https://sigusoft.com/12500.html