Loading [MathJax]/jax/output/CommonHTML/jax.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >结合 Vuex 和 Pinia 做一个适合自己的状态管理 nf-state

结合 Vuex 和 Pinia 做一个适合自己的状态管理 nf-state

作者头像
用户1174620
发布于 2022-05-12 06:00:23
发布于 2022-05-12 06:00:23
95700
代码可运行
举报
运行总次数:0
代码可运行

一开始学习了一下 Vuex,感觉比较冗余,就自己做了一个轻量级的状态管理。 后来又学习了 Pinia,于是参考 Pinia 改进了一下自己的状态管理。

结合 Vuex 和 Pinia, 保留需要的功能,去掉不需要的功能,修改一下看着不习惯的使用方法,最后得到了一个满足自己需要的轻量级状态管理 —— nf - state

设计思路

还是喜欢 MVC设计模式,状态可以看做 M,组件是V,可以用 controller 做调度,需要访问后端的话,可以做一个 services。这样整体结构比较清晰明了。

当然简单的状态不需要 controller,直接使用 getters、actions 即可。整体结构如下:

源码

https://gitee.com/naturefw-code/nf-rollup-state

在线演示

https://naturefw-code.gitee.io/nf-rollup-state/

在线文档

https://nfpress.gitee.io/doc-nf-state

优点

  • 支持全局状态局部状态
  • 可以像 Vuex 那样,用 createStore 统一注册全局状态 ;
  • 也可以像 Pinia 那样,用 defineStore 分散定义全局状态和局部状态;
  • 根据不同的场景需求,选择适合的状态变更方式(安全等级);
  • 可以和 Vuex、Pinia 共存;
  • 数据部分和操作部分“分级”存放,便于遍历;
  • 状态采用 reactive 形式,可以直接使用 watch、toRefs 等;
  • 更轻、更小、更简洁;
  • 可以记录变化日志,也可以不记录;
  • 封装了对象、数组的一些方法,使用 reactive 的时候可以“直接”赋值。

缺点

  • 不支持 option API、vue2;
  • 暂时不支持 TypeScript
  • 暂时不支持 vue-devtool;
  • 不支持SSR;
  • 只有一个简单的状态变化记录(默认不记录)。

nf-state 的结构

  • state:支持对象、函数的形式。
  • getters:会变成 computed,不支持异步(其实也可以用异步)。
  • actions:变更状态,支持异步。
  • 内置函数: patch:修改部分属性,支持深层。

本来想只保留 state 即可,但是看看 Pinia,感觉加上 getter、action 也不是不行,另外也参考 Pinia 设置了几个内置函数。

内置函数

reactive 哪都好,就是不能直接赋值,否则就会失去响应性,虽然有办法解决,但是需要多写几行代码,所以我们可以封装一下。好吧,是看到 Pinia 的 patch 后想到的。

$state

可以直接整体赋值,支持 object 和 数组。直接赋值即可,这样用起来就方便多了。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
this.dataList.$state = {xxx}

$patch

修改部分属性。我们可以直接改状态的属性值,但是如果一次改多个的话,就有一点点麻烦,用$patch可以整洁一点。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 依次设置属性值:
this.pagerInfo.count = list.allCount === 0 ? 1 : list.allCount
this.pagerInfo.pagerIndex = 1

// 使用 $patch 设置属性值:
this.pagerInfo.$patch({
  count: list.allCount === 0 ? 1 : list.allCount,
  pagerIndex: 1
})

支持深层属性。

全局状态的使用方式

全局状态有两种定义方式:

  • 像 Vuex 那样,在 main.js 里面统一注册;
  • 像 Pinia 那样,在组件里面定义。

在 main.js 里面统一注册全局状态

nf-state 的全局状态的使用方法和 Vuex 差不多,先创建一个 js文件,定义一个或者多个状态,然后在main.js里面挂载。

优点:可以统一注册、便于管理,一个项目里有哪些全局状态,可以一目了然。

  • /store/index.js
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 定义全局状态
import { createStore } from '@naturefw/nf-state'

/* 模拟异步操作 */
const testPromie = () => {
  return new Promise((resolve) => {
    setTimeout(() => {
      const re = {
        name: '异步的方式设置name'
      }
      resolve(re)
    }, 500)
  })
}

/**
 * 统一注册全局状态。key 相当于  defineStore 的第一个参数(id)
 */
export default createStore({
  // 定义状态,会变成 reactive 的形式。store 里面是各种状态
  store: {
    // 如果只有 state,那么可以简化为一个对象的方式。
    user: {
      isLogin: false,
      name: 'jyk', //
      age: 19,
      roles: []
    },
    // 有 getters、actions
    userCenter: {
      state: {
        name: '',
        age: 12,
        list: []
      },
      getters: {
        userName () {
          return this.name + '---- 测试 getter'
        }
      },
      actions: {
        async loadData(val, state) {
          const foo = await testPromie()
          state.name = foo.name
          this.name = foo.name
          this.$state = foo
          this.$patch(foo)
        }
      },
      options: {
        isLocal: false, // true:局部状态;false:全局状态(默认属性);
        isLog: true, // true:做记录;false:不用做记录(默认属性);
        /**
         * 1:宽松,可以各种方式改变属性,适合弹窗、抽屉、多tab切换等。
         * 2:一般,不能通过属性直接改状态,只能通过内置函数、action 改变状态
         * 3:严格,不能通过属性、内置函数改状态,只能通过 action 改变状态
         * 4:超严,只能在指定组件内改变状态,比如当前用户的状态,只能在登录组件改,其他组件完全只读!
        */
        level: 1
      }
    },
    // 数组的情况
    dataList: [123] 
  },
  // 状态初始化,可以给全局状态设置初始状态,支持异步。
  init (store) {
      // 可以从后端API、indexedDB、webSQL等,设置状态的初始值。
  }
})
  • main.js
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
import { createApp } from 'vue'
import App from './App.vue'

import store from './store'

createApp(App)
  .use(store)
  .mount('#app')

在组件里获取统一注册的全局状态

使用方法和 Vuex 类似,直接获取全局状态:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
  import { store } from '@naturefw/nf-state'

  const { user, userCenter } = store

在组件里注册全局状态

这种方式,借鉴了Pinia的方式,我们可以建立一个 js 文件,然后定义一个状态,可以用Symbol 作为标志,这样可以更方便的避免重名。(当然也可以用 string)

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
import { defineStore } from '@naturefw/nf-state'

const flag = Symbol('UserInfo')
// const flag = 'UserInfo'

const getUserInfo = () => defineStore(flag, {
  state: {
    name: '客户管理',
    info: {}
  },
  getters: {
  },
  actions: {
    updateName(val) {
      this.name = val
    }
  }
})

export {
  flag,
  getUserInfo
}

虽然使用 Symbol 可以方便的避免重名,但是获取状态的时候有点小麻烦。 ID(状态标识)支持 string 和 Symbol ,大家可以根据自己的情况选择适合的方式。

在组件里面引入 这个js文件,然后可以通过 getUserInfo 函数获取状态,可以用统一注册的全局状态的方式获取。

使用局部状态

基于 provide/inject 设置了局部状态。

有时候,一个状态并不是整个项目都需要访问,这时候可以采用局部状态,比如列表页面里的状态。

定义一个局部状态

我们可以建立一个js文件,定义状态:

  • state-list.js
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
import { watch } from 'vue'

import { defineStore, useStore, store } from '@naturefw/nf-state'

const flag = Symbol('pager001')
// const flag = 'pager001'

/**
 * 注册局部状态,父组件使用 provide 
 * * 数据列表用
 * @returns
 */
const regListState = () => {
  // 定义 列表用的状态
  const state = defineStore(flag, {
    state: () => {
      return {
        moduleId: 0, // 模块ID
        dataList: [], // 数据列表
        findValue: {}, // 查询条件的精简形式
        findArray: [], // 查询条件的对象形式
        pagerInfo: { // 分页信息
          pagerSize: 5,
          count: 20, // 总数
          pagerIndex: 1 // 当前页号
        },
        selection: { // 列表里选择的记录
          dataId: '', // 单选ID number 、string
          row: {}, // 单选的数据对象 {}
          dataIds: [], // 多选ID []
          rows: [] // 多选的数据对象 []
        },
        query: {} // 查询条件
      }
    },
    actions: {
      /**
       * 加载数据,
       * @param {*} isReset true:需要设置总数,页号设置为1;false:仅翻页
       */
      async loadData (isReset = false) {
        // 获取列表数据
        const list = await xxx
        // 使用 $state 直接赋值
        this.dataList.$state = list.dataList
        if (isReset) {
          this.pagerInfo.$patch({
            count: list.allCount === 0 ? 1 : list.allCount,
            pagerIndex: 1
          })
        }
      }
    }
  },
  { isLocal: true } // 设置为局部状态,没有设置的话,就是全局状态了。
  )

  // 初始化
  state.loadData(true)

  // 监听页号,实现翻页功能
  watch(() => state.pagerInfo.pagerIndex, (index) => {
    state.loadData()
  })

  // 监听查询条件,实现查询功能。
  watch(state.findValue, () => {
    state.loadData(true)
  })

  return state
}

/**
 * 子组件用 inject 获取状态
 * @returns
 */
const getListState = () => {
  return useStore(flag)
}

export {
  getListState,
  regListState
}

是不是应该把 watch 也内置了?

在父组件引入局部状态

建立父组件,使用 getListState 引入局部状态:

  • data-list.vue
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
  // 引入
  import { regListState } from './controller/state-list.js'

  // 注册状态
  const state = regListState()

调用 getListState() 会用 provide 设置一个状态。

在子组件里获取局部状态

建立子组件,获取局部状态:

  • pager.vue
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
  // 局部状态
  import { getListState } from '../controller/state-list.js'

  // 获取父组件提供的局部状态
  const state = getListState()

调用 getListState(), 内部会用 inject (注入)获取父组件的局部状态。这样使用起来就比较明确,也比较简单。

子组件也可以调用 regListState ,这样可以注册一个子组件的状态,子子组件只能获取子组件的状态。 子子组件如果想获取父组件的状态,那么需要设置不同的ID。

安全等级

变更状态可以有四个安全级别:宽松、一般、严格、超严。

安全级别

state类型

直接改属性

内置函数

action

范围

举例

宽松

reactive

所有组件

弹窗、抽屉的状态

一般

readonly

所有组件

严格

readonly

所有组件

超严

readonly

特定组件才可更改

当前用户状态

  • 宽松:任何组件里都可以通过属性、内置函数和 action 来更改状态。 比如弹窗状态(是否打开)、抽屉状态(是否打开)、tab标签的切换等。 这些场景里,如果可以直接修改属性的话,那么可以让代码更简洁。
  • 一般和严格:二者主要区别是,内置函数是否可以使用的问题,其实一开始不想区分的,但是想想还是先分开的话,毕竟多提供了一个选择。
  • 超严:只能在特定的组件里改变状态,其他组件只能读取状态。 比如当前访问者的状态,只有在登录组件、退出组件里改变,其他组件不能更改。

这样可以更好的适应不同的场景需求。

和 Pinia 的区别

nf-state 看起来和 Pnina 挺像的,那么有哪些区别呢?

局部状态

Pinia 都是 全局状态,没有局部状态,或者说,局部状态比较简单,似乎不用特殊处理,只是,既然都封装了,那么就做全套吧,统一封装,统一使用风格。

状态的结构

虽然都是 reactive 的形式,但是内部结构的层次不一样。

pinia 的状态,数据部分和操作部分都在一个层级里面,感觉有点分布清楚,所以 pinia 提供了 来实现 toRefs 的功能。

我还是喜欢那种层次分明的形式,比如这样:

这样设计层次很清晰,可以直接使用 toRefs 实现解构,而不会解构出来“不需要”的方法。

支持的功能

官方提供的状态管理需要满足各种需求,所以要支持 option API、vue2、TypeScript等。

而我自己做的状态管理,满足自己的需求即可,所以可以更简洁,当然可能无法满足你的需求。

可以不重复制造轮子,但是要拥有制造轮子的能力。做一个状态管理,可以培养这种能力。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022-05-11,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Rust入坑指南:智能指针
在了解了Rust中的所有权、所有权借用、生命周期这些概念后,相信各位坑友对Rust已经有了比较深刻的认识了,今天又是一个连环坑,我们一起来把智能指针刨出来,一探究竟。
Jackeyzhe
2020/03/12
9030
【Rust 基础篇】Rust 智能指针
在 Rust 中,智能指针是一种提供了额外功能的指针类型。智能指针可以在编译时和运行时检查内存安全,并提供了更灵活的所有权和借用模型。本篇博客将详细介绍 Rust 中的智能指针,包括常用的智能指针类型、创建和使用智能指针、内存安全和性能考虑等。
繁依Fanyi
2023/10/12
2710
【Rust精彩blog】Rust 中几个智能指针的异同与使用场景
想必写过 C 的程序员对指针都会有一种复杂的情感,与内存相处的过程中可以说是成也指针,败也指针。一不小心又越界访问了,一不小心又读到了内存里的脏数据,一不小心多线程读写数据又不一致了……我知道讲到这肯定会有人觉得“出这种问题还不是因为你菜”云云,但是有一句话说得好:“自由的代价就是需要时刻保持警惕”。
MikeLoveRust
2020/02/20
1.9K0
2023学习日志
此时可以使用Box<T>指针指向嵌套的列表,得到cons list类型的结构体。(指针的内存大小是已知的,但列表的大小是在进行结构体声明时未知的)
TomoriNao
2023/07/27
1650
【Rust每周一知】理解智能指针Box<T>
指针是个通用概念,它表示内存地址这种类型,其引用或“指向”其他数据。Rust中的指针是“第一类公民”(first-class values),可以将它们移动或复制,存储到数据结构中并从函数中返回。Rust提供了多种类型的指针:
MikeLoveRust
2020/02/20
2.2K0
rust的内存管理
内存管理是rust最有意思的事情了。rust的内存管理有三条准则。 let分配资源 分配会转移所有权,比如赋值直接move了 值和变量在作用域末尾会被清理,释放 drop方法会在释放前调用 rust支持移动语义和复制语义,为此抽象出了两个trait,clone和copy 非堆内存可以使用copy,隐式转化,clone需要显示调用 关于借用的规则,使用& 一个引用的生命周期不能超过其被引用的时间 如果存在一个可变借用,不允许存在其他值 如果不存在可变借用,允许存在多个不可变借用 借用规则方法类型 &self
李子健
2022/05/08
7620
【译】Rust与智能指针
如果你一直在订阅这个系列,关于所有权的那篇文章[1]可能给你带来了这种印象——Rust 确实是个好东西,C++不应该在生产环境中使用。智能指针可能会改变你的想法。用现代的话来说,Smart pointers 是指那些有点(嗯......)额外(东西)的指针。他们本质上还是管理其所指向的对象的内存地址,并且当对象不再被使用的时候会将其释放。这消除了很多因不恰当的内存管理而引起的 bug,并使得编程不再那么枯燥乏味。C++智能指针为原始指针提供了一个安全的替代方案,而 Rust 智能指针则在保证安全的前提下扩展了语言功能。
MikeLoveRust
2020/10/26
1.1K0
【译】Rust与智能指针
Rust 总结
所有权是用来管理堆上内存的一种方式,在编译阶段就可以追踪堆内存的分配和释放,不会对程序的运行期造成任何性能上的损失。
谛听
2022/06/04
1.8K0
揭开智能指针 Box 的神秘面纱
熟悉 c++ 的肯定知道 shared_ptr, unique_ptr, 而 Rust 也有智能指针 Box, Rc, Arc, RefCell 等等,本文分享 Box 底层实现
MikeLoveRust
2021/08/13
6150
《Rust避坑式入门》第1章:挖数据竞争大坑的滥用可变性
赵可菲是一名Java程序员,一直在维护一个有十多年历史的老旧系统。这个系统即将被淘汰,代码质量也很差,每次上线都会出现很多bug,她不得不加班修复。公司给了她3个月的内部转岗期,如果转不出去就会被裁员。她得知公司可能会用Rust重写很多系统,于是就报名参加了公司的Rust培训,希望能够转型。
程序员吾真本
2024/08/29
5810
《Rust避坑式入门》第1章:挖数据竞争大坑的滥用可变性
Rust学习笔记Day17 智能指针之Box<T>
经过这一段时间的学习,基础知识里,我们还剩数据结构没有学习,而数据结构里最难的就是智能指针。
用户1072003
2023/02/23
3760
Rust学习笔记Day17 智能指针之Box<T>
Rust学习笔记Day18 智能指针Cow/MutexGuard
这是用于提供写时克隆(Clone-on-Write)的一个智能指针,和虚拟内存管理的写时复制很像。
用户1072003
2023/02/23
7180
Rust学习笔记Day18 智能指针Cow/MutexGuard
Rust编程学习笔记Day7-一个值可以有多个所有者吗?
我们之前介绍的单一所有权,其实已经能满足我们使用内存的大部分场景。在编译时就能完成静态检查,不会影响运行时的效率。
用户1072003
2023/02/23
9890
Rust编程学习笔记Day7-一个值可以有多个所有者吗?
66个让你对Rust又爱又恨的场景之一:变量与值
属于手动内存管理流派的C++,虽然提供了手动管理内存的灵活性,但容易因程序员的失误导致内存泄漏、悬垂指针、双重释放和野指针等问题。
程序员吾真本
2024/07/18
5560
66个让你对Rust又爱又恨的场景之一:变量与值
【Rust 基础篇】Rust 的 `Rc<RefCell<T>>` - 共享可变性的智能指针
在 Rust 中,Rc<RefCell<T>> 是一种组合智能指针,用于实现多所有权共享可变数据。Rc 允许多个所有者共享相同的数据,而 RefCell 允许在有多个引用的情况下对数据进行可变操作。
繁依Fanyi
2023/10/12
9470
31.Rust-智能指针
Rust 可以在 堆 上存储数据。Rust 语言中的某些类型,如 向量 Vector 和 字符串对象 String 默认就是把数据存储在 堆 上的。
面向加薪学习
2022/06/30
3210
go 开发者的 rust 入门
即:在任意给定时间,要么 只能有一个可变引用,要么 只能有多个不可变引用。引用必须总是有效的。
王磊-字节跳动
2021/11/27
1.9K0
【Rust每周一知】如何理解Rust的默认线程安全?
本文以Rc和RefCell为例,讨论Rust中的Send和Sync是如何保证线程安全的。
MikeLoveRust
2020/02/12
1.5K0
《Rust避坑式入门》第2章:解决多线程并发数据竞争的不可变性
从第1章所讨论的出现数据竞争问题的多线程并发剧院订票系统的代码能够看出,虽然可变性能够方便地随时修改值,但滥用可变性,会在多线程并发编程时,带来数据竞争的难题。
程序员吾真本
2024/09/03
7170
《Rust避坑式入门》第2章:解决多线程并发数据竞争的不可变性
Rust避坑现代C++悬垂指针
C++是一门应用广泛的编程语言。在2023年JetBrains全球开发者生态问卷调查中,C++在受访程序员过去一年中的使用率,占25%,紧跟JavaScript、Python和Java之后。在本书撰写时,根据JetBrains的统计,程序员使用最多的是C++17。
程序员吾真本
2024/09/18
6442
Rust避坑现代C++悬垂指针
推荐阅读
相关推荐
Rust入坑指南:智能指针
更多 >
LV.1
这个人很懒,什么都没有留下~
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验