2 Star 15 Fork 2

自然框架/vue-data-state

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

nf-state 轻量级状态管理

最新代码转移到: https://gitee.com/naturefw/nf-rollup-state
源码目录:https://naturefw.gitee.io/

介绍

Vue3 的轻量级的状态管理。
简称:nf-state
基于 reactive 完全发挥 composition 的特点,简单快捷,好用。

  • 全局状态,用法和Vuex类似。
  • 只读状态,只有指定位置才可以改变,其他组件只能读取,更安全。
  • 跟踪状态,可以跟踪变更情况,记录状态变化的时间、函数、组件、代码位置、属性名、原值、新值,支持嵌套属性。
  • 初始化,可以对全局状态进行初始化赋值。

只包含状态 state,不包含 mutations、action 这类操作方法,可以使用 Vue3 的 Composition API 的方式来操作状态。

技术栈

  • Vue3
  • vite2

源码

https://gitee.com/naturefw/vue-data-state

自然框架/vue-data-state

在线演示

https://naturefw.gitee.io/vite2-vue3-demo/

安装教程

npm i nf-state
或者
yarn add nf-state

使用说明

  1. createStore 创建实例,定义全局状态和初始化函数。
// store-nf/index.js
// 加载状态的类库
import { createStore } from 'nf-state'

// 加载 controller,非必要。
import userController from '../views/state/controller/userController.js'

export default createStore({
  // 读写状态,直接使用 reactive
  state: {
    // 用户是否登录以及登录状态
    user: {
      isLogin: false,
      name: 'jyk', //
      age: 19
    }
  },
  // 全局常量,使用 readonly 
  readonly:{
    // 访问indexedDB 和 webSQL 的标识,用于区分不同的库
    dbFlag: {
      project_db_meta: 'plat-meta-db' // 平台 运行时需要的 meta。
    },
    // 用户是否登录以及登录状态
    user1: {
      isLogin: false,
      info:{
        name: '测试第二层属性'
      },
      name: 'jyk', //
      age: 19
    }
  },
  // 跟踪状态,用 proxy 给 reactive 套娃
  track: {
    trackTest: {
      name: '跟踪测试',
      age: 18,
      children1: {
        name1: '子属性测试',
        children2: {
          name2: '再嵌一套'
        }
      }
    },
    test2: {
      name: ''
    }
  },
  // 可以给全局状态设置初始状态,同步数据可以直接在上面设置,如果是异步数据,可以在这里设置。
  init (state, read) {
    userController().setWriteUse(read.user1)
    setTimeout(() => {
      read.dbFlag.project_db_meta = '加载后修改'
    }, 2000)
  }
})

  • state:固定名称不能更改。里面的属性可以随意设置,只是属性必须是对象(包含数组),不能是基础类型。

  • readonly:固定名称不能更改。里面的函数可以随意设置,函数名称就是注册和获取的函数名称。
    必须是对象(数组),不能是基础类型。

  • track:可以跟踪的状态。

  • init:初始化函数,固定名称不能更改。
    可以写异步代码。

  1. main.js 挂载到 app
//main.js
import { createApp } from 'vue'
import App from './App.vue'
import store from './store-nf' // 轻量级状态

createApp(App)
  .use(store) // 加载状态,调用 init 执行初始化函数。
  .mount('#app')
  1. 模板里可以用 $state 访问全局状态。
<template>
  全局状态-user:{{$state.user1}}<br>
</template>

目前只支持全局状态,局部状态需要先在代码里面获取,然后返回给模板。

  1. 在组件里获取状态。
import { state, watchState } from 'nf-state'

// 可以直接操作状态
console.log(state)

const testTract2 = () => {
  state.trackTest.children1.name1 = new Date().valueOf()
}
 
const testTract3 = () => {
  state.trackTest.children1.children2.name2 = new Date().valueOf()
  state.test2.name = new Date().valueOf()
}


  1. 设置监听和钩子函数
import { state, watchState } from 'nf-state'

// 设置监听和钩子
watchState.trackTest(({keyPath, key, value, oldValue}) => {
  if (keyPath === '') {
    console.log(`\nstateKey.${key}=`)
  } else {
    console.log(`\nstateKey.${keyPath.replace(',','.')}.${key}=` )
  }
  console.log('oldValue:', oldValue)
  console.log('value:', value )
  // return null
})
  1. 局部状态,使用跟踪的方法。
import { reactive, provide, inject } from 'vue'
import { trackReactive } from 'nf-state'

const flag = 'test2'

/**
 * 注入局部状态
 */
const reg = () => {
  // 需要在函数内部定义,否则就变成“全局”的了。
  const _test = reactive({
    name: '局部状态的对象形式的controller'
  })
  // 注入
  provide(flag, _test)
  // 其他操作,比如设置 watch
  return _test
}

/**
 * 获取注入的状态
 */
const get = () => {
  // 获取
  const re = inject(flag)
  return re
}

const regTrack = () => {
  const ret = reactive({
    name: '局部状态的可跟踪状态'
  })
  // 定义记录跟踪日志的容器
  const logTrack = reactive([])
  // 设置监听和钩子
  const watchSet = (res) => {
    console.log(res)
    console.log(res.stack)
    console.log(logTrack)
  }
  const loaclTrack = trackReactive(ret, 'loaclTrack', logTrack, watchSet)

  return {
    loaclTrack,
    logTrack,
    watchSet
  }
}

// 其他操作

export {
  regTrack,
  reg,
  get,
}

基本用法就是这些了,其他的就是各种灵活应用。

MIT License Copyright (c) 2021 自然框架 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

类似 Vuex 的轻量级的数据、状态、缓存综合管理方法。简称:Vueds 展开 收起
JavaScript 等 3 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
JavaScript
1
https://gitee.com/naturefw/vue-data-state.git
git@gitee.com:naturefw/vue-data-state.git
naturefw
vue-data-state
vue-data-state
master

搜索帮助