行为模式-命令模式(The Command Pattern)

本文大部分内容翻译至《Pro Design Pattern In Swift》By Adam Freeman,一些地方做了些许修改,并将代码升级到了Swift2.0,翻译不当之处望多包涵。

命令模式(The Command Pattern)

行为请求者”与“行为实现者”通常呈现一种“紧耦合”。但在某些场合,比如要对行为进行“记录、撤销/重做、事务”等处理,这种无法抵御变化的紧耦合是不合适的。在这种情况下,如何将“行为请求者”与“行为实现者”解耦,将一组行为抽象为对象实现二者之间的松耦合


示例工程

Xcode OS X Command Line Tool工程:

Calculator.swift

class Calculator {
    private(set) var total = 0
    
    func add(amount:Int) {
        total += amount
    }
    
    func subtract(amount:Int) {
        total -= amount
    }
    
    func multiply(amount:Int) {
        total = total * amount
    }
    
    func divide(amount:Int) {
        total = total / amount
    }
}

Calculator类定义了一个存储属性total,以及改变total值的一些方法。

main.swift

let calc = Calculator()

calc.add(10)
calc.multiply(4)
calc.subtract(2)

print("Total: \(calc.total)")

运行程序,输出:

Total: 38

理解命令模式解决的问题

假如两个请求组件同时操作同一个 Calculator 对象,每个请求组件都去调用方法去修改total的值。



现在想象一下你需要支持撤销前面的操作。一个解决方法是每一个请求组件都追踪自己的操作以便未来能撤销。但是这么做的问题是每一个组件都不知道其他组件做了什么,这样很可能导致撤销出现混乱。


理解命令模式

命令模式用一个对象来提供方法调用所有可以解决撤销等一系列问题。



命令模式的关键就是这个 命令对象。在它的私有实现里,命令对象有接收对象的引用和如何让接收者调用方法的说明。

图中,receiver和invocation instructions都是私有的所有请求组件并不能访问。唯一公有的是execution method。


实现命令模式

定义命令协议

实现命令模式的第一步是定义一个拥有execution 方法的协议。

Commands.swift

protocol Command {
    func execute()
}

行为实现者允许行为请求者执行方法但隐藏了receiver对象和invocation instructions。

定义命令实现类

实现类对于swift来说可以很简单,因为instructions可以用闭包来实现。

Commands.swift

protocol Command {
    func execute()
}

class GenericCommand<T> : Command {
    private var receiver: T
    private var instructions: T -> Void
    
    init(receiver:T, instructions: T -> Void) {
        self.receiver = receiver
        self.instructions = instructions
    }
    
    func execute() {
        instructions(receiver)
    }
    
    class func createCommand(receiver:T, instuctions: T -> Void) -> Command {
        return GenericCommand(receiver: receiver, instructions: instuctions)
    }
}

我们定义了一个泛型实现类GenericCommand ,它有私有属性receiver 和instructions。execute方法调用了instructions并将receiver作为参数传递了进去。

应用命令模式

Calculator.swift

class Calculator {
    private(set) var total = 0
    private var history = [Command]()
    
    func add(amount:Int) {
        addUndoCommand(Calculator.add, amount: amount)
        total += amount
    }
    
    func subtract(amount:Int) {
        addUndoCommand(Calculator.subtract, amount: amount)
        total -= amount
    }
    
    func multiply(amount:Int) {
        addUndoCommand(Calculator.multiply, amount: amount)
        total = total * amount
    }
    
    func divide(amount:Int) {
        addUndoCommand(Calculator.divide, amount: amount)
        total = total / amount
    }
    
    private func addUndoCommand(method:Calculator -> Int -> Void, amount:Int) {
        self.history.append(GenericCommand<Calculator>.createCommand(self){calc in
            method(calc)(amount)
        })
    }
    
    func undo() {
        if self.history.count > 0 {
            self.history.removeLast().execute()
            // temporary measure - executing the command adds to the history
            self.history.removeLast()
        }
    }
}

并发保护

Calculator.swift

import Foundation
class Calculator {
    private(set) var total = 0
    private var history = [Command]()
    private var queue = dispatch_queue_create("arrayQ", DISPATCH_QUEUE_SERIAL)
    private var performingUndo = false
    
    func add(amount:Int) {
        addUndoCommand(Calculator.subtract, amount: amount)
        total += amount
    }
    
    func subtract(amount:Int) {
        addUndoCommand(Calculator.add, amount: amount)
        total -= amount
    }
    
    func multiply(amount:Int) {
        addUndoCommand(Calculator.divide, amount: amount)
        total = total * amount
    }
    
    func divide(amount:Int) {
        addUndoCommand(Calculator.multiply, amount: amount)
        total = total / amount
    }
    
    private func addUndoCommand(method:Calculator -> Int -> Void, amount:Int) {
        if (!performingUndo){
            dispatch_sync(queue){[weak self] in
                self!.history.append(GenericCommand<Calculator>.createCommand(self!){calc in
                    //Currying
                    method(calc)(amount)
                })
            }
        }
        
    }
    
    func undo() {
        dispatch_sync(self.queue){[weak self] in
            if self!.history.count > 0 {
                self!.performingUndo = true
                self!.history.removeLast().execute()
                self!.performingUndo = false
            }
        }
        
    }
}

我们创建了一个串行队列,用同步方法dispatch_sync提交操作命令给数组来保证 history数组不会被并发修改。同时我们定义了一个performingUndo布尔变量,用来当我们执行撤销命令时阻止addUndoCommand 方法调用。

使用撤销功能

main.swift

let calc = Calculator()
calc.add(10)
calc.multiply(4)
calc.subtract(2)
print("Total: \(calc.total)")

for _ in 0 ..< 3 {
    calc.undo()
    print("Undo called. Total: \(calc.total)")
}

运行程序,可以看到值最后为0:

Undo called. Total: 40
Undo called. Total: 10
Undo called. Total: 0

命令模式的变形

下面将一次介绍三种变形:

1.创建复合命令

前面的例子中每一次只能撤销一个命令,但是利用command协议来创建一个外层类实现复数命令也是很简单的。

Commands.swift

.....

class CommandWrapper : Command {
    private let commands:[Command]
        init(commands:[Command]) {
        self.commands = commands
    }
    
    func execute() {
        for command in commands {
            command.execute()
        }
    }
}
.....

CommandWrapper类创建了一个存储command对象的常量数组。接下来我们在 Calculator类中增加一个方法。

Calculator.swift

......
func getHistorySnaphot() -> Command? {
            var command:Command?
            dispatch_sync(queue){[weak self] in
                command = CommandWrapper(commands: self!.history.reverse())
            }
            return command
    }
.....

最后修改main.swit:

let calc = Calculator()
calc.add(10)
calc.multiply(4)
calc.subtract(2)

let snapshot = calc.getHistorySnaphot()
print("Pre-Snapshot Total: \(calc.total)")

snapshot?.execute()
print("Post-Snapshot Total: \(calc.total)")

运行程序:

Pre-Snapshot Total: 38
Post-Snapshot Total: 0

2.宏命令

命令通畅可以做成宏,这样允许一系列的针对不同对象的操作。将命令当做对象使用的话,receiver就必须传递给excute方法而不是初始化方法。

Commands.swift

protocol Command {
      func execute(receiver:Any)
}

class CommandWrapper : Command {
    private let commands:[Command]
    
    init(commands:[Command]) {
        self.commands = commands;
    }
    
    func execute(receiver:Any) {
        for command in commands {
            command.execute(receiver)
        }
    }
}

class GenericCommand<T> : Command {
    private var instructions: T -> Void
    
    init(instructions: T -> Void) {
        self.instructions = instructions
    }
        
    func execute(receiver:Any) {
        if let safeReceiver = receiver as? T {
            instructions(safeReceiver)
        } else {
            fatalError("Receiver is not expected type")
        }
    }
        
    class func createCommand(instuctions: T -> Void) -> Command {
        return GenericCommand(instructions: instuctions)
    }
}

Calculator.swift

import Foundation
class Calculator {
    private(set) var total = 0
    private var history = [Command]()
    private var queue = dispatch_queue_create("arrayQ", DISPATCH_QUEUE_SERIAL)
    
    func add(amount:Int) {
        addMacro(Calculator.add, amount: amount)
        total += amount
    }
    
    func subtract(amount:Int) {
        addMacro(Calculator.subtract, amount: amount)
        total -= amount
    }
    
    func multiply(amount:Int) {
        addMacro(Calculator.multiply, amount: amount)
        total = total * amount
    }
    
    func divide(amount:Int) {
        addMacro(Calculator.divide, amount: amount)
        total = total / amount
    }
    
    private func addMacro(method:Calculator -> Int -> Void, amount:Int) {
        dispatch_sync(self.queue){[weak self] in
            self!.history.append(GenericCommand<Calculator>.createCommand(
            { calc in method(calc)(amount) }))
        }
    }
    
    func getMacroCommand() -> Command? {
        var command:Command?
        dispatch_sync(queue){[weak self] in
            command = CommandWrapper(commands: self!.history)
        }
        return command
    }
}

最后我们看main.swift:

let calc = Calculator()
calc.add(10)
calc.multiply(4)
calc.subtract(2)

print("Calc 1 Total: \(calc.total)")

let macro = calc.getMacroCommand()
let calc2 = Calculator()
macro?.execute(calc2)

print("Calc 2 Total: \(calc2.total)")

运行程序,得到下面结果:

Calc 1 Total: 38
Calc 2 Total: 38

3.闭包代替命令

Calculator.swift

import Foundation;
class Calculator {
    private(set) var total = 0
    typealias CommandClosure = (Calculator -> Void)
    private var history = [CommandClosure]()
    private var queue = dispatch_queue_create("arrayQ", DISPATCH_QUEUE_SERIAL)
    
    func add(amount:Int) {
        addMacro(Calculator.add, amount: amount)
        total += amount
    }
    
    func subtract(amount:Int) {
        addMacro(Calculator.subtract, amount: amount)
        total -= amount
    }
    
    func multiply(amount:Int) {
        addMacro(Calculator.multiply, amount: amount);
        total = total * amount
    }
    
    func divide(amount:Int) {
        addMacro(Calculator.divide, amount: amount)
        total = total / amount
    }
    
    private func addMacro(method:Calculator -> Int -> Void, amount:Int) {
        dispatch_sync(self.queue, {() in
            self.history.append({ calc in  method(calc)(amount)})
        })
    }
    
    func getMacroCommand() -> (Calculator -> Void) {
        var commands = [CommandClosure]();
        dispatch_sync(queue, {() in
            commands = self.history
        })
        return { calc in
            if (commands.count > 0) {
                for index in 0 ..< commands.count {
                    commands[index](calc)
                }
            }
        }
    }
}

接着我们看main.swift:

let calc = Calculator()
calc.add(10)
calc.multiply(4)
calc.subtract(2)

print("Calc 1 Total: \(calc.total)")

let macro = calc.getMacroCommand()
let calc2 = Calculator()
macro(calc2)
print("Calc 2 Total: \(calc2.total)")

运行程序:

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

推荐阅读更多精彩内容