写作不易,未经作者允许禁止以任何形式转载!
effect作为Vue响应式原理中的核心,在Computed、Watch、Reactive中都有出现 主要和Reactive(Proxy)、track、trigger等函数配合实现收集依赖,触发依赖更新
effect可以被理解为一个副作用函数,被当做依赖收集,在响应式数据更新后被触发。 Vue的响应式API例如Computed、Watch都有用到effect来实现
function effect<T = any>(
fn: () => T,
options: ReactiveEffectOptions = EMPTY_OBJ
): ReactiveEffect<T> {
// 如果已经是effect,则重置
if (isEffect(fn)) {
fn = fn.raw
}
// 创建effect
const effect = createReactiveEffect(fn, options)
// 如果不是惰性执行,先执行一次
if (!options.lazy) {
effect()
}
return effect
}
const effectStack: ReactiveEffect[] = []
function createReactiveEffect<T = any>(
fn: () => T,
options: ReactiveEffectOptions
): ReactiveEffect<T> {
const effect = function reactiveEffect(): unknown {
// 没有激活,说明调用了effect stop函数
if (!effect.active) {
// 无调度者则直接返回,否则执行fn
return options.scheduler ? undefined : fn()
}
// 判断EffectStack中有没有effect,有则不处理
if (!effectStack.includes(effect)) {
// 清除effect
cleanup(effect)
try {
/*
* 开始重新收集依赖
* 压入stack
* 将effect设置为activeEffect
* */
enableTracking()
effectStack.push(effect)
activeEffect = effect
return fn()
} finally {
/*
* 完成后将effect弹出
* 重置依赖
* 重置activeEffect
* */
effectStack.pop()
resetTracking()
activeEffect = effectStack[effectStack.length - 1]
}
}
} as ReactiveEffect
effect.id = uid++ // 自增id,effect唯一标识
effect.allowRecurse = !!options.allowRecurse
effect._isEffect = true // 是否是effect
effect.active = true // 是否激活
effect.raw = fn // 挂载原始对象
effect.deps = [] // 当前effect的dep数组
effect.options = options // 传入的options
return effect
}
// 每次effect运行都会重新收集依赖,deps是effect的依赖数组,需要全部清空
function cleanup(effect: ReactiveEffect) {
const { deps } = effect
if (deps.length) {
for (let i = 0; i < deps.length; i++) {
deps[i].delete(effect)
}
deps.length = 0
}
}
Track这个函数常出现在reactive的getter函数中,用于依赖收集 源码详解见注释
function track(target: object, type: TrackOpTypes, key: unknown) {
// activeEffect为空表示没有依赖
if (!shouldTrack || activeEffect === undefined) {
return
}
// targetMap依赖管理Map,用于收集依赖
// 检查targetMap中有没有target,没有则新建
let depsMap = targetMap.get(target)
if (!depsMap) {
targetMap.set(target, (depsMap = new Map()))
}
// dep用来收集依赖函数,当监听的key值发生变化,触发dep中的依赖函数更新
let dep = depsMap.get(key)
if (!dep) {
depsMap.set(key, (dep = new Set()))
}
if (!dep.has(activeEffect)) {
dep.add(activeEffect)
activeEffect.deps.push(dep)
// 开发环境会触发onTrack,仅用于调试
if (__DEV__ && activeEffect.options.onTrack) {
activeEffect.options.onTrack({
effect: activeEffect,
target,
type,
key
})
}
}
}
Trigger常出现在reactive中的setter函数中,用于触发依赖更新 源码详解见注释
function trigger(
target: object,
type: TriggerOpTypes,
key?: unknown,
newValue?: unknown,
oldValue?: unknown,
oldTarget?: Map<unknown, unknown> | Set<unknown>
) {
// 获取依赖Map,如果没有则不需要触发
const depsMap = targetMap.get(target)
if (!depsMap) {
// never been tracked
return
}
// 使用Set保存需要触发的effect,避免重复
const effects = new Set<ReactiveEffect>()
// 定义依赖添加函数
const add = (effectsToAdd: Set<ReactiveEffect> | undefined) => {
if (effectsToAdd) {
effectsToAdd.forEach(effect => {
if (effect !== activeEffect || effect.allowRecurse) {
effects.add(effect)
}
})
}
}
// 将depsMap中的依赖添加到effects中
// 只为了理解和原理的话 各个分支不用细看
if (type === TriggerOpTypes.CLEAR) {
// collection being cleared
// trigger all effects for target
depsMap.forEach(add)
} else if (key === 'length' && isArray(target)) {
depsMap.forEach((dep, key) => {
if (key === 'length' || key >= (newValue as number)) {
add(dep)
}
})
} else {
// schedule runs for SET | ADD | DELETE
if (key !== void 0) {
add(depsMap.get(key))
}
// also run for iteration key on ADD | DELETE | Map.SET
switch (type) {
case TriggerOpTypes.ADD:
if (!isArray(target)) {
add(depsMap.get(ITERATE_KEY))
if (isMap(target)) {
add(depsMap.get(MAP_KEY_ITERATE_KEY))
}
} else if (isIntegerKey(key)) {
// new index added to array -> length changes
add(depsMap.get('length'))
}
break
case TriggerOpTypes.DELETE:
if (!isArray(target)) {
add(depsMap.get(ITERATE_KEY))
if (isMap(target)) {
add(depsMap.get(MAP_KEY_ITERATE_KEY))
}
}
break
case TriggerOpTypes.SET:
if (isMap(target)) {
add(depsMap.get(ITERATE_KEY))
}
break
}
}
// 封装effects执行函数
const run = (effect: ReactiveEffect) => {
if (__DEV__ && effect.options.onTrigger) {
effect.options.onTrigger({
effect,
target,
key,
type,
newValue,
oldValue,
oldTarget
})
}
// 如果存在scheduler则调用
if (effect.options.scheduler) {
effect.options.scheduler(effect)
} else {
effect()
}
}
// 触发effects中的所有依赖函数
effects.forEach(run)
}
了解了Track用于依赖收集,Trigger用于依赖触发,那么他们的调用时机是什么时候呢?来看看Reactive的源码就清楚了,源码详解见注释。 注:源码结构较为复杂(封装),为便于理解原理,以下为简化源码。
function reactive(target:object){
return new Proxy(target,{
get(target: Target, key: string | symbol, receiver: object){
const res = Reflect.get(target, key, receiver)
track(target, TrackOpTypes.GET, key)
return res
}
set(target: object, key: string | symbol, value: unknown, receiver: object){
let oldValue = (target as any)[key]
const result = Reflect.set(target, key, value, receiver)
// trigger(target, TriggerOpTypes.ADD, key, value)
trigger(target, TriggerOpTypes.SET, key, value, oldValue)
return result
}
})
}
Computed是Vue中常用且好用的一个属性,这个属性的值在依赖改变后同步进行改变,在依赖未改变时使用缓存的值。
Show me the Code
function computed<T>(
getterOrOptions: ComputedGetter<T> | WritableComputedOptions<T>
) {
let getter: ComputedGetter<T>
let setter: ComputedSetter<T>
if (isFunction(getterOrOptions)) {
getter = getterOrOptions
setter = __DEV__
? () => {
console.warn('Write operation failed: computed value is readonly')
}
: NOOP
} else {
getter = getterOrOptions.get
setter = getterOrOptions.set
}
return new ComputedRefImpl(
getter,
setter,
isFunction(getterOrOptions) || !getterOrOptions.set
) as any
}
class ComputedRefImpl<T> {
private _value!: T
private _dirty = true
public readonly effect: ReactiveEffect<T>
public readonly __v_isRef = true;
public readonly [ReactiveFlags.IS_READONLY]: boolean
constructor(
getter: ComputedGetter<T>,
private readonly _setter: ComputedSetter<T>,
isReadonly: boolean
) {
this.effect = effect(getter, {
lazy: true,
// 响应式数据更新后将dirty赋值为true
// 下次执行getter判断dirty为true即重新计算computed值
scheduler: () => {
if (!this._dirty) {
this._dirty = true
// 派发所有引用当前计算属性的副作用函数effect
trigger(toRaw(this), TriggerOpTypes.SET, 'value')
}
}
})
this[ReactiveFlags.IS_READONLY] = isReadonly
}
get value() {
// the computed ref may get wrapped by other proxies e.g. readonly() #3376
const self = toRaw(this)
// 当响应式数据更新后dirty为true
// 重新计算数据后,将dirty赋值为false
if (self._dirty) {
self._value = this.effect()
self._dirty = false
}
// 依赖收集
track(self, TrackOpTypes.GET, 'value')
// 返回计算后的值
return self._value
}
set value(newValue: T) {
this._setter(newValue)
}
}
Watch主要用于对某个变量的监听,并做相应的处理 Vue3中不仅重构了watch,还多了一个WatchEffect API
用于对某个变量的监听,同时可以通过callBack拿到新值和旧值
watch(state, (state, prevState)=>{})
每次更新都会执行,自动收集使用到的依赖
无法获取到新值和旧值,可手动停止监听
onInvalidate(fn)
传入的回调会在watchEffect
重新运行或者watchEffect
停止的时候执行
const stop = watchEffect((onInvalidate)=>{
// ...
onInvalidate(()=>{
// ...
})
})
// 手动停止监听
stop()
Show me the Code
// watch
export function watch<T = any, Immediate extends Readonly<boolean> = false>(
source: T | WatchSource<T>,
cb: any,
options?: WatchOptions<Immediate>
): WatchStopHandle {
if (__DEV__ && !isFunction(cb)) {
warn(
`\`watch(fn, options?)\` signature has been moved to a separate API. ` +
`Use \`watchEffect(fn, options?)\` instead. \`watch\` now only ` +
`supports \`watch(source, cb, options?) signature.`
)
}
return doWatch(source as any, cb, options)
}
export function watchEffect(
effect: WatchEffect,
options?: WatchOptionsBase
): WatchStopHandle {
return doWatch(effect, null, options)
}
以下为删减版源码,理解核心原理即可 详情见注释
function doWatch(
source: WatchSource | WatchSource[] | WatchEffect | object,
cb: WatchCallback | null,
{ immediate, deep, flush, onTrack, onTrigger }: WatchOptions = EMPTY_OBJ,
instance = currentInstance
): WatchStopHandle {
let getter: () => any
let forceTrigger = false
let isMultiSource = false
// 对不同的情况做getter赋值
if (isRef(source)) {
// ref通过.value获取
getter = () => (source as Ref).value
forceTrigger = !!(source as Ref)._shallow
} else if (isReactive(source)) {
// reactive直接获取
getter = () => source
deep = true
} else if (isArray(source)) {
// 如果是数组,做遍历处理
isMultiSource = true
forceTrigger = source.some(isReactive)
getter = () =>
source.map(s => {
if (isRef(s)) {
return s.value
} else if (isReactive(s)) {
return traverse(s)
} else if (isFunction(s)) {
return callWithErrorHandling(s, instance, ErrorCodes.WATCH_GETTER, [
instance && (instance.proxy as any)
])
} else {
__DEV__ && warnInvalidSource(s)
}
})
} else if (isFunction(source)) {
// 如果是函数的情况
// 有cb则为watch,没有则为watchEffect
if (cb) {
// getter with cb
getter = () =>
callWithErrorHandling(source, instance, ErrorCodes.WATCH_GETTER, [
instance && (instance.proxy as any)
])
} else {
// no cb -> simple effect
getter = () => {
if (instance && instance.isUnmounted) {
return
}
if (cleanup) {
cleanup()
}
return callWithAsyncErrorHandling(
source,
instance,
ErrorCodes.WATCH_CALLBACK,
[onInvalidate]
)
}
}
} else {
// 异常情况
getter = NOOP
// 抛出异常
__DEV__ && warnInvalidSource(source)
}
// 深度监听逻辑处理
if (cb && deep) {
const baseGetter = getter
getter = () => traverse(baseGetter())
}
let cleanup: () => void
let onInvalidate: InvalidateCbRegistrator = (fn: () => void) => {
cleanup = runner.options.onStop = () => {
callWithErrorHandling(fn, instance, ErrorCodes.WATCH_CLEANUP)
}
}
// 记录oldValue,并通过runner获取newValue
// callback的封装处理为job
let oldValue = isMultiSource ? [] : INITIAL_WATCHER_VALUE
const job: SchedulerJob = () => {
if (!runner.active) {
return
}
if (cb) {
// watch(source, cb)
const newValue = runner()
if (
deep ||
forceTrigger ||
(isMultiSource
? (newValue as any[]).some((v, i) =>
hasChanged(v, (oldValue as any[])[i])
)
: hasChanged(newValue, oldValue)) ||
(__COMPAT__ &&
isArray(newValue) &&
isCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance))
) {
// cleanup before running cb again
if (cleanup) {
cleanup()
}
callWithAsyncErrorHandling(cb, instance, ErrorCodes.WATCH_CALLBACK, [
newValue,
// pass undefined as the old value when it's changed for the first time
oldValue === INITIAL_WATCHER_VALUE ? undefined : oldValue,
onInvalidate
])
oldValue = newValue
}
} else {
// watchEffect
runner()
}
}
// important: mark the job as a watcher callback so that scheduler knows
// it is allowed to self-trigger (#1727)
job.allowRecurse = !!cb
// 通过读取配置,处理job的触发时机
// 并再次将job的执行封装到scheduler中
let scheduler: ReactiveEffectOptions['scheduler']
if (flush === 'sync') { // 同步执行
scheduler = job
} else if (flush === 'post') { // 更新后执行
scheduler = () => queuePostRenderEffect(job, instance && instance.suspense)
} else {
// default: 'pre'
// 更新前执行
scheduler = () => {
if (!instance || instance.isMounted) {
queuePreFlushCb(job)
} else {
// with 'pre' option, the first call must happen before
// the component is mounted so it is called synchronously.
job()
}
}
}
// 使用effect副作用处理依赖收集,在依赖更新后调用scheduler(其中封装了callback的执行)
const runner = effect(getter, {
lazy: true,
onTrack,
onTrigger,
scheduler
})
// 收集依赖
recordInstanceBoundEffect(runner, instance)
// 读取配置,进行watch初始化
// 是否有cb
if (cb) {
// 是否立刻执行
if (immediate) {
job()
} else {
oldValue = runner()
}
} else if (flush === 'post') {
// 是否更新后执行
queuePostRenderEffect(runner, instance && instance.suspense)
} else {
runner()
}
// 返回手动停止函数
return () => {
stop(runner)
if (instance) {
remove(instance.effects!, runner)
}
}
}
Mixin意为混合,是公共逻辑封装利器。 原理比较简单,那就是合并。
function mergeOptions(
to: any,
from: any,
instance?: ComponentInternalInstance | null,
strats = instance && instance.appContext.config.optionMergeStrategies
) {
if (__COMPAT__ && isFunction(from)) {
from = from.options
}
const { mixins, extends: extendsOptions } = from
extendsOptions && mergeOptions(to, extendsOptions, instance, strats)
mixins &&
mixins.forEach((m: ComponentOptionsMixin) =>
mergeOptions(to, m, instance, strats)
)
// 对mixin中的对象进行遍历
for (const key in from) {
// 如果存在则进行覆盖处理
if (strats && hasOwn(strats, key)) {
to[key] = strats[key](to[key], from[key], instance && instance.proxy, key)
} else {
// 如果不存在则直接赋值
to[key] = from[key]
}
}
return to
}
简单粗暴放进Set,调用时依次调用
function mergeHook(
to: Function[] | Function | undefined,
from: Function | Function[]
) {
return Array.from(new Set([...toArray(to), ...toArray(from)]))
}
Vuex是在Vue中常用的状态管理库,在Vue3发布后,这个状态管理库也随之发出了适配Vue3的Vuex4
this.$store
访问到store数据?new Vue
,创建了一个Vue实例,相当于借用了Vue的响应式。总的来看,可以把Vue3.x理解为一个每个组件都注入了的mixin?
去除冗余代码看本质
export function createStore (options) {
return new Store(options)
}
class Store{
constructor (options = {}){
// 省略若干代码...
this._modules = new ModuleCollection(options)
const state = this._modules.root.state
resetStoreState(this, state)
// bind commit and dispatch to self
const store = this
const { dispatch, commit } = this
this.dispatch = function boundDispatch (type, payload) {
return dispatch.call(store, type, payload)
}
this.commit = function boundCommit (type, payload, options) {
return commit.call(store, type, payload, options)
}
// 省略若干代码...
}
}
function resetStoreState (store, state, hot) {
// 省略若干代码...
store._state = reactive({
data: state
})
// 省略若干代码...
}
export function createAppAPI<HostElement>(
render: RootRenderFunction,
hydrate?: RootHydrateFunction
): CreateAppFunction<HostElement> {
return function createApp(rootComponent, rootProps = null) {
// 省略部分代码....
const app: App = (context.app = {
_uid: uid++,
_component: rootComponent as ConcreteComponent,
_props: rootProps,
_container: null,
_context: context,
version,
// 省略部分代码....
use(plugin: Plugin, ...options: any[]) {
if (installedPlugins.has(plugin)) {
__DEV__ && warn(`Plugin has already been applied to target app.`)
} else if (plugin && isFunction(plugin.install)) {
installedPlugins.add(plugin)
plugin.install(app, ...options)
} else if (isFunction(plugin)) {
installedPlugins.add(plugin)
plugin(app, ...options)
} else if (__DEV__) {
warn(
`A plugin must either be a function or an object with an "install" ` +
`function.`
)
}
return app
},
// 省略部分代码 ....
}
}
下面接着看provide实现
install (app, injectKey) {
// 实现通过inject获取
app.provide(injectKey || storeKey, this)
// 实现this.$store获取
app.config.globalProperties.$store = this
}
provide(key, value) {
// 已存在则警告
if (__DEV__ && (key as string | symbol) in context.provides) {
warn(
`App already provides property with key "${String(key)}". ` +
`It will be overwritten with the new value.`
)
}
// 将store放入context的provide中
context.provides[key as string] = value
return app
}
// context相关 context为上下文对象
const context = createAppContext()
export function createAppContext(): AppContext {
return {
app: null as any,
config: {
isNativeTag: NO,
performance: false,
globalProperties: {},
optionMergeStrategies: {},
errorHandler: undefined,
warnHandler: undefined,
compilerOptions: {}
},
mixins: [],
components: {},
directives: {},
provides: Object.create(null)
}
}
import { useStore } from 'vuex'
export default{
setup(){
const store = useStore();
}
}
function useStore (key = null) {
return inject(key !== null ? key : storeKey)
}
function inject(
key: InjectionKey<any> | string,
defaultValue?: unknown,
treatDefaultAsFactory = false
) {
const instance = currentInstance || currentRenderingInstance
if (instance) {
// 有父级实例则取父级实例的provides,没有则取根实例的provides
const provides =
instance.parent == null
? instance.vnode.appContext && instance.vnode.appContext.provides
: instance.parent.provides
// 通过provide时存入的key取出store
if (provides && (key as string | symbol) in provides) {
return provides[key as string]
// 省略一部分代码......
}
}
function provide<T>(key: InjectionKey<T> | string | number, value: T) {
if (!currentInstance) {
if (__DEV__) {
warn(`provide() can only be used inside setup().`)
}
} else {
let provides = currentInstance.provides
const parentProvides =
currentInstance.parent && currentInstance.parent.provides
if (parentProvides === provides) {
provides = currentInstance.provides = Object.create(parentProvides)
}
// TS doesn't allow symbol as index type
provides[key as string] = value
}
}
function createComponentInstance(vnode, parent, suspense) {
const type = vnode.type;
const appContext = (parent ? parent.appContext : vnode.appContext) || emptyAppContext;
const instance = {
parent,
appContext,
// ...
provides: parent ? parent.provides : Object.create(appContext.provides),
// ...
}
// ...
return instance;
}
可从vue中引入provide、inject、getCurrentInstance等API进行库开发 / 高阶用法,这里不过多赘述。
了解Vue3的Diff算法优化前,可以先了解一下Vue2的Diff算法 本部分注重把算法讲清楚,将不进行逐行源码分析
「最长递增子序列」 减少Dom元素的移动,达到最少的 dom 操作以减小开销。 关于最长递增子序列算法可以看看最长递增子序列
Vue2中对vdom进行全量Diff,Vue3中增加了静态标记进行非全量Diff 对vnode打了像以下枚举内的静态标记
export const enum PatchFlags{
TEXT = 1 , //动态文本节点
CLASS = 1 << 1, //2 动态class
STYLE = 1 << 2, //4 动态style
PROPS = 1 << 3, //8 动态属性,但不包含类名和样式
FULL_PROPS = 1 << 4, //16 具有动态key属性,当key改变时,需进行完整的diff比较
HYDRATE_EVENTS = 1 << 5,//32 带有监听事件的节点
STABLE_FRAGMENT = 1 << 6, //64 一个不会改变子节点顺序的fragment
KEYED_FRAGMENT = 1 << 7, //128 带有key属性的fragment或部分子节点有key
UNKEYEN_FRAGMENT = 1 << 8, //256 子节点没有key的fragment
NEED_PATCH = 1 << 9, //512 一个节点只会进行非props比较
DYNAMIC_SLOTS = 1 << 10,//1024 动态slot
HOISTED = -1, //静态节点
//指示在diff过程中要退出优化模式
BAIL = -2
}
<div>
<p>Hello World</p>
<p>{{msg}}</p>
</div>
对msg变量进行了标记
import { createVNode as _createVNode, toDisplayString as _toDisplayString, openBlock as _openBlock, createBlock as _createBlock } from "vue"
export function render(_ctx, _cache, $props, $setup, $data, $options) {
return (_openBlock(), _createBlock("div", null, [
_createVNode("p", null, "Hello World"),
_createVNode("p", null, _toDisplayString(_ctx.msg), 1 /* TEXT */)
]))
}
// Check the console for the AST
import { createVNode as _createVNode, toDisplayString as _toDisplayString, openBlock as _openBlock, createBlock as _createBlock } from "vue"
/*
* 静态提升前
*/
export function render(_ctx, _cache, $props, $setup, $data, $options) {
return (_openBlock(), _createBlock("div", null, [
_createVNode("p", null, "Xmo"),
_createVNode("p", null, "Xmo"),
_createVNode("p", null, "Xmo"),
_createVNode("p", null, _toDisplayString(_ctx.msg), 1 /* TEXT */)
]))
}
/*
* 静态提升后
*/
const _hoisted_1 = /*#__PURE__*/_createVNode("p", null, "Xmo", -1 /* HOISTED */)
const _hoisted_2 = /*#__PURE__*/_createVNode("p", null, "Xmo", -1 /* HOISTED */)
const _hoisted_3 = /*#__PURE__*/_createVNode("p", null, "Xmo", -1 /* HOISTED */)
export function render(_ctx, _cache, $props, $setup, $data, $options) {
return (_openBlock(), _createBlock("div", null, [
_hoisted_1,
_hoisted_2,
_hoisted_3,
_createVNode("p", null, _toDisplayString(_ctx.msg), 1 /* TEXT */)
]))
}
// Check the console for the AST
// 模板
<div>
<button @click="onClick">btn</button>
</div>
// 使用缓存前
// 这里我们还没有开启事件监听缓存,熟悉的静态标记 8 /* PROPS */ 出现了,
// 它将标签的 Props (属性) 标记动态属性。
// 如果我们存在属性不会改变,不希望这个属性被标记为动态,那么就需要 cacheHandler 的出场了。
import { createVNode as _createVNode, openBlock as _openBlock, createBlock as _createBlock } from "vue"
export function render(_ctx, _cache, $props, $setup, $data, $options) {
return (_openBlock(), _createBlock("div", null, [
_createVNode("button", { onClick: _ctx.onClick }, "btn", 8 /* PROPS */, ["onClick"])
]))
}
// Check the console for the AST
// 使用缓存后
import { createVNode as _createVNode, openBlock as _openBlock, createBlock as _createBlock } from "vue"
export function render(_ctx, _cache, $props, $setup, $data, $options) {
return (_openBlock(), _createBlock("div", null, [
_createVNode("button", {
onClick: _cache[1] || (_cache[1] = (...args) => (_ctx.onClick(...args)))
}, "btn")
]))
}
// Check the console for the AST
它的意思很明显,onClick 方法被存入 cache。 在使用的时候,如果能在缓存中找到这个方法,那么它将直接被使用。 如果找不到,那么将这个方法注入缓存。 总之,就是把方法给缓存了。