在Immutable.js中如何實現撤銷重做功能（詳細教學）

這篇文章主要介紹了基於Immutable.js 實現撤銷重做功能及一些需要注意的地方,需要的朋友可以參考下

瀏覽器的功能越來越強大，許多原來由其他客戶端提供的功能漸漸轉移到了前端，前端應用也越來越複雜。許多前端應用，尤其是一些線上編輯軟體，運行時需要不斷處理用戶的交互，提供了撤消重做功能來確保交互的流暢性。不過為一個應用程式實作撤銷重做功能並不是一件容易的事。 Redux官方文件中 介紹如何在 redux 應用程式中實作撤銷重做功能。基於redux 的撤銷功能是一個自頂向下的方案：引入redux-undo 之後所有的操作都變成了「可撤銷的」，然後我們不斷修改其配置使得撤銷功能變得越來越好用（這也是 redux-undo 有這麼多配置項目 的原因)。

本文將採用自底向上的思路，以一個簡易的線上畫圖工具為例子，使用TypeScript 、 Immutable.js 實作一個實用的「撤銷重做」功能。大致效果如下圖所示：

第一步：決定哪些狀態需要歷史記錄，建立自訂的State 類別

#並非所有的狀態都需要歷史記錄。許多狀態是非常瑣碎的，尤其是一些與滑鼠或鍵盤互動相關的狀態，例如在畫圖工具中拖曳一個圖形時我們需要設定一個「正在進行拖曳」的標記，頁面會根據該標記顯示對應的拖曳提示，顯然該拖曳標記不應該出現在歷史記錄中；而另一些狀態無法被撤銷或是不需要被撤銷，例如網頁視窗大小，向後台發送過的請求清單等。

排除那些不需要歷史記錄的狀態，我們將剩餘的狀態用Immutable Record 封裝起來，並定義State 類別：

// State.ts
import { Record, List, Set } from 'immutable'
const StateRecord = Record({
 items: List<Item>
 transform: d3.ZoomTransform
 selection: number
})
// 用类封装，便于书写 TypeScript，注意这里最好使用Immutable 4.0 以上的版本
export default class State extends StateRecord {}

#這裡我們的例子是一個簡易的線上畫圖工具，所以上面的State 類別中包含了三個字段，items 用來記錄已經繪製的圖形，transform 用來記錄畫板的平移和縮放狀態，selection 則表示目前選中的圖形的ID。而畫圖工具中的其他狀態，例如圖形繪製預覽，自動對齊配置，操作提示文字等，則沒有放在 State 類別中。

第二步：定義Action 基類，並為每種不同的操作建立對應的Action 子類

與redux-undo 不同的是，我們仍然採用指令模式：定義基底類Action，所有對State 的操作都被封裝為一個Action 的實例；定義若干Action 的子類，對應於不同類型的動作。

在 TypeScript 中，Action 基底類別用 Abstract Class 定義比較方便。

// actions/index.ts
export default abstract class Action {
 abstract next(state: State): State
 abstract prev(state: State): State
 prepare(appHistory: AppHistory): AppHistory { return appHistory }
 getMessage() { return this.constructor.name }
}

Action 物件的 next 方法用來計算「下一個狀態」，prev 方法用來計算「上一個狀態」。 getMessage 方法用來取得 Action 物件的簡短描述。透過 getMessage 方法，我們可以將使用者的操作記錄顯示在頁面上，讓使用者更方便地了解最近發生了什麼。 prepare 方法用來在 Action 第一次被應用之前，使其「準備好」，AppHistory 的定義在本文後面會給出。

Action 子類舉例

下面的 AddItemAction 是一個典型的 Action 子類，用於表達「新增一個新的圖形」。

// actions/AddItemAction.ts
export default class AddItemAction extends Action {
 newItem: Item
 prevSelection: number
 constructor(newItem: Item) {
 super()
 this.newItem = newItem
 }
 prepare(history: AppHistory) {
 // 创建新的图形后会自动选中该图形，为了使得撤销该操作时 state.selection 变为原来的值
 // prepare 方法中读取了「添加图形之前 selection 的值」并保存到 this.prevSelection
 this.prevSelection = history.state.selection
 return history
 }
 next(state: State) {
 return state
  .setIn(['items', this.newItem.id], this.newItem)
  .set('selection', this.newItemId)
 }
 prev(state: State) {
 return state
  .deleteIn(['items', this.newItem.id])
  .set('selection', this.prevSelection)
 }
 getMessage() { return `Add item ${this.newItem.id}` }
}

在執行階段行為

應用程式運行時，使用者互動產生一個Action 流，每次產生Action 物件時，我們呼叫該物件的next 方法來計算後一個狀態，然後將該action 儲存到一個清單中以備後用；使用者進行撤銷操作時，我們從action 清單中取出最近一個Action並呼叫其prev 方法。應用執行時，next/prev 方法被呼叫的情況大致如下：

// initState 是一开始就给定的应用初始状态
// 某一时刻，用户交互产生了 action1 ...
state1 = action1.next(initState)
// 又一个时刻，用户交互产生了 action2 ...
state2 = action2.next(state1)
// 同样的，action3也出现了 ...
state3 = action3.next(state2)
// 用户进行撤销，此时我们需要调用最近一个action的prev方法
state4 = action3.prev(state3)
// 如果再次进行撤销，我们从action列表中取出对应的action，调用其prev方法
state5 = action2.prev(state4)
// 重做的时候，取出最近一个被撤销的action，调用其next方法
state6 = action2.next(state5)
Applied-Action

為了方便後面的說明，我們對Applied-Action 進行一個簡單的定義：Applied-Action 是指那些操作結果已經反映在目前應用程式狀態中的action；當action 的next 方法執行時，該action 變成applied；當prev 方法被執行時，該action 變成unapplied。

第三個步驟：建立歷史記錄容器AppHistory

前面的State 類別用來表示某個時刻應用程式的狀態，接下來我們定義AppHistory 類別用來表示應用的歷史記錄。同樣的，我們仍然使用 Immutable Record 來定義歷史記錄。其中 state 欄位用來表達目前的應用狀態，list 欄位用來存放所有的 action，而 index 欄位用來記錄最近的 applied-action 的下標。應用的歷史狀態可以透過 undo/redo 方法計算得到。 apply 方法用來在 AppHistory 中新增並執行特定的 Action。具體程式碼如下：

// AppHistory.ts
const emptyAction = Symbol('empty-action')
export const undo = Symbol('undo')
export type undo = typeof undo // TypeScript2.7之后对symbol的支持大大增强
export const redo = Symbol('redo')
export type redo = typeof redo
const AppHistoryRecord = Record({
 // 当前应用状态
 state: new State(),
 // action 列表
 list: List<Action>(),
 // index 表示最后一个applied-action在list中的下标。-1 表示没有任何applied-action
 index: -1,
})
export default class AppHistory extends AppHistoryRecord {
 pop() { // 移除最后一项操作记录
 return this
  .update(&#39;list&#39;, list => list.splice(this.index, 1))
  .update(&#39;index&#39;, x => x - 1)
 }
 getLastAction() { return this.index === -1 ? emptyAction : this.list.get(this.index) }
 getNextAction() { return this.list.get(this.index + 1, emptyAction) }
 apply(action: Action) {
 if (action === emptyAction) return this
 return this.merge({
  list: this.list.setSize(this.index + 1).push(action),
  index: this.index + 1,
  state: action.next(this.state),
 })
 }
 redo() {
 const action = this.getNextAction()
 if (action === emptyAction) return this
 return this.merge({
  list: this.list,
  index: this.index + 1,
  state: action.next(this.state),
 })
 }
 undo() {
 const action = this.getLastAction()
 if (action === emptyAction) return this
 return this.merge({
  list: this.list,
  index: this.index - 1,
  state: action.prev(this.state),
 })
 }
}

#

第四步：添加「撤销重做」功能

假设应用中的其他代码已经将网页上的交互转换为了一系列的 Action 对象，那么给应用添上「撤销重做」功能的大致代码如下：

type HybridAction = undo | redo | Action
// 如果用Redux来管理状态，那么使用下面的reudcer来管理那些「需要历史记录的状态」
// 然后将该reducer放在应用状态树中合适的位置
function reducer(history: AppHistory, action: HybridAction): AppHistory {
 if (action === undo) {
 return history.undo()
 } else if (action === redo) {
 return history.redo()
 } else { // 常规的 Action
 // 注意这里需要调用prepare方法，好让该action「准备好」
 return action.prepare(history).apply(action)
 }
}
// 如果是在 Stream/Observable 的环境下，那么像下面这样使用 reducer
const action$: Stream<HybridAction> = generatedFromUserInteraction
const appHistory$: Stream<AppHistory> = action$.fold(reducer, new AppHistory())
const state$ = appHistory$.map(h => h.state)
// 如果是用回调函数的话，大概像这样使用reducer
onActionHappen = function (action: HybridAction) {
 const nextHistory = reducer(getLastHistory(), action)
 updateAppHistory(nextHistory)
 updateState(nextHistory.state)
}

第五步：合并 Action，完善用户交互体验

通过上面这四个步骤，画图工具拥有了撤消重做功能，但是该功能用户体验并不好。在画图工具中拖动一个图形时，MoveItemAction 的产生频率和 mousemove 事件的发生频率相同，如果我们不对该情况进行处理，MoveItemAction 马上会污染整个历史记录。我们需要合并那些频率过高的 action，使得每个被记录下来的 action 有合理的撤销粒度。

每个 Action 在被应用之前，其 prepare 方法都会被调用，我们可以在 prepare 方法中对历史记录进行修改。例如，对于 MoveItemAction，我们判断上一个 action 是否和当前 action 属于同一次移动操作，然后来决定在应用当前 action 之前是否移除上一个 action。代码如下：

// actions/MoveItemAction.ts
export default class MoveItemAction extends Action {
 prevItem: Item
 // 一次图形拖动操作可以由以下三个变量来进行描述：
 // 拖动开始时鼠标的位置(startPos)，拖动过程中鼠标的位置(movingPos)，以及拖动的图形的 ID
 constructor(readonly startPos: Point, readonly movingPos: Point, readonly itemId: number) {
 // 上一行中 readonly startPos: Point 相当于下面两步：
 // 1. 在MoveItemAction中定义startPos只读字段
 // 2. 在构造函数中执行 this.startPos = startPos
 super()
 }
 prepare(history: AppHistory) {
 const lastAction = history.getLastAction()
 if (lastAction instanceof MoveItemAction && lastAction.startPos == this.startPos) {
  // 如果上一个action也是MoveItemAction，且拖动操作的鼠标起点和当前action相同
  // 则我们认为这两个action在同一次移动操作中
  this.prevItem = lastAction.prevItem
  return history.pop() // 调用pop方法来移除最近一个action
 } else {
  // 记录图形被移动之前的状态，用于撤销
  this.prevItem = history.state.items.get(this.itemId)
  return history
 }
 }
 next(state: State): State {
 const dx = this.movingPos.x - this.startPos.x
 const dy = this.movingPos.y - this.startPos.y
 const moved = this.prevItem.move(dx, dy)
 return state.setIn(['items', this.itemId], moved)
 }
 prev(state: State) {
 // 撤销的时候我们直接使用已经保存的prevItem即可
 return state.setIn(['items', this.itemId], this.prevItem)
 }
 getMessage() { /* ... */ }
}

从上面的代码中可以看到，prepare 方法除了使 action 自身准备好之外，它还可以让历史记录准备好。不同的 Action 类型有不同的合并规则，为每种 Action 实现合理的 prepare 函数之后，撤消重做功能的用户体验能够大大提升。

一些其他需要注意的地方

撤销重做功能是非常依赖于不可变性的，一个 Action 对象在放入 AppHistory.list 之后，其所引用的对象都应该是不可变的。如果 action 所引用的对象发生了变化，那么在后续撤销时可能发生错误。本方案中，为了方便记录操作发生时的一些必要信息，Action 对象的 prepare 方法中允许出现原地修改操作，但是 prepare 方法只会在 action 被放入历史记录之前调用一次，action 一旦进入纪录列表就是不可变的了。

上面是我整理给大家的，希望今后会对大家有帮助。

相关文章：

vue页面离开后执行函数的实例

vue轮播图插件vue-concise-slider的使用

vue加载自定义的js文件方法

以上是在Immutable.js中如何實現撤銷重做功能（詳細教學）的詳細內容。更多資訊請關注PHP中文網其他相關文章！