[Java] 메뉴 항목을 Stack 으로 관리하기 (feat.팩토리 메소드)

• 이전 글에 이어서 메뉴를 Stack 으로 관리하도록 수정해 본다.
• 팩토리메소드를 적용해 객체 생성에 관한 코드를 숨기고, 좀 더 의미있는 이름의 메소드를 제공한다.

Stack 구현

어디에 저장하느냐가 아니라 어떻게 가져올 것인가에 초점을 맞춰서 진행하므로, 기존에 만들었던 링크드리스트를 이용해 Stack 을 간단히 구현한다. 배열을 이용해 구현해도 상관없다.

public class Stack<E> extends LinkedList<E> {

  public E push(E value) {
    add(value);
    return value;
  }

  public E pop() {
    return remove(size() - 1);
  }

  public E peek() {
    return get(size() - 1);
  }

  public boolean empty() {
    return size() == 0;
  }
}

스택의 기본적인 특징은 후입선출(Last-In First-Out)이다. 이와 같은 특징은 웹브라우저 탐색 시 뒤로가기나 되돌리기(ctrl + z)와 같은 기능을 구현할 때 용이하다. Stack 에 넣을때는 순차적으로 들어가고 Stack 에서 빠져나올때는 가장 최근 작업부터 역순으로 빠져나온다.

이를 메뉴 진입 시 보여주는 Prompt 에 적용해 보자. 메뉴를 진입할때 순차적으로 나타내고, 또 이전으로 돌아갈때는 그 역순으로 보여준다.

As-is

  [메인]
  1. 과제
  2. 게시글
  3. 회원
  4. 가입인사
  5. 도움말
  0. 이전
  메인> 1
  
  [과제]
  1. 등록
  2. 조회
  3. 변경
  4. 삭제
  5. 목록
  0. 이전
  과제>        <---- 이 부분을 Stack 으로 관리한다.

메인 메뉴에서 하위 메뉴로 진입 시 입력 창에 현재 어디까지 진입했는지 표시가 되지 않고 있다. MenuGroup 생성자에서 title 을 받아 그대로 출력만 해주고 있기 때문이다.

MenuGroup

public class MenuGroup extends AbstractMenu {

  // 생성자에서 title 받음
  public MenuGroup(String title) {
    super(title);
  }

  @Override
  public void execute(Prompt prompt) {
    this.printMenu();

    while (true) {  // title 사용
      String input = prompt.input("%s> ", this.getTitle()); 

          ...
    }
  }
}

App

public class App {
  public static void main(String[] args) throws Exception {
    Prompt prompt = new Prompt(System.in);

    ArrayList<Board> boardRepository = new ArrayList<>();
    ArrayList<Assignment> assignmentRepository = new ArrayList<>();
    ArrayList<Member> memberRepository = new ArrayList<>();
    ArrayList<Board> greetingRepository = new ArrayList<>();

    MenuGroup mainMenu = new MenuGroup("메인");

    MenuGroup boardMenu = new MenuGroup("게시글");
    boardMenu.add(new MenuItem("등록", new BoardAddHandler(boardRepository, prompt)));
    boardMenu.add(new MenuItem("조회", new BoardViewHandler(boardRepository, prompt)));
    boardMenu.add(new MenuItem("변경", new BoardModifyHandler(boardRepository, prompt)));
    boardMenu.add(new MenuItem("삭제", new BoardDeleteHandler(boardRepository, prompt)));
    boardMenu.add(new MenuItem("목록", new BoardListHandler(boardRepository, prompt)));
    mainMenu.add(boardMenu);
    
        ....
  }
}

App클래스에서 직접 객체를 생성하는 코드가 많이 포함되어 있다. 왜 객체를 생성해야 하는지 불분명하고 굳이 알 필요도 없다. 코드의 가독성이 떨어지고 복잡해 보인다.

To-be

MenuGroup

public class MenuGroup extends AbstractMenu {
      ...
  
  // 생성자에서 Stack 을 받는다.
  private MenuGroup(String title, Stack<String> breadcrumb) {
    super(title, breadcrumb);
  }

  // 팩토리 메서드를 이용해 인스턴스를 반환한다.
  public static MenuGroup getInstance(String title) {
    return new MenuGroup(title, new Stack<>());
  }

  @Override
  public void execute(Prompt prompt) {
    // 메뉴를 실행할 때 메뉴의 제목을 breadcrumb 에 추가한다.
    breadcrumb.push(title);
    this.printMenu();

    while (true) {
      String input = prompt.input("%s> ", this.getMenuPath());

      if (input.equals("menu")) {
        this.printMenu();
        continue;
      } else if (input.equals("0")) {
        break;
      }

      try {
        int menuNo = Integer.parseInt(input);
        if (menuNo < 1 || menuNo > menus.size()) {
          System.out.println("메뉴 번호가 옳지 않습니다.");
          continue;
        }

        this.menus.get(menuNo - 1).execute(prompt);  // 실행할때마다 Stack 에 push 된다.
      } catch (Exception e) {
        System.out.println("메뉴가 옳지 않습니다");
      }
    }

    breadcrumb.pop(); // 메뉴 나갈때 메뉴 제목을 제거한다.
  }
  
  // App 에 좀더 직관적인 코드를 제공하기 위한 편의성 메소드
  public MenuItem addItem(String title, MenuHandler handler) {
    MenuItem menuItem = new MenuItem(title, handler, breadcrumb);
    add(menuItem);
    return menuItem;
  }

  // App 에 좀더 직관적인 코드를 제공하기 위한 편의성 메소드
  public MenuGroup addGroup(String title) {
    MenuGroup menuGroup = new MenuGroup(title, breadcrumb);
    add(menuGroup);
    return menuGroup;
  }
}

App에서 MenuGroup을 호출할때 Stack 을 만들어 AbstractMenu로 전달해 준다. 객체 생성에 대한 코드는 팩토리 메소드를 이용한다.

생성자를 직접 호출하기 보다 의미있는 이름 을 가진 팩토리 메소드를 통해 반환하도록 하는것이 코드 가독성에 좋다. 또한 생성자를 private로 설정해 팩토리 메소드에서만 객체 생성이 가능하도록 할 수 있다.

App클래스에서 아래와같이 getInstance를 호출하면서 “메인” 이라는 메뉴 제목을 생성자로 주입한다. 이때 Stack 객체도 함께 만들어 주입해준다.

  MenuGroup mainMenu = MenuGroup.getInstance("메인");

메뉴 입력을 받는 excute가 최초 호출되면 위 코드에서 생성자로 받아서 필드로 가지고 있던 메뉴 title 을 Stack 에 넣는다. 현재 Stack 에는 “메인”이 들어가 있는 상태가 된다.

  int menuNo = Integer.parseInt(input);
  this.menus.get(menuNo - 1).execute(prompt);

이후 입력한 메뉴 번호에 따른 title 이 계속해서 Stack 에 push 된다. breadcrumb 은 getMenuPath()에서 만들어진다.

  // Stack 에서 메뉴목록을 가져와 조립한다.
  public String getMenuPath() {
    return String.join("/", breadcrumb.toArray(new String[0]));
  }

menus 목록은 App 클래스에서 addItem과 addGroup이 호출될 때마다 저장된다.

  MenuGroup mainMenu = MenuGroup.getInstance("메인");

  MenuGroup boardMenu = mainMenu.addGroup("게시글");
  boardMenu.addItem("등록", new BoardAddHandler(boardRepository, prompt));
  boardMenu.addItem("조회", new BoardViewHandler(boardRepository, prompt));
  boardMenu.addItem("변경", new BoardModifyHandler(boardRepository, prompt));
  boardMenu.addItem("삭제", new BoardDeleteHandler(boardRepository, prompt));
  boardMenu.addItem("목록", new BoardListHandler(boardRepository, prompt));

App

public class App {

  public static void main(String[] args) throws Exception {
    Prompt prompt = new Prompt(System.in);

    List<Board> boardRepository = new LinkedList<>();
    List<Assignment> assignmentRepository = new LinkedList<>();
    List<Member> memberRepository = new ArrayList<>();
    List<Board> greetingRepository = new ArrayList<>();

    MenuGroup mainMenu = MenuGroup.getInstance("메인");
    
    MenuGroup boardMenu = mainMenu.addGroup("게시글");
    boardMenu.addItem("등록", new BoardAddHandler(boardRepository, prompt));
    boardMenu.addItem("조회", new BoardViewHandler(boardRepository, prompt));
    boardMenu.addItem("변경", new BoardModifyHandler(boardRepository, prompt));
    boardMenu.addItem("삭제", new BoardDeleteHandler(boardRepository, prompt));
    boardMenu.addItem("목록", new BoardListHandler(boardRepository, prompt));

    MenuGroup memberMenu = mainMenu.addGroup("회원");
    memberMenu.addItem("등록", new MemberAddHandler(memberRepository, prompt));
    memberMenu.addItem("조회", new MemberViewHandler(memberRepository, prompt));
    memberMenu.addItem("변경", new MemberModifyHandler(memberRepository, prompt));
    memberMenu.addItem("삭제", new MemberDeleteHandler(memberRepository, prompt));
    memberMenu.addItem("목록", new MemberListHandler(memberRepository, prompt));

    MenuGroup greetingMenu = mainMenu.addGroup("가입인사");
    greetingMenu.addItem("등록", new BoardAddHandler(greetingRepository, prompt));
    greetingMenu.addItem("조회", new BoardViewHandler(greetingRepository, prompt));
    greetingMenu.addItem("변경", new BoardModifyHandler(greetingRepository, prompt));
    greetingMenu.addItem("삭제", new BoardDeleteHandler(greetingRepository, prompt));
    greetingMenu.addItem("목록", new BoardListHandler(greetingRepository, prompt));

    mainMenu.addItem("도움말", new HelpHandler(prompt));

    // jvm 까지 오류보고 안가게 막기
    while (true) {
      try {
        mainMenu.execute(prompt);
        prompt.close();
        break;
      } catch (Exception e) {
        System.out.println("main() 예외 발생");
      }
    }

엔트리포인트가 되는 App 클래스에서의 코드가 좀 더 직관적이고 의미를 알아볼 수 있는 메소드들로 변했다.

소스코드

https://bit.ly/48Abpgy