阅读 144

利用Dectorator分模块存储Vuex状态(下)

1、引言

在上篇中我们介绍了利用Decorator分模块来存储数据,在Weex页面实例创建时读取数据到Vuex,但是存在无效数据存储冗余的问题,并且不支持registerModule来动态存取数据,接下来主要介绍下利用Decorator来实现数据存储的黑白名单和模块动态注册时数据存取的实现方式。

2、 设置state黑白名单

在设置state的黑白名单时,我们需要对各个模块单独设置,即允许在不同module中设置黑或白名单,同时需要在unregisterModule移除模块时同时移除黑白名单中的引用,在这里我们使用WeakMapWeakSet来存储相关信息,避免module注销时无法释放相应的prop

2.1、getter的依赖收集

WeakMap是ES6中新增的数据类型,其键属于弱引用,可以很好的避免在没有其他引用时,因Map存在引用无法释放而导致的内存泄漏。首先,需要创建黑白名单的修饰器:

const WHITE_TAG = 1; // 白名单tag
const BLACK_TAG = 2; // 黑名单tag
// 存储state的信息
const filterMap = new WeakMap();
// 存储state[prop]的getter,用于在setState时过滤无效的prop
const descriptorSet = new WeakSet();
// 接受黑白名单的tag,返回对应的修饰器
const createDescriptorDecorator = tag => (target, prop) => {
    if (!filterMap.has(tag)) {
        // 设置当前state的黑白名单信息
        filterMap.set(target, tag);
    } else if (filterMap.get(target) ^ tag) {
        // 在同一state中,不能同时存在黑名单和白名单
        throw new Error('...');
    }
    let value = target[prop];
    return {
        enumerable: true,
        configurable: true,
        get: function() {
            const {get: getter} = Object.getOwnPropertyDescriptor(target, prop) || {};
            if (getter && !descriptorSet.has(getter)) {
                // 收集依赖到WeakSet
                descriptorSet.add(getter);
            }
            return value;
        },
        set: function(newVal) {
            value = newVal;
        }
    };
};

const shouldWrite = createDescriptorDecorator(WHITE_TAG);
const forbidWrite = createDescriptorDecorator(BLACK_TAG);
复制代码

这样就完成了修饰器的编写,使用时对需要的stateproperty修饰即可:

const module = {
    state: () => ({
        @shouldWrite
        property1: {},
        property2: [],
    })
};
复制代码

此时当读取state.property1时就会将property1getter存入到descriptorSet中,供过滤时使用。

2.2、解析modulestate

getter触发依赖收集后,我们将stateproperty存入了descriptorSet,现在我们需要根据modulestate,利用descriptorSet将无效的数据过滤掉,返回pureState:

/**
 * [根据黑白名单,过滤state中无效的数据,返回新state]
 * @param  {[type]} module [state对应的module]
 * @param  {[type]} state  [待过滤的state对象]
 * @return {[type]}        [新的state]
 */
const parseModuleState = (module, state) => {
    const {_children, state: moduleState} = module;
    const childrenKeys = Object.keys(_children);
    // 获取state中各个property的getter
    const descriptors = Object.getOwnPropertyDescriptors(moduleState);
    // 判断当前state启用黑名单还是白名单,默认黑名单
    const tag = filterMap.get(moduleState) || BLACK_TAG;
    const isWhiteTag = tag & WHITE_TAG;
    // Object.fromEntries可以用object.fromentries来polyfill
    const pureState = Object.fromEntries(Object.entries(state).filter(([stateKey]) => {
        const {get: getter} = descriptors[stateKey] || {};
        // 过滤子模块的数据,只保留白名单或不在黑名单里的数据
        return !childrenKeys.some(childKey => childKey === stateKey)
                && !((isWhiteTag ^ descriptorSet.has(getter)));
    }));
    return pureState;
}
复制代码

这样剔除了冗余的数据,只保留有效数据存入storage

3、registerModule

Vuex支持registerModuleunregisterModule来动态的注册模块和注销模块,并且可以通过设置{preserveState: true}来保存SSR渲染的数据,在Weex中同样需要在registerModule时初始化已有的数据到state,这里我们选择在插件初始化时扩展下:

// 根据传入的newState,初始化module及其子module的state
const setModuleState = async (store, path, newState) => {
    const namespace = path.length ? normalizeNamespace(path) : '';
    const module = store._modulesNamespaceMap[namespace];
    const setChildModuleState = function setChildModuleState(_module, _state) {
        const {_children, state} = _module;
        const childrenKeys = Object.keys(_children);
        Object.entries(_state).map(([key, value]) => {
            if (childrenKeys.every(a => a !== key)) {
                state[key] = value;
            } else if (_children[key]) {
                // 子模块递归设置
                setChildModuleState(_children[key], _state[key]);
            }
        });
    };
    setChildModuleState(module, newState);
};
export const createStatePlugin = (option = {}) => {
    const {supportRegister = false} = option;
    return function(store) {
        if (supportRegister) {
            // 扩展registerModule方法,先保留对原方法的引用
            const registerModule = store.registerModule;
            // 涉及到对storage的操作,将其扩展为async方法
            store.registerModule = async function(path, rawModule, options) {
                // 调用Vuex的registerModule
                registerModule.call(store, path, rawModule, options);
                // 在注册module完成后,初始化数据
                const {rawState} = options || {};
                const newState = typeof rawState === 'function' ? rawState() : rawState;
                if (newState) {
                    // 设置state
                    setModuleState(store, path, newState);
                    ...
                }
            }
        }
    }
}
复制代码

以上就完成了在registerModule时,对state数据初始化操作,还可以调用parseModuleState后模块所需数据存入storageunregisterModule的扩展更简单,只需在注销的同时删除storage中对应模块的数据即可,再次不再赘述。

4、小结

在Weex开发时,因各个页面实例拥有独立的JS运行环境,无法共享Vuex数据,所以在项目中会使用storageBroadcastChannel等来实现页面通信和数据共享。本文利用Decorator来实现Vuex数据的分模块存储,同时提供stateproperty黑白名单过滤及registerModule时数据动态初始化功能。以上是本人项目中的一点心得,如若有误,还请斧正。

关注下面的标签,发现更多相似文章
评论