上个月入职了新公司,开始新的造梦(填坑)之旅,开发过程当中遇到了VueDevTool没法使用的状况,归纳而言即因项目过大致使VueDevTool崩溃的状况,console
了几天顶不住了,遂尝试开发vue插件解决,效果以下,纯原创毫不是重复造轮子,瓜包熟,走过路过别错过。html
最重要的是:每日一冰,干活卖命,明年老板换新车前端
若是VueDevTool用得很快乐,也建议看看,本菜在实现插件过程当中遇到不少问题,最后发现解决或优化方案竟然大多来自于以前学习vue源码时的积累,更感受厚积薄发的重要性,在这里暂举两个我的以为比较有表明性的问题及解决关键点vue
我但愿拿到页面全部已挂载的局部组件实例,思路是根据组件树,由页面组件(根)深度递归从而动态进行后代组件收集,很天然想到beforeRouteEnter
,那beforeRouteEnter
在什么时机执行?该怎么拿到组件实例?如何区分全局组件和局部组件?若是有子路由,我想拿最深一层的页面组件实例又该怎么拿?node
# 关键点
next Or 洋葱模型
路由守卫在父子组件中的生命周期钩子执行顺序
复制代码
后代组件实例及其dom如何获取?(但愿无侵入,因此不能用refs)在数据变化致使后代组件装载卸载时,如v-if
,我该如何监听到变化的后代组件、而且从新构建插件?若是触发了屡次组件装、卸载,我只但愿重建一次且局部构建,如何实现?git
# 关键点
$children
父组件mounted必定在子组件mounted后
nextTick实现原理
domdiff
复制代码
补充一下,当切换到【中药预览页】时(这里的切换是用过v-if
控制的,),加载了两个组件,因而会触发两次构建的订阅(构建具体含义后文会详细说的),但只发布了一次,这里就是用到了nextTick
的思路github
主要面向的实际上是VueDevTool这个谷歌插件,实现的功能也和其类似(少侠休走,存在如快速切换定位组件、直接操做组件状态必定程度节省更改代码时间等优化);vue-router
先说咱们熟悉的VueDevToolnpm
即时查看组件数据和必定程度修改组件数据的功能一度让我爱不释手,但有些问题也让我咬牙切齿,主要是下面三点数组
最后一点至为关键,毕竟感觉过了美好,谁还想回到刀耕火种?一直打一个log看一下页面确实烦恼,就尝试看能不能优化下这个问题,也会有缺陷,但进步是一步接一步嘛。promise
如今来思考下咱们要解决的问题:
路由组件自己能够经过beforeRouteEnter
钩子获取;获取后代组件,主要在于获取组件挂载名(key)和组件实例(val),而自己就是一颗组件树,问题就转变为了由根节点递归一棵树,查阅源码后,知道了在vue中主要利用两个属性:
组件实例:$children
组件名:$options.__file
要注意两点:
uid
在不在当前已经收集到的组件列表中(用一个数组ids存储全部挂载组件的id),在则进行局部注册,不在则直接无论(说明其父组件是全局组件)递归函数以下
function _registerComp(rootCompInstance,rootCompName){
// 注册当前组件
setVmInstance.call(rootCompInstance,rootCompName)
// 收集当前已注册组件的id,用以实现后面v-if致使的组件装、卸载状况
ids.push(rootCompInstance._uid);
// 获取全部已挂载子组件
let compsInstance = rootCompInstance.$children;
compsInstance.forEach(comp => {
let {err,result} = getVal(comp,'$options._componentTag');
let compName;
if(err){
// console.log('获取失败',rootCompInstance,comp);
// compName = '获取失败'
}else {
compName = tf(result);
// 递归加载 组件中的内容 w-todo 待添加引用关系 父子孙组件
let filePathInfo = getVal(comp,`$options.__file`);
// 若是找不到__file 说明是全局UI组件 忽略掉
if(filePathInfo.err){
}else {
_registerComp(comp,compName)
}
}
})
}
复制代码
这道题,enenen,会者不难难者不会,有两个方案:一是借助洋葱模型,不断的在beforeRouteEnter的next中收集匹配到的实例;二是
route.matched获取。其返回的是一个数组,存储元素的数据结构中有两个属性
components.default.__file和
instances.default`,分别能够获取组件名和组件实例,剩下的,直接复用上面的注册逻辑就好啦。
此处作一个扩展,有个需求:给定一堆函数,但愿按顺序调用时,上一个函数控制下一个函数的执行时机,好比上一个函数执行时符合一个条件才继续执行下面的函数,不符合则停止调用,如何实现?
这其实就是咱们常见的next的写法,不过度扩展,附上实现next的代码以供理解(此处假定数组中存入的是对象,其属性handler
是给定函数),只说两句
function compass(arr){
let idx = 0;
let next = () => {
if (idx === arr.length) {
return out()
}
let layer = arr[idx++];
// 这个match就是上层函数判断是否是须要继续执行下一个函数的逻辑
if (layer.match(pathname)) {
layer.handler(req,res,next);
}else {
next();
}
}
next();
}
复制代码
(其实支持多级路由的思考也是大神同事给的,果真idea才是区分码农和大神的分水岭,在此感谢)
在.vue
文件中,这是个很简单的问题,但在插件中,却牵扯了不少海面下的陈年往事,主要是:jsx、h(creatElement)、render和vnode的前世此生;如上面效果图,我想渲染的是一个tabs
效果,其对应的代码是下面这样的。
function generateTabs(opt,target,targetKey) {
let {key,props = {}, style = {} , events = [],children = []} = opt;
function _genPane(list) {
return list.map(item=>{
let {props={},content} = item;
return h('el-tab-pane',{
props: {
...props,
key: props.name
}
},[content])
})
}
return h('el-tabs',{
props: {
...props,
value: target[targetKey]
},
style,
on: {
...events,
'tab-click':(item)=>{
target[targetKey] = item.name
}
}
},_genPane(children))
}
复制代码
其中咱们常见的v-model
对应在jsx属性中value
和事件tab-click
;从中咱们也能真正理解以前背的八股文了:v-model是change和value的语法糖。
至于几个关键词的关系,限于篇幅只能在下一篇文章中详细解释,只说一句话:真实dom根据虚拟dom即vnode生成,而render就是返回虚拟dom的函数,h函数是creatElement函数的别名,用于根据配置项生成vnode。
考虑无侵入,采用vue的插件机制:Vue的插件机制其实就是传递use函数一个带install
方法的对象,会默认执行install
方法并传递Vue构造函数。
考虑是debug插件,对外暴露isDev
的配置项(具体阅读【配置项】),若是是测试环境才接入插件
路由守卫在父子组件中的生命周期钩子执行顺序
父beforeRouteEnter - 父beforeMount - 子beforeMount - 父beforeRouteEnter-next - 子mounted - 父mounted
复制代码
beforeRouteEnter
中支持以下写法获取组件实例,假设三级父子路由嵌套,此钩子会匹配三次,而根据洋葱模型原则,咱们能够持有一个变量用于存储路由匹配到的组件,最后一次next函数的赋值就是咱们要的最深的路由匹配组件
beforeRouteEnter (to, from, next) {
next(vm => {
console.log('beforeRouteEnter==',vm.$options.name);
// 最后一个被路由匹配上的就是页面组件
pageVm = vm;
})
},
复制代码
分两种状况:
mounted
才进行插件的初始化,这样就能够避免重复注册的性能浪费v-if
致使页面中组件的装载卸载 :若是其组件的父组件在当前收集中心中,就根据当前页面实例重置收集中心列表
mounted(){
let ids = getCurrentIds()
if( this.$parent && ids.indexOf(this.$parent._uid) !== -1){
emitInitVmDebuPlugin()
}
if(currentPageVm && currentPageVm._uid == this._uid){
emitInitVmDebuPlugin()
}
}
// 触发初始化插件逻辑 根据全部页面组件进行收集中心初始化
export function emitInitVmDebuPlugin(){
// console.log('开始注册逻辑 订阅');
// 根据页面组件获取其对应的收集中心 (考虑都要支持多级路由 此处为将全部PageVmHandler进行收集中心的初始化)
function initVmDebuPlugin(){
// console.log('开始注册逻辑 发布')
// 初始化逻辑
}
// 避免重复调用
nextTick(initVmDebuPlugin)
}
复制代码
此处作一个扩展,有个需求,异步数据使得vue数据改变致使页面变动,但愿能拿到dom。很天然的咱们会想到this.$nextTick
,那他是怎么作到的呢?还有,咱们屡次改变属性值时,页面其实只刷新了一次,又是怎么实现的?
一样言简意赅的说,事件环微任务+防抖且去重,你们程度不一,本菜尽量快速科普一下。
事件环机制对客户端而言,能够简单理解为存在两个队列,分别存放宏任务(setTimeout、setInterval、Promise的构造函数是同步的、setImmediate、I/O、UIrendering)和微任务(Promise的回调(then)、process.nextTick),给个我的记忆思路:若是是语言原生提供的,就是微任务,如Promise;果是宿主环境提供的,如setTimeout则是宏任务。
根据这种机制,Vue中会将函数放在微任务中,好比Promise.resolve()
,这样就能等到页面dom已经挂载上再去获取了。
防抖且去重,这没啥,设个开关和定时器就好;去重能够用Set[...new Set(list)]
,废话很少说,show me code
let callbacks = [];
let waiting = false;
function flushCallbacks(...params) {
callbacks = [...new Set(callbacks)]
for (let i = 0; i < callbacks.length; i++) {
let callback = callbacks[i];
callback(...params);
}
waiting = false;
callbacks = [];
}
export function nextTick(cb,...params) {
callbacks.push(cb); // 默认的cb 是渲染逻辑 用户的逻辑放到渲染逻辑以后便可
if (!waiting) {
waiting = true;
// 1.promise先看支持不支持
// 2.mutationObserver
// 3.setImmdiate
// 4.setTimeout Vue3 next-tick就直接用了promise
Promise.resolve().then(()=>{
flushCallbacks(...params)
}); // 屡次调用nextTick 只会开启一个promise
}
}
复制代码
nextTick的兼容判断我在本身的插件里没用这么复杂,对这个有兴趣的同窗能够自行了解下,核心源码以下
if (typeof Promise !== 'undefined' && isNative(Promise)) {
const p = Promise.resolve()
timerFunc = () => {
p.then(flushCallbacks)
// In problematic UIWebViews, Promise.then doesn't completely break, but
// it can get stuck in a weird state where callbacks are pushed into the
// microtask queue but the queue isn't being flushed, until the browser
// needs to do some other work, e.g. handle a timer. Therefore we can
// "force" the microtask queue to be flushed by adding an empty timer.
if (isIOS) setTimeout(noop)
}
isUsingMicroTask = true
} else if (!isIE && typeof MutationObserver !== 'undefined' && (
isNative(MutationObserver) ||
// PhantomJS and iOS 7.x
MutationObserver.toString() === '[object MutationObserverConstructor]'
)) {
// Use MutationObserver where native Promise is not available,
// e.g. PhantomJS, iOS7, Android 4.4
// (#6466 MutationObserver is unreliable in IE11)
let counter = 1
const observer = new MutationObserver(flushCallbacks)
const textNode = document.createTextNode(String(counter))
observer.observe(textNode, {
characterData: true
})
timerFunc = () => {
counter = (counter + 1) % 2
textNode.data = String(counter)
}
isUsingMicroTask = true
} else if (typeof setImmediate !== 'undefined' && isNative(setImmediate)) {
// Fallback to setImmediate.
// Technically it leverages the (macro) task queue,
// but it is still a better choice than setTimeout.
timerFunc = () => {
setImmediate(flushCallbacks)
}
} else {
// Fallback to setTimeout.
timerFunc = () => {
setTimeout(flushCallbacks, 0)
}
}
复制代码
咱们知道,一个对象若是存在引用,就会干扰js的垃圾回收,假设咱们进行了页面跳转,收集中心仍保持旧页面实例,就会出现这个问题,这里咱们能够采用路由守卫进行清空收集中心的处理。
这里只能点到为止,具体建议阅读【迭代优化】模块,是全部修复问题的心路历程。
// 在页面跳转时清空插件
beforeRouteLeave(to, from, next){
// 清空插件 考虑都要支持多级路由 调用全部的PageVmHandler的重置方法
resetVmDebuPlugin()
next()
},
复制代码
因我司有微前端体系,因此有作兼容,稍微复杂点,不过也差很少,若是不了解微前端的小伙伴,打个广告,能够看下个人微前端系列文章:微前端之singleSPA实战|技术点评,最关键点只有一个:在主应用中能够获取到子应用的全局变量,因此兼容思路以下
isMapp
和getMappWinodow
,前者用以判断是子应用仍是主应用,后者用于在主应用中获取子应用的全局变量这样,咱们就实现了子应用的兼容啦
if(callFn(isDev,window.location)){
// 若是是子应用 则加载子应用的插件
if(isMapp){
return mappPluginFn(options)
}
// 不然 加载主应用的插件
else{
return vmPluginFn(options)
}
}
复制代码
其实核心思路也讲的差很少了,一句话:以页面为单元,收集当前已渲染的组件实例,用户能够自行切换(如目前的点击切换)当前查看变量指向哪一个组件实例,至此,咱们就能够快乐的抛弃console.log
啦(至少别那么常见zzz)。
(很简单,但小伙伴们说挺实用的,大佬们别嫌弃哈,若是能够,烦劳贵手帮南方本小菜点个star鼓励一下吧)
npm i vue-debug-plugin -D
复制代码
import vueDebugPluginFn from 'vue-debug-plugin';
let vueDebugPlugin = vueDebugPluginFn({
/** 无微应用能够忽略 * @param {*} to 路由对象 详情可见vue-router官网 * @param {*} pageVm 当前页面组件实例 * @returns */
getMappWinodow(to,pageVm){
// 若是存在且只存在微前端控制面板 且 子应用存在 则返回
if(to.fullPath == '/'){
return pageVm.app.sandbox.proxy;
}
},
isDev(location){ // 默认为false 不传插件会直接不加载
let localIdentifyings = ['8082','test'];
let isDev = localIdentifyings.some(id => location.href.indexOf(id) !== -1)
return isDev
},
hasElementUI: true // 项目是否接入了elementUi
// isMapp: true 若是是子应用 须要设置为true 无微应用能够忽略
})
Vue.use(vueDebugPlugin)
复制代码
配置项 | 类型 | 做用 | 是否必填 |
---|---|---|---|
getMappWinodow | Function | 获取子应用的全局变量 (若是不须要承接微应用能够不传递);默认参数会传递路由对象和当前页面组件实例 | 否 |
isDev | Function | Boolean | 判断是不是开发环境 若是函数返回为true才接入插件(传入true也行);默认参数会传递当前页面路径(window.location) | 是 |
hasElementUI | Boolean | 项目是否接入了elementUi ,若是接入了则采用其进行优化 | 否 |
isMapp | Boolean | 微应用场景下,子应用也须要引入此插件,若是是子应用 须要将此值设置为true | 否 |
运行效果见文首
<template>
<div class="home">
<h1>{{name}}</h1>
<w-dialog/>
</div>
</template>
<script>
import wDialog from '../components/w-dialog';
export default {
name: 'Home',
components: {
wDialog
},
data(){
return {
name: '老妈身体健康'
}
}
}
</script>
复制代码
其中组件代码
<template>
<div v-show="show" class="wrapper">
{{dianame}}
</div>
</template>
<script>
export default {
components: {},
props: {},
data() {
return {
dianame: '我是弹窗数据-小侄女愈来愈可爱',
show: false
};
}
};
</script>
<style scoped>
.wrapper{}
</style>
复制代码
<template>
<div class="about">
<h1>{{name}}</h1>
</div>
</template>
<script>
export default {
data(){
return {
name: '清哥新婚快乐!!'
}
}
}
</script>
复制代码
在须要调试的组件中调用setVmInstance
,传入key,在window上会挂载$vm${key}
的变量,指向当前组件的实例
维护一个map数据结构,key为setVmInstance
传入的key,值为组件实例,此为订阅;定义setVm
函数,传入key
则会在map上取出对应的实例,并将$vm
指向此实例,此为发布;
存在问题
解决问题
setVm
和$vm
改写为插件形式,进行解耦合;在生命周期中进行判断,若是实例上有定义d_name
,则进行订阅(调用setVmInstance),从而减小对外接口的显示调用
存在问题
解决问题
渲染一个按钮,点击显示渲染面板,将全部订阅的key渲染在面板上,全部的key包裹节点监听点击事件,调用setVm
从而切换组件
存在问题
解决问题
考虑微前端场景,将插件分场景判断,若是是主应用,正常渲染;若是是子应用,在子应用的window(被代理)上挂载vmMap变量,不佳渲染逻辑(使用主应用的),用户传递一个函数getMappWinodow,用户判断和获取子应用的window,若是有返回值,则在主应用中进行vmMap的切换,从而达到承接子应用的效果
存在问题
解决问题
分离主应用和子应用插件功能,暴露配置项isMapp用于判断是否为子应用; 暴露配置项getMappWinodow用于主应用获取子应用的全局变量; 暴露isDev用于判断需不须要加载插件;
存在问题
解决问题
暴露hasElementUI用于判断项目是否接入了elementUI 若是接入了则使用jsx渲染其组件;
d_name
搞了五一三天放假的改进,注册方式再也不放在mixin的mounted中,而是采用beforeRouteEnter
,经过当前页面组件深度递归后代组件进行组件注册
存在问题
解决问题
d_name
采用订阅发布模式,在插件的做用域中维系一个对象,key为setVmInstance
传入的key,值为组件实例,
维护一个map数据结构(这样能够保证插入顺序和渲染顺序一致,下文代指收集中心),此为订阅;定义setVm
函数,传入key
则会在map上取出对应的实例,并将$vm
指向此实例,此为发布;(重点思路,单页应用,也就意味着应用的单元为“页面”,也就是说咱们研究的是页面组件及其对应的后台组件)
mixin中定义setVmInstance,在生命周期中其
this就是指向当前渲染的组件实例,调用setVmInstance存入
vmMap`实现组件的订阅beforeRouteEnter
得到页面组件实例,进行深度递归注册,其中核心点是根据$children
属性获取子组件vmMap
中获取对应组件而后切换效果图里的$vm
指向便可。这是目前最新一版,思路在正文中,就不赘述啦
elementUi
待扩展为能够动态支持UI库,提高扩展性(最近公司太忙了,下次必定,下次必定~)v-if
致使的组件装卸载 最近感触颇多,在上周一的日记看到这样一段话
脑子里忽然想到另外一句诗“念天地之悠悠,独仓然而涕下”,换我如今,一天12个小时+的学或写代码,应该改为“念代码之悠悠”吧,但好像很搞笑的样子。
复制代码
由于业务的庞大,第一次就独立承接一个比较大的需求时不免疲于奔命,忙忙碌碌,但仍是想写,想去优化,五一解决了须要在组件中注册的问题,说不出的开心,搞笑的是昨晚作梦竟然都是同事用个人插件加载不出来而后我去排查的场景,有种看什么东西长大的感受。
每晚很晚走,但不是一我的,还有一个实习生,也是我室友,每次晚上看我都会说:“哎呀志远,太卷了太卷了,别学了”,但每次都会和我一块儿学到很晚。回去的时间大可能是深夜和凌晨的交接线,两我的走在空无一人的大街上,月明星稀,会很肆无忌惮的打打闹闹,偶尔一两辆小吃车,百无聊赖的老板看到有人路过会很快的精神一下,发现不是顾客又会很快的百无聊赖,后来见得次数多了,抬头低头百无聊赖的状态无缝衔接,但仍是几乎每晚都能见到。
老板的坚持出摊,室友的坚持学习,咱们都在坚持着一些东西,无关辛苦,只是愿意,记得高中的时候老师让咱们学鲁迅刻字,写座右铭,当时写的是:一念既定,万山无阻。不是当初想像中的本身,或好或坏,但最起码在必定程度上作到了些什么。
没啥说的了,若使诸君稍有启发,不枉此文心力^-^;
哦对了,还有一件事:八年室友结婚啦,新婚快乐!!!(小伙伴方便的话,star能够不点,帮小菜去掘金留个言【清哥新婚快乐】吧~~~)
哦对了,还有一件事:微医招聘,地标杭州,团队大、大佬多、好看小姐姐多,速来(大佬们留言,我去捞人)
哦对了,还有一件事:能够的话,轻点小手帮小弟点个star呗
哦对了,还有一件事:咱们家冰冰真好看