Application States Management for San
JavaScript Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc update img Mar 13, 2017
example/todos update version Mar 20, 2017
src bump 1.1.0 Dec 22, 2017
test add connect.createConnector Oct 23, 2017
.babelrc
.editorconfig add base files Feb 22, 2017
.gitignore add base files Feb 22, 2017
CHANGELOG 1.0.1 Mar 20, 2017
LICENSE add base files Feb 22, 2017
README.md transfer from ecomfe to baidu Mar 24, 2018
circle.yml add karma to test Mar 16, 2017
package.json transfer from ecomfe to baidu Mar 24, 2018
webpack.config.js 修改 umd 包名 May 20, 2017

README.md

san-store

NPM version Build Status License

San 框架的官方应用状态管理套件,其理念是类似 flux 的单向流。

flow

提示:使用 san-store 需要同时使用 san-update 2.x 创建状态变更器,san-store 将使用此变更器更新 store 中的应用状态。

下载

NPM:

$ npm i san-store

使用

Webpack + Babel

通过 named import 导入

import {store, connect} from 'san-store';
import {builder} from 'san-update';


store.addAction('changeUserName', function (name) {
    return builder().set('user.name', name);
});


let UserNameEditor = san.defineComponent({
    submit() {
        store.dispatch('changeUserName', this.data.get('name'));
    }
});
connect.san({
    name: 'user.name'
})(UserNameEditor);

webpack 环境配置网上有太多文章,在此不赘述了

AMD

通过 require 拿到的 exports 上包含 store 和 connect

var sanStore = require('san-store');
var store = sanStore.store;
var connect = sanStore.connect;
var builder = require('san-update').builder;

store.addAction('changeUserName', function (name) {
    return builder().set('user.name', name);
});


var UserNameEditor = san.defineComponent({
    submit: function () {
        store.dispatch('changeUserName', this.data.get('name'));
    }
});
connect.san({
    name: 'user.name'
})(UserNameEditor);

请为 amd loader 正确配置 san-store 的引用路径。通过 npm 安装的项目可以采用下面的配置

require.config({
    baseUrl: 'src',
    paths: {
        'san-router': '../dep/san-store/dist/san-store.source'
    }
});

示例项目

从例子开始和模仿比死啃枯燥的文档要更人性化。 Todos 是如何在项目里使用 san-store 进行状态管理的示例项目。

为什么要进行应用状态管理

使用 san-store 进行应用状态管理,就要先接受它的理念:

  1. 单向流
  2. 全局唯一的应用状态源
  3. 状态更新模式单一,不能通过store直接更新应用状态

那么,使用 san-store 进行应用状态管理,和自己在组件里完成所有事情,有什么区别呢?

why use

自己管理你的应用状态

自己在组件里完成所有事情,意味着你需要自己管理你的应用状态。经验丰富的开发人员能够凭着设计经验和直觉让应用良构,但在不断的迭代与新需求开发的过程,他们需要持续的思考和回答这些问题:

  1. 应用状态数据保存在一个顶层组件还是分散在各个组件内?
  2. 应用状态数据怎么下发给需要使用的组件?
  3. 某个子组件区域的应用状态是否需要和外部绝缘?
  4. 如何更新应用状态数据?双向绑定还是消息通知?
  5. 更深层次组件的交互行为如何通知保存应用状态的组件更新?

于是,我们很容易把应用做成上面的样子:

  1. 数据的更新流自顶向下
  2. 底层组件的用户交互通过双向绑定更新到上层组件,上层组件刷新所有子组件的视图,同时通过双向绑定继续往上更新
  3. 底层组件的用户交互通过消息向上传递,顶层组件处理消息,更新自身状态数据,然后自顶向下更新

我们看到,向下的数据更新流和向上的更新流以及消息流是夹杂在一起的。如果管理得当,这样做其实并没有什么问题。但你需要小心翼翼的在不断增加的需求中维护应用的消息流转,你需要清醒的认识到每一个操作带来的状态变更最终将更新到哪个组件,再由它下发。有没有觉得心很累?

使用 san-store 管理应用状态

如果使用 san-store 进行应用状态管理,这个流会变得清晰很多:

  1. 所有的应用状态保存在 store 中
  2. 用户交互的唯一出口只有 dispatch action,不是更新双向绑定的上层组件,不是向上派发的消息
  3. dispatch action 带来的应用状态变更,将更新到 connect 的组件中

从图中可以看到,组件树上的流将变得清晰,只有自顶向下的更新流。

是不是要使用 san-store

我们并不认为 san-store 适合所有场景。统一的进行应用状态管理,只有当你的应用足够大时,它带来维护上的便利才会逐渐显现出来。如果你只是开发一个小系统,并且预期不会有陆续的新需求,那我们并不推荐你使用它。大多数增加可维护性的手段意味着拆分代码到多处,意味着你没有办法在实现一个功能的时候一路到尾畅快淋漓,意味着开发成本可能会上升。

所以,你应该根据你要做的是一个什么样的应用,决定要不要使用 san-store。

你需要做什么

san-store 只是提供了全局唯一状态管理和状态更新方式,你可以天然的实现单向流。但是更重要的是,你需要 为自己的应用划分应用状态。所以你至少需要考虑以下问题:

  1. 你的应用有哪些业务场景?
  2. 每个业务场景有哪些应用状态?
  3. 不同业务场景之间的应用状态是否有相通复用的?
  4. 应用状态数据应该保存成什么结构?

基于这些,你基本上可以划分应用状态,设计结构,并为它们起一些清晰的命名了。这都是让你的应用良构,你所必须做的设计。

Store和默认实例

一个应用具有唯一的应用状态源,在一个地方管理整个应用的所有状态,是一个比较共识的方式。所以 san-store 提供了默认的 store 实例。

复杂业务场景下,当同一系统中有不同团队开发自己的业务模块,各团队之间没有状态共享,可以考虑分别建立store实例进行开发,相关细节请参考connect.createConnector章节。

但绝大多数时候,应用开发者不需要手工创建自己的 Store 实例,只需要 import 默认的 store 实例。

import {store} from 'san-store';

通过 getState 方法,可以获取 store 中的状态数据。

let appState = store.getState('user.name');
console.log(appState);

store 并没有提供修改状态数据的方法,修改状态数据只能通过 dispatch action 来做到,具体细节请参考 Action 章节。通过 addAction 方法可以添加 action。

store.addAction('changeUserName', name => builder().set('user.name', name));

当然,你也可以通过 new Store 创建自己的 Store 实例。创建时可以传入初始化数据和声明 actions。

import {Store} from 'san-store';


let myStore = new Store({
    initData: {
        user: {
            name: 'your name'
        }
    },

    actions: {
        changeUserName(name) {
            return builder().set('user.name', name);
        }
    }
})

本节最后,还是要强调下,应用开发应当遵循 一个应用具有唯一的应用状态源。说白了就是 要按常理出牌

Action

Action 是 san-store 最重要的组成部分之一,它:

  1. 在一个 store 内每个 action 具有唯一名称,通过名称 dispatch
  2. 是 store 更新状态的唯一入口
  3. 状态更新是同步的,这使得状态更新可依赖当前状态环境,可被记录、被追溯和重放

如果你使用了 san-store,Action 应该是你业务组件的唯一出口:用户操作事件等需要改变应用状态时,都应该 dispatch Action。它的签名如下:

{updateBuilder?} function ({*}payload, {{Function}getState, {Function}dispatch})

变更应用状态

Action 接收一个 payload,返回一个 san-update 的 builder 对象。store 使用 builder 对象生成状态变更函数,并执行它,使 store 内部的状态得到更新。当然,如果当前 action 不期望对 store 的状态进行更新,可以不返回 builder 对象。

import {updateBuilder} from 'san-update';

store.addAction('changeUserName', function (name) {
    return updateBuilder().set('user.name', name);
});

// 通过名称 dispatch
store.dispatch('changeUserName', 'erik');

san-update 是一个 Immutable 的更新对象库,其提供了一些更新函数(如set、push等),通过 newObj = set(oldObj, 'x', 1) 的使用形式让对象更新 Immutable。builder 是 san-update 提供的一个很好用的功能,通过 builder 你可以预定义一系列的数据更新操作,然后通过 builder.build 方法可以获得一个更新函数。san-store 就是利用这个功能,使用 action 返回的 builder 生成对象更新函数,再调用它进行 store 内部状态更新。

san-update 的 builder 支持预定义所有 san-update 支持的数据操作,通过 san-update文档:可用指令 可以查看所有操作类型。常用的有:

  • apply: 对现有数据项应用更新
  • set: 设置数据项
  • remove: 数组移除项
  • push: 数组push操作
  • pop: 数组pop操作
  • unshift: 数组unshift操作
  • shift: 数组shift操作
  • splice: 数组splice操作

使用前请阅读 san-update文档:使用builder构建更新函数 进行详细了解。

获取当前应用状态

Action 的第二个参数是一个对象,其中的 getState 方法可以用于获得当前 store 中的应用状态。这个方法是 this 无关的。

import {updateBuilder} from 'san-update';

store.addAction('initCount', function (count, {getState}) {
    if (getState('count') == null) {
        return updateBuilder().set('count', count);
    }
});

store.dispatch('initCount', 10);

如果我们的更新操作仅依赖于当前数据状态项的值,也可以使用 san-update 提供的 apply 方法。

import {updateBuilder} from 'san-update';

store.addAction('initCount', function (count) {
    // apply 意思是:在原有的值上应用新的值
    return updateBuilder().apply('count', oldValue => {
        return oldValue == null ? count : oldValue;
    });
});

store.dispatch('initCount', 10);

异步过程

同步的 Action 返回一个 updateBuilder,并立即更新数据状态,但我们经常会遇到异步的场景,常见的比如请求数据、返回并更新应用状态。Action 在设计上作为 业务组件的唯一出口, 对异步支持的方式如下:

  1. 返回一个 Promise 时,当前 Action 为异步
  2. 返回一个 updateBuilder 或什么都不返回时,当前 Action 为异步

下面是一个简单的例子: 一个列表请求的行为,此时要显示 loading,在请求返回时更新应用状态中的列表项,同时隐藏 loading。

import {updateBuilder} from 'san-update';

store.addAction('fetchList', function (page, {getState, dispatch}) {
    dispatch('showLoading');
    dispatch('updateCurrentPage', page);

    return requestList(page).then(list => {
        if (getState('currentPage') === page) {
            dispatch('updateList', list);
            dispatch('hideLoading');
        }
    });
});

store.addAction('showLoading', function () {
    return updateBuilder().set('loading', true);
});

store.addAction('hideLoading', function () {
    return updateBuilder().set('loading', false);
});

store.addAction('updateCurrentPage', function (page) {
    return updateBuilder().set('currentPage', page);
});

store.addAction('updateList', function (list) {
    return updateBuilder().set('list', list);
});


// 这里模拟一下,意思意思
function requestList(page) {
    return new Promise(resolve => {
        setTimeout(() => {
            let pageList = [1, 2, 3];
            resolve(pageList);
        }, 500);
    });
}

例子中有下面几个要点:

  1. 异步 Action 可以多次 dispatch 其他的 Action,通过第二个参数对象中的 dispatch 方法。这个方法和 getState 一样,也是 this 无关的。
  2. fetchList 中马上 updateCurrentPage,在请求返回时使用 getState 方法对 currentPage 判断,能够避免用户快速多次点击页码时发起多个 list 请求,请求返回的顺序不同可能导致问题。
  3. 异步 Action 没有更新应用状态的能力,想要更新应用状态必须 dispatch 同步 Action。下面的代码说明了为什么,感兴趣可以看看。
store.addAction('fetchList', function (page, {getState, dispatch}) {
    dispatch('showLoading');
    dispatch('updateCurrentPage', page);

    return requestList(page).then(list => {
        if (getState('currentPage') === page) {
            dispatch('hideLoading');
            
            // 如果异步 Action 支持在 promise 中返回 updateBuilder 并更新状态
            // 这里的代码就可能导致问题。因为 promise.then 不是马上运行的
            // 这里的 currentPage 不代表 updateBuilder 运行时的 currentPage
            // currentPage 可能被另外一个 dispatch fetchList 改掉
            // 所以这里应该 dispatch 一个同步的 Action 让应用状态即时完成变更
            // dispatch('updateList', list);  // good
            return updateBuilder().set('list', list); // warning
        }
    });
});

组件的connect

connect.san

san-store 内置了connect.san方法对默认store实例San 组件进行连接,步骤和 redux 类似:

  1. 通过 connect.san 方法创建一个 connect 组件的函数
  2. 调用这个函数对组件进行connect
import {store, connect} from 'san-store';

let connector = connect.san(
    {name: 'user.name'},
    {change: 'changeUserName'}
);
connector(UserNameEditor);


// 通常我们只需要对当前声明的组件进行connect,可以合并成一句
connect.san(
    {name: 'user.name'},
    {change: 'changeUserName'}
)(UserNameEditor);

connect.san 方法的签名为,{function(Class)}connect.san({Object}mapStates, {Object?}mapActions)

connect.createConnector

当实际业务中真的需要多个store实例时,可以通过这个函数自行创建方法连接store实例和San组件。步骤如下:

  1. 创建store实例
  2. 通过 connect.createConnector 方法创建一个 connect函数
  3. 调用这个函数对刚刚声明的store实例和组件进行connect
import {Store, connect} from 'san-store';

// 创建模块A中的store实例
const storeA = new Store({
    initData: {
        name:'erik'
    },
    actions:{
        changeUserName() {
            return builder().set('user.name', name);
        }
    }
});

// 调用connect.createConnector方法,传入store实例
const connectA = connect.createConnector(storeA);

const UserNameEditor = san.defineComponent({...});

// 调用手动创建的connectA方法进行storeA和组件连接
connectA(
    {name: 'user.name'},
    {change: 'changeUserName'}
)(UserNameEditor);

connect.createConnector 方法的签名为 {function(Class)}connect.createConnector({Store}store)

mapStates

Object

mapStates 参数指定了要把哪些状态注入到组件,key 是要注入到组件的数据项名称,value 是 store 中状态项的名称。

import {store, connect} from 'san-store';


let UserNameEditor = san.defineComponent({
    // connect 后,name 数据项由 store 提供
    template: '<div title="{{name}}">......</div>'
});

connect.san(
    {name: 'user.name'}
)(UserNameEditor);

mapActions

Object

通常我们在组件内通过调用 store.dispatch(actionName, payload) 方法更新应用状态,由于 actionName 的应用全局唯一性,名字需要比较完整,对于组件来说这么长的名称会显得比较冗余。通过 mapActions 可以在组件的 actions 成员上生成 dispatch action 的快捷方法,让组件可以更便捷的 dispatch action。

mapActions 的 key 是要映射到组件 actions 成员上的方法名,value 是 action 的名称。

import {store, connect} from 'san-store';


let UserNameEditor = san.defineComponent({
    submit() {
        // 通过 mapActions,可以把 dispatch action 简化成组件自身的方法调用
        // store.dispatch('changeUserName', this.data.get('name'));
        this.actions.change(this.data.get('name'));
    }
});

connect.san(
    {name: 'user.name'},
    {change: 'changeUserName'}
)(UserNameEditor);