@gxs/vue-atom NPM

vue-atom

vue-atom是vue3的一个原子状态管理库。
在composition api的加持下使得共享状态变得非常简单，它甚至可以简化成仅仅一行export const store = reactive(initState)就能实现全组件的状态的共享。但是，这对于一个全局共享库来说过于简单，vue-atom在其之上做了最低程度的封装，例如：插件，状态关联，hook，使其好适用于各种规模的项目。
vue-atom的定位不在于替代vuex，它是你的另一种状态管理的选择, 如果你听说过 recoil.js 这或许可以是你在vue下的选择。

install

npm install @gxs/vue-atom -S

基本使用

// store.ts 创建
import { defineAtom } from "@gxs/vue-atom"
export const useAtom0 = defineAtom("root", { msg: "root atom" })

// 可以创建任意数量
export const useAtom1 = defineAtom("item", { msg: "item atom" })

<script>
// any.vue
import { useAtom } from "store.ts"
const store = useAtom() // { msg: "root atom" }
</script>

高级应用

调用defineAtom()会创建一个工厂函数，该工厂函数静态的挂载了各种辅助管理的方法，它们被用于不同的场景。它的类型声明如下所示：

declare type AtomFactory<T = {}, S = {}, F = T> = {
    (prop?: unknown): F;
    computed<T, N>(name: string | symbol, options: {
        get: ComputedGetter<T>;
        set: ComputedSetter<T, N>;
    }): void;
    computed<T>(name: string | symbol, getter: ComputedGetter<T>): void;
    use(option: AtomFactory | ReturnType<useAtomPlugin>): AtomFactory;
    fork(atomFactory: AtomFactory): AtomFactory;
    onGetter<T>(fn: onGetter): AtomFactory;
    onChildMount(fn: onChildMount): AtomFactory;
    [PluginCustomProperty: string | symbol]: any;
} & S;

插件(`use`)🔗

适用于特殊状态的复用。在初始化时会接收到每个被使用的atom的name,响应式对象，静态工厂函数，可以发挥想象去做喜欢的事.

状态关联(`fork` | `use`)

import { defineAtom } from "@gxs/vue-atom"
const rootAtom = defineAtom("root", { msg: "root atom" })
const child1Atom = defineAtom("atom1", { msg: "atom1" })

// 通过fork关联
child1Atom.fork(rootAtom)

// 通过use关联
rootAtom.use(child1Atom)

// 注册父Atom的钩子进行混入
rootAtom.onChildMount((options) => {
  const { child: { state } } = options
  if(child.name === "atom1") {
    state.MMM = "from parent mixin"
  }
})

每个atom就像是状态管理中的component，vue-atom提供了相关的API让多个atom进行关联, 关联后会触发onChildMount注册的回调函数。

使用起来的感觉和插件有点类似，它们之间的差异点主要有两项： 1. 关联会在内部记录关联的atom形成状态树 2. 两个atom存在依赖项但同时又都要被组件所使用，此时用插件会显得繁琐

hook🔗

onGetter，当获取时动态的决定返回

onChildMount，当自身作为其他atom的顶层依赖时自动触发

全部 example🔗

Q&A

为什么computed被当成了静态属性进行使用而不是引用vue？

这是妥协后的处理，computed作为派发状态使用时需要依赖已经是响应式的状态，不然会无法响应式更新。但是在响应式是调用后的产物。

为什么只处理的状态，而没有逻辑相关的处理？

在当下hook提供了强大的逻辑复用能力，所有与状态管理无关的业务逻辑都应该以自定义hook的方式被单独管理。

代码过于分散，写起来像是面条，这是缺陷吗？

如开头的介绍，vue-atom只做用于管理状态最低程度的整合。通常情况下你不会在一个atom用用到所有的API，如果真的全用到了全部，甚至感觉还不够，你或许可以考虑将vue-atom二次封装，useAtomValue这个API会暴露atom内部维护的上下文，这对你或许有用。

它与Vuex相比较优势是什吗？

体积小，类型化，灵活，与composition api共存，对于高要求的模块化项目支持更好，更强的可塑性。

定位是什么？

状态的复杂度可以宏观的分为三类，低中高。低：期望响应式的全局状态中：在之前的基础上，期待一定的管理功能高：期望按自己的想法来 vue-atom的定位是承上启下，对于中低要求都能开箱即用。对于高要求的大型项目，自身关联机制可以提供很好的底层支持，它不要求一定要在顶层进行关联，它可以是任意一个atom节点。