디자인 패턴 정리 - Template Method Pattern

12. Template Method Pattern

목적

• 알고리즘의 뼈대를 정의하고 일부를 서브 클래스에 위임한다. 이렇게 함으로서 알고리즘의 구조를 변경하지 않고 알고리즘의
  일부 내용을 서브 클래스에서 재정의 할 수 있도록 한다.
• 많은 방식의 알고리즘을 각각 캡슐화시키면서 중복되는 코드가 여러 클래스에 존재하게 된다. -> 중복 코드의 문제.
• 이를 해결하기 위해 알고리즘의 중복되는 부분을 부모 클래스에 캡슐화시키고 달라지는 부분만 서브클래스에서 구현하게 한다.
• 결과적으로 중복되는 코드를 줄일 수 있고, 한 곳에서 관리하게 되므로 유지 보수에 유리하다.

예

카페 예시

카페에서 커피를 만드는 것과 차를 만드는 과정을 봐보자.

• 물을 끓이고 -> 뜨거운 물에 (차, 커피)를 우려내고 -> (차, 커피)를 (일회용, 다회용)컵에 따르고 -> 커피의 경우 (설탕, 우유, 샷)을 차의 경우 (레몬) 등의 토핑을 추가한다. -> 완성 후 제공한다.

이렇게 음료를 만들고 제공하는 전체적인 알고리즘(구조, 틀)은 동일하면서 커피 or 티에 따라 내용이 달라지거나 공통으로 적용되는
부분들이 존재한다.  따라서 해당 부분들은 전부 하나의 부모 클래스에서 구현하고 달라지는 부분만 각자의 서브 클래스에서 구현하게 할 수 있다.

 

정렬 예시

이름과 나이 정보가 있는 사람들에 대해서 정렬한다고 해보자. 이때 선택사항으로는 이름 or 나이로 정렬할 수 있다. 정렬 시 버블 정렬을 한다면 정렬 알고리즘의 방식은 동일하지만 비교하는 부분만 다르다. 따라서 각 서브 클래스에서 맞는 비교를 구현하게 하고 정렬을
하는 과정은 부모 클래스에서 구현하게 하여 코드의 중복은 줄이면서 한곳에서 관리하게 할 수 있다.

카페 예제 코드

• 커피와 차 중에서 고르게 한다.
• CafeBeverageMaker abstract 클래스를 만들고 여기서 알고리즘을 관리한다.
  • coffee, tea 클래는 추상 클래스를 상속받아서 구현한다.
• CafeBeverageMaker에 정의 된 음료 제조 알고리즘을 따르면서 각 음료에 맞게 재정의하는 구조이다.

Main.class 링크

public class Main {
    public static void main(String[] args) throws IOException {
        CafeBeverageMaker cafe;
        System.out.println("Hi~ 여기는 woonsik Cafe 입니다!\n");

        BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
        System.out.println("메뉴를 골라주세요. (coffee, tea)");
        String s = br.readLine();
        if (s.equals("coffee")) {
            System.out.println("[커피 주문 시작]");
            cafe = new Coffee();
            cafe.prepareBeverage();
        } else if (s.equals("tea")) {
            System.out.println("[티 주문 시작]");
            cafe = new Tea();
            cafe.prepareBeverage();
        } else {
            System.out.println("없는 메뉴입니다.");
        }
    }
}

CafeBeverageMaker abstract class 링크

• 공통으로 필요로 하는 부분은 여기서 통합 관리한다.
• 각 부분에 맞게 재정의가 필요한 부분은 abstract 메소드로 선언한다.

public abstract class CafeBeverageMaker {
    public final void prepareBeverage() {
        boilWater();
        brew();
        if (takeIn()) {
            pourInTakeOutCup();
        } else {
            pourInCup();
        }
        if (customTopping())
            addTopping();
        finish();
    }

    public abstract void brew();

    public abstract boolean customTopping();

    public abstract void addTopping();

    public void lemon() {
        System.out.println("레몬을 추가할까요?");
    }

    public void milk() {
        System.out.println("우유를 추가할까요?");
    }

    public void sugar() {
        System.out.println("설탕을 추가할까요?");
    }

    public void shot() {
        System.out.println("샷을 추가할까요?");
    }

    public void boilWater() {
        System.out.println("물을 끓입니다.");
    }

    public boolean takeIn() {
        System.out.println("테이크 아웃입니까? (y/n)");
        BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
        try {
            return br.readLine().equals("y");
        } catch (IOException e) {
            e.printStackTrace();
        }
        return true;
    }

    public void pourInCup() {
        System.out.println("유리컵에 음료를 따릅니다.");
    }

    public void pourInTakeOutCup() {
        System.out.println("일회용컵에 음료를 따릅니다.");
    }

    public void finish() {
        System.out.println("음료가 준비되었습니다. 맛있게 드세요 :)");
    }

    public String input() {
        BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
        try {
            return br.readLine().substring(0, 1);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return "n";
    }
}

Coffee.class 링크

public class Coffee extends CafeBeverageMaker {

    @Override
    public void brew() {
        System.out.println("커피원두를 우려냅니다.");
    }

    @Override
    public boolean customTopping() {
        System.out.println("추가 옵션을 선택하시겠습니까?");
        return input().equals("y");
    }

    @Override
    public void addTopping() {
        milk();
        if (input().equals("y")) System.out.println("우유 추가...");
        sugar();
        if (input().equals("y")) System.out.println("설탕 추가...");
        shot();
        if (input().equals("y")) System.out.println("샷 추가...");
    }
}

Tea.class 링크

public class Tea extends CafeBeverageMaker {
    @Override
    public void brew() {
        System.out.println("1: 우롱티 2: 보리티 3: 녹차티 4: 보스니아티 5: 티티");
        switch (Integer.parseInt(input())) {
            case 1:
                System.out.println("우롱티를 우립니다.");
                break;
            case 2:
                System.out.println("보리티를 우립니다.");
                break;
            case 3:
                System.out.println("녹차티를 우립니다.");
                break;
            case 4:
                System.out.println("보스니아티를 우립니다.");
                break;
            case 5:
                System.out.println("TT ~ TT");
                break;
            default:
                System.out.println("메뉴에 없는 주문입니다. 탈락~ 빵!");
        }
    }

    @Override
    public boolean customTopping() {
        System.out.println("추가 옵션을 선택하시겠습니까?");
        return input().equals("y");
    }

    @Override
    public void addTopping() {
        lemon();
        if (input().equals("y")) System.out.println("레몬을 올립니다...");
    }
}

이렇게 티와 커피를 같은 부분은 재사용하고 다른 부분은 재정의해서 동일한 알고리즘으로 음료를 제조할 수 있다.

---

이름/나이 정렬 예제 코드

• 이름과 나이가 다른 사람을 나이 or 이름으로 정렬할 때 알고리즘의 동일한 틀은 유지하면서 비교 부분만 재정의할 수 있다.

Main.class

public class MainTest {
  public static void main(String[] args) {
      Person[] people = {
          new Person(1002, "Bapple"),
          new Person(1001, "People"),
          new Person(1000, "Apple"),
          new Person(3000, "Dooly"),
          new Person(30, "Ddochi"),
          new Person(25, "Michol"),
          new Person(20000, "Douner"),
          new Person(3, "HeeDong")
      };
      System.out.println("\noriginal people");
      for (Person p : people) {
          System.out.println(p);
      }

      System.out.println("\nsort by Name");
      Sorter sorter = new NameSorter();
      sorter.bubbleSort(people);
      for (Person p : people) {
          System.out.println(p);
      }

      System.out.println("\nsort by Age");
      Sorter sorter2 = new AgeSorter();
      sorter2.bubbleSort(people);
      for (Person p : people) {
          System.out.println(p);
      }
  }
}

 

 

Sorter interface

public interface Sorter {
    int compare(Object i, Object j);

    default void bubbleSort(Object[] obj) {
        for (int i = 0; i < obj.length - 1; i++) {
            for (int j = i + 1; j < obj.length; j++) {
                if (compare(obj[i], obj[j]) < 0) { // 재정의가 필요한 부분
                    Object tmp = obj[i];
                    obj[i] = obj[j];
                    obj[j] = tmp;
                }
            }
        }
    }
}

AgeSorter.class implements Sorter

public class AgeSorter implements Sorter {
    @Override
    public int compare(Object i, Object j) {
        return ((Person)j).getAge() - ((Person)i).getAge();
    }
}

NameSorter.class implements Sorter

public class NameSorter implements Sorter {
    @Override
    public int compare(Object i, Object j) {
        return ((Person)j).getName().compareTo(((Person)i).getName());
    }
}

 

다이어그램

[커피 예제 다이어그램]

[정렬 예제 다이어그램]

설명

공통 알고리즘 부분은 부모 클래스에 두고 다르게 정의가 필요한 부분만 하위 클래스에서 재정의해서 사용한다. 큰틀은
상위 클래스에서 잡으므로 서브 클래스에서 재정의하더라도 그걸 사용할지 말지는 상위 클래스에게 달려있다.
상위 클래스에서 공통 부분을 통합 관리하므로 코드의 중복도 사라졌고, 역활에 맞는 부분만 정의되어서 코드 유지 관리에도 용이해졌다.

결과

[커피]

[정렬]

 

---

Q. 전략패턴과 템플릿 메소드 패턴의 차이는 무엇일까?

A. 어찌보면 상황에 따라 알고리즘을 변경하는 부분을 서브 클래스에 맡긴다는 측면에서 비슷할 수 있다. 하지만 서브 클래스에 맡기는 부분에서 규모의 차이가 있다.

템플릿 메소드 패턴은 상속을 이용해서 알고리즘의 일부분만 서브 클래스에 맡기고 최대한 공통 부분은 템플릿, 즉 구조로 가져가는 것이다. 최대한 동일한 구조를 재사용하면서 다른 특정 부분만 서브클래스가 상속받아 재정의한다는 특징이 있다.

스트래지 패턴은 템플릿 방식과 다르게 구현부분이 다른 알고리즘 마다, 즉 이름별로 정렬, 나이별로 정렬, 날짜별로 정렬 등등 알고리즘이 별도로 존재한다면 각 알고리즘을 캡슐화하여 생성한 후 필요한 알고리즘을 불러서 사용하는 방식이다.