[디자인패턴] 10. 데커레이터 패턴 ( Decorator Pattern )

01 Apr 2020

디자인패턴

1. 데커레이터 패턴이란?

데커레이터 패턴은 기본 기능에 추가할 수 있는 기능의 종류가 많은 경우에 각 추가 기능을 Decorator 클래스로 정의한 후 필요한 Decorator 객체를 조합함으로써 추가 기능의 조합을 설계하는 방식이다.

예를 들어 기본 도로 표시기능에 차선표시, 교통량 표시, 교차로 표시, 단속 카메라 표시의 4가지 추가 기능이 있을 때 추가 기능의 모든 조합은 15가지나 된다. 데커레이터 패턴을 사용하면 개별 추가 기능에 해당하는 Decorator 클래스 4개만 구현하고, 개별 추가 기능을 객체의 형태로 조합함으로써 추가 기능의 조합을 구현할 수 있다.

또한 프로그램을 실행하는 중에도 Decorator 객체의 조합이 가능하므로 필요한 추가 기능의 조합을 동적으로 생성하는 것도 가능하다.

아래는 데커레이터 패턴의 콜라보레이션과 역할이 수행하는 작업에 대한 설명이다.

decorator-pattern-collaboration

Component : 기본 기능을 뜻하는 ConcreteComponent와 추가 기능을 뜻하는 Decorator의 공통 기능을 정의한다. 클라이언트는 Component를 통해 실제 객체를 사용
ConcreteComponent : 기본 기능을 구현하는 클래스
Decorator : 많은 수가 존재하는 구체적인 Decorator의 공통 기능을 제공
ConcreteDecoratorA, ConcreteDecoratorB : Decorator의 하위 클래스로 기본 기능에 추가되는 개별적인 기능을 뜻함

아래는 데커레이터 패턴의 순차 다이어그램과 그에 대한 설명이다.

decorator-pattern-sequence-diagram

ConcreteComponent가 정의 되있고, ConcreteDecoratorA의 객체와 이에 대한 데커레이터로 ConcreteDecoratorB의 객체가 있다고 가정해보자. 즉, 다음과 같이 객체가 생성된 경우이다.

Component c = new ConcreteComponent();
Component a = new ConcreteComponentA(c);
Component b = new ConcreteComponentB(a);

Client가 객체 b의 operation() 메서드를 호출하면 객체 b가 가리키는 Component, 즉 ConcreteDecoratorA 객체 a의 operation() 메서드를 호출한다.
객체 a 역시 자신이 가리키는 Component, 즉 ConcreteComponent 객체 c의 operation() 메서드를 호출한 후 자신의 addedBehavior() 메서드를 호출한다.
객체 b 역시 객체 a의 operation() 메서드를 호출한 후 자신의 addedBehavior() 메서드를 호출한다.

이와 같은 순서는 addedBehavior()메서드가 자신의 Component 동작 후에 호출되는 경우를 보여주는데 데커레이터 패턴에서는 자신의 addedBehavior() 메서드를 먼저 호출한 후 Component의 operation()메서드를 호출하는 방식으로 구현할 수 있다.

이렇게 설명한 것으로는 감이 오지 않기 때문에 아래의 예제를 통해 데커레이터 패턴을 왜, 어떻게 적용하는지 알아보자.

2. 데커레이터 패턴 예제 : 도로 표시 방법 조합하기

2.1 도로표시 방법 구현

네비게이션을 생각해보면 보통 일반적으로 도로를 간단한 선으로 표시하고, 추가적으로 도로의 차선을 표시하는 기능을 추가로 선택해서 제공하고 있다. 이러한 기능을 직접 구현해보면 아래와 같이 클래스 다이어그램을 작성할 수 있다.

decorator-pattern-road-class-diagram

아래는 위의 클래스 다이어그램을 실제 코드로 구현한 것이다.

public class RoadDisplay {

    public void draw() {
        System.out.println("기본 도로 표시");
    }

}

public class RoadDisplayWithLane extends RoadDisplay {

    @Override
    public void draw() {
        super.draw();
        drawLane();
    }

    private void drawLane() {
        System.out.println("차선 표시");
    }
}

public class Client {

    public static void main(String[] args) {

        RoadDisplay road = new RoadDisplay();
        road.draw();    // 기본 도로 표시

        RoadDisplay roadWithLane = new RoadDisplayWithLane();
        roadWithLane.draw();    // 기본도로 + 차선 표시

    }

}

RoadDisplay 클래스에는 기본 도로 표시 기능을 실행하기 위한 draw()메서드를 구현한다. RoadDisplayWithLane 클래스는 기본 도로 표시뿐만아니라 차선을 표시하려고 상속받은 draw()메서드를 오버라이드한다.

다시 정리해보면 RoadDisplayWithLane 클래스에서 기본 도로 표시 기능은 상위 클래스, 즉 RoadDisplay 클래스의 draw() 메서드를 호출함으로써 구현하고, 차선을 표시하는 추가 기능은 drawLane()메서드를 호출함으로써 구현한다.

2.2 문제점

위와 같이 코드를 작성하게 되면 추후에 발생하게 되는 문제들은 무엇이 있는지 알아보자.

또다른 도로 표시 기능을 추가로 구현하고 싶다면 어떻게 해야할까? 예를 들면 기본 도로 표시에 교통량을 표시하고 싶을 경우
여러 가지 추가 기능을 조합해 제공하고 싶다면 어떻게 해야할까? 예를 들면 기본 도로 표시에 차선 표시 기능과 교통량 표시 기능을 함께 제공하고 싶을 경우

2.2.1 또 다른 도로 표시기능이 추가로 구현한 경우

위의 코드와 같이 새로운 도로 표시기능(교통량 표시)을 추가하는 방법은 RoadDisplayWithTraffic 클래스에 RoadDisplay 클래스를 상속받아 정의할 수 있는데 아래는 RoadDisplayWithTraffic 클래스를 추가한 클래스 다이어그램과 다이어그램을 바탕으로 작성된 코드이다.

decorator-pattern-roard-class-diagram2

public class RoadDisplayWithTraffic extends RoadDisplay {

    @Override
    public void draw() {
        super.draw();
        drawTraffic();
    }

    private void drawTraffic() {
        System.out.println("교통량 표시");
    }
}

2.2.2 여러가지 추가 기능을 조합해야하는 경우

RoadDisplay 클래스의 하위 클래스로 도로 표시에 기능을 추가하는 것은 적절한 설계 방법이 될 수 있다. 그러나 다양한 기능의 조합을 고려해야할 경우 상속을 통한 기능의 확장은 각 기능별로 클래스를 추가해야한다는 단점이 존재한다.

도로 표시를 하는 기본 기능에 추가로 제공할 수 있는 차선, 교통량, 교차로를 표시한다고 가정할 때 아래와 같은 8가지 조합이 가능하다.

경우	기본기능	추가기능1 : 차선	추가기능2 : 교통량	추가기능3 : 교차로	클래스 이름
1	O	X	X	X	RoadDisplay
2	O	O	X	X	RoadDisplayWithLane
3	O	X	O	X	RoadDisplayWithTraffic
4	O	X	X	O	RoadDisplayWithCrossing
5	O	O	O	X	RoadDisplayWithLaneTraffic
6	O	O	X	O	RoadDisplayWithLaneCrossing
7	O	X	O	O	RoadDisplayWithTrafficCrossing
8	O	O	O	O	RoadDisplayWithLaneTrafficCrossing

위와 같이 상속을 통해 조합의 각 경우를 설계한다면 각 조합별로 하위 클래스를 아래의 클래스 다이어그램처럼 구현해야한다.

decorator-pattern-road-class-diagram3

2.3 데커레이터 패턴을 통한 해결책

앞에서 상속을 이용한 기능 추가 방법을 소개했는데 이 방법은 추가되는 기능의 조합별로 하위 클래스를 구현해야하는 문제가 발생한다. 이렇게 조합 수가 늘어나는 문제를 해결하려면 각 추가 기능별로 개별 클래스를 설계하고 기능을 조합할 때 각 클래스의 객체 조합을 이용하면 된다.

아래의 클래스 다이어그램은 기본 기능인 RoadDisplay 클래스에 차선을 표시하는 기능을 추가하기 위한 LaneDecorator 클래스와 교통량을 표시하는 기능을 추가하기 위한 TrafficDecorator 클래스를 이용한 설계이다.

decorator-pattern-road-class-diagram4

기본 기능만을 이용할 때는 RoadDisplay 클래스의 객체를 생성하면 충분하지만 차선을 표시하는 기능을 추가적으로 필요하다면 LaneDecorator클래스의 객체가 필요하다. 이때 LaneDecorator에서는 차선표시 기능만 직접 제공하고 도로 표시 기능은 RoadDisplay 클래스의 draw()메서드를 호출하는 방식으로 구현한다.

LaneDecorator 클래스는 RoadDisplay 객체에 대한 참조가 필요한데, 이는 LaneDecorator 클래스의 상위 클래스인 DisplayDecorator 클래스에서 Display 클래스로의 컴포지션 관계를 통해 표현되고 있다.

위와 같은 방식으로 설계한 코드는 아래와 같다.

// 출력, 표시 추상 클래스
public abstract class Display {

    public abstract void draw();

}

// 기본 도로 표시 클래스 : 출력 클래스 상속
public class RoadDisplay extends Display {

    @Override
    public void draw() {
        System.out.println("기본도로 표시");
    }

}

// 다양한 추가 기능에 대한 공통 추상 클래스
public abstract class DisplayDecorator extends Display {

    private Display decoratedDisplay;   // 출력 클래스 참조 변수

    //생성자
    public DisplayDecorator(Display decoratedDisplay) {
        this.decoratedDisplay = decoratedDisplay;
    }

    // 출력 메서드 오버라이드
    @Override
    public void draw() {
        decoratedDisplay.draw();
    }

}

// 차선 표시를 추가하는 클래스 : 다양한 추가 기능에 대한 공통 클래스 상속
public class LaneDecorator extends DisplayDecorator {

    // 생성자
    public LaneDecorator(Display decoratedDisplay) {
        super(decoratedDisplay);
    }

    // 출력 메서드 오버라이드
    @Override
    public void draw() {
        super.draw();
        drawLane();
    }

    // 차선 표시 메서드
    private void drawLane() {
        System.out.println("\t차선 표시");
    }

}

// 교통량 표시를 추가하는 클래스 : 추가 기능에 대한 공통 클래스 상속
public class TrafficDecorator extends DisplayDecorator {

    // 생성자
    public TrafficDecorator(Display decoratedDisplay) {
        super(decoratedDisplay);
    }

    // 출력 메서드 오버라이드
    @Override
    public void draw() {
        super.draw();
        drawTraffic();
    }

    // 교통량 표시 메서드
    private void drawTraffic() {
        System.out.println("\t교통량 표시");
    }

}

public class Client {
    public static void main(String[] args) {
        Display road = new RoadDisplay();
        road.draw(); // 기본도로 표시

        Display roadWithLane = new LaneDecorator(new RoadDisplay());
        roadWithLane.draw(); // 기본도로 + 차선 표시

        Display roadWithTraffic = new TrafficDecorator(new RoadDisplay());
        roadWithTraffic.draw(); // 기본 도로 + 교통량 표시
    }
}

기본도로 표시
기본도로 표시
	차선 표시
기본도로 표시
	교통량 표시

원하는 결과대로 도로 표시 조합이 이루어졌다. 도로를 표시하는 기능만 필요하다면 RoadDisplay 객체만을 이용하면 되고, 차선 표시 기능까지 필요하다면 RoadDisplay, LaneDecorator 객체를 이용하면 된다. 그리고 교통량 표시 기능이 필요하다면 RoadDisplay, TrafficDecorator객체를 함께 이용하면 된다.

위의 Client 코드에서 주목해서 봐야할 점은 road, roadWithLane, roadWithTraffic 객체의 접근이 모두 Display 클래스를 통해 이루진다는 점이다. 기본도로, 차선, 교통량의 조합에 관계 없이 Client 클래스는 동일한 Display 클래스만을 통해 일관성있는 방식으로 도로 정보를 표시할 수 있게 되었다.

roadWithLane 객체에 draw() 메서드가 호출되면 먼저 RoadDisplay 객체의 draw() 메서드를 호출하고, LaneDecorator 객체의 drawLane() 메서드를 호출한다. 이 과정을 순차 다이어그램으로 나타내면 아래와 같다.

decorator-pattern-road-sequence-diagram

roadWithLane 객체의 draw() 메서드는 먼저 RoadDisplay 클래스의 draw() 메서드를 호출해야 한다. 이는 LaneDecorator 클래스의 상위 클래스인 DisplayDecorator 클래스의 draw() 메서드를 호출해 DisplayDecorator 클래스를 가리키는 decoratedDisplay 객체를 호출함으로써 실행된다. 그런 다음 LaneDecorator 클래스의 drawLane() 메서드를 호출하면 추가 기능인 차선을 표시할 수 있게 된다.

이러한 방식의 설계를 이용하면 추가 기능 조합별로 별도의 클래스를 구현하는 대신 추가 기능에 해당하는 클래스의 객체를 조합해 추가 기능의 조합을 구현할 수 있게 된다. 예를 들어 기본 도로 표시 기능에 차선, 교통량도 함께 표시하고 싶다면 코드를 아래와 같이 작성하면 된다.

public class Client2 {
    public static void main(String[] args) {
        Display roadWithLaneAndTraffic = new TrafficDecorator(new LaneDecorator(new RoadDisplay()));
        roadWithLaneAndTraffic.draw();
    }
}

기본도로 표시
	차선 표시
	교통량 표시

RoadDisplay 클래스의 생성자를 기본으로 두고, LaneDecorator 클래스와 TrafficDecorator 클래스의 생성자를 사용하도록 하면 위와 같이 원하는 결과를 출력할 수 있다.

이러한 설계는 추가 기능의 수가 많을수록 효과가 크다. 예를 들어 교차로를 표시하는 추가 기능을 지원하면서 기존의 다른 추가 기능과의 조합을 지원하려면 아래의 클래스 다이어그램처럼 CrossingDecorator 클래스를 추가하기만 하면된다.

decorator-pattern-road-class-diagram5

위의 클래스 다이어그램처럼 CrossingDecorator 클래스의 코드를 작성하면 아래와 같다.

public class CrossingDecorator extends DisplayDecorator {
    
    // 기존의 도로 표시 클래스 설정
    public CrossingDecorator(Display decoratedDisplay) {
        super(decoratedDisplay);
    }

    @Override
    public void draw() {
        super.draw();   // 설정된 기존의 표시 기능을 실행
        drawCrossing(); // 추가적으로 교차로를 표시
    }

    private void drawCrossing() {
        System.out.println("\t교차로 표시");
    }
    
}

draw() 메서드가 호출되면 drawCrossing() 메서드를 호출해 교차로를 표시하기 전 상위 클래스, 즉 DisplayDecorator 클래스의 draw()메서드를 호출한다. 그러면 decoratedDisplay 객체가 가리키는 draw() 메서드를 호출하게 된다.

public class Client3 {
    public static void main(String[] args) {
        Display roadWithCrossingAndLaneAndTraffic = new LaneDecorator(new TrafficDecorator(new CrossingDecorator(new RoadDisplay())));
        roadWithCrossingAndLaneAndTraffic.draw();
    }
}

기본도로, 교차로, 교통량, 차선을 차례로 표시하는 객체의 코드는 위와 같이 작성할 수 있고, 아래와 같이 원하는 결과를 출력할 수 있다.

기본도로 표시
	교차로 표시
	교통량 표시
	차선 표시

위의 예제를 데커레이터 패턴에 적용하여 각 요소를 정리해보면 아래와 같다.

Display : Component
RoadDisplay : ConcreteComponent
DisplayDecorator : Decorator
LaneDecorator, TrafficDecorator, CrossingDecorator : ConcreteDecorator