Vue3源碼解讀effectScope API及實現(xiàn)原理
vue3新增effectScope相關(guān)的API
其官方的描述是創(chuàng)建一個 effect 作用域,可以捕獲其中所創(chuàng)建的響應(yīng)式副作用 (即計算屬性和偵聽器),這樣捕獲到的副作用可以一起處理。并給出了示例:
const scope = effectScope()
scope.run(() => {
const doubled = computed(() => counter.value * 2)
watch(doubled, () => console.log(doubled.value))
watchEffect(() => console.log('Count: ', doubled.value))
})
// 處理掉當前作用域內(nèi)的所有 effect
scope.stop()
我們就從這個示例入手看看具體的源碼實現(xiàn):
effectScope
// packages/reactivity/src/effectScope.ts
export function effectScope(detached?: boolean) {
// 返回EffectScope實例
return new EffectScope(detached)
}
EffectScope
export class EffectScope {
/**
* @internal
*/
private _active = true
/**
* @internal
*/
effects: ReactiveEffect[] = []
/**
* @internal
*/
cleanups: (() => void)[] = []
/**
* only assigned by undetached scope
* @internal
*/
parent: EffectScope | undefined
/**
* record undetached scopes
* @internal
*/
scopes: EffectScope[] | undefined
/**
* track a child scope's index in its parent's scopes array for optimized
* // index作用:在父作用域數(shù)組中跟蹤子作用域范圍索引以進行優(yōu)化。
* removal
* @internal
*/
private index: number | undefined
constructor(public detached = false) {
// 記錄當前scope為parent scope
this.parent = activeEffectScope
if (!detached && activeEffectScope) {
this.index =
(activeEffectScope.scopes || (activeEffectScope.scopes = [])).push(
this
) - 1
}
}
get active() {
return this._active
}
run<T>(fn: () => T): T | undefined {
if (this._active) {
const currentEffectScope = activeEffectScope
try {
activeEffectScope = this
return fn()
} finally {
activeEffectScope = currentEffectScope
}
} else if (__DEV__) {
warn(`cannot run an inactive effect scope.`)
}
}
/**
* This should only be called on non-detached scopes
* 必須在非分離的作用域上調(diào)用
* @internal
*/
on() {
activeEffectScope = this
}
/**
* This should only be called on non-detached scopes
* @internal
*/
off() {
activeEffectScope = this.parent
}
// stop方法
stop(fromParent?: boolean) {
if (this._active) {
let i, l
// stop effects
for (i = 0, l = this.effects.length; i < l; i++) {
this.effects[i].stop()
}
// 執(zhí)行所有的cleanups
for (i = 0, l = this.cleanups.length; i < l; i++) {
this.cleanups[i]()
}
// 遞歸停止所有的子作用域
if (this.scopes) {
for (i = 0, l = this.scopes.length; i < l; i++) {
this.scopes[i].stop(true)
}
}
// nested scope, dereference from parent to avoid memory leaks
if (!this.detached && this.parent && !fromParent) {
// optimized O(1) removal
const last = this.parent.scopes!.pop()
if (last && last !== this) {
this.parent.scopes![this.index!] = last
last.index = this.index!
}
}
this.parent = undefined
this._active = false
}
}
}
在執(zhí)行scope.run的時候會將this賦值到全局的activeEffectScope變量,然后執(zhí)行傳入函數(shù)。對于computed、watch、watchEffect(watchEffect是調(diào)用doWatch實現(xiàn)的,與watch實現(xiàn)響應(yīng)式綁定的方式相同)這些API都會創(chuàng)建ReactiveEffect實例來建立響應(yīng)式關(guān)系,而收集對應(yīng)的響應(yīng)式副作用就發(fā)生在ReactiveEffect創(chuàng)建的時候,我們來看一下ReactiveEffect的構(gòu)造函數(shù):
// ReactiveEffect的構(gòu)造函數(shù)
constructor(
public fn: () => T,
public scheduler: EffectScheduler | null = null,
scope?: EffectScope
) {
// effect實例默認會被記錄到指定scope中
// 如果沒有指定scope則會記錄到全局activeEffectScope中
recordEffectScope(this, scope)
}
// recordEffectScope實現(xiàn)
export function recordEffectScope(
effect: ReactiveEffect,
// scope默認值為activeEffectScope
scope: EffectScope | undefined = activeEffectScope
) {
if (scope && scope.active) {
scope.effects.push(effect)
}
}
可以看到如果我們沒有傳入scope參數(shù),那么在執(zhí)行recordEffectScope時就會有一個默認的參數(shù)為activeEffectScope,這個值不正是我們scope.run的時候賦值的嗎!所以新創(chuàng)建的effect會被放到activeEffectScope.effects中,這就是響應(yīng)式副作用的收集過程。
那么對于一起處理就比較簡單了,只需要處理scope.effects即可
組件的scope
日常開發(fā)中其實并不需要我們關(guān)心組件副作用的收集和清除,因為這些操作是已經(jīng)內(nèi)置好的,我們來看一下源碼中是怎么做的
組件實例中的scope
在組件實例創(chuàng)建的時候就已經(jīng)new了一個屬于自已的scope對象了:
const instance: ComponentInternalInstance = {
...
// 初始化scope
scope: new EffectScope(true /* detached */),
...
}
在我們執(zhí)行setup之前,會調(diào)用setCurrentInstance,他會調(diào)用instance.scope.on,那么就會將activeEffectScope賦值為instance.scope,那么在setup中注冊的computed、watch等就都會被收集到instance.scope.effects
function setupStatefulComponent(
instance: ComponentInternalInstance,
isSSR: boolean
) {
// 組件對象
const Component = instance.type as ComponentOptions
...
// 2. call setup()
const { setup } = Component
if (setup) {
// 創(chuàng)建setupContext
const setupContext = (instance.setupContext =
// setup參數(shù)個數(shù)判斷 大于一個參數(shù)創(chuàng)建setupContext
setup.length > 1 ? createSetupContext(instance) : null)
// instance賦值給currentInstance
// 設(shè)置當前實例為instance 為了在setup中可以通過getCurrentInstance獲取到當前實例
// 同時開啟instance.scope.on()
setCurrentInstance(instance)
// 暫停tracking 暫停收集副作用函數(shù)
pauseTracking()
// 執(zhí)行setup
const setupResult = callWithErrorHandling(
setup,
instance,
ErrorCodes.SETUP_FUNCTION,
// setup參數(shù)
[__DEV__ ? shallowReadonly(instance.props) : instance.props, setupContext]
)
// 重新開啟副作用收集
resetTracking()
// currentInstance置為空
// activeEffectScope賦值為instance.scope.parent
// 同時instance.scope.off()
unsetCurrentInstance()
...
} else {
finishComponentSetup(instance, isSSR)
}
}
對于選項式API的收集是同樣的操作:
// support for 2.x options
if (__FEATURE_OPTIONS_API__ && !(__COMPAT__ && skipOptions)) {
setCurrentInstance(instance)
pauseTracking()
// 處理options API
applyOptions(instance)
resetTracking()
unsetCurrentInstance()
}
完成了收集那么對于清理就只需要在組件卸載的時候執(zhí)行stop方法即可:
// packages/runtime-core/src/renderer.ts
const unmountComponent = (
instance: ComponentInternalInstance,
parentSuspense: SuspenseBoundary | null,
doRemove?: boolean
) => {
if (__DEV__ && instance.type.__hmrId) {
unregisterHMR(instance)
}
const { bum, scope, update, subTree, um } = instance
...
// stop effects in component scope
// 副作用清除
scope.stop()
...
}以上就是Vue3源碼解讀effectScope API及實現(xiàn)原理的詳細內(nèi)容,更多關(guān)于Vue3 effectScope API的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
詳解SpringBoot 解決攔截器注入Service為空問題
這篇文章主要介紹了詳解SpringBoot 解決攔截器注入Service為空問題的解決,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-06-06
使用Spring自定義實現(xiàn)IOC和依賴注入(注解方式)
這篇文章主要介紹了使用Spring自定義實現(xiàn)IOC和依賴注入(注解方式),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08
Java異常處理之java.lang.ClassCastException問題
這篇文章主要介紹了Java異常處理之java.lang.ClassCastException問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
Java數(shù)據(jù)結(jié)構(gòu)與算法學習之雙向鏈表
雙向鏈表也叫雙鏈表,是鏈表的一種,它的每個數(shù)據(jù)結(jié)點中都有兩個指針,分別指向直接后繼和直接前驅(qū)。所以,從雙向鏈表中的任意一個結(jié)點開始,都可以很方便地訪問它的前驅(qū)結(jié)點和后繼結(jié)點。本文將為大家詳細介紹雙向鏈表的特點與使用,需要的可以參考一下2021-12-12

