Design Patterns - Command

Behavioral Patterns - Command

Intent

---

요청 자체를 캡슐화하는 것이다. 이를 통해 요청이 서로 다른 사용자를 매개변수로 만들고, 요청을 대기시키거나 로깅하여, 되돌릴 수 있는 연산을 지원한다.

작동(Action), 트랜젝션(Transaction) 이라고도 불린다.

Utility

---

수행할 동작을 객체로 매개변수화 하고자 할 때

콜백함수를 구현하여 매개변수화를 표현할 수 있다.

서로다른 시간에 요청을 명시하고, 저장하며, 실행하고 싶을 때

요청을 받아 처리하는 객체가 주소 지정 방식과는 독립적으로 표현될 수 있다면, Command 객체를 다른 프로세스에게 넘겨주고 거기서 해당 처리를 진행 할 수 있다.

실행 취소 기능을 지원하고 싶을 때

Command의 Excute() 연산은 상태를 저장할 수 있는데, 이를 이용해서 지금까지 얻은 결과를 바꿀 수 있다.

실행된 명령어를 모두 기록해 두었다가 이 리스트를 역으로 탐색하여 다시 Command 클래스 내에 정의된 UnExcute() 연산을 통해 수행 취소를 한다.

시스템이 고장 났을 떄 재적용이 가능하도록 변경 과정에 대한 로깅을 지원하고 싶을 떄

Command 인터페이스를 확장하여 Load() 와 Store() 연산을 정의하면 상태의 변화를 지속적(persistent) 저장소에 저장해 둘 수 있다.

시스템 장애가 발생했을떄, 해당 저장소에서 저장된 명령어를 읽어 다시 Excute() 연산을 통해 재실행 하면 된다.

기본적은 연산의 조합으로 만든 상위 수준의 연산을 써서 시스템을 구조화하고 싶을 떄

정보 시스템의 일반적인 특성은 트랜잭션(Transaction) 을 처리해야 한다는 것이다. 트랜잭션은 일련의 과정을 통해 데이터를 변경하는 것이다. Command Pattern은 이런 트랜잭션의 모델링을 가능하게 한다.

Command 클래스는 일관된 인터페이스를 정의하는데, 이로써 모든 트랜잭션이 동일한 방식으로 호출된다.

새로운 트랜잭션을 만들면 상속으로 Command 클래스를 확장하면 되므로 시스템 확장도 어렵지 않게 가능하다.

Structure

---

Basic Structure

Structure Example

Elements

• Command
  • 연산 수행에 필요한 인터페이스를 선언
• ConcreteCommand
  • PasteCommand, OpenCommand 에 해당
  • Receiver 객체와 액션 간의 연결성을 정의
  • 처리 객체에 정의된 연산을 호출하도록 Excute() 연산을 구현
• Client
  • Appilication 에 해당
  • ConcreteCommand 객체를 생성하고 처리 객체로 정의
• Invoker
  • MenuItem 에 해당
  • Command Pattern 에 처리를 수행할 것을 요청
• Receiver
  • Document, Appilication 에 해당
  • 요청에 관련된 연산 수행 방법을 저장
  • 어떤 클래스도 요청 수신자로써 동작 가능

사용자는 ConcreteCommand 객체를 생성하고 이를 수신자로 지정한다.

Invoker 클래스는 ConcreteCommand 객체를 저장한다.

Invoker 클래스는 Command에 정의된 Excute() 를 호출하여 요청을 발생시킨다. 명령어가 취소기능이 가능하다면, ConcreteCommand는 이전에 Excute() 호출 전 상태의 취소 처리를 위해 저장한다.

ConcreteCommand 객체는 요청을 실체 처리할 객체에 정의된 연산을 호출한다.

다음 다이어그램은 협력자 사이의 상호작용을 보여준다.

Command 객체로 요청 발생자(Invoker)가 요청 수신자에서 분리된다.

Feature

---

• Command는 연산을 호출하는 객체와 연산 수행 방법을 구현하는 객체를 분리한다.
• Command는 일급 클래스이다. 다른 객체와 같은 방식으로 조작되고 확장할 수 있다.
• 명령을 여러 개로 복합해서 복합 명령을 만들 수 있다.
  • Composite Pattern으로 요로 명령어를 구성할 수 있다.
• 새로운 Command 객체를 추가하기 쉽다.
  • 기존 클래스를 변경할 필요 없이 단지 새로운 명령어에 대응하는 클래스만 정의하면 된다.

Implementation

---

Implement Example

/**
* @brief Command - Command
* @details 요청을 표현하는 클래스로써 요청 처리에 대한 인터페이스를 정의
*/
class Command{
public:
  virtual ~Command() = default;
  virtual void excute() = 0;

protected:
  Command();
};

/**
* @brief ConcreteCommand - OpenCommand
* @details 요청을 구체화하여 요청 처리에 대한 인터페이스를 구현
*/
class OpenCommand : public : Command {
public:
  OpenCommand(Application* app) : m_app(app) {}

  void excute() override {
    const char* name = askUser();

    if(name != nullptr) {
        Document* doc = new Document(name);
        m_app->add(doc);
        doc->open();
    }
  }

protected:
  virtual const char* askUser();
private:
  Application* m_app = nullptr;
  char* m_response = nullptr;
};

/**
* @brief ConcreteCommand - PasteCommand
* @details 요청을 구체화하여 요청 처리에 대한 인터페이스를 구현
*/
class PasteCommand : public : Command {
public:
  PasteCommand(Document* doc) : m_doc(doc) {}

  void excute() override {
    m_doc->paste();
  }

private:
  Document* m_doc;
};

/**
* @brief ConcreteCommand - SimpleCommand
* @details 처리 객체와 함께 처리 내용의 Callback 함수를 받아 요청을 처리
*/
template<class Receiver>
class SimpleCommand : public : Command {
public:
  typedef void (Receiver::*Action)();

  SimpleCommand(Receiver* r, Action a) : m_recv(r), m_actionCB(a) {}

  void excute() override {
    (m_recv->*m_actionCB)();
  }

private:
  Receiver* m_recv = nullptr;
  Action* m_actionCB = nullptr;
};

/**
* @brief ConcreteCommand - MacroCommand
* @details 여러가지 요청을 일련의 순서대로 실행하는 요청 관리 클래스
*/
class MacroCommand : public : Command {
public:
  MacroCommand(Receiver* r, Action a) : m_recv(r), m_actionCB(a) {}

  virtual void add(Command* cmd) { m_cmds.push(cmd); }
  virtual void remove() { m_cmds.pop(); }

  void excute() override {
    for(const auto& iter : m_cmds){
      iter.excute();
    }
  }

private:
  std::queue<Command*> m_cmds;
};


...

  // 요청에 관련된 연산 수행 방법을 저장한 Reciver 객체 생성
  MyClass* receiver = new MyClass();

  ...

  // 요청을 처리하는 객체와 객체 내의 요청 처리 함수를 통해 요청을 처리
  Command* cmd = new SimpleCommand<MyClass>(Receiver receiver,
                                            &Myclass::Action);
  
  // 요청 처리
  cmd->excute();

  ...

...

Related Pattern

---

---

---

참고. Design Patterns : Elements of Reusable Object-Oriented Software - Erich Gamma

---