当下vue3如此火热,vue3的下一代轻量级状态管理工具pinia也是我们必不可少的学习对象,想要学习pinia,就要知道它的实现原理
现在我们就手把手实现一个自己的青铜版pinia
pinia的核心实现原理和 组合式api effectScope 密不可分,那么组合式api effectScope 有什么作用呢,我们可以看下官网的描述:
创建一个 effect 作用域,可以捕获其中所创建的响应式副作用 (即计算属性和侦听器),这样捕获到的副作用可以一起处理
这段描述说明 effectScope() 执行后会创建一个副作用域,并返回一个对象,对象上面提供一个run方法和stop方法
run方法接受一个函数,函数内部执行的所有关于响应式的代码都会被捕获对应的依赖,当具有响应式代理对象属性发生变化的时候,所有依赖于该对象属性的组件都会被 重新渲染
stop函数执行则是可以使run 函数内的所有关于代理对象的响应式都失效,也就是将收集到的依赖全部释放
有点绕,没关系,我们直接上代码
首先创建一个store对象,对象上有 state 对象,和useStore 函数
useStore 函数和pinia的useStore 的功能和使用方式类似
函数内创建一个 setup 函数,该函数和vue3的setup 函数类似
里面利用 reactive 执行创建响应式对象,并记录下来保存到 store.state 上,然后返回store.state给组件使用
那么如何让使用 store.state 的组件具有当store.state的属性值改变后而重新执行渲染功能呢
这个时候 effectScope API的作用就来了,他可以帮我们完成这个事情
effectScope() 执行得到一个 scope 对象,执行 scope.run()的时候会将传入run函数里面的函数执行,我们只需要将setup函数传入
setup函数里面的所有关于响应式对象的使用依赖都会被收集,每当一个新的组件引用 useStore 的时候都会创建一个新的 scope.run(setup) 执行,每个使用到useStore的组件都会被收集依赖
这样每个依赖到store.state的组件都能在store.state改变的时候进行重新渲染
const store = {
state: {
val: 0
},
useStore () {
// 创建响应式的 setup 函数,效果和vue中的 setup 是一样的,都是用来收集数据响应式依赖的
const setup = () => {
// 让 this.state 成为响应式代理对象
// 先判断 this.state 是否是一个reactive生成的响应式的代理对象,是的话就不需要 this.state 再次成为响应式代理对象了
if (!Vue.isReactive(this.state)) {
this.state = Vue.reactive(this.state)
}
}
const scope = Vue.effectScope()
// 执行run 的时候会执行setup函数,收集依赖
scope.run(setup)
return this.state
}
}
然后我们创建两个子组件并使用这个store
<body>
<script
src="https://cdnjs.cloudflare.com/ajax/libs/vue/3.2.37/vue.global.min.js"
integrity="sha512-rCO3ZZnxh9j/Y725Iq2Cqr2lc9fi83zVeN3PFTUosktylZsCFjD13PDbKrzKjKO/idjM4KlMQC52AsoGFTAe6A=="
crossorigin="anonymous"
referrerpolicy="no-referrer"
>script>
<div id="app">div>
<script>
const store = {
state: {
val: 0
},
useStore () {
// 创建响应式的setUp函数,效果和vue中的setUp 是一样的,都是用来收集数据响应式依赖的
const setup = () => {
// 让 this.state 成为响应式代理对象
// 先判断 this.state 是否是一个reactive生成的响应式的代理对象,是的话就不需要 this.state 再次成为响应式代理对象了
if (!Vue.isReactive(this.state)) {
this.state = Vue.reactive(this.state)
}
}
const scope = Vue.effectScope()
// 执行run 的时候会执行setup函数,收集响应式依赖
scope.run(setup)
return this.state
}
}
// 子组件1
const childrenOne = Vue.defineComponent({
name: 'children-one',
setup () {
// 为什么要执行useStore,因为要通过 useStore 内的setup 函数为该组件提供响应式的依赖搜集
// storeA 已经是一个最基本的状态管理对象了
// 不过我们一般不建议直接修改store的值,后续会提供actions去帮助大家更改state的值
const storeA = store.useStore()
const add = () => {
storeA.val += 1
// 也可以直接通过 store.state 去访问state对象
// store.state.val +=1
}
return {
add,
storeA,
store
}
},
template: `
children-one
{{storeA.val}}
store: {{store.state.val}}
`
})
// 子组件2
const childrenTwo = Vue.defineComponent({
name: 'children-two',
setup () {
const storeB = store.useStore()
const remove = () => {
storeB.val -= 1
}
return {
remove,
storeB
}
},
template: `
children-two
{{storeB.val}}
`
})
const app = Vue.createApp({
name: 'app',
components: {
'children-one': childrenOne,
'children-two': childrenTwo,
},
template: `
`
})
app.mount('#app')
script>
body>
因为store.state 是具有响应式的代理对象,所以我们可以通过直接改变store.state.val 的值去更新对应组件
我们来看下效果: