python命令模式

标签： python 设计模式

引子

命令模式其实仔细想想还是比较容易理解的，只是不知道我理解的对不对，按照书中的例子，大致上就是想设计一个万能遥控器，遥控器上有七个槽，每个槽都能关联一个设备，而且每个槽对应一个ON和OFF的开关， 这两个开关能控制对应槽上关联设备的动作。

问题来了

遥控器的ON和OFF怎么知道对着一个洗衣机是打开，关闭，甩干还是干洗呢，其实如果不知道命令模式，让我想这件事，我也能想到设计一个中间件作为洗衣机和遥控器之间对话的媒介，遥控器按下ON，这个中间件告诉洗衣机，去干洗，之后洗衣机就执行了正确的动作，这样动作的请求者遥控器从动作的执行者洗衣机对象中解耦。这样无论后续增加多少别的设备，遥控器始终说的都是ON和OFF。

如何实现

先从一个插槽坐起，在第一个插槽我想让他控制一盏灯的亮和灭。
首先创建一盏灯

class Light(object):
    #可以初始化灯的类型，例如是厨房的灯还是起居室的灯
    def __init__(self, type):
        self.light = type
    #灯本身的控制方法，on和off，这里的on和off不同于遥控器的，这只是灯自己的方法，就像是洗衣机的
    #甩干和漂洗一样
    def on(self):
        print(str(self.light) + " light On")
    def off(self):
        print(str(self.light) + " light Off")

创建遥控器

class RemoteController(object):
    def __init__(self):
        self.onCommand = {}
        self.offCommand = {}
    #这里是对遥控器的插槽和按钮进行定义
    def setCommand(self, slot, onCommand, offCommand):
        self.onCommand.setdefault(slot, onCommand)
        self.offCommand.setdefault(slot, offCommand)
    #遥控器ON按钮按下后执行的动作
    def onButtonWasPress(self, slot):
        self.onCommand[slot].execute()
    #遥控器OFF按钮按下后执行的动作
    def offButtonWasPress(self, slot):
        self.offCommand[slot].execute()

关键的来了，命令对象，也就是这个中间件

#电灯开
class LightOnCommand(Command):
    #传入某个电灯对象
    def __init__(self, light):
        self.light = light
    #定义一个execute方法，调用传入对象的特定方法
    def execute(self):
        self.light.on()
#电灯关
class LightOffCommand(Command):
    def __init__(self, light):
        self.light = light
    def execute(self):
        self.light.off()

测试一下

def client():
    controller = RemoteController()
    #要控制起居室的灯
    livingRoomLight = Light("Living Room")
    #将livingRoomLight对象传到这个中间件里面，这时这个中间件就和电灯关联了
    livingRoomLightOn = LightOnCommand(livingRoomLight)
    livingRoomLightOff = LightOffCommand(livingRoomLight)
    #定义一下遥控器的设置，0号槽控制电灯，on按钮是打开起居室的灯，off按钮是关闭起居室的灯
    #这时这个中间件又和遥控器关联了
    controller.setCommand(0, livingRoomLightOn, livingRoomLightOff)
    #控制一下
    controller.onButtonWasPress(0)
    controller.offButtonWasPress(0)
if __name__ == '__main__':
    client()

灯亮了又灭了

Living Room light On
Living Room light Off

定义

将请求封装成对象，以便使用不同的请求、队列或者日志来参数化其他对象。命令模式也支持可撤销的操作

命令对象将动作和接受者包在对象中，这个对象只暴露出一个execute()方法，当此方法被调用时，接受者就会进行这些动作。从外面来看，其他对象不知道究竟哪个接受者进行了哪些动作，例如遥控器根本不知道按下on和off自己都做了些什么，它只知道如果调用execute方法，请求的目的就达到了。

增加撤销功能

遥控器上增加一个撤销按钮，作用是按下此按钮后，最后被控制的电气设备回到他之前的状态，例如目前电灯是亮的，按下撤销按钮后，灯就灭了。
首先对所有的命令对象增加undo方法

#电灯开
class LightOnCommand(Command):
    def __init__(self, light):
        self.light = light
    def execute(self):
        self.light.on()
    def undo(self):
        self.light.off()
#电灯关
class LightOffCommand(Command):
    def __init__(self, light):
        self.light = light
    def execute(self):
        self.light.off()
    def undo(self):
        self.light.on()

接下来需要让遥控器能追踪到最后执行了哪个电器的命令对象，这需要在RemoteController类中增加一个unCommand属性，用它来记录此对象，之后调用此对象的undo方法

class RemoteController(object):
    def __init__(self):
        self.onCommand = {}
        self.offCommand = {}
        self.undoCommand = None
    def setCommand(self, slot, onCommand, offCommand):
        self.onCommand.setdefault(slot, onCommand)
        self.offCommand.setdefault(slot, offCommand)
    def onButtonWasPress(self, slot):
        self.onCommand[slot].execute()
        self.undoCommand = self.onCommand[slot]
    def offButtonWasPress(self, slot):
        self.offCommand[slot].execute()
        self.undoCommand = self.offCommand[slot]
    def undoButtonWasPress(self):
        self.undoCommand.undo()

其他槽的内容就是粘贴复制了

看一个比较实际的例子

在一个图形界面中，一个操作可以被菜单栏中的菜单项，快捷键，工具栏图标或者右键菜单项所调用，实际发生的操作，例如Exit,Save或者Close，全部都由ConcreteCommand实现，GUI窗口接收到退出指令，文档接收到保存指令等等都是一个个Receiver的实例。
这里可以和上面做一个类比，我觉得还是遥控器的例子比较好理解
可以把窗口，文件等图形控件看成是一个个电器，窗口有自己的动作行为，例如最大化，最小化，退出等，文件也有自己的动作行为，例如保存，打开，新建等，这些都可以看成是电器的各种各样的动作。他们是类图中Receiver的实例。
先来创建Receiver对象

class Windou:
# exit方法， 执行退出操作
    def exit(self):
        sys.exit(0)
class Document:
    def __init__(self, filename):
        self.filename = filename
        self.contents = "This file cannot be modified"
    # 保存方法，执行写一段文字到文件里
    def save(self):
        with open(self.filename, 'w') as file:
            file.write(self.contents)

再看看调用类，他们可以使菜单栏的菜单项，快捷键，工具栏图标或者右键菜单，可以把他们看做是万能遥控器，点击菜单栏上的一个按钮，激活一个快捷键，按下一个工具栏上的图标，或者右键选择一个选项，他们都会执行你关联在它上面的一个操作。

# 这是一个工具栏按钮
class ToolbarButton:
    def __init__(self, name, iconname):
        self.name = name
        self.iconname = iconname
    def click(self):
        self.command.execute()
# 这是一个菜单栏上的菜单项
class MenuItem:
    def __init__(self, menu_name, menuitem_name):
        self.menu = menu_name
        self.item = menuitem_name
    def click(self):
        self.command.execute()
# 这是一个快捷键
class KeyboardShortcut:
    def __init__(self, key, modifire):
        self.key = key
        self.modifier = modifire
    def keyPress(self):
        self.command.execute()

之后就是这个中间件了，它作为了调用者和接受者之间的桥梁，实现了调用者和接受者的解耦。

# 保存命令，这里需要传入执行此命令的接受者实例
class SaveCommand:
    def __init__(self, document):
        self.document = document
    def execute(self):
        self.document.save()
# 退出命令，这里需要传入执行此命令的接受者实例
class ExitCommand:
    def __init__(self, window):
        self.window = window
    def execute(self):
        self.window.exit()

实际调用看看

# 通过工具栏上额一个按钮实现文件保存功能，这是一个Invoker实例
save_button = ToolbarButton("save", 'save.png')
#创建一个文件实例，这是一个Receiver实例
doc = Document("a_document.txt")
# 这是ConcreteCommand的实例，它接收了一个Receiver对象，这里是doc对象，关联了此对象的save方法
save = SaveCommand(doc)
save_button.command = save
# 执行这个按钮的click方法，文件被保存了
save_button.click()

尾声

就写这些吧，不知道理解的是否正确，不过按照这样的类比方式，我是能比较容易的理解，光是看定义和书中的描述，着实让我糊涂，毕竟我不是程序员。