可以在 vue3 源码中编写单元测试,并通过vscode的vitest插件
断点调试功能,
就可以知道 vue 组件的整个流程,比如下面这个单测,其中包含了两个组件,其中一个作为父组件App
,
一个作为子组件Comp
,用于测试组件的挂载和更新
test('basic component', async () => {
const number = ref(1)
const App = {
setup() {
const innerNumber = number
return () => {
console.log('app render')
return h('div', { id: 'test-id', class: 'test-class' }, [
h(Comp, { value: innerNumber.value }),
])
}
},
}
const Comp = {
props: ['value'],
setup(props: any) {
const x = computed(() => props.value)
return () => {
console.log('son render')
return h('span', null, 'number ' + x.value)
}
},
}
const root = nodeOps.createElement('div')
render(h(App, null), root)
let innerStr = serializeInner(root)
expect(innerStr).toBe(
`<div id="test-id" class="test-class"><span>number 1</span></div>`
)
number.value = 3
await nextTick()
innerStr = serializeInner(root)
expect(innerStr).toBe(
`<div id="test-id" class="test-class"><span>number 3</span></div>`
)
})
挂载流程#
在断点调试render(h(App, null), root)
的过程中,发现首先会进行挂载组件mountComponent
,因为这是第一次渲染,在进入setupComponent
函数,
用于处理 props 和 slots 和一些初始化工作,比如当 setup 函数的返回值是一个对象的时候,代理 setup 的返回值 (proxyRefs(setupResult)
),但是当前的
测试用例并不会走这一步,因为当前返回的是一个渲染函数
const mountComponent = () => {
...
setupComponent(...);
...
setupRenderEffect(...);
...
};
export function setupComponent(
instance: ComponentInternalInstance,
isSSR = false
) {
// ...
const { props, children } = instance.vnode
const isStateful = isStatefulComponent(instance)
initProps(instance, props, isStateful, isSSR)
initSlots(instance, children)
const setupResult = isStateful
? setupStatefulComponent(instance, isSSR)
: undefined
isSSR && setInSSRSetupState(false)
return setupResult
}
当初始化子组件时,因为在父组件传入了 props,{ value: innerNumber.value }
,注意这是一个数字,而不是一个 ref,所以在 initProps 中,会把父组件传递的 props 转换成一个shallowReactive
响应式的数据,
注意用户在子组件里面不应该修改 props,并且修改 props 拦截操作就在上文提到的setupStatefulComponent
中实现 (instance.proxy = markRaw(new Proxy(instance.ctx, PublicInstanceProxyHandlers))
)
export function initProps(
instance: ComponentInternalInstance,
rawProps: Data | null,
isStateful: number, // result of bitwise flag comparison
isSSR = false
) {
const props: Data = {}
if (isStateful) {
// stateful
// 为什么要是用shallowReactive包裹props?下文会进行解释
instance.props = isSSR ? props : shallowReactive(props)
}
}
接下来对渲染函数使用setupRenderEffect
的componentUpdateFn(下文会用到)
进行依赖收集,并且进行渲染
expect(innerStr).toBe(
`<div id="test-id" class="test-class"><span>number 1</span></div>`
)
更新流程#
当修改了number.value = 3
,由于依赖收集首先会重新执行 App 组件的 render,然后在进行 patch,当 patch 到子组件时,
由于 props 发生了变化,则子组件实例会重新更新副作用函数
const updateComponent = (n1: VNode, n2: VNode, optimized: boolean) => {
const instance = (n2.component = n1.component)!
// 为什么vue是组件级别的更新?下文会进行解释
if (shouldUpdateComponent(n1, n2, optimized)) {
...
// 由于props发生了变化,则子组件实例会重新更新副作用函数
instance.effect.dirty = true
instance.update()
} else {
// no update needed. just copy over properties
n2.el = n1.el
instance.vnode = n2
}
...
}
当重新执行子组件更新时,就会更新 Props 和 Slots,并重新执行子组件 render 获取最新的 vnode,并执行 patch 更新操作,然后子组件就更新完成了
// 子组件的更新 instance.update()
const componentUpdateFn = ()=>{
...
updateComponentPreRender(instance, next, optimized)
...
// 更新完成重新得到子组件的vnode,即会重新执行子组件的render
const nextTree = renderComponentRoot(instance)
// 执行patch更新操作
patch(
prevTree,
nextTree,
// parent may have changed if it's in a teleport
hostParentNode(prevTree.el!)!,
// anchor may have changed if it's in a fragment
getNextHostNode(prevTree),
instance,
parentSuspense,
namespace,
)
}
const updateComponentPreRender = (
instance: ComponentInternalInstance,
nextVNode: VNode,
optimized: boolean
) => {
...
// 更新props
updateProps(instance, nextVNode.props, prevProps, optimized)
updateSlots(instance, nextVNode.children, optimized)
...
}
至于为什么要用 shallowReactive 包裹 props#
因为除了渲染函数,其他副作用也会使用 props,如 computed 等,
如果 props 不使用响应式对象,那么只有渲染函数会重新执行,其他的副作用函数,就不会重新执行了,这是一个很严重的 bug,
所以 props 必须是响应式对象,并且也只能是浅的,因为子组件只关心props.x变化了,不关心props.x.a变化了
,
但是有些情况下,会有如下这种代码,直接传递一个对象,这种其实 props.value 并没有更新,相当于 innerNumber
又依赖收集了子组件的渲染函数,并且官方文档不推荐这种写法
test('basic component', async () => {
const App = {
setup() {
const innerNumber = reactive({ data: 1 })
return () => {
console.log('app render')
return h('div', { id: 'test-id', class: 'test-class' }, [
h(Comp, { value: innerNumber }),
])
}
},
}
const Comp = {
props: ['value'],
setup(props: any) {
onMounted(async () => {
props.value.data = 3
await nextTick()
innerStr = serializeInner(root)
expect(innerStr).toBe(
`<div id="test-id" class="test-class"><span>number 3</span></div>`
)
})
return () => {
console.log('son render')
return h('span', null, 'number ' + props.value.data)
}
},
}
const root = nodeOps.createElement('div')
render(h(App, null), root)
let innerStr = serializeInner(root)
expect(innerStr).toBe(
`<div id="test-id" class="test-class"><span>number 1</span></div>`
)
})
至于为什么 vue 是组件级别的更新#
比如下面这个案例pure component
,其中的这个Comp是一个没有props的组件
,在父组件变更的时候shouldUpdateComponent
会返回false
,
就不会走更新这个子组件的分支了,那么就只有父子间的 render 函数会重新执行,子组件的 render 函数就不会重新执行,所以vue是组件级别的更新
test('pure component', async () => {
const number = ref(1)
const App = {
setup() {
const innerNumber = number
return () => {
// number.value = 3 后,会打印 app render
console.log('app render')
return h(
'div',
{ id: 'test-id-' + innerNumber.value, class: 'test-class' },
[h(Comp)],
)
}
},
}
const Comp = {
setup(props: any) {
return () => {
// number.value = 3 后,不会打印 son render
console.log('son render')
return h('span', null, 'number')
}
},
}
const root = nodeOps.createElement('div')
render(h(App, null), root)
number.value = 3
await nextTick()
})
export function shouldUpdateComponent(
prevVNode: VNode,
nextVNode: VNode,
optimized?: boolean,
): boolean {
const { props: prevProps } = prevVNode
const { props: nextProps } = nextVNode
...
// 这里就是解释了为什么vue是组件级别的更新了
// 就比如上文提到的test('pure component')这个单测
// 那么prevProps和nextProps都是null,所以return false,
// 就不会走更新这个子组件的分支了 不会执行 instance.update()
if (prevProps === nextProps) {
return false
}
...
return false
}