[Design Pattern] Command Pattern - 커맨드 패턴

Command Pattern

커맨드 패턴은 요청을 독립된 객체로 변환하여 요청에 대한 모든 정보를 포함하게 만드는 행동 패턴입니다.

• 다양한 요청을 메서드로 매개변수화하고, 요청의 실행을 지연하거나 큐에 넣을 수 있으며, 실행 취소 기능을 지원할 수 있습니다.

여러 명령들을 추상화해서 class로 정의하고 Object로 만들어서 사용하는 Pattern입니다.

• 또한 행위(Behavior) 패턴에 속합니다.
• 클래스가 일을 실행할떄, 자신의 클래스 or 다른 클래스의 Method를 호출합니다.
  • 그러나 Method를 호출한 결과는 Object에 반영되지만, 일의 이력은 어디에도 남지 않습니다.
• 이때, ‘이 일을 실행하시오’ 라는 ‘명령’을 표현하는 클래스가 있으면 편합니다.
• 명령을 나타내는 클래스의 인스턴스로 하나의 ‘물건’처럼 표현할 수 있습니다.
• 명령에 대한 이력을 관리하고 싶을 때에는 그 인스턴스의 집합을 관리하면 됩니다.
• 명령의 집합을 저장해주면 같은 명령을 재실행할 수도 있고, 복수의 명령을 모아서 새로운 명령으로 재이용 할 수 있습니다.

---

Diagram

• Command: 명령의 인터페이스를 정의하는 역할입니다.
• ConcreteCommand (Command1): 실제로 실행되는 기능을 구현, 즉 Command라는 인터페이스를 구현합니다.
• Invoker: 명령의 행동을 개시하는 역할을 하며, Command에서 정의되는 API를 호출합니다.
• Receiver: Command가 명령을 실행할 때 그 대상이 되는 역할, 명령을 받아들이는 수신자라고 지칭합니다.

---

Example

class Command:
    def execute(self):
        pass

class PrintCommand(Command):
    def __init__(self, print_str: str):
        self.print_str = print_str
    
    def execute(self):
        print(f"from print command: {self.print_str}")

• Base Interface로 execute() 메서드만 존재합니다.
• Command를 상속받습니다.
• __init__ 메서드에서 print_str을 인자로 받아 내부에 저장합니다.
• execute() 메서드에서 저장되어 있는 print_str을 출력합니다.

 

first_command = PrintCommand("first command")
second_command = PrintCommand("second command")

first_command.execute()
second_command.execute()

from print command: first command
from print command: second command

• PrintCommand 객체인 first_command, second_command 을 생성합니다.
• 생성된 객체들을 실행시키면 예상한 대로 출력됩니다.

---

조금 더 복잡한 Command 클래스 구조

• Dog: ‘sit’,’stay’ 2가지 명령어를 알아 듣습니다.
• DogCommand:
  • Command에서 상속을 받습니다.
  • Dog에서 명령을 내리는 class로 내부에 명령을 내릴 Dog Object가 존재합니다.
  • 명령들을 저장하는 리스트인 Commands가 존재합니다.

from typing import List

class Dog:
    def sit(self):
        print("The dog sat down")
    
    def stay(self):
        print("The dog is staying")

class DogCommand(Command):
    def __init__(self, dog: Dog, commands: List[str]):
        self.dog = dog
        self.commands = commands

    def execute(self):
        for command in self.commands:
            if command == 'sit':
                self.dog.sit()
            elif command == 'stay':
                self.dog.stay()

• Dog
  • sit(), stay() 2가지 명령 함수가 존재합니다.
• Dog Command
  • Command를 상속받습니다.
  • __init__: Dog object와 명령어 list인 commands를 인자로 받아 내부에 저장합니다.
  • execute()
    • commands 명령 리스트에서 string 하나씩 추출합니다.
    • string이 'sit'이면 sit() 함수를 실행합니다.
    • string이 'stay'이면 stay() 함수를 실행합니다.

baduk = Dog()
dog_command = DogCommand(baduk, ['stay', 'sit', 'sit'])
dog_command.execute()

• 명령을 들을 Dog object인 baduk 을 생성합니다.
• DogCommand object인 dog_command 생성 후 baduk과 명령어 list에 'stay', 'sit', 'sit'을 넣어서 전달합니다.
• 실행시키면 강아지는 stay를 한 후 2번 sit 실행합니다.

• Command Interface는 Command Class
• Command를 상속받는 Command1은 Dog Command Class,
• Command1의 명령을 받는 Object인 Receiver1은 Dog와 대응됩니다.

여기서 Invoker Class는 구현되지 않았습니다.

 

 

class Invoker:
    def __init__(self):
        self.command_list = []

    def addCommand(self, command: Command):
        self.command_list.append(command)

    def runCommands(self):
        for command in self.command_list:
            command.execute()

 

Invoker 클래스:

• __init__: 명령들을 저장하는 리스트인 command_list가 존재합니다.
• addCommand: Command 객체를 추가하는 함수입니다.
• runCommands: command_list의 모든 command를 execute()를 통해 실행시키는 함수입니다.

 

invoker = Invoker()
invoker.addCommand(first_command)
invoker.addCommand(dog_command)
invoker.addCommand(second_command)
invoker.runCommands()

• Invoker 객체인 invoker를 생성한 후 addCommand를 통해 이전에 생성했던 Command 객체들을 추가합니다.
• runCommands를 통해 실행하면 모든 명령어가 차례대로 실행되는 것을 확인할 수 있습니다.

Command Pattern은 명령을 추상화해서 객체로 다루는 패턴입니다.