redux-undo 的 groupBy 和 filter

本文不是 redux-undo 的 GetStart,所以在阅读之前最好先了解redux-undo。文章只是简单的介绍笔者使用 redux-undo 时所遇到的问题及解决方法。

什么是redux-undo?

higher order reducer to add undo/redo functionality to redux state containers.

原理

简单来说,redux-undo将reducer 分为:past,present,future。past 和 future 都是数组,分别记录 undo 和 redo,present 就是当前的 reducer。例如使用 redux-undo 前是这样子使用:state.counter,那么使用后需要这样子用:state.counter.present。

详情请参考:

Implementing Undo History
redux-undo

配置 undoableConfig

使用 redux-undo 方法如下:

import undoable from 'redux-undo';
undoable(reducer, undoableConfig)

重点是 undoableConfig 中的 groupBy 和 filter。二者皆为一个函数,可以使用 groupByActionTypes、includeAction、excludeAction,也可以使用自定义的函数。filter还可以使用 combineFilters 将自定义filter 和includeAction、excludeAction组合使用。

groupBy

在使用 redux-undo 时有这么一个场景。比如说一个 input 的状态放在 redux,onChange 时会发 action(UPDATE_INPUT) 更新 store。如果想使用 redux-undo 监听这个 input 的输入记录。

const undoableConfig = {
    filter: includeAction([UPDATE_INPUT]}
}

那么此时 input 的每次修改都会记录在 undo past 中,输入一个 "input" 字符串会记录5次,这样子显然是不行的。我希望的是只记录一次,所以就需要 groupBy 来配合了。

import undoable, { groupByActionTypes } from 'redux-undo'

const undoableConfig = {
    filter: includeAction([UPDATE_INPUT],
    groupBy: groupByActionTypes(UPDATE_INPUT),
}

此时就已经实现了 input 的输入只会记录一次,非常棒。但是此时假设需要在 input value 的长度小于5时只记录一次,大于5以后每次修改都记录呢?这时候 groupByActionTypes 就玩不转了。但是别忘了 groupBy 就是一个函数,groupByActionTypes 只是作者提供的一个通用的方法。要实现刚才的需求就需要我们自定义 groupBy 方法了。

import { get } from 'lodash'

const undoableConfig = {
    filter: includeAction([UPDATE_INPUT],
    groupBy: (action) => get(action, 'payload.undoableGroupName', null),
}

这样子,在需要 groupBy 的时候传入一个参数 undoableGroupName,相同的 undoableGroupName 连续的 action 就只会记录一步。若 undoableGroupName 值则为 null,连续的 action 则不会被分组。

filter

上文已经简单介绍过 filter,简单来说就是筛选出需要记录的 actionTypes。那 redux-undo 既然已经提供了 includeAction,还有什么可说的呢?来看下面这个案例。假设有一个 ACTION_A 是需要记录的,那应该这样子用:

import undoable, { includeAction } from 'redux-undo'

const undoableConfig = {
    filter: includeAction([ACTION_A]
}

很简单就能实现。那若是有这么一个 action,在 someAction 中 ACTION_A 就不需要记录。

export const someAction = (var1, var2) => {
  return function (dispatch) {
    dispatch(subAction_A_ToReducerA(var1))
    dispatch(subAction_B_ToReducerB(var2))
  }
}

export const subAction_A_ToReducerA = (var1) => {
  return {
    type: ACTION_A,
    var1: var1
  }
}

export const subAction_B_ToReducerB = (var2) => {
  return {
    type: ACTION_B,
    var2: var2
  }
}

要怎么实现呢?这时候就需要我们自定义 filter 了。redux-undo 提供了 combineFilters 方法,可以将 includeAction 和 customFilter 结合起来。比如像这样:

import undoable, { includeAction } from 'redux-undo'

const undoableConfig = {
    filter: combineFilters(
        includeAction([ACTION_A],
        customFilter
    )
}
const customFilter = (action) => !get(action, 'payload.undoableFiltered', false)

这样,someAction 也需要做一定的修改。someAction 中的 ACTION_A 就会被 filter 掉,不被记录下来。

export const someAction = (var1, var2) => {
  return (dispatch) => {
     const undoableFiltered = true
     
     dispatch(subAction_A_ToReducerA(var1, undoableFiltered))
     dispatch(subAction_B_ToReducerB(var2))
  }
}

export const subAction_A_ToReducerA = (var1, undoableFiltered) => {
  return {
    type: ACTION_A,
    undoableFiltered: undoableFiltered,
    var1: var1
  }
}

以上就是笔者在实践中遇到的特殊情况,幸运的是巧妙的使用 groupBy 和 filter解决了以上问题。

参考:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容