안녕하세요. N` 입니당.


이번 포스팅 에서는 드디어 길고 길었던 "패턴이야기"의 마지막을 장식합니다.


마지막으로 다루는 패턴은 "컴파운드 패턴 (Compound Pattern)" 으로, 이 패턴은 여태까지 배웠던 패턴들의 종합이라 볼 수 있습니다.

 

컴파운드 패턴은 


일반적으로 자주 생길 수 있는 문제를 해결하기 위한 용도로, 

2개 이상의 패턴을 결합해서 사용하는 것


의미합니다.


즉, 이 패턴의 사용한다는 것은 여태까지 배웠던 여러 패턴들을 결합해서 특정 문제를 해결하는 것을 의미하며, 대표적으로 꽤 유명한 패턴 중 하나인 MVC(Model-View-Controller) 패턴은 이러한 컴파운드 패턴에 속합니다.


오늘 리뷰는 요구사항을 살펴보며 그에 따라 여러 패턴을 사용하게 되는 예제와 함께 MVC 패턴 내부의 컴파운드 원리를 간략하게 알아보려 합니다.

(사용하는 예제 및 자료는 제게 OOP 를 가르쳐 주셨던 한국기술교육대 김상진 교수님의 자료를 참고하였습니다.)



1. 오리꽥꽥 시뮬레이터!


요구사항은 간단합니다.

여러가지 특징을 가진 오리들을 제작하고, 오리들이 꽥꽥하며 우는 시뮬레이터 하는 것이죠.


여러 오리를 제작하기 위해, 첫 번째로 설계한 UML 은 아래와 같습니다. (코드 대신 UML 로 대치...)

 

 

 

이 UML 에 따라 제작된 클래스를 시뮬레이션 하는 프로그램을 저는 다음과 같이 제작하였습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/**
 * 오리 시뮬레이터 정의.
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class DuckSimulator {
 
    /**
     * 테스트 클래스 제작.
     *
     * @param args
     */
    public static void main(String[] args) {
        DuckSimulator duckSimulator = new DuckSimulator();
        duckSimulator.simulate();
    }
 
    /**
     * 시뮬레이터 작성.
     *
     * <pre>
     *     이 곳에 비지니스 시뮬레이션 기능을 넣을 것!
     * </pre>
     */
    public void simulate(){
        Duck rubberDuck = new RubberDuck();
        simulate(rubberDuck);
    }
 
    /**
     * 오리를 넣어 시뮬레이션.
     *
     * @param duck
     */
    private void simulate(Duck duck){
        duck.quack();
    }
}
 
// CONSOLE RESULT
// 삐이익~~ 
cs



2. 오리가 아닌 다른 동물을 테스트!


테스트 클래스는 현재 잘 작동하고 있습니다만, 오리와 비슷한 성격을 가진 거위 클래스를 이 테스트에 포함하고 싶습니다.


거위 클래스 명세는 다음과 같습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
/**
 * 거위 클래스
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class Goose {
 
    /**
     * 거위의 울음.
     */
    public void honk() {
        System.out.println("Honk");
    }
}
cs



해당 테스트 클래스에서 거위를 사용하려면, 오리와 호환을 맞춰야할 것으로 보입니다. 

좋은 방법이 있을까요? 여러분은 알고 있을 것이라 생각합니다. 


아래 패턴을 기억해 보죠.



제작한 거위 어댑터는 아래와 같습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/**
 * 거위를 오리로 호환시켜주는 클래스
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class GooseAdapter extends Duck {
 
    private Goose goose;
 
    public GooseAdapter(Goose goose) {
        this.goose = goose;
    }
 
    @Override
    public void quack() {
        goose.honk();
    }
}
 
// TEST CLASS
public class DuckSimulator {
    /**
     * 시뮬레이터 작성.
     *
     * <pre>
     *     이 곳에 비지니스 시뮬레이션 기능을 넣을 것!
     * </pre>
     */
    public void simulate(){
        // 거위를 오리로 호환하여, 테스트
        Duck goose = new GooseAdapter(new Goose());
        simulate(goose);
    }
}
 
// CONSOLE RESULT
// Honk
cs



3. 오리들의 꽥꽥한 횟수 구하기!


추가된 요구사항은 시뮬레이션을 한번 할 때, 전체 오리들이 꽥꽥한 횟수를 구해야하는 것입니다. 

이를 구현하기 위한 방법으로 static 변수를 이용하고자 합니다.


구현 알고리즘으로 떠오르는 것은 quack 메소드가 호출될 때마다 해당 변수를 증가시키면 되지만, 이를 위해서는 Duck 을 구현한 모든 클래스를 손봐야하는 것으로 보입니다. (많이 고쳐야 함.. 짜증...)

(Duck::quack 자체를 추상 메소드에서 일반 메소드로 변경하고 카운트를 증가시켜도 되지만, 이를 위해서는 상속받은 모든 오리클래스들이 quack 을 재정의할 때 super.quack 을 반드시 사용하도록 모두 고쳐야 합니다.)


이를 위해서 제안하는 방법은 꽥꽥한 횟수만을 관리하는 클래스를 제공하는 것을 목표로 합니다.

요구사항인 Duck::quack 을 요청했을 때 카운트가 증가해야하는 재정의가 필요하며, 이는 편의에 맞게 상속을 우회하는 패턴을 생각해 볼 수 있습니다.


우리는 이런 방법론을 배운적이 있습니다.



그렇습니다. 횟수를 관리하는 장식자를 만들 것입니다.

저는 아래와 같이 장식자를 제작하였고, 그에 따라 시뮬레이터 역시 변경하였습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/**
 * 꽥꽥한 횟수를 관리하는 장식자
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class QuackCountDecorator extends Duck{
    private Duck duck;
 
    private static int QUACK_COUNT = 0;
 
    public QuackCountDecorator(Duck duck) {
        this.duck = duck;
    }
 
    @Override
    public void quack() {
        // 오리가 울 때마다, 카운트를 관리하도록 처리.
        ++QUACK_COUNT;
 
        duck.quack();
    }
 
    /**
     * 오리가 꽥꽥한 횟수 출력.
     *
     * @return
     */
    public static int GetQuackCount() {
        return QUACK_COUNT;
    }
}
 
/**
 * 오리 시뮬레이터 정의.
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class DuckSimulator {
 
     /**
     * 시뮬레이터 작성.
     *
     * <pre>
     *     이 곳에 비지니스 시뮬레이션 기능을 넣을 것!
     * </pre>
     */
    public void simulate(){
 
        // 고무오리 테스트.
        {
            Duck rubberDuck = new QuackCountDecorator(new RubberDuck());
            simulate(rubberDuck);
        }
 
        // 거위를 오리로 호환하여, 테스트
        {
            // 장식자로 치장.
            Duck goose = new QuackCountDecorator(new GooseAdapter(new Goose()));
            simulate(goose);
        }
 
        System.out.println(String.format("꽥꽥 횟수 출력 : %d회", QuackCountDecorator.GetQuackCount()));
    }
}
 
// CONSOLE RESULT
// 삐이익~~
// Honk
// 꽥꽥 횟수 출력 : 2회
 
cs



4. 장식자 생성의 불편함, 이를 위한 객체 생성의 캡슐화!


장식자를 이용하여, 꽥꽥 횟수에 대한 관심을 한 곳으로 몰아 버린 것은 적절한 선택인 듯 합니다.


하지만, 그에 대한 비용으로 불편한 API 사용이란 대가를 치뤄야 합니다.

대표적으로 주목할 코드는 아래의 어댑터와 장식자를 같이 사용한 사례입니다.


1
 Duck goose = new QuackCountDecorator(new GooseAdapter(new Goose()));
cs


카운트를 모든 오리에 대해서 관리해야 한다면, 매번 위와 같이 장식자를 붙여줘야 할 것으로 보이는데요. 

차라리, 해당 방식으로 객체를 생성해야할 일이 많다면 객체생성 방법 자체를 캡슐화하는 것도 방법으로 보입니다.


특정 목적에 맞게 객체를 생산해주는 클래스를 팩토리라 하며, 카운트에 대한 관심을 지원할 수 있는 팩토리 클래스를 제작해 봅시다.

(이에 대한 자세한 내용은 아래에서 참고!)




이 예제에서는 여러 타입의 객체를 목적에 맞게 생산해주는 추상 팩토리(Abstract Factory) 를 사용하였으며,

그에 대한 코드는 아래와 같습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/**
 * 카운트 뿐만이 아닌 특정 관심사에 따라 팩토리를 생성할 수 있음으로, 추상 팩토리를 제작.
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public abstract class AbstractDuckFactory {
 
    /**
     * 고무오리 생산.
     *
     * @return
     */
    public abstract Duck createRubberDuck();
 
    /**
     * 거위 생산.
     *
     * @return
     */
    public abstract Duck createGoose();
}
 
/**
 * 꽥꽥 카운팅 데코레이터를 장식한 오리 객체를 생산하는 팩토리.
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class CountingDuckFactory extends AbstractDuckFactory{
 
    private static CountingDuckFactory INSTANCE = new CountingDuckFactory();
 
    private CountingDuckFactory(){}
 
    /**
     * 싱글톤으로 제작.
     *
     * <pre>
     *     팩토리는 의미적으로 한개여도 충분해 보임.
     * </pre>
     *
     * @return
     */
    public static CountingDuckFactory GetInstance() {
        return INSTANCE;
    }
 
    /**
     * 고무오리 생산.
     *
     * @return
     */
    @Override
    public Duck createRubberDuck() {
        // QuackCountDecorator 으로 장식하였음!
        return new QuackCountDecorator(new RubberDuck());
    }
 
    /**
     * 거위 생산.
     *
     * @return
     */
    @Override
    public Duck createGoose() {
        return new QuackCountDecorator(new GooseAdapter(new Goose()));
    }
}
 
cs


현재까지의 요구사항에서는 AbstractDuckFactory 를 굳이 제작할 필요는 없어보이지만,

추 후 오리들에 대한 새로운 관심사가 생길 경우 그에 맞는 적절한 객체를 생성할 수 있도록 추상 클래스를 제작했습니다.


또한 구현된 CountingDuckFactory 는 현재 의미적으로 한개여도 충분해 보인다는 생각이 들며, 그에 따라 싱글톤 클래스로 제작하였습니다.



팩토리를 제작하였으니, 그에 따라 테스트 클래스는 다음과 같이 편리하게 고칠 수 있을 것 같네요..


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/**
 * 오리 시뮬레이터 정의.
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class DuckSimulator {
 
    /**
     * 시뮬레이터 작성.
     *
     * <pre>
     *     이 곳에 비지니스 시뮬레이션 기능을 넣을 것!
     * </pre>
     */
    public void simulate(){
 
        // 고무오리 테스트.
        {
            // 팩토리로 객체 생성을 캡슐화
            Duck rubberDuck = CountingDuckFactory.GetInstance().createRubberDuck();
            simulate(rubberDuck);
        }
 
        // 거위를 오리로 호환하여, 테스트
        {
            // 팩토리로 객체 생성을 캡슐화
            Duck goose = CountingDuckFactory.GetInstance().createGoose();
            simulate(goose);
        }
 
        System.out.println(String.format("꽥꽥 횟수 출력 : %d회", QuackCountDecorator.GetQuackCount()));
    }
}
cs



5. 오리떼 관찰!


현재 제작된 오리 시뮬레이터에서는 각각의 오리객체가 꽥꽥하도록 정의되어 있습니다.

하지만 오리 객체를 더 많이 테스트 하고 싶다면, 팩토리에서 객체를 생성하고 DuckSimulator::simulate 메소드를 매번 호출해야 합니다.

(즉 여러 오리 객체에 대한 관리가 불편합니다. ㅡㅡ^)


만약 테스트의 요구사항이 지금과 같이 여러 오리들을 순회하며 Duck::quack 을 실행하는 것이 목적이라면, 아래 패턴을 이용해 볼 수 있을 것 같습니다.



지금부터 오리떼(Flock)를 나타낼 수 있는 클래스의 제작을 목표로 하며, DuckSimulator::simulate 를 사용할 수 있도록 하려 합니다.

이 때 오리들을 순회하면서 동작하고, 기존 Duck 의 인터페이스를 그대로 계승하도록 해야할 것 입니다.


즉, 오리들을 그룹으로 묶은 복합계층(Composite)을 만들고 단일계층(RubberDuck..)과 동일한 인터페이스를 제공할 생각입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/**
 * 오리떼 클래스.
 *
 * <pre>
 *     오리떼라는 복합계층을 제작하며, 단일계층과 동일한 취급을 할 수 있게 해줌.
 *     Composite Pattern
 * </pre>
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class Flock extends Duck{
 
    private List<Duck> duckList = new ArrayList<>();
 
    public void addDuck(Duck duck) {
        duckList.add(duck);
    }
 
    @Override
    public void quack() {
        // 순회하면서, Duck::quack 기능을 수행.
        // 반복자 패턴(Iterator)
        duckList.forEach(Duck::quack);
    }
}
 
 
/**
 * 오리 시뮬레이터 정의.
 *
 * Created by Doohyun on 2017. 11. 19..
 */
public class DuckSimulator {
 
     /**
     * 시뮬레이터 작성.
     *
     * <pre>
     *     이 곳에 비지니스 시뮬레이션 기능을 넣을 것!
     * </pre>
     */
    public void simulate(){
 
        // 오리떼 생성.
        Flock flock = new Flock();
 
        // 고무오리 추가.
        flock.addDuck(CountingDuckFactory.GetInstance().createRubberDuck());
 
        // 거위 추가
        flock.addDuck(CountingDuckFactory.GetInstance().createGoose());
 
        // 오리떼 테스트.
        simulate(flock);
    }
}
 
cs



여기까지, 오리 시뮬레이터의 요구사항을 일단 마치려고 합니다.

이 곳에서 사용된 패턴은 Adapter, Decorator, Factory, Composite, Iterator 패턴으로 오리 시뮬레이터를 제작하기 위해 연속적으로 패턴이 사용되었습니다.

위의 언급된 예제에서는 일련의 패턴들이 어떻게 연속적으로 사용될 수 있는지 볼 수 있습니다. 


하지만, 이 것이 컴파운드-패턴은 아닙니다. 

여러 패턴을 동시에 사용하였다고 컴파운드-패턴은 아니고, 여러 패턴이 결합되어 특정 용도로 사용되는 것을 말하기 때문이죠.


지금부터는 대표적인 컴파운드-패턴인 MVC 를 살짝 보며, MVC 가 어떤 용도로 여러가지 패턴들을 사용하고 있는지 볼 것입니다.



6. MVC


MVC 는 Model-View-Controller 의 약자로 Model(데이터 및 비지니스 문제)과 View(화면) 사이에 제어하는 층(Controller)를 두는 것을 목표로 합니다.

 


세 가지의 각 컴포넌트는 다음과 같은 역할을 하고 있습니다.


- Model 


모든 데이터 및 비지니스 로직들을 포함합니다. 또한 View 와 Controller 에게 본인의 상태(데이터)를 제공할 수 있는 인터페이스 및 상태 변경 이벤트를 제공하지만, 보통은 다른 두 컴포넌트들에게 별 관심은 없습니다.


- View 


Model 을 표현할 수 있는 기능을 담당합니다. 

데이터를 표현하기 위해 Model 로 부터 상태를 가져오도록 하며, 사용자의 입력을 Controller 로 전달하곤 합니다.


- Controller


View 로부터 사용자의 입력 이벤트를 인지하며, Model 의 상태변경을 요청하거나 View 에게 표시변경을 요청합니다.



이 세 가지 컴포넌트를 패턴 관점에서 보면, 보편적으로 다음과 같이 나누곤 합니다.

 


MVC 의 목적은 Model 과 View 를 분리하는 것으로 이는 꽤 중요한 이슈입니다. 

이 원칙을 지킬 시, 이를테면 아래와 같은 이득을 볼 수 있습니다.


비지니스적인 문제는 일관될 수 있지만, 이를 표현하는 방법은 다양해질 수 있습니다. 

  CUI -> GUI 로 변경 시, 비지니스 문제를 변경할 필요가 있을지 고민해봐야 합니다. 

  혹은 일관된 데이터로 여러 뷰를 표현해야 할 수도 있죠.


표현하기 위한 방법이 분리되어 있다면, 

  비지니스 문제가 변경되도 표현방법만 알맞게 호환해주면 원활하게 개발할 수 있습니다.



이 것으로, Effective OOP 카테고리도 마무리입니다. 

올해부터 시작한 OOP 에 대한 정리가 끝나게 되니, 정말 감회가 새로운 것 같네요. :-) 


여기까지 정리를 할 수 있었고, 공부를 할 수 있게 해준 것은 꾸준히 제 블로그를 봐주고 스터디에 적극적으로 참여해주신 구성원분들 덕이라고 생각을 합니다.

(잊지 못할 것입니다. ㅠㅡㅠ)


또한, 이러한 기반 지식 및 자료를 제게 알려주신 교수님께도 감사합니다. ㅎㅎ


여기까지 공부를 마쳤다면, 저를 포함한 이 글을 읽는 모든 분들은 이 책을 한 권 마스터한 것입니다.

나름, 수준있는 예제를 들고왔기 때문에 이 책을 보며, 블로그를 다시 읽어주신다면 정말로 도움이 되지 않을까 생각이 드네요. 

(여러분들도 이제 패턴병에 걸릴 시간입니다. 히히히)


Head First Design Patterns 헤드 퍼스트 디자인 패턴
국내도서
저자 : 에릭 프리먼(Eric Freeman) / 서환수역
출판 : 한빛미디어 2005.09.04
상세보기



조금 부족한 면이 없는 글들이긴 하지만, 

이 글들을 읽은 모든 분들이 정말 멋있고 훌륭한 개발자가 되는 것에 조금이라도 도움이 되길 바랍니다. ^^







반응형
Posted by N'

프로그래머는 일련의 비지니스 문제를 해결하기 위해 프로그램을 개발합니다.

(당연한 이야기지만, ㅡㅡ^)


이 때 비지니스 로직 중 가장 많이 사용하는 것은 아마 자료구조일 것이며, 수많은 목록형 데이터를 처리하기 위해 자료구조를 순회하며 행위를 수행하도록 작성하곤 합니다.


이를테면, 아래와 같이 말이죠?


1
2
3
4
5
6
List<String> nameList = Arrays.asList("강현지""남두현""유덕형""유형주");
        
for (String name : nameList) {
    // 리스트 목록을 순회하며, 데이터를 콘솔로 출력
    System.out.println(name);
}
cs


이와 같이 List 자체의 내부 구현 방법은 노출되어 있지 않지만, 내부의 데이터를 쉽게 순회할 수 있다는 것은 매력적입니다.

(즉 사용자는 ArrayList, LinkedList 의 내부 구현 상태는 알 필요가 없고, for-each 같은 순회 방법만 알면 됩니다.)


이와 같은 패턴을 Iterator 패턴(반복자 패턴)이라 부르며, 이번 포스팅에서는 이에 대한 예제와 함께 자세한 이야기를 다뤄보고자 합니다.


Iterator 패턴은 객체 내부의 특정 목록 데이터 순회하는 것이 목적이며, 흔히 아래와 같은 인터페이스를 구현하도록 하고 있습니다.

(아래 인터페이스는 java.util 패키지에 존재하는 Iterator 인터페이스 입니다.)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public interface Iterator<E> {
 
    /**
     * 다음 순회하고자 하는 객체가 존재하는가?
     *
     * @return
     */
    boolean hasNext();
 
    /**
     * 순회하고자 하는 다음 객체를 출력.
     * 
     * @return
     */
    E next();
}
cs


해당 인터페이스는 특정 목록 데이터를 순회하는 로직에 사용하는 메소드 서명들을 포함하고 있습니다. 

(다음 순회하는 항목이 있는가? 다음 항목으로 이동 등...)


이를 이용하여, 특정 클래스의 내부 목록을 순회하는 방법을 다음과 같이 서술해 볼 수 있을 것 같군요.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/**
 * 심플한 반복자의 구현
 *
 * Created by Doohyun on 2017. 8. 1..
 */
public class SimpleArrayIterator implements Iterator<String>{
 
    private String[] helloArray;
    private int position = 0;        // 현재 위치한 포지션의 index 관리
 
    public SimpleArrayIterator(String[] helloArray) {
        this.helloArray = helloArray;
    }
 
    /**
     * 현재 포지션이 길이 안에 존재하며 해당 배열의 값이 null 이 아닐 때, 다음 항목이 존재한다고 볼 수 있습니다.
     *
     * @return
     */
    @Override
    public boolean hasNext() {
        return position < helloArray.length && helloArray[position] != null;
    }
 
    /**
     * 다음 포지션으로 진행.
     *
     * @return
     */
    @Override
    public String next() {
        ++position;
        return helloArray[position - 1];
    }
}
cs


이렇게 구현한 반복자를 사용하는 방법은 종종 비지니스 로직을 작성하던 중 구현해 본 적이 있을 것입니다.


보통 Iterator 를 사용하여 순회하는 예제는 다음과 같이 제공하곤 합니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 목록 데이터.
String[] nameArray = {"강현지""남두현""유덕형""유형주"};
 
// 반복자 제작.
SimpleArrayIterator simpleArrayIterator = new SimpleArrayIterator(nameArray);
 
// 반복자를 이용하여, 순회.
while (simpleArrayIterator.hasNext()) {
    System.out.println(simpleArrayIterator.next());
}
 
// CONSOLE LOG
// 강현지
// 남두현
// 유덕형
// 유형주
cs


하지만, 보통 우리는 반복자를 이용하여 데이터를 순회하기 보다는 for-loop 를 통해 순회를 하곤 합니다. 


특히, JAVA5 부터 지원하는 새로운 형태의 for문을 종종 이용하곤 하는데요.

이 때 Java.lang.Iterable 인터페이스를 구현해주면, 새롭게 작성된 클래스도 해당 for 문을 사용할 수 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/**
 * Array 배열을 순회하는 반복가능 클래스 구현.
 *
 * Created by Doohyun on 2017. 8. 3..
 */
public class SimpleArrayIterable implements Iterable<String>{
 
    private String[] nameArray;
 
    public SimpleArrayIterable(String[] nameArray) {
        this.nameArray = nameArray;
    }
 
    /**
     * 반복자를 출력하도록 하고 있습니다.
     *
     * <pre>
     *     새로 작성된 for-loop 에서는 해당 반복자를 사용하도록 하고 있습니다.
     * </pre>
     *
     * @return
     */
    @Override
    public Iterator<String> iterator() {
        return new SimpleArrayIterator(nameArray);
    }
}
 
// 반복 가능 클래스 테스트 로직..
{
 
    // 목록 데이터.
    String[] nameArray = {"강현지""남두현""유덕형""유형주"};
 
    // 반복 가능 클래스의 인스턴스 제작.
    SimpleArrayIterable simpleArrayIterator = new SimpleArrayIterable(nameArray);
 
    // 새로운 형태의 for-loop 이용..
    for (String name : simpleArrayIterator) {
        System.out.println(name);
    }
 
}
cs


이로써, 예상할 수 있는 것은 모든 Collection 은 Iterable 을 구현하고 있다는 것을 알 수 있습니다.

모든 Collection 은 새로운 형태의 for-loop 을 사용할 수 있으니까요?


이와 같이, 알게 모르게 많은 사용하고 있던 Iterator 패턴은 [순회하는 방법을 캡슐화]하고 있습니다.

이는 Collection 의 내부 구현과 별도로 일관된 균일한 접근을 할 수 있도록 도와줄 수 있을 것 같습니다.

(꼭 Collection 이 아닌, Tree Graph 등 여러 자료구조를 탐색하는 것에도 사용할 수 있겠죠?)


이를 통해 꽤 괜찮은 컨셉의 비지니스 로직을 만들 수 있겠죠? ^^

한 번 이 글을 보고 실습해보면 나쁘지 않을 것 같습니다..... 



또한, 언제나 마무리 인사로,


"이 글을 보는 분들에게 도움이 되길 바랍니다. :-)"





반응형
Posted by N'

컴퓨터로 처리하는 데이터는 계속해서 복잡해져 왔고, 복잡한 프로세스를 가진 프로그램을 제작하기 위해 꽤 많은 기술과 방법들이 등장했습니다.


그 중 한가지는 OOP 로, 복잡한 데이터와 행위를 하나의 단위로 결합하여 관리함으로써 프로그램의 구조화 및 유지보수성을 키웠을 것이라 생각합니다.


이러한 가운데, 오늘 포스팅에서는 제작한 클래스의 내부 데이터(멤버 변수)들이 많고 이를 초기화(생성자 및 Setter 등)하는 과정이 생각보다 복잡할 때 사용하기 좋은 빌더 패턴(Builder Pattern)에 대해 다뤄보고자 합니다.


빌더 패턴을 이용하면, 객체 생성 시 초기화하는 과정을 보다 직관적이며 편리하게 이용할 수 있습니다.


예를들어, 아래와 같이 멤버변수가 많은 클래스가 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
 * 빌더 패턴 테스트를 위한 VO
 *
 * Created by Doohyun on 2017. 7. 20..
 */
public class TestModelVo {
 
    private Integer field1;
    private Integer field2;
    private Integer field3;
    private Integer field4;
    private Integer field5;
    private Integer field6;
    private Integer field7;
    
    // SETTER, GETTER 생략
}
cs


이 클래스를 이용하여 객체를 제작해야할 경우, 각 멤버변수에 데이터를 넣는 방법은 다음과 같이 두 가지 방법을 생각해볼 수 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// setter 를 이용하는 방법.
{
    TestModelVo testModelVo = new TestModelVo();
    testModelVo.setField1(1);
    testModelVo.setField2(2);
    testModelVo.setField3(3);
    testModelVo.setField4(4);
    testModelVo.setField5(5);
    testModelVo.setField6(6);
    testModelVo.setField7(7);
}
 
// 한 번에 초기화할 수 있는 생성자를 제공하는 방법.
{
    TestModelVo testModelVo = new TestModelVo(1,2,3,4,5,6,7);
}
cs


모두 많이 사용하는 방법일 것이라 생각합니다.


첫 번째 방법은 Setter 를 이용하여 부분적으로 초기화를 수행하고 있습니다. 

보통 이렇게 많이 사용하는 편이지만, 초기화 과정이 한 단위 씩 끊어서 일어나고 있습니다.

(즉 객체는 이미 생성되었고 생성된 객체에 데이터를 넣는 과정. 일반적이며 나쁘지 않은 방법)


두 번째 방법은 데이터를 미리 받아, 객체를 생성할 수 있도록 생성자를 정의하는 방법입니다.

이 방법도 많이 사용하는 편이지만, 위의 예제와 같이 기화 값이 많을 경우 가독성 및 사용성이 떨어질 수 있습니다. 

(각 파라미터가 무엇인지, 제대로 값은 넣고 있는지, 등의 확인이 필요할 듯 합니다.)


또한 부분적으로 멤버변수를 초기화를 하고 싶은 경우, 그만큼의 생성자를 만들어야할 수 있습니다.



빌더패턴을 이용하면 복잡한 객체 생성 과정을 한 단위의 작업으로 다양하게 처리할 수 있으며, 이는 꽤 많이 사용될 여지를 줄 수 있습니다.


빌더패턴의 목적은 '복잡한 특정 객체의 생성 및 초기화할 수 있는 클래스의 제작'이며, 각 초기화 과정을 파이프라인 형식으로 사용할 수 있는 메소드를 제공하여 한 단위로 다양한 초기화 과정을 만들 수 있습니다.


파이프라인 형식은 일련의 행위를 수행한 후 자기 자신을 출력의 결과로 넘김으로써, 메소드를 파이프 연결 하듯이 계속 이어 사용할 수 있도록 하는 방법입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/**
 * TestModelVo 를 생성할 수 있는 빌더.
 *
 * Created by Doohyun on 2017. 7. 20..
 */
public class TestModelVoBuilder {
 
    private TestModelVo testModelVo;
 
    private TestModelVoBuilder() {
        testModelVo = new TestModelVo();
    }
 
    /**
     * 빌더 인스턴스를 생성하는 정적 메소드.
     *
     * @return
     */
    public static TestModelVoBuilder Builder() {
        TestModelVoBuilder instance = new TestModelVoBuilder();
 
        return instance;
    }
 
    /**
     * 특정 초기화 작업 후, 자기자신을 결과를 넘김으로 파이프라인식의 메소드로 사용 가능.
     *
     * @param field1
     * @return
     */
    public TestModelVoBuilder setField1(Integer field1) {
        testModelVo.setField1(field1);
 
        return this;
    }
 
    /**
     * 필드2 초기화.
     *
     * @param field2
     * @return
     */
    public TestModelVoBuilder setField2(Integer field2) {
        testModelVo.setField1(field2);
 
        return this;
    }
 
    /**
     * 제작완료 후, 결과 VO 출력.
     *
     * @return
     */
    public TestModelVo build() {
        return testModelVo;
    }
}
 
// 한 단위로 복잡한 생성과정을 다양하게 만들 수 있어보임. (메소드를 이어 사용하는 파이프라인)
TestModelVo testModelVo = TestModelVoBuilder.Builder().setField1(1).setField2(2).build();
cs


이 방법을 이용하면, 한 단위로 다양한 생성자를 제작하는 것과 비슷한 효과를 볼 수 있습니다.

또한 파이프라인 형식으로 이용하기 때문에 편리하며, 메소드를 이용하기 때문에 초기화하는 방법이 직관적입니다.


이 방법은 설정과 관련된 객체를 생성하거나, 함수형 프로그래밍에서 일련의 쿼리를 만드는 등 여러 목적으로 많이 사용하고 있습니다.



예를들어, JAVA8 에서 등장한 Comparator::thenCompare 는 다음과 같은 원리로 만들어볼 수 있습니다.

(Comparator::thenCompare 는 정렬의 조건을 추가할 수 있는 메소드입니다.)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/**
 * thenCompare 기능을 지원하는 Comparator Builder
 *
 * Created by Doohyun on 2017. 7. 20..
 */
public class SimpleComparatorBuilder<T> {
    private Comparator<T> comparator;
 
    private SimpleComparatorBuilder() {
    }
 
    /**
     * 첫 초기화 시, 무조건 정렬조건을 받도록 함.
     *
     * - 적어도 한 조건을 받고, 다양한 비교조건을 제작.
     *
     * @param comparator
     * @param <T>
     * @return
     */
    public static <T> SimpleComparatorBuilder<T> Create(Comparator<T> comparator) {
        SimpleComparatorBuilder<T> simpleComparator = new SimpleComparatorBuilder<>();
 
        simpleComparator.comparator = comparator;
 
        return simpleComparator;
    }
 
    /**
     * 정렬의 조건을 추가하는 메소드.
     * 
     * @param inputComparator
     * @return
     */
    public SimpleComparatorBuilder<T> thenCompare(Comparator<T> inputComparator) {
        SimpleComparatorBuilder<T> simpleComparator = new SimpleComparatorBuilder<>();
 
        // 동적인 비교자 생성. 일련의 동적파라미터화.
        simpleComparator.comparator = (a, b) -> {
            // 기존 존재하는 비교자를 이용하여 비교.
            int compareResult = this.comparator.compare(a, b);
 
            if (compareResult == 0) {
                // 비교 결과, 두 객체가 동일할 경우 새로 입력된 비교 연산자를 이용하여 비교.
                return inputComparator.compare(a, b);
            } else {
                // 비교 결과가 다를 경우, 결과를 출력.
                return compareResult;
            }
        };
 
        // 새로 제작된 빌더를 출력.
        return simpleComparator;
    }
 
    /**
     * 조건에 대한 추가가 끝났을 경우, 내부의 비교자를 출력.
     * 
     * @return
     */
    public Comparator<T> build() {
        return comparator;
    }
}
cs


SimpleComparatorBuilder 의 목적은 비교자(Comparator)의 생성에 있어서, 비교하는 과정을 파이프라인 형식으로 다양하게 만들 수 있도록 thenCompare 기능을 제공하는 것입니다.


이를 이용하여, 다음과 같이 다양한 조건에 따라 비교하는 비교쿼리를 수행할 수 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/**
 * 비교구문을 테스트하는 메소드.
 */
public static void 비교_구문_테스트() {
    // 테스트를 위한 목록
    List<MemberVo> memberVos = Arrays.asList(
                                        new MemberVo("강XX"25)
                                        , new MemberVo("유XX"27)
                                        , new MemberVo("유XX"21));
 
 
    /**
     * 이름으로 내림차순
     * 나이로 오름차순.
     */
    Collections.sort(memberVos
                , SimpleComparatorBuilder.<MemberVo>Create((a, b) -> b.getName().compareTo(a.getName())).
                     thenCompare((a, b) -> a.getAge().compareTo(b.getAge())).build()
    );
 
    System.out.println(memberVos);
}
 
// CONSOLE LOG
// [{유XX, 21세}, {유XX, 27세}, {강XX, 25세}]
cs


다행히, 잘 작동하는 모듈이 만들어졌습니다. :-)

(시간이 괜찮다면, 이 글을 보고 직접 만들어보는 것을 추천합니다.)


이와 같이, 빌더패턴을 이용하면 단순히 객체 초기화 뿐만이 아닌 어떤 원하는 다양한 목적을 쉽게 구현할 수 있을 것입니다.

(Stream API 가 대표적이며, 이를 이용하여 Collection 에 대해 다양한 쿼리를 제작할 수 있습니다.)



"간단하지만, 쓸모가 적절한 이 패턴을 잘 알아두면 정말 좋지 않을까요?" 

라는 생각을 해보며, 이번 포스팅을 마칩니다.



이 글을 읽는 모두가 도움이 되었으면 좋겠습니다. :-)






반응형
Posted by N'

[사내 선배 개발자]분들 모두 잘하시지만(저는 언제쯤 잘할 수 있을까요? ㅜㅡㅜ), 

그 중 저에게 있어서 가장 믿을 수 있는 파트너였고, 간접적인 스승(직접적으로 뭔가 교육 등을 받지는 않았으니...)이신 선배님이 한 분 계십니다.


그 분과 디자인패턴 이야기가 종종 나올 때면, 언제나 끝에는 이 말로 종결을 짓곤 합니다.


"모든 디자인패턴은 Command 패턴을 구현하기 위해 존재할 뿐이야..."


이번 포스팅은 이 선배님께서 가장 강조하던 Command(명령)패턴에 관하여 다뤄보려고 합니다.


명령 패턴의 주 목적은 이름 그대로, 요청(명령)에 대한 캡슐화입니다.


이 패턴은 실제 요청자(Invoker)와 그 연산을 실제로 실행하는 자(Receiver) 사이에 일종의 중계자(Controller)를 두고 중계자가 캡슐화한 요청(명령)을 관리-실행을 하는 구조(has-a)로, 이는 요청자와 실행자 사이의 관계를 느슨하게 하는 것을 목표로 합니다.


언제나처럼 요구사항을 풀어가며 예제를 해결해보죠.



1. 요구사항


귀사에서 현재 제작하고 관리하는 어플리케이션 중 하나는 Cafe 관리 솔루션입니다.

Cafe 관리 솔루션은 "Cafe 내에서 사용하는 많은 infra 의 작동상태를 관리" 하는 것을 목적으로 하였으며, 꽤 많은 회사에서 이 솔루션을 사용하고 있습니다.


그렇기 때문에, Cafe 관리 솔루션의 요구사항은 끊기지 않는 것 같습니다. @.@


[욕심많은 기획자]는 다양한 기기를 관리할 수 있는 만능 리모콘 제작을 의뢰했습니다.

만능 리모콘에는 오직 한개의 버튼밖에 없지만, Cafe 에서 사용하는 많은 infra 의 on/off 를 오직 이 버튼만으로 관리하길 기대합니다.


여기서 중요한 것은 아직 우리는 관리할 모든 infra 를 받지 못했습니다. ㅜㅡㅜ



2. 다양한 infra, 더욱 다양한 서명들.


먼저 관리요청을 받은 infra 의 상태를 먼저 체크해 볼 필요가 있습니다.

각 infra 들은 많은 사람들에 의해서 제작이 되었고, 그렇기 때문에 당연하게도 메소드의 서명들이 모두 다릅니다.


또한, 버튼을 누를 때마다 해야할 일이 한 개는 아닌 것 같습니다.

Ex. MusicPlayer 의 경우, 버튼에 의해 활성화할 시 해야할 일은 아마도 MusicPlayer::on, MusicPlayer::startMusic 정도 일 것입니다.


하지만 더 안타까운 것은 추가 될 infra 역시 다양한 메소드 서명과 다양한 룰이 등장할 것이란거죠.



3. 요청의 캡슐화 및 컨트롤


메소드 서명과 사용 방법이 모든 infra 마다 다르다는 것은 꽤 골치 아픈 문제처럼 보입니다.

또한 만능 리모콘은 요청을 처리하기 위해서 infra 의 많은 정보를 알아야하는 것은 좋아 보이지 않습니다.

(만능 리모콘이 infra 가 추가될 때마다 해당 정보를 알기 위해 수정을 해야합니다.)


하지만 요청에 대한 일련의 복잡한 과정을 만능 리모콘에 맞게 '버튼'이라는 하나의 인터페이스로 단순화한다면 간단한 문제가 될 수 있을지도 모릅니다. 

단순화는 만능 리모콘이 요청을 처리하기 위해서 infra 의 정보를 몰라도 됨을 의미합니다.


우리는 이와같은 문제를 한 번 풀어본 적이 있습니다.

기억이 나나요? 맞습니다. 바로 Facade 의 개념을 도입해보죠.


Facade 패턴이 궁금하다면 아래 포스팅을 참고! :-)



만능 리모콘의 요청에 맞춰 각 infra가 해야할 일을 다음과 같이 단순화를 하고자 합니다.


1
2
3
4
5
6
7
8
9
10
11
/**
 * 리모콘이 할 수 있는 인터페이스 정의
 *
 * Created by Doohyun on 2017. 7. 6..
 */
public interface ICommand {
    /**
     * 실행
     */
    void execute();
}
cs



이에 따라 요청에 따라 infra 가 해야할 동작을 담을 ConcreteCommand 클래스를 만들어보죠.


아래는 MusicPlayer 와 MusicPlayer 에 대한 on/off 요청을 캡슐화한 클래스입니다.

요청을 캡슐화한 클래스에서는 요청전략에 따라 해야할 일련의 과정을 수행하도록 하였습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/**
 * 음악 플레이어
 *
 * <pre>
 *     실제 액션을 하는 객체를 의미
 *     receiver.
 * </pre>
 *
 * Created by Doohyun on 2017. 7. 6..
 */
public class MusicPlayer {
    
    public void on() {
        System.out.println("음악플레이어 전원을 올린다.");
    }
 
    public void startMusic() {
        System.out.println("음악 재생");
    }
 
    public void endMusic() {
        System.out.println("음악 끄기");
    }
    
    public void off() {
        System.out.println("음악플레이어 끄기");
    }
}
 
/**
 * 음악플레이어 스위치를 켜는 명령 정의.
 *
 * Created by Doohyun on 2017. 7. 6..
 */
public class MusicPlayerOnCommand implements ICommand {
 
    private MusicPlayer musicPlayer;
 
    public MusicPlayerOnCommand(MusicPlayer musicPlayer) {
        this.musicPlayer = musicPlayer;
    }
 
    /**
     * 음악 전원을 올리고 재생한다.
     */
    @Override
    public void execute() {
        musicPlayer.on();
        musicPlayer.startMusic();
    }
}
 
/**
 * 음악플레이어 스위치를 끄는 명령 정의.
 * 
 * Created by Doohyun on 2017. 7. 6..
 */
public class MusicPlayerOffCommand implements ICommand{
    private MusicPlayer musicPlayer;
 
    public MusicPlayerOffCommand(MusicPlayer musicPlayer) {
        this.musicPlayer = musicPlayer;
    }
 
    /**
     * 음악을 끄고, 전원을 내린다.
     */
    @Override
    public void execute() {
        musicPlayer.endMusic();
        musicPlayer.off();
    }
}
cs



이제 앞써 구현한 명령(ICommand) 객체를 사용할 만능리모콘은 다음과 같이 제작해보겠습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/**
 * 명령 객체를 관리하는 중계자.
 *
 * Created by Doohyun on 2017. 7. 6..
 */
public class RemoteController {
 
    private ICommand command;
 
    /**
     * 명령객체 세팅.
     *
     * @param command
     */
    public void setCommand(ICommand command) {
        this.command = command;
    }
 
    /**
     * 실행
     */
    public void execute() {
        Optional.ofNullable(command).ifPresent(ICommand::execute);
    }
}
cs


RemoteController 는 ICommand 를 has-a 관계로 취하고 있으며, 이는 infra 를 실행함에 있어서 어떤 정보도 알 필요가 없음을 의미합니다.


즉, 캡슐화된 요청은 일종의 전략이라고 볼 수 있으며 RemoteController 는 전략을 사용하고 있는 형태로 볼 수 있을 것 같습니다.


전략 패턴에 대한 내용은 아래에서 확인할 수 있습니다.



이제 구현된 내용을 테스트하는 코드를 간단히 작성해보겠습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Receiver
MusicPlayer musicPlayer = new MusicPlayer();
 
// Invoker 와 Receiver 사이의 Controller
RemoteController controller = new RemoteController();
 
// 음악플레이어 켜기. (invoke type 1)
controller.setCommand(new MusicPlayerOnCommand(musicPlayer));
controller.execute();
 
// 음악플레이어 끄기. (invoke type 2)
controller.setCommand(new MusicPlayerOffCommand(musicPlayer));
controller.execute();
 
// CONSOLE LOG
// 음악플레이어 전원을 올린다.
// 음악 재생
// 음악 끄기
// 음악플레이어 끄기
cs


이 구조에서는 만약 새로운 infra 가 생긴다 하더라도, 

ICommand 를 구현하는 요청객체를 만들어 RemoteController 에 세팅하면 특별히 다른 부분을 수정할 필요가 없어 보입니다. (OCP)


현재 구조를 UML 로 표현해보면 다음과 같습니다.



이 구조를 많이 보지 않았나요?

상위 모듈인 Controller 와 하위모듈인 ConcreteCommand 들은 모두 추상적인 ICommand 에 의존하고 있습니다. (DIP)


이 것에 대해 존경하는 또 다른 선배님의 말씀을 빌리면,


모든 패턴의 UML 을 그려보면 다 똑같아....


라고 하고 싶군요.



3. 명령 패턴 응용.


명령 패턴의 또 다른 묘미는 명령 객체를 관리할 수 있다는 것입니다.


Controller 에서 명령 객체를 has-a 관계로 유지하며 리하는 방식을 목적에 맞게 구현함으로써, undo/redo, macro 등을 개발해 볼 수 있습니다.


이러한 기능들은 특히, invoker 입장에서 특정 행위를 receiver 를 이용해 하기 위해 정보를 유지해야하는 불편함을 덜어줄 수 있을 것입니다.


이번 절에서는 명령 패턴의 대표적인 활용 예시인 UNDO/REDO 를 구현해보겠습니다.


이를 위해 앞써, 구현한 interface 의 명세를 조금 수정할 생각입니다.

특정 요청에 대한 행위를 취소하는 기능인 undo 를 추가하기 위해서죠..


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
 * undo 를 지원하는 명령인터페이스
 *
 * Created by Doohyun on 2017. 7. 6..
 */
public interface ICommand {
 
    /**
     * 실행취소
     */
    void undo();
 
    /**
     * 실행
     */
    void execute();
}
cs



이를 구현하는 ConcreteCommand 객체는 다음과 같습니다.

이번에는 특별하게 상태가 있는 요청입니다.


POSS 를 켜기 위해서는 id, pwd 가 필요하며, 요청객체에서 상태를 유지하도록 하였습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/**
 * 포스를 작동시키는 커맨드 구현.
 *
 * Created by Doohyun on 2017. 7. 7..
 */
public class POSSOnCommand implements ICommand {
 
    private String id;
    private String pwd;
    private POSS poss;
 
    /**
     * 포스를 켜는 커맨드 구현.
     *
     * <pre>
     *     상태를 유지함으로써, 
     *     invoker 는 요청을 한번 할 때를 제외하고는 해당 정보를 유지할 필요가 없음.
     * </pre>
     *
     * @param poss
     * @param id
     * @param pwd
     */
    public POSSOnCommand(POSS poss, String id, String pwd) {
        this.poss = poss;
        this.id = id;
        this.pwd = pwd;
    }
 
    @Override
    public void undo() {
        poss.logout();
        poss.closeSystem();
    }
 
    @Override
    public void execute() {
        poss.pushStartButton();
        poss.login(id, pwd);
    }
}
cs



다음 수정을 해볼 부분은 RemoteController 입니다. 

Stack 두 개를 목적에 따라 분류하여 명령 객체를 관리하고 있으며, RemoteController::execute, RemoteController::undo 가 실행될 때마다 적절하게 명령들을 이동시키고 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/**
 * 컨트롤러 undo/redo 지원
 *
 * Created by Doohyun on 2017. 7. 6..
 */
public class RemoteController {
 
    // 일반 명령을 위한 스택
    private Stack<ICommand> commandStack = new Stack<>();
    // UNDO 명령을 위한 스택
    private Stack<ICommand> undoStack = new Stack<>();
 
    // 명령을 추가
    public void setCommand(ICommand commandWithUndoable) {
        commandStack.push(commandWithUndoable);
    }
 
    /**
     * 일반 적인 실행. (REDO 포함)
     */
    public void execute() {
        if (!commandStack.isEmpty()) {
            // [일반명령 스택]에서 가장 마지막에 담긴 명령객체를 추출 후 실행.
            ICommand command = commandStack.pop();
            command.execute();
 
            // 해당 명령을 UNDO 스택에 삽입.
            undoStack.push(command);
        }
    }
 
    /**
     * 작업 취소 (Undo)
     */
    public void undo() {
        if (!undoStack.isEmpty()) {
            // [UNDO 명령 스택]에서 가장 마지막에 담긴 명령객체를 추출 후 실행.
            ICommand command = undoStack.pop();
            command.undo();
 
            // 일반 실행 스택에 데이터 삽입.
            commandStack.push(command);
        }
    }
}
 
cs



자, 코드가 수정 되었으니 마찬가지로 테스트 코드를 또 만들어보죠.

포스팅에서 제공은 안하지만 [커피머신 작동 명령] 까지 동시에 같이 세팅해 보도록 하였습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
CoffeeMachine coffeeMachine = new CoffeeMachine();
POSS poss = new POSS();
 
RemoteController controller2 = new RemoteController();
 
// 포스 작동 명령 세팅.
controller2.setCommand(new POSSOnCommand(poss, "Doohyun","486"));
 
controller2.execute();
controller2.undo();
controller2.execute();
 
// 커피머신 작동 명령 세팅
controller2.setCommand(new CoffeeMachineOnCommand(coffeeMachine));
controller2.execute();
controller2.undo();
controller2.undo();
controller2.execute();
 
// CONSOLE LOG
// 포스 켜기
// 로그인 : Doohyun, 486
// 로그아웃
// 포스 끄기
// 포스 켜기
// 로그인 : Doohyun, 486
// 커피기계 스위치 켜기
// 커피기계 스위치 끄기
// 로그아웃
// 포스 끄기
// 포스 켜기
// 로그인 : Doohyun, 486
cs


다행히, 실행/실행취소가 적절하게 잘 작동하는 것처럼 보입니다.

특히 주목할 점은 POSS 의 재실행 시, 상태인 id/pwd 를 다시 입력할 필요가 없다는 것입니다.

이는 invoker 입장에서 이와 같은 요구사항 처리 시, 정보를 계속 유지할 필요가 없음을 의미합니다.



이번 포스팅에서 다룬 명령 패턴은 '요청의 캡슐화' 라는 특정 목적을 가지고 있지만, 사실 여태 살펴본 다른 패턴들과 크게 다르지는 않은 듯 합니다.


특정 요청에 대한 복잡한 일련의 과정을 단순화한 전략에 따른 행위를 하도록 다형성을 이용했으며, 각 컴포넌트간의 관계를 느슨하게 위해 SOLID 의 두-세가지(SRP, OCP, DIP) 정도를 충족하도록 적용한 구조입니다.


패턴에 대한 이해도 중요하지만, 여러 패턴들 속에서 반복적으로 나타나는 이러한 특징들을 계속 접해보는 것도 도움이 되지 않을까 생각이 듭니다. :-)

감사합니다.



- 추가 사항 (2017.09. 10)


명령 패턴에 대한 실습자료는 아래와 같습니다. 감사합니다. ^^


CommandHomeWork.zip


반응형
Posted by N'

최근 사내의 선배에게 소프트웨어 개발에 대한 이야기를 하던 중 다음과 같은 이야기가 있었습니다.


"개발은 혼자할 수 있지만, 소프트웨어는 다수에 의해 만들 수 밖에 없는 듯...."


작은 규모의 프로젝트라면 슈퍼 개발자 혼자서 요구사항의 범위를 모두 충족할 수 있지만,

어느정도 중소 이상 급의 규모의 프로젝트라면 협업은 불가피해 보입니다.

(사실, 개발 뿐 아니라 모든 일이 그런 듯.... ㅡㅡ^)


그렇기 때문에, 개발자들은 타인에 의해서 작성된 모듈을 많이 사용하며 또한 본인이 만든 모듈 역시 배포를 해야할 것입니다.


앞써, 우리는 타에 의해서 배포된 모듈을 본인이 작성한 인터페이스 형식으로 변경하기 위한 패턴을 배웠습니다. 

네, 맞습니다. 바로 Adapter 패턴입니다. :-)



이번에는 반대로 본인이 만든 어떤 소프트웨어의 복잡한 모듈에 대하여 [간략화 된 인터페이스] 를 제공함으로써, 라이브러리 사용자들이 쉽게 사용하며 이해할 수 있도록 도움을 주는 Facade 패턴에 대해 다뤄보려고 합니다.

(Facade 는 "건물의 정면"을 뜻합니다.)


Facade 패턴의 목표는 자주 사용하는 일련의 공통적인 작업에 대한 편의 메소드를 제공해주는 것이며, 이번 리뷰에서는 이해를 위해 간단한 코드를 제공할 생각입니다.


언제나처럼 첫 시작은 요구사항입니다.


1. 요구사항


신입 IT 기술 매니저인 당신은 Cafe 의 인프라를 관리하는 부서로 발령을 받았습니다.


이 부서에서는 Cafe 의 여러 시스템들을 관리하는 프로그램을 배포하고 있으며, 

주 목적은 Cafe 개업 시작과 종료 시 [전등, 영업기계(POSS), 커피머신 세팅, 음악볼륨 조절] 등의 인프라를 끄고 키는 것을 관리하는 시스템을 목적으로 합니다.


이 과정에는 일련의 방법 및 매뉴얼(예를들어 커피머신은 영업 시작 1시간 전에는 미리 켜야 합니다.)이 존재하며, 매번 고객사에 판매할 때마다 이 작업을 교육 시켜야 합니다.


OOP 지식의 전문가인 당신은 반복적인 룰(Rule)을 모든 모듈 사용자가 숙지할 필요가 없다고 생각하고 있으며, 개선방법을 고려해보고자 기존 모듈들을 살펴보고 적절한 방법을 찾고자 합니다.



2. 이미 만들어진 복잡한 API


모듈을 확인해본 결과,


모든 인프라(전등, POSS, 커피머신 등)들은 단순하게 개업 시작, 종료에만 사용하는 것이 아닌 여러 상황(Event)의 변화에 따라 해야할 행위들이 존재했습니다.

(개업 시작, 종료 역시 큰 범위에서는 Event 의 한 종류라고 생각할 수 있겠군요.)


예를들어, 살펴본 CoffeeMachine 인프라 클래스입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/**
 * 커피 머신.
 *
 * Created by Doohyun on 2017. 7. 2..
 */
public class CoffeeMachine {
    /**
     * 커피 머신 스위치 올리기.
     */
    public void clickOnSwitch(){
        System.out.println("커피머신 스위치 올리기");
    }
 
    /**
     * 커피 머신 스위치 내리기.
     */
    public void clickOffSwitch(){
        System.out.println("커피머신 스위치 내리기");
    }
 
    /**
     * 스팀 기계 체크.
     */
    public void checkSteam() {
        System.out.println("스팀 체크");
    }
 
    /**
     * 에스프레소 필터 체크
     */
    public void checkEspressoShopFilter() {
        System.out.println("에스프레소 필터 체크");
    }
 
    /**
     * 커피콩 추가.
     */
    public void addCoffeeBean() {
        System.out.println("커피콩 추가");
    }
    
    // 이하 생략...  이 클래스의 행위는 너무 많음 ㅡㅡ^
}
 
cs



문제는 모든 인프라 클래스들이 행위가 너무 많다는 것이며, 

모든 기능이 해당 클래스가 책임져야 할 문제이기 때문에 메소드 추출 및 이동과 같은 리팩토링을 하는 것은 오히려 API 의 혼란을 가져올 여지가 있어 보입니다. 


이미 모든 고객사들은 특정 상황에 따라 문서 및 교육에 따라 아래처럼 모듈을 사용하고 있습니다.

 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/**
 * 스타벅스 카페
 *
 * Created by Doohyun on 2017. 7. 2..
 */
public class StarbucksCafe {
 
    private CoffeeMachine coffeeMachine;
    private MusicPlayer musicPlayer;
    private Poss poss;
 
    private String masterId = "MASTER_ID";
    private String masterPwd = "MASTER_PWD";
 
    public StarbucksCafe() {
        this.coffeeMachine = new CoffeeMachine();
        this.musicPlayer = new MusicPlayer();
        this.poss = new Poss();
    }
 
    /**
     * Event 1 : 카페 오픈.
     */
    public void open() {
        
        // STEP1 커피 머신 켜기.
        {
            this.coffeeMachine.clickOnSwitch();                     // 커피머신 스위치 켜기
            this.coffeeMachine.checkSteam();                        // 스팀 체크
            this.coffeeMachine.checkEspressoShopFilter();           // 에스프레소 샷 필터 체크
            this.coffeeMachine.addCoffeeBean();                     // 커피콩 추가
        }
 
        // STEP2 포스 켜기
        {
            this.poss.clickOnSwitch();                              // 포스켜기
            this.poss.inputIdentity(masterId, masterPwd);           // 포스 로그인
        }
 
        // STEP3 음악 켜기
        {
            this.musicPlayer.clickOnSwitch();                       // 음악플레이어 켜기
            this.musicPlayer.loginToMelon(masterId, masterPwd);     // 멜론 로그인
            this.musicPlayer.runMusic();                            // 음악켜기
        }
    }
 
    /**
     * Event 2 : 카페 종료.
     */
    public void close() {
        
        // STEP1 커피 머신 정리
        {
            this.coffeeMachine.checkEspressoShopFilter();           // 에스프레소 샷 필터 체크
            this.coffeeMachine.checkSteam();                        // 스팀 체크
            this.coffeeMachine.clickOffSwitch();                    // 커피머신 스위치 끄기
        }
 
        // STEP2 음악 끄기
        {
            this.musicPlayer.logoutFromMelon();                     // 멜론 로그아웃
            this.musicPlayer.clickOffSwitch();                      // 음악플레이어 끄기
        }
        
        // STEP3 포스 끄기
        {
            this.poss.logout();                                     // 포스 정산 및 로그아웃
            this.poss.clickOffSwitch();                             // 포스 종료
        }
    }
}
 
cs


STARBUCKS 카페의 경우 문서에 따라, 잘 정리하여 운영을 하고 있습니다.

문서가 잘 정리되어 있고, 고객사의 개발자들이 그에 따라 잘 개발해준다면 문제가 없어보입니다.

(위와 동일한 코드를 작성해주면 되니, 아무 문제가 없을수도 있습니다.)


하지만 위와 같은 복잡한 API 를 모든 개발사의 개발자가 알고 있어야 한다는 것은, 그만큼의 API 에 대한 문서 및 교육이 필요함을 의미합니다. 


또한, 우리가 제공하는 API 가 기능추가를 의도할 때(예를들어 새로운 infra 가 추가 되었고, 이는 모든 Cafe 의 카페 오픈 하는 비지니스에 포함이 되어야할 경우), 모든 고객사에게 이를 알려야 하며 잘 사용하고 있는지에 대한 검토 또한 필요할 수 있습니다.

(A/S 가 부실하면, 고객사를 잃을 수도 있겠죠? ㅡㅡ^)


즉, 고객사의 편의를 위한 새로운 방법이 필요할 수 있어 보입니다.

 


3. 포장(wrapping) 을 통한 편리한 API 사용.


프로그래밍 기법 중에 우리는 포장(Wrapping)을 하는 경우는 흔히 볼 수 있습니다.


대표적인 것이 Java 의 Number 관련(Integer, Double...) Wrapper 클래스들입니다. 

이 Wrapper 클래스들은 원시타입인 int, double 등에 대하여 Boxing 과정을 통해 클래스로써의 특성을 가질 수 있도록 해줍니다.


즉, 기존 어떤 상태를 특정 목적에 따라 포장하는 것을 Wrapping 이라고 칭할 수 있을 것 같으며, 우리는 이 과정을 알게 모르게 많이 배웠습니다.


- Adapter 패턴


이미 "제공되는 것" 과 "필요한 것" 의 차이를 극복하기 위해, 타모듈의 객체를 본인에게 유리한 인터페이스로 Wrapping 합니다.


- Decorator 패턴


주어진 상황에 따라 기존 객체에게 책임이나 속성을 덧붙이기 위해, 장식으로 대상객체를 Wrapping 합니다. 

이는 상속을 통해서만 책임을 확장할 수 있던 방법의 대안이 되었습니다.


Decorator 패턴에 대한 리뷰는 아래에서 참고! :-)



Facade 패턴 역시 Wrapping 을 사용하는 방법으로, 

복잡하게 제공할 수 밖에 없는 API 들을 일종의 매뉴얼화 시킨 객체를 제공함으로써 라이브러리 사용을 극대화시키도록 합니다.


즉, 매뉴얼을 코드화 시켰다고 생각하는 것이 좋겠군요.

StarbucksCafe 에서 제작하도록 지시했던 메뉴얼을 다음과 같은 Wrapping 클래스로 제공해보죠.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/**
 * 카페 운영을 위한 파사드 정의.
 *
 * Created by Doohyun on 2017. 7. 2..
 */
public class CafeOperateFacade {
    private CoffeeMachine coffeeMachine;
    private MusicPlayer musicPlayer;
    private Poss poss;
 
    private String masterId;
    private String masterPwd;
 
    public CafeOperateFacade(String masterId, String masterPwd) {
        this.coffeeMachine = new CoffeeMachine();
        this.musicPlayer = new MusicPlayer();
        this.poss = new Poss();
 
        this.masterId = masterId;
        this.masterPwd = masterPwd;
    }
    
    //  직접적인 컴포넌트 사용을 위해, GETTER 를 제공.
 
    /**
     * 카페 머신 출력.
     * 
     * @return
     */
    public CoffeeMachine getCoffeeMachine() {
        return coffeeMachine;
    }
 
    /**
     * 음악 플레이어 출력.
     * 
     * @return
     */
    public MusicPlayer getMusicPlayer() {
        return musicPlayer;
    }
 
    /**
     * 포스 출력.
     * 
     * @return
     */
    public Poss getPoss() {
        return poss;
    }
 
    /**
     * Id 출력.
     * 
     * @return
     */
    public String getMasterId() {
        return masterId;
    }
 
    /**
     * 패스워드 출력.
     * 
     * @return
     */
    public String getMasterPwd() {
        return masterPwd;
    }
 
    /**
     * Event 1 : 카페 오픈.
     */
    public void open() {
 
        // STEP1 커피 머신 켜기.
        {
            this.coffeeMachine.clickOnSwitch();                     // 커피머신 스위치 켜기
            this.coffeeMachine.checkSteam();                        // 스팀 체크
            this.coffeeMachine.checkEspressoShopFilter();           // 에스프레소 샷 필터 체크
            this.coffeeMachine.addCoffeeBean();                     // 커피콩 추가
        }
 
        // STEP2 포스 켜기
        {
            this.poss.clickOnSwitch();                              // 포스켜기
            this.poss.inputIdentity(masterId, masterPwd);           // 포스 로그인
        }
 
        // STEP3 음악 켜기
        {
            this.musicPlayer.clickOnSwitch();                       // 음악플레이어 켜기
            this.musicPlayer.loginToMelon(masterId, masterPwd);     // 멜론 로그인
            this.musicPlayer.runMusic();                            // 음악켜기
        }
    }
 
    /**
     * Event 2 : 카페 종료.
     */
    public void close() {
 
        // STEP1 커피 머신 정리
        {
            this.coffeeMachine.checkEspressoShopFilter();           // 에스프레소 샷 필터 체크
            this.coffeeMachine.checkSteam();                        // 스팀 체크
            this.coffeeMachine.clickOffSwitch();                    // 커피머신 스위치 끄기
        }
 
        // STEP2 음악 끄기
        {
            this.musicPlayer.logoutFromMelon();                     // 멜론 로그아웃
            this.musicPlayer.clickOffSwitch();                      // 음악플레이어 끄기
        }
 
        // STEP3 포스 끄기
        {
            this.poss.logout();                                     // 포스 정산 및 로그아웃
            this.poss.clickOffSwitch();                             // 포스 종료
        }
    }
}
 
cs


위와 같이, 공통적으로 사용할 법한 기능들을 간편한 API 로 제공하였습니다.

또한, 각 인프라 역시 직접적으로 사용할 수 있도록 Getter 메소드를 제공하고 있습니다.


공통적으로 사용할 법한 기능들은 각 Cafe 클래스에서 사용하고, 특수한 기능들은 알아서 직접적으로 모듈을 사용하라고 열어둔 셈입니다.


자, Facade 를 제공함으로써 각 고객사 모듈이 어떻게 변했는지 확인해볼까요?


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
 * 스타벅스 카페
 *
 * Created by Doohyun on 2017. 7. 2..
 */
public class StarbucksCafe {
 
    private CafeOperateFacade cafeOperateFacade;
 
    private String masterId = "MASTER_ID";
    private String masterPwd = "MASTER_PWD";
 
    public StarbucksCafe() {
        this.cafeOperateFacade = new CafeOperateFacade(masterId, masterPwd);
    }
 
    /**
     * 카페를 오픈한다.
     */
    public void open() {
        cafeOperateFacade.open();
    }
 
    /**
     * 카페를 닫는다.
     */
    public void close() {
        cafeOperateFacade.close();
    }
}
cs


복잡했던, 모듈이 매우 심플(Simple) 해졌군요. :-)

복잡한 API 문서를 정성들여 제공하는 것보다, 쓰기 좋은 라이브러리를 제공해주는 편이 고객사 입장에서는 더 좋겠죠?


또한, 우리는 고객사의 코드를 관리할 수 있습니다.

예를들어 우리는 라이브러리의 CafeOperateFacade::open 을 수정하면, 모든 고객사들의 소스에 수정사항에 대한 영향을 줄 수 있습니다.


그렇지만 이는 사실 단순하게 좋다고만 볼 수는 없습니다. 

미치는 영향이 잘못하면 고객사들에게는 큰 피해가 갈 수도 있겠죠?



이번 리뷰에서 다룬, Facade 의 개념은 우리가 사용하는 많은 라이브러리에 적용되어 있습니다.


복잡한 Javascript 문법을 편리하게 하기 위하여 jQuery 가 생겼으며, JDBC 의 불편한 Mapping 과정 때문에 iBatis, Hibernate 등의 ORM 이 많이 사용되고 있습니다.


즉, 복잡한 라이브러리를 Wrapping 하여 편리한 API 만을 볼 수 있게함으로써 많은 개발자들의 개발기간을 감축(FACADE 의 최종 목적)시켰으며, 이는 OOP 의 개념에서 가장 큰 목적이 아닐까 생각을 합니다.


이 글이 도움이 되길 바랍니다. :-)











반응형
Posted by N'

이번 주부터는 [번외] 로 작성되는 리뷰 입니다.


스터디에서는 가장 많이 활용할 법한 패턴들을 다뤘지만, 

지금부터는 그외에 적어도 "기본서에 서술된 패턴" 들에 대한 이야기를 다뤄볼 생각입니다.


고작, 6개의 패턴정도만 다루고 이 카테고리를 끝내기에는 조금 아쉽더군요..... 

아마 이 것이 More OOP & FP....


참고로 여기서 기본서란 아래 책을 말합니다.


Head First Design Patterns 헤드 퍼스트 디자인 패턴
국내도서
저자 : 에릭 프리먼(Eric Freeman) / 서환수역
출판 : 한빛미디어 2005.09.04
상세보기


번외로 시작하는 이번 포스팅에서 처음 다뤄볼 패턴은 "주어진 상황 및 용도에 따라 객체에 책임을 덧붙일 수 있는 Decorator Pattern" 입니다.


이 패턴을 사용하면 동적으로 기능을 확장할 수 있으며, 클래스의 기능을 확장 하려면 꼭 상속을 해야 한다는 법칙을 대신할 수 있는 대안이 될 수 있을 것 같습니다.


한번, 요구사항과 함께 본격적으로 리뷰를 해보겠습니다.



1. Coffee 의 가격문제.


우리가 마시는 Coffee 에는 다양한 재료가 포함될 수 있습니다. 

예를들어, Latte 에는 Espresso 와 Milk 가 포함되며, Mocha 에는 Latte 재료에 Chocolate Syrup 이 포함됩니다.

또한, Coffee 종류에 따라 Espresso 역시 다른 블랜딩 방식을 사용할 수 있을 것 같습니다.


이렇게 Coffee 마다 사용하는 재료는 다양하며, 

그에 따라 가격을 책정하고 싶은 것이 이번 포스팅의 최종 목표입니다.



2. 상속관계를 통한 Coffee 가격 계산.


요구사항은 그렇게 큰 문제는 아닌 것처럼 보입니다.


Coffee 라는 최상위 클래스를 만들고 해당 클래스에서는 Coffee::getCost 라는 행위에 대한 서명을 명시합시다. 

물론 구체적인 구현은 하위 클래스들이 할 일이죠..


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/**
 * 커피 클래스
 *
 * <pre>
 *     계산에 대한 기능을 명시.
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public abstract class Coffee {
 
     /**
     * 커피 이름 출력
     *
     * @return
     */
    public abstract String getName();
 
    /**
     * 코스트에 대한 메소드 서명 정의
     *
     * <pre>
     *     해당 클래스를 상속받는 클래스는 모두 이 기능을 구현해야함.
     * </pre>
     *
     * @return
     */
    public abstract Integer getCost();
}
 
/**
 * 라떼 기능 구현.
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public class Latte extends Coffee{
 
    @Override
    public String getName() {
        return "라떼";
    }
 
    /**
     * 라떼의 가격은 5900 원.
     *
     * @return
     */
    @Override
    public Integer getCost() {
        return 5900;
    }
}
cs


이렇게 제품마다 가격에 대한 기능을 적절하게 구현해준다면, 요구사항을 쉽게 정리할 수 있을 것 같습니다. 


이를 UML 로 표현해보면 다음과 같을 것 같군요.

 




일단, 제품에 따라 가격이란 개념을 표현할 수는 있습니다. 


하지만 요구사항에서는 재료따라 Coffee 의 가격이 책정되길 바랍니다. 

이는 즉 재료의 가격이 변하면 Coffee 의 가격도 변하길 바람을 말하는 듯 합니다.



3. 재료기능에 대한 기능 추가 및 상속구조 변화.


재료에 대한 기능을 상위 클래스에 정의를 함으로써, 이 문제를 해결할 수 있을 것 같습니다.


기본적인 커피 가격을 부모클래스에서 책정하고, 사용하는 재료에 따라 하위클래스에서 적절하게 가격을 추가하는 것이죠.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/**
 * 커피 클래스
 *
 * <pre>
 *     계산에 대한 기능을 명시.
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public abstract class Coffee {
 
    /**
     * 우유 사용여부
     *
     * @return
     */
    public abstract Boolean getHasMilkYn();
 
    /**
     * 코스트에 대한 메소드 서명 정의
     *
     * <pre>
     *     기본적인 커피가격.
     * </pre>
     *
     * @return
     */
    public Integer getCost() {
        // 처음 가격은 4000 원.
        Integer cost = 4000;
 
        if (getHasMilkYn()) {
            // 우유 가격 추가.
            cost+=900;
        }
 
        return cost;
    }
}
 
/**
 * 하우스 블렌딩 방식으로 만든 에스프레소
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public class HouseBlendingEspresso extends Coffee{
 
    @Override
    public Boolean getHasMilkYn() {
        return false;
    }
 
    /**
     * 하우스 블렌딩 방식은 일반 에스프레소보다 가격이 1000 원 비쌈.
     *
     * @return
     */
    @Override
    public Integer getCost() {
        return 1000 + super.getCost();
    }
}
 
/**
 * 라떼는 하우스 블렌딩 방식 에스프레소를 사용.
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public class Latte extends HouseBlendingEspresso{
 
    @Override
    public Boolean getHasMilkYn() {
        return true;
    }
}
cs


이제, 재료에 따라 가격도 연동될 것입니다. 

우유 가격을 정확히 명시하였으며, 우유를 사용하는 Latte 는 사용여부만 적절히 구현해주면 됩니다.

(우유 가격 변동에 따라 유연하게 Latte 의 가격을 변동시킬 수 있습니다.)


심지어, 상속관계를 이용하여 Blending 방식에 따른 커피가격 역시 변동할 수 있도록 구현하였습니다. 


즉 상속구조 및 적절한 메소드 추가를 통해 부모의 기능에 자신의 입맛에 맞도록 적절한 치장을 하고 있습니다만, 이 구조는 다음과 같은 아쉬움이 존재합니다.


- 재료 추가에따라 Coffee 에 기능을 추가하고, Coffee::getCost 를 수정해야합니다.


- Syrup 을 추가해야한다면, Coffee::getHasSyrupYn 를 추가해야합니다.

Coffee::getHasSyrupYn 의 추가는, 모든 구현클래스들에 이 기능을 구현해야함을 의미합니다. 

  (Interface 서명 변경과 같은 문제입니다.)

- 또한, Coffee::getCost 역시 수정해야 합니다.


- 각 최종 구현클래스들은 재료에 유연할 수 없습니다.


- 상속구조 기반으로 재료관계를 명시하였기 때문에, 컴파일 시간에 모든 행위가 결정 됩니다.

- Latte 는 무조건 HouseBlendingEspresso 만 사용합니다. 

  즉, 다른 블렌딩을 사용하려면 새 클래스를 만들어야 합니다.

- 또한 더블샷, 시럽추가 등의 재료에 대한 유연함을 줄 수 없음을 의미합니다.


즉, 지금 구조는 새로운 요구사항 추가에 있어서 기존 코드를 수정해야할 가능성이 농후하네요..



4. 상속관계에서 연관관계로 리팩토링.


사실 모든 상속관계는 연관관계(has-a) 로 풀 수 있습니다. (Favor has-a over is-a )


우리는 이 규칙을 Observer 패턴의 리뷰 중 [자바 내장 모듈의 한계 및 극복] 에서 다뤄본 적이 있습니다.



연관관계를 이용하면, 상속관계를 실행시간에 동적으로 정의해줄 수 있습니다.


Decorator 패턴은 이러한 연관관계를 이용하여 기능의 변화를 수행하기 위한 패턴입니다.


이를 이용하여 현재 문제로 드러난 "상속에 의한 컴파일 시점에 정의된 재료의 변경 문제" 를 해결할 수 있을 것 같아 보이며, 연관관계이기 때문에 "재료 추가 및 변경에 대해 자유" 를 기대해 볼 수 있을 것 같습니다.


한 번, 장식을 위한 클래스를 다음과 같이 정의해보죠..


장식(Decorator) 객체는 기본적으로 장식 대상 객체와 동일한 Type 이며, 

장식된 객체는 기존의 객체를 대신하여 역할을 수행할 수 있도록 구현할 것입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/**
 * 조미료가 되는 클래스 정의.
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public abstract class CondimentDecorator extends Coffee {
 
    private Coffee coffee;
 
    /**
     * 커피를 has-a 관계로 표현.
     *
     * @param coffee
     */
    public CondimentDecorator(Coffee coffee) {
        this.coffee = coffee;
    }
 
    /**
     * 커피를 출력하도록 변경.
     *
     * @return
     */
    protected Coffee getCoffee() {
        return this.coffee;
    }
}
 
cs


생성자 부분에서는 장식대상이 되는 객체를 입력받아 has-a 관계로 유지하고자 합니다.

행위의 추가는 장식대상이 되는 객체를 사용하여, 구현을 할 것입니다.


이제, 아래와 같이 장식을 구현해 볼 수 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/**
 * 우유 데코레이터
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public class MilkDecorator extends CondimentDecorator{
    public MilkDecorator(Coffee coffee) {
        super(coffee);
    }
    /**
     * 장식대상 객체이름을 그대로 사용.
     *
     * @return
     */
    @Override
    public String getName() {
        return getCoffee().getName();
    }
    /**
     * 우유 가격인 900 원 추가.
     *
     * @return
     */
    @Override
    public Integer getCost() {
        return getCoffee().getCost() + 900;
    }
}
 
/**
 * 라떼 데코레이터
 *
 * Created by Doohyun on 2017. 6. 25..
 */
public class LatteDecorator extends CondimentDecorator {
 
    public LatteDecorator(Coffee coffee) {
        super(coffee);
    }
 
    /**
     * 이름을 재정의.
     *
     * @return
     */
    @Override
    public String getName() {
        return "라떼";
    }
 
    /**
     * 가격은 장식 대상 객체의 기존 가격을 그대로 사용.
     *
     * @return
     */
    @Override
    public Integer getCost() {
        return getCoffee().getCost();
    }
}
cs


우유와 관련된 기능은 MilkDecorator 로 구현하여, 장식대상 객체의 가격을 900원 상승시키도록 하였습니다.


LatteDecorator 는 장식대상 객체의 명을 "라떼"로 변경하는 기능을 담당합니다. 

가격은 그대로군요.


우리는 이 장식들을 이용하여, HouseBlendingEspresso 객체 대하여 동적으로 상속받는 것과 같은 효과를 줄 수 있습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
Coffee coffee = new HouseBlendingEspresso();
System.out.println(String.format("커피명 : %s, 커피가격 : %d", coffee.getName(), coffee.getCost()));
 
// 우유 데코레이터로 치장.
coffee = new MilkDecorator(coffee);
// 라떼 데코레이터로 치장.
coffee = new LatteDecorator(coffee);
 
System.out.println(String.format("커피명 : %s, 커피가격 : %d", coffee.getName(), coffee.getCost()));
 
// CONSOLE LOG
// 커피명 : 하우스블렌딩 에스프레소, 커피가격 : 5000
// 커피명 : 라떼, 커피가격 : 5900
cs


만약 샷을 추가하는 기능을 제작한다면, 


마찬가지로 ShotDecorator 를 제작하여 치장을 해줄 수 있을 것 같습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/**
 * 샷을 추가하는 데코레이터
 * 
 * Created by Doohyun on 2017. 6. 25..
 */
public class ShotDecorator extends CondimentDecorator{
 
    public ShotDecorator(Coffee coffee) {
        super(coffee);
    }
 
    @Override
    public Integer getCost() {
        return getCoffee().getCost() + 500;
    }
 
    @Override
    public String getName() {
        return getCoffee().getName();
    }
}
 
Coffee coffee = new HouseBlendingEspresso();
System.out.println(String.format("커피명 : %s, 커피가격 : %d", coffee.getName(), coffee.getCost()));
 
// 우유 데코레이터로 치장.
coffee = new MilkDecorator(coffee);
// 라떼 데코레이터로 치장.
coffee = new LatteDecorator(coffee);
 
// 더블샷 데코레이터 치장.
coffee = new ShotDecorator(coffee);
coffee = new ShotDecorator(coffee);
 
System.out.println(String.format("커피명 : %s, 커피가격 : %d", coffee.getName(), coffee.getCost()));
 
// CONSOLE LOG
// 커피명 : 하우스블렌딩 에스프레소, 커피가격 : 5000
// 커피명 : 라떼, 커피가격 : 6900
cs


이러한 장식구조를 이용하여 동적으로 상속구조를 취할 수 있으며, 

자주 사용할 법한 클래스(이를테면, Americano, Latte)들은 내부에서 일정한 방식으로 장식하도록 하는 프리셋을 만들어 제공해 줄 수 있을 것 같군요.


[샷추가나 시럽추가]와 같은 추가기능에도 대응이 가능할 것 같습니다.



Decorator 패턴은 이와 같이 행위 추가를 하고자 하는 타겟 객체를 has-a 관계로 유지함으로써, 적절하게 기존 기능에 행위를 추가를 할 수 있는 패턴입니다.


이는 상속을 이용하여 메소드를 재정의하는 것과 비슷하지만, 


- 실행시간에 동적으로 상속구조를 흉내낼 수 있다는 점


- 상속구조에 따라 클래스를 생성하는 것이 아닌, 장식의 조립을 통해 객체를 생성한다는 점


복잡한 클래스의 상속구조에서 벗어나는 것에 큰 도움이 될 것입니다.


위의 예제에 대하여, 정리가 된 [실행 가능 프로젝트] 를 제공하며 이번 포스팅을 마무리합니다.

이 글이 모두에게 도움이 되길 바랍니다.


 

STUDY_OOP8.zip


반응형
Posted by N'

이번 포스팅은 마지막 스터디 시간에 잠시 언급을 했던 [리팩토링]이라는 주제에 대한 내용을 다뤄보고자 합니다. 

많은 개발자들이 리팩토링을 언급하는 경우가 종종있지만, 이 개념에 대해 오해하는 사람들도 종종 있으며 단순히 코드정리라고 생각하는 경우도 많이 있는 듯 합니다.


지난 시간에 진행한 스터디에서는 Martin Fowler 의 [리팩토링-코드 품질을 개선하는 객체지향 사고법] 에 서술된 내용을 기반으로 진행을 하였으며, 보다 자세한 리뷰를 이번 포스팅에서 작성하고자 합니다.


이 책이 궁금하신 분은 아래 링크를 참고해보세요. 


리팩토링 - 코드 품질을 개선하는 객체지향 사고법
국내도서
저자 : 마틴 파울러(Martin Fowler) / 김지원역
출판 : 한빛미디어 2012.11.09
상세보기


지난 스터디에서 진행했던 자료는 아래 링크에서 확인하실 수 있습니다. :-)



크게 다뤄볼 목차는 리팩토링의 개념과 필요성, 그리고 여러 방법들을 제시해 볼 생각입니다.


특히, 방법같은 경우는 새로운 개념이 아닌 우리가 보통 코드 정리를 위해 하고 있는 내용들이 주를 이룰 수도 있습니다. (즉 갑자기 새로운 개념이 등장하지는 않습니다. ㅡㅡ^)



1. 리팩토링의 개념.


리팩토링이란 이미 구현된 일련의 행위에 대한 변경 없이, 내부 구조를 변경하는 것을 말합니다.

내부 구조를 변경하는 이유는 코드의 가독성과 유지보수성을 향상시키기 위함이죠.


이 개념은 성능을 최적화하는 문제와는 다릅니다.

성능 최적화는 사실 기능을 추가하는 문제와 크게 다르지 않습니다. 


즉, 구현된 행위에 대한 스펙변경 없이 코드 품질을 위해 내부 구조를 변경하는 것을 의미합니다.


이 책의 저자인 Martin Fowler 는 


"컴퓨터가 이해하는 코드는 어느 바보나 짤 수 있다. 좋은 프로그래머는 사람이 이해하는 코드를 짠다."


라고 말했습니다.


즉, 같이 일하는 주체는 사람이며, 나중에 코드를 리뷰 해야할 주체(보통은 나... 종종 나..) 역시 사람이 때문에 이 과정은 매우 중요한 듯 합니다. 



2. 리팩토링의 필요성.


소프트웨어 개발에 있어서, 리팩토링을 하는 과정은 꽤 중요한 이슈입니다.


일단, 리팩토링 과정을 통해 중복된 코드를 함수로 만들거나 모듈로 빼내는 등의 작업들을 통해 소프트웨어 공학에서 말하는 유지보수성을 키울 수 있습니다. 즉 이러한 일련의 과정들은 전체적으로 소프트웨어 설계의 질적 향상을 불러올 수 있습니다.


이러한 소프트웨어 설계의 질적 향상은 일련의 행위에 대한 가독성을 높일 수 있을 것입니다.

같이 일하는 동료, 혹은 유지보수해야하는 본인을 위해서라도 가독성있는 코드를 작성하는 것이 중요하겠죠? 


또한, 전반적인 코드 개선의 과정을 통해 버그 수정을 수월하게 할 수 있습니다.


이런 전반적으로 좋은 코드를 바탕으로 요구사항을 수용하는 것은 과적으로 개발시간의 단축 및 강건한 프로그램을 만드는 것에 도움이 될 것입니다.



3. 리팩토링의 시점.


리팩토링 과정은 강건하고 유지보수성이 좋은 소프트웨어를 만들기 위한 과정이며, 계속해서 프로젝트를 좋은 설계 기반 위에 얹을 수 있을 것입니다.


하지만, 아무 때나 모든 코드를 깔끔하게 정리해야할까요?

그것은 조금 시간낭비일 수 있습니다. 이미 잘 작동하며, 요구사항 추가에 대한 명세가 없는 모든 모듈을 굳이 수정하는 것은 정말로 할 것이 없을 때 연습을 위해서 좋을 수도 있습니다.


[리팩토링-코드 품질을 개선하는 객체지향 사고법] 에서는 어느 정도 제안하는 리팩토링의 시점이 있으며, 이는 다음과 같습니다.


- The Rule of Three


유사한 것을 세 번하면, 리팩토링을 고려해 볼 필요가 있을 것 같습니다.

보통을 유사한 과정을 캡슐화하여, 추후 재활용을 도모합니다.


- 새로운 기능을 개발할 때.


현재 구현되어 있는 상태가 새로운 요구사항을 받아들이기 힘들 때 리팩토링을 합니다.

확장에 열려있게 수정하고(OCP), 기능을 추가하는 것이 더 수월할 것입니다.


이 때, 중요한 것은 리팩토링을 할 때는 기능을 추가하지 말고, 기능을 추가할 때는 리팩토링을 하지 않기를 권장합니다. (Two Hats)


- 버그를 수정할 때


당연한 이야기이지만, 코드에 대한 이해도가 높아지면 버그 수정이 쉬워질 것입니다.

난해한 코드 속에서 버그 수정을 하기 보다는, 리팩토링 과정을 통해 어느정도 가독성 및 이해도를 갖추고 수정하는 것이 빠른 경우가 있을 수 있습니다.


- 코드 리뷰를 할 때


팀원들과 진행하는 코드 리뷰 과정을 통해 리팩토링을 할 수 있습니다.


실력이 좋은 개발자일지라도 너무 본인이 작성한 코드를 집중해서 보면, 객관적인 가독성 및 유지보수성, 논리적 오류 등을 찾기 쉽지 않을 수 있습니다.


즉, 타인이 같이 봐주는 코드 리뷰나 페어 프로그래밍 등의 과정은 본인이 작성한 코드의 가독성 및 유지보수성을 높게 할 수 있으며, 특히 주니어 개발자들이 노하우 기반의 성장할 수 있는 기회일 수 있습니다.


하지만, 너무 많은 사람이 이 활동에 참여하면 비효율적이라고 합니다.

적당한 소수인원이 진행하는 코드리뷰가 권장됩니다.



4. 리팩토링 방법


언급한 바와 같이 리팩토링은 구현된 일련의 행위 변경 없이, 코드의 유지보수성, 확장용이성 등을 높게 하기 위해 내부 구조를 변경하는 작업입니다.


하지만, 막연하게 코드정리를 한다는 것은 아닌 듯 합니다. 

리팩토링 하는 방법과 그에 대한 이름 역시 존재합니다. 하지만, 이 방법들은 이미 여러분들이 알고 있는 방법일 수 있습니다.


- 테스트 코드 작성


리팩토링을 하기 전에 가장 먼저 작업해야할 것은 테스트 코드를 작성하는 것입니다.

기능을 유지하고 코드를 개선하는 것이 목적이며, 코드 수정 뒤에 기능이 이전과 동일하게 작동하는 지 확인을 할 필요가 있습니다.


이는 사실 리팩토링 과정에서만 필요한 것은 아닙니다.

보통 특정 기능을 만든다고 할 때, 코드 작성이 끝이 아닌 기능 단위의 검증이 수반되어야 합니다. 


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/**
 * 개인별 평가종류에 대한 기능이 잘 작동되는지에 대한 테스트.
 */
@Test
public void 개인별_평가종류_테스트() {
 
    // 동일 조건 테스트 케이스 제작.
    final Integer companySubjectSn = 1001;
    final Integer hrAppraisalSn = 20;
    final Integer memberSubjectSn = 1;
 
    /**
     * 테스트 결과 목록
     */
    List<Integer> targetHrAppraisalKindSnList = hrAppraisalOperateExecuteService.readTargetHrAppraisalKinsSnList(
                                                                                            companySubjectSn
                                                                                            , hrAppraisalSn
                                                                                            , memberSubjectSn);
 
    // 테스트에 대한 결과 명시..
    System.out.println(String.format("회사순번 %d, 평가순번 : %d, 구성원 순번 : %d", companySubjectSn, hrAppraisalSn, memberSubjectSn));
    System.out.println("평가종류순번 테스트 : " + targetHrAppraisalKindSnList);
}
cs



- Extract Method


너무 길게 작성된 메소드에 대하여, 일련의 특정 행위를 캡슐화하여 메소드로 분리하는 작업입니다. 

(철자 그대로 메소드 추출입니다.)

메소드가 길게 작성 되었다는 것은 해당 메소드의 책임이 너무 많음을 의미할 수 있습니다. 

그렇기 때문에 일련의 특정 행위를 메소드로 추출하는 작업은 일종의 책임의 분배를 하는 작업일 수 있습니다. (SRP)


보통은 이해가 필요한 부분에 대하여, 분리 후 주석을 명시하는 편입니다.

주석을 명시하는 것 외에도 메소드의 이름은 짧고 기능을 잘 설명할 수 있어야 한다고 합니다.


하지만, 제 생각에는 메소드의 라인이 너무 길게 작성 되었다고 무조건 메소드로 추출하는 것은 반대입니다. 재활용할 여지가 없는 로직을 굳이 분리하여 코드의 흐름이나 디버깅 등의 불편함을 주고 싶지는 않습니다.


메소드 추출 대신에, [block] 을 이용해보는 방법을 저는 제안합니다.

길게 작성된 로직에 대하여, 아래와 같이 block 으로 단계를 나누고 주석을 명시한다면 아무리 긴 로직도 가독성을 크게 해치지 않을 것입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public void tooLongMethod() {
 
    /**
     * Map 주석 쓰는법.
     *
     * 대상자순번에 대한 이름 그룹
     *
     * key : 대상자 순번
     * value : 이름
     */
    final Map<Integer, String> recipientByNameMap;
    {
        // recipientByNameMap 을 만들기 위해 어떠한 일련의 과정을 하는중..
        // Refactoring 원칙에 따르면, 이 곳은 새 메소드로써 정의 해야함.
    }
 
    // 대상자순번에 대한 이름 그룹을 통해 이름_순번 string 을 가진 목록을 출력        
    // 자료구조를 상수화. 내부를 변경하지도 말 것.
    // 메소드 내에 많은 변수는 버그를 양산하기 쉬움.       
    final List<String> recipientBarcodeList;
    {
 
    }
}
cs


block 방식의 코드 작성은 사실 실제 메소드로 추출만 안했을 뿐이지, 캡슐화를 한 것과 별반 다르지 않습니다. 변경사항이 생겼다면, 특정 block 만 수정을 함으로써 메소드를 추출했던 것과 같은 효과를 볼 수 있습니다.


추 후, 재사용성을 위해 메소드로 추출해야 한다면, 해당 block 을 메소드로 만들고 치환하면 됩니다. 


아래는 구성원에 대한 이름 그룹을 만드는 과정을 Extract method 한 결과입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
public void tooLongMethod() {
 
    /**
     * Map 주석 쓰는법.
     *
     * 대상자순번에 대한 이름 그룹
     *
     * key : 대상자 순번
     * value : 이름
     */
    final Map<Integer, String> recipientByNameMap = getRecipientByNameMap();
 
    // 대상자순번에 대한 이름 그룹을 통해 이름_순번 string 을 가진 목록을 출력        
    // 자료구조를 상수화. 내부를 변경하지도 말 것.
    // 메소드 내에 많은 변수는 버그를 양산하기 쉬움.       
    final List<String> recipientBarcodeList;
    {
 
    }
}
 
/**
 * 대상자 순번에 대한 이름 그룹 출력.
 *
 * <pre>
 * key : 대상자 순번
 * value : 이름
 * </pre>
 *
 * @return
 */
public Map<Integer, String> getRecipientByNameMap() {
    // recipientByNameMap 을 만들기 위해 어떠한 일련의 과정을 하는중..
    // Refactoring 원칙에 따르면, 이 곳은 새 메소드로써 정의 해야함.
}
cs



- Move Method 


한 클래스의 메소드가 타 모듈에서 너무 많이 사용되거나, 해당 클래스의 상태를 전혀 사용하지 않는다면 메소드의 위치를 변경할 것을 제안합니다.


다른 모듈에서 훨씬 많이 사용하는 경우.


해당 메소드를 많이 사용하는 모듈로 이동시키고, 기존 클래스에서는 이동시킨 모듈을 이용한 위임호출로 기존 기능을 유지해 볼 수 있을 것 같습니다.



- 상태를 전혀 사용하지 않는 경우.


클래스는 상태와 행위를 결합하여 관리하고자 생긴 개념입니다.


하지만, 행위 자체가 상태를 동반하지 않는다면 이 메소드를 정적 메소드로 변경을 해볼 수 있을 것 같습니다. 

(특정 주체에 대하여, 정적 메소드가 많아진다면 Util 클래스의 제작을 고려합시다..)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public class MemberVo {
    private String name;
 
    public MemberVo(String name) {
        this.name = name;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    /**
     * 상태를 사용하지 않는 메소드는 정적 메소드로 만들길 권장.
     * 
     * @param name
     * @return
     */
    public static String GetMemberFormatter(String name) {
        return String.format("그 사람의 이름 : ", name);
    }
}
cs



- 불필요한 임시변수 제거


대부분의 임시 변수는 사실 메소드로 대체할 수 있습니다. 

임시 변수의 사용은 메소드의 길이를 증가시키고, 버그를 양산할 여지가 있습니다.

(임시변수를 많은 곳에서 변경하면, 디버깅 및 유지보수가 힘들 수도....)


하지만, STEP-BY-STEP 으로 작성된 코드를 리뷰함에 있어서, 상태를 잠시 어느 순간까지 가지고 있는 것은 오히려 가독성에 더 좋을 수 있습니다.

그렇지만, 변수 상태로 남겨두면 [사이드-이펙트]를 일으킬 여지가 있으니, 상수형으로 상태를 유지시키는 것도 하나의 방법이라고 할 수 있습니다. 자료구조 역시, 영속 자료구조(내부가 바뀌지 않는 구조)를 유지 해야겠죠?


아래는, 임시변수를 메소드로 대체한 것과 특정 상태를 상수로 유지하는 방법입니다.

제 입장은 가독성 및 디버깅을 위해서라도 상수형태의 상태를 남겨, STEP 별로 읽을 수 있도록 하는 것을 권장합니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public void tempMethodProcessing() {
 
    // 임시 변수 제거.
    // 메소드로 변수를 대체. 코드 길이를 줄일 수 있음.
    {
        for (MemberVo memberVo : memberDao.selectList(companySn)) {
            // something work!!
        }
    }
 
    // 상수로써, 데이터를 잠시 관리
    // 이 것이 오히려 디버깅이나 가독성면에서 보다 좋을 수 있음
    {
        final List<MemberVo> memberVoList = memberDao.selectList(companySn);
 
        for (MemberVo memberVo: memberVoList) {
            // something work!!
        }
    }
}
cs



- 분기 제거


일련의 분기처리 과정은 조건의 추가 및 삭제에 유연하지 못할 수 있습니다.

이는 요구사항 추가에 따라 분기한 과정들을 모두 살펴보며, 수정을 해야함을 의미합니다.


객체지향 다형성(Polymorphism)으로 이 문제를 해결할 수 있습니다.

특정 조건들 즉 상태를 객체로 관리함으로써, 기존 구조의 변경 없이 확장을 하는 것을 지향합니다.(OCP)


우리는 이에 대한 내용을 꽤 많이 다뤄보았습니다.



대표적으로 분기를 제거할 수 있는 패턴에는 방문자(Visitor), 전략(Strategy), 상태(State) 패턴 등이 있습니다. 


하지만, 모든 구조를 if 없이 구현하겠다는 의지는 좋지 않습니다. 

패턴에 의한 코드의 파편화는 결국 코드의 난이도를 올리며, 극한으로 작성된 패턴들은 오히려 가독성을 많이 저해할 수 있습니다.


요즘의 대세는 주니어가 봐도 이해하기 좋은 코드를 작성하는 것인 듯 합니다.



5. 리팩토링의 한계와 극복


리팩토링은 매우 중요한 일이지만, 모든 상황에 대하여 리팩토링할 수는 없는 것 같습니다. ㅡㅡ^

상황은 언제나 좋은 방향으로만 흘러가는 것이 아니니 말이죠. (가끔 좋지 않은 방향으로, 아니 종종...)


그렇기 때문에 이번 절에서는 리팩토링의 한계와 극복방법에 대해 다뤄보려 합니다.



- DataBase 스키마의 변경


우리가 작성하는 많은 응용 프로그램들의 로직들은 DB 스키마와 매우 밀접한 의존을 가지고 있습니다. 

아무리 잘 작성된 코드도 DB 스키마의 변경에서 자유로울 수는 없을 것 같군요....


DB 스키마의 변경에 따라 당연히 응용 프로그램 역시 변화에 대처를 해야하지만, 그 대처를 최소화하는 방법이 없는 것은 아닌 듯 합니다. 


DB 스키마 클래스와 비지니스 로직간의 중간 층(Layer)을 두고, 많은 응용프로그램에서 이 중간 층을 이용하여 개발을 한다면 생각보다 많은 부분을 변경하지 않아도 될 수도 있습니다.

스키마 변경에 따라 중간 층에만 최대한의 수정을 할 수 있다면 좋겠죠? :-)


우리는 이 방법 역시 배운적이 있습니다.

맞습니다. 여기서 말하는 중간 층은 바로 어댑터(Adapter) 입니다.



저는 이 방법을 매우 지향합니다. 

사내에서 제 역할인 [백-엔드 개발자]로써, [프론트-엔드 개발자]에게 특정 요청에 필요한 정보만 적재적소하게 줄 수 있도록 제어를 하는 편입니다.


이 방법은 DB 스키마 변경에 따른 프론트-엔드 개발자의 영역의 변화를 최소화할 수 있으며, 최근 마감기한을 앞두고 새로운 요구사항에 의해 엎어질 뻔한 프로젝트를 구할 수 있는 [최고의 한방]이 되었습니다.



- 메소드 서명의 변경


우리는 경우에 따라 이미 개발되었고 잘 사용하고 있는 메소드를 수정할 경우가 종종 있습니다.


메소드 내부의 구조의 개선이나 최적화 등은 그나마 괜찮지만, 메소드의 서명을 변경하는 해당 메소드를 사용하는 모든 곳을 고쳐야 하기 때문에 안타까운 일이 발생할 수 있습니다.


이런 경우, 우리는 오버로드 방식을 한 번 고려해볼 수 있습니다.


즉, 기존 서명은 남기고, 새 서명을 가진 메소드를 제작하는 것입니다. 

물론 기존 서명은 새 서명을 가진 메소드를 사용하게 함으로써, 코드중복을 없앨 수 있겠죠? 


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
 * 회사 순번과 구성원 순번으로 이용하여 데이터를 조회
 * 
 * <pre>
 *     하지만, 이제는 구성원 순번 목록을 이용하여 조회해야함.
 *     즉 해당 메소드는 구서명임..
 *     
 *     새로 작성된 서명을 사용하는 방식으로 내부구조를 개선..
 * </pre>
 * 
 * @param companySubjectSn
 * @param memberSubjectSn
 * @return
 */
public List<MemberVo> selectMemberList(Integer companySubjectSn, Integer memberSubjectSn) {
    return selectMemberList(companySubjectSn, Arrays.asList(memberSubjectSn));
}
 
/**
 * 새로 만든 서명.
 * 
 * 회사순번과 구성원 순번 목록으로 데이터를 조회.
 * 
 * @param companySubjectSn
 * @param memberSubjectSnList
 * @return
 */
public List<MemberVo> selectMemberList(Integer companySubjectSn, List<Integer> memberSubjectSnList) {
    // something Work!!
}
cs


만약 기존 서명을 더이상 팀의 구성원들이 지금부터라도 사용하길 지양한다면, 사장(Deprecated) 를 고려하는 것도 좋습니다.


사장을 시켰다면, 문서에 아래와 같이 사장 사유와 우회법을 명시하세요. :-)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/**
 * 회사 순번과 구성원 순번으로 이용하여 데이터를 조회
 * 
 * <pre>     
 *     Deprecated 사유 : 이 메소드는 오직 구성원 순번만 받고 있음. 
 *                      새 서명을 가진, 구성원 순번 목록을 이용하여 조회하는 새 서명을 가진 MemberDao::selectMemberList 을 사용하길 권장.
 * </pre> 
 * 
 * @param companySubjectSn
 * @param memberSubjectSn
 * @return
 */
@Deprecated
public List<MemberVo> selectMemberList(Integer companySubjectSn, Integer memberSubjectSn) {
    return selectMemberList(companySubjectSn, Arrays.asList(memberSubjectSn));
}
cs



- 리팩토링 보다는 재개발을....


작성된 기존 코드의 설계가 새 요구사항을 수용하기에 있어서, 많은 변화가 있어야 한다면 처음부터 다시 작성하는 편이 좋을 수도 있습니다.


단, 대부분의 기능이 정상적으로 작동을 할 때 이 방법을 해야할지도 모릅니다.

[버그 투성이 코드]를 참고하여 만든 새로운 코드 역시 [버그 투성이] 겠죠... ㅡㅡ^


하지만, 새로 작성하기에 시간이 부족하거나 너무 많을 경우 기존 코드를 세부 컴포넌트로 분리를 해볼 것을 제안합니다. 분리된 세부 컴포넌트들 중 특정 컴포넌트만 재개발을 하면 되는 경우도 종종 존재합니다.



- 마감시간이 다되었다면, 리팩토링은 잠시 보류...


마감시간이 다되었을 때, 리팩토링 등의 코드개선은 좋아 보이지 않습니다.

(당신의 상사에게 뒷통수를 맞을 수 있습니다... )


이미 잘 작동하며 테스트까지 끝낸 모듈에 마감시간을 앞두고 리팩토링을 하다가 버그를 심는 멍청한 짓은 좋지 못합니다.


또한, 프로그래머의 코드 철학도 중요하지만 이 제품을 쓸 고객과의 약속이 더 중요합니다.


이 내용들의 기반은 저에게 OOP 를 알려주신 교수님의 자료와 [리팩토링-코드품질을 개선하는 객체지향 사고법] 의 내용을 바탕으로 작성되었지만, 실무에서 약 2년정도 참여해보며 후배들에게 꼭 알려주고 싶은 이야기들을 담은 것 같습니다.


아직 부족한 것이 많지만, 경험을 통해 이 사례가 좋았다고 느낀 점들을 특히 부각시켜 서술하였습니다. 

(그래서 약간 꼰대 같을 수도 ㅜㅡㅜ)



어찌하든, 이 것으로 [CHAPTER X] 도 끝입니다. 


끝까지 읽어주신 여러분 정말로 감사합니다. :-)


반응형
Posted by N'

6. 리팩토링.pdf



마지막 스터디에서 잠시 진행했던, Extra 챕터입니다. 


모두들 수고하셨습니다. @.@ [꾸벅][꾸벅]



참고자료 

- 한국기술교육대학교 - 객체지향개발론및실습 (김상진 교수님)

- Refactoring


추가내용!


Refactoring.zip


이 곳의 내용을 보충할 실습 코드를 첨부합니다.




반응형
Posted by N'

Observer 패턴에 다루는 마지막 포스팅입니다. 


정말, 이 패턴에 대해 할 말이 많군요...

그만큼 많이 사용하고 유명한 패턴이기 때문에 그런 듯 합니다.

(그렇다고, Observer 패턴은 사랑은 아닙니다...     ㅡㅡ^)


Observer 패턴과 관련된 정보는 아래에서 참고!



앞써, 언급한 바와 같이 Observer 패턴은 매우 많이 사용하는 패턴입니다.

그렇기 때문에 JAVA 를 만든 개발자들은 이 패턴을 보다 적극적으로 활용할 수 있도록, JDK1.0 부터 모듈을 배포하였습니다.


오늘 포스팅에서는 지난 포스팅에서 만든 예제를 자바의 Observer 패턴 관련 클래스를 이용하여 리팩토링해보려 합니다. 대상 프로젝트는 "[CHAPTER 5] 실무 활용 패턴 (하) [Observer 패턴] + 추가내용2" 하단에서 다운로드 할 수 있습니다.


일단, 자바에서 제공하는 내장 모듈인 Observable 과 Observer 부터 소개를 해보겠습니다.



1. 자바 내장 모듈 [Observable 과 Observer]


앞써, 알아봤던 Observer 패턴에서는 크게 두 개의 컴포넌트가 있음을 확인했습니다.

바로 주제(Subject)와 관찰자(Observer) 입니다. 기억이 나시나요?


자바 내장 모듈은 이 [두 개의 컴포넌트]들을 쉽게 제작할 수 있도록 지원하고 있습니다.


- Observable [java.util.Observable]


주제(Subject)에 해당하는 컴포넌트를 만들 수 있도록 지원하는 클래스입니다. 

변화를 통보할 대상인 [Observer 인터페이스]목록을 Thread-safe 하게 관리하며, 통보할 수 있는 메소드를 지원하고 있습니다.


통보하는 메소드는 물론 PUSH, PULL 방식 모두 지원하도록 설계되어 있습니다.


1
2
3
4
5
// PULL 방식 notify. (아무것도 보내지 않는 방식)
observable.notifyObservers();
        
// PUSH 방식 notify. (아쉽게도, 통보할 때 보내는 데이터 타입은 한 개로 제한..)
observable.notifyObservers(memberList);
cs


편리해보이지만, 주의해볼만한 사항은 Observable 이 class 라는 점입니다.

Observer 인터페이스들을 관리해야하는 로직을 담아야하기 때문에 interface 로 제작할 수는 없었던 듯 합니다.


- Observer [java.util.Observer]


관찰자(Observer)에 해당하는 컴포넌트를 만들 수 있도록 지원하는 인터페이스입니다.

이 전 예제의 IObserver 를 대체할 수 있겠군요.


Observer 의 내부를 보면, 아래와 같습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
public interface Observer {
    /**
     * This method is called whenever the observed object is changed. An
     * application calls an <tt>Observable</tt> object's
     * <code>notifyObservers</code> method to have all the object's
     * observers notified of the change.
     *
     * @param   o     the observable object.
     * @param   arg   an argument passed to the <code>notifyObservers</code>
     *                 method.
     */
    void update(Observable o, Object arg);
}
cs


파라미터로는 [주제에 해당하는 Observable o] 과 [Push 방식을 통해 전달되는 데이터인 Object args] 이 존재 합니다. 


[Object args]의 주석을 보면, Observable::notifyObservers 를 통해 넘겨지는 데이터가 온다고 써있습니다. 즉, PUSH 방식으로 통보를 하면 통보 시 전달한 데이터가 넘어오고, PULL 방식을 사용하면 NULL 임을 짐작할 수 있을 것 같습니다.



쉽게 사용할 수 있도록 제작된 모듈이니, 이 정도면 한 번 모듈을 사용해서 Observer 패턴을 구현해 볼 수 있을 것 같군요. 


한번, 지난 포스팅에서 작성한 예제를 바탕으로 리팩토링을 한번 해볼까요? 



2. 내장 모듈을 사용한 리팩토링


이미 우리는 Observer 패턴을 구현하였기 때문에 JDK 의 내장모듈을 쉽게 부착할 수 있을 지도 모릅니다. 


먼저 우리가 작성했던 주제(Subject) 컴포넌트인 DataManager 부터 손을 보도록 하죠.


DataManager 클래스는 Observable 클래스를 상속받을 예정이며, 이를 통해 Observer 를 관리하던 메소드 및 멤버변수도 삭제할 것입니다. 


저는 아래와 같이 만들어 봤습니다. (정확히 말하면, 기능 삭제만 했습니다. @.@)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/**
 * 메신저에서 사용하는 데이터를 총괄적으로 관리하는 데이터 매니저.
 *
 * <pre>
 *     Observable 를 상속!
 *     그러나, 추 후 DataManager 가 상속받아야 하는 클래스가 있으면 문제 발생.
 *     (JAVA 는 다중상속을 할 수 없음..)
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 16..
 */
public class DataManager extends Observable{
 
    // 통보대상 집합 (삭제. Observable 클래스가 지원)
    // private HashSet<IObserver> iObserverSet = new HashSet<>();
 
    /**
     * 옵저버 추가
     *
     * <pre>
     *     Deprecated 사유 : Observable::addObserver 를 통해 이 기능을 대체 가능.
     *
     *     삭제할 것.
     * </pre>
     *
     * @param observer
     */
    @Deprecated
    public void registerObserver(IObserver observer) {
      //  iObserverSet.add(observer);
    }
 
    /**
     * 옵저버 삭제
     *
     * <pre>
     *     Deprecated 사유 : Observable::deleteObserver 를 통해 이 기능을 대체 가능.
     *
     *     삭제할 것.
     * </pre>
     *
     * @param observer
     */
    @Deprecated
    public void deleteObserver(IObserver observer) {
     //   iObserverSet.remove(observer);
    }
 
    /**
     * 각 옵저버에게 현재 상태 데이터를 넘기면서, 변경사실을 알린다.
     *
     * <pre>
     *     Deprecated 사유 : Observable::notifyObservers 를 통해 이 기능을 대체 가능.
     *
     *     삭제할 것.
     * </pre>
     *
     */
    @Deprecated
    public void notifyObserver() {
     /*   for (IObserver observer : iObserverSet) {
           observer.update(this);
        }*/
    }
 
   /**
     * 서버로부터 데이터 로드
     *
     * <pre>
     *     각 정보 목록들은 한 트랜잭션에서 동시에 갱신된다고 가정.
     * </pre>
     *
     * @param memberVoList
     * @param approvalDocList
     * @param messageVoList
     */
    public void loadByServer(List<MemberVo> memberVoList, List<ApprovalDoc> approvalDocList, List<MessageVo> messageVoList) {
        // something work
 
        // 변화가 일어났음을 알림. (이 메소드 호출을 통해 자주 통보하는 것을 막을 수 있음)
        setChanged();
 
        // Observable::notifyObservers 기능 사용. PULL 방식
        notifyObservers();
    }
}
cs


Observer 를 관리하는 서명들은 위에서 모두 주석 혹은 사장(Deprecated) 처리가 되었지만, 최종적으로 삭제할 것입니다. 


Observable 을 상속받음으로써, DataManager 는 서버로부터 전달된 데이터만 업데이트 하고,  Observable::setChanged와 Observable::notifyObservers 만 사용해주면 되는군요. 


여기서, 주목할 것은 Observable::setChanged로 상태 변화가 일어났음을 나타내는 메소드 입니다. 

이 메소드를 통해 너무 자주 통보되는 것을 막을 수 있으며, 이를 호출하지 않고 Observable::notifyObservers 만 호출하면 아무 일도 일어나지 않습니다. 

적절한 비지니스 로직으로 Observable::setChanged 를 제어할 수 있을 것 입니다.


즉 구현에 있어서 Observer 관련 내용을 신경쓰지 않아도 됩니다.



이제 관찰자(Observer) 컴포넌트를 수정할 차례입니다. 


우리는 이전에 IObserver 를 구현하는 데모 View 컴포넌트를 만든 적이 있습니다. 

이제는 Observer 를 구현하도록 수정하고, IObserver 와 작별을 할 것입니다. :-)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class DemoViewComponent_V1 implements Observer {
 
    /**
     * 화면 갱신
     *
     * @param o
     * @param arg
     */
    @Override
    public void update(Observable o, Object arg) {
        if (instanceof DataManager) {
            final DataManager dataManager = (DataManager) o;
 
            // 구성원 정보 업데이트.
            {
                // 유연한 구성원 데이터 조회
                final List<MemberVo> memberVoList = dataManager.getMemberList();
                viewUpdateByMember(memberVoList);
            }
 
            // 전자결재 정보 업데이트.
            {
                // 유연한 전자결재 데이터 조회
                final List<ApprovalDoc> approvalDocList = dataManager.getApprovalDocList();
                viewUpdateByApprovalDoc(approvalDocList);
            }
        }
    }
}
cs


일단, DataManager 의 서명이 변경되었으니 테스트 코드 쪽에서도 불이 났을 것입니다. 

테스트 코드 역시 조금 수정을 할 필요가 있겠군요. 


새 메소드 서명에 따라 다음과 같이 변경할 수 있어 보입니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// 데이터 매니저 생성
DataManager dataManager = new DataManager();
 
// 데모 View 컴포넌트 생성.
DemoViewComponent_V1 demoViewComponent_v1 = new DemoViewComponent_V1();
DemoViewComponent_V2 demoViewComponent_v2 = new DemoViewComponent_V2();
 
// 각 컴포넌트들이 Data 변경알림에 대해 구독하겠다고 등록.
dataManager.addObserver(demoViewComponent_v1);
dataManager.addObserver(demoViewComponent_v2);
 
// something work
dataManager.loadByServer(
        Arrays.asList(new MemberVo("강현지"), new MemberVo("유덕형"), new MemberVo("유형주"))
        , Arrays.asList(new ApprovalDoc("통과 - 스터디 신청"))
        , Arrays.asList(new MessageVo("모두, 스터디 참여 잘해줘서 감사합니다."), new MessageVo("그동안 수고하셨습니다.")));
 
 
// CONSOLE LOG
// 데모2 메시지 View 화면 갱신 중..
// [모두, 스터디 참여 잘해줘서 감사합니다.] 갱신 중
// [그동안 수고하셨습니다.] 갱신 중
// 데모2 메시지 View 화면 갱신 완료!!
// 
// 데모1 구성원 View 화면 갱신 중..
// [강현지] 갱신 중
// [유덕형] 갱신 중
// [유형주] 갱신 중
// 데모1 구성원 View 화면 갱신 완료!!
// 
// 데모1 전자결재 View 화면 갱신 중..
// [통과 - 스터디 신청] 갱신 중
// 데모1 전자결재 View 화면 갱신 완료!!
cs


다행히 DataManager 의 변화에 따라 View 컴포넌트들이 적절한 행위를 잘 해주는 군요. :-)



3. 자바 내장 모듈의 한계와 극복


Observable 과 Observer 를 사용하면 편리하게 Observer 패턴을 사용할 수 있음을 확인하였습니다. 

하지만, 이 내장 모듈에는 한계가 존재합니다. Observable 이 클래스라는 것이죠. 


Observable 을 개발한 개발자의 의도는 Observable 을 상속받길 원했겠지만, 아쉽게도 DataManager 에 상속을 해야할 일이 있다고 가정해봅시다.


Java 에서는 다중상속을 지원하지 않으니, Observable 을 상속하는 것을 포기해야 합니다.

또한 상태의 변화가 있다고 체크하는 Observable::setChanged 는 protected 입니다. 상속이 힘들다고, DataManager 에 Observable 인스턴스를 만들어 관리한다 하더라도 Observer 들에게 통보를 할 수 없습니다. 


이는, 설계원칙 Favor has-a over is-a (상속해야하는 것을 has-a 로 바꿀 수 있어야 한다.)에 위배됩니다. 

안타깝군요. ㅜㅡㅜ


하지만 조금 돌아가면 방법이 없지는 않습니다.

Observable 을 상속한 다른 클래스(이를테면, MessengerObservable) 을 만들고, DataManager 가 MessengerObservable 을 has-a 관계로 취할 수 있을 것 같습니다.


저는 이렇게 작성을 해보았습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/**
 * 메신저에서 사용할 Observable 클래스
 *
 * <pre>
 *     DataManager 에 직접 상속을 할 수 없기 때문에, 해당 클래스를 제작.
 *     DataManager 가 Observable 을 사용하기 위해서는 이 모듈을 사용해야함.
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 18..
 */
public class MessengerObservable extends Observable{
 
    /**
     * Observer 에게 통보
     *
     * <pre>
     *     - setChanged 메소드는 해당 클래스에서 제어.
     *     - Observer 들이 DataManager 에 접근할 수 있도록 PUSH 방식 Observer 패턴을 사용.
     * </pre>
     */
    @Override
    public void notifyObservers(Object dataManager) {
        this.setChanged();
 
        // PUSH 방식 Observer 패턴 사용을 통해 DataManager 를 넘김.
        super.notifyObservers(dataManager);
    }
 
}
 
/**
 * 메신저에서 사용하는 데이터를 총괄적으로 관리하는 데이터 매니저.
 *
 * <pre>
 *     Observable 를 상속불가 우회
 *     - MessengerObservable 를 has-a 관계로 처리.
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 16..
 */
public class DataManager extends SomethingSuperObject{
 
    private MessengerObservable messengerObservable = new MessengerObservable();
 
    /**
     * 추가 메소드 지원.
     *
     * <pre>
     *     - MessengerObservable 에 Observer 추가.
     * </pre>
     *
     * @param observer
     */
    public void addObserver(Observer observer) {
        messengerObservable.addObserver(observer);
    }
 
    /**
     * 삭제 메소드 지원.
     *
     * <pre>
     *     - MessengerObservable 에서 Observer 삭제.
     * </pre>
     *
     * @param observer
     */
    public void deleteObserver(Observer observer) {
        messengerObservable.deleteObserver(observer);
    }
 
    /**
     * 서버로부터 데이터 로드
     *
     * <pre>
     *     각 정보 목록들은 한 트랜잭션에서 동시에 갱신된다고 가정.
     * </pre>
     *
     * @param memberVoList
     * @param approvalDocList
     * @param messageVoList
     */
    public void loadByServer(List<MemberVo> memberVoList, List<ApprovalDoc> approvalDocList, List<MessageVo> messageVoList) {
        // something work!!
 
        // PUSH 방식으로 우회.
        messengerObservable.notifyObservers(this);
    }
}
 
/**
 * 데모 View 갱신 컴포넌트 (V1)
 *
 * <pre>
 *     - 구성원과 전자결재 화면을 업데이트.
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 17..
 */
public class DemoViewComponent_V1 implements Observer {
 
    /**
     * 화면 갱신
     *
     * @param o
     * @param arg
     */
    @Override
    public void update(Observable o, Object arg) {
 
        if (arg instanceof DataManager) {
            final DataManager dataManager = (DataManager) arg;
 
            // 구성원 정보 업데이트.
            {
                // 유연한 구성원 데이터 조회
                final List<MemberVo> memberVoList = dataManager.getMemberList();
                viewUpdateByMember(memberVoList);
            }
 
            // 전자결재 정보 업데이트.
            {
                // 유연한 전자결재 데이터 조회
                final List<ApprovalDoc> approvalDocList = dataManager.getApprovalDocList();
                viewUpdateByApprovalDoc(approvalDocList);
            }
        }
    }
}
 
cs


주목할 점은 MessengerObservable 이 PUSH 방식으로 DataManager 를 전달하기 때문에, Observer 구현체들은 두번째 파라미터인 Object arg 를 통해 DataManager 를 찾아야 합니다.


드디어, Observer 패턴과 관련된 모든 내용이 끝이 났고, 동시에 이번 스터디에서 진행예정이던 모든 패턴이 끝이 났습니다. (ㅜㅡㅜ)


이 포스팅의 결과물 프로젝트는 아래에서 참고! 



STUDY_OOP7.zip



마지막 패턴이야기라 그런지 유종의 미를 잘 거두고 싶었습니다. 

그래서 더욱 자세히 쓰고자 이 패턴에 대해 세 개의 포스팅으로 나누어 작성 했었던 것 같습니다.


주 독자와 나누는 마지막 패턴 이야기라 조금 섭섭하기도 하기도 하고, 더 알려줄 것이 없나 고민도 하게 되었던 것 같습니다. 그래서 빨리 끝낼 수 있는 걸 질질 끌었던 것 같기도.....


특히 최근에 마지막 스터디를 진행하기 전 날, [대학교 1학년]-[SW멤버십 회원]-[M사 신입사원]-[스터디 진행]까지의 있었던 일들이 주마등처럼 지나갔었습니다. 


[문과출신 공대생]이라는 핸디캡 극복을 위해 노력했었고, [4학년 동기들 중 2학년이었던 SW멤버십]에서 끝까지 살아남기 위해 발버둥을 쳤으며, [M사 신입사원] 시절 사내에서 아무도 하지 않았기 때문에 누군가의 도움도 기대할 수 없는 솔루션급 앱들을 밤새 만들고 고치며 끝내 좌절하던 경험들은 저에게 뼈아픈 교훈들만 주었던 것 같습니다.


최근에 읽었던 칼럼 중 [지금의 실력은 지식의 총합이 아닌 고통의 총합] 이라는 글은 이 때의 일을 주마등처럼 지나가게 한 촉매가 아니었나 생각이 듭니다. 


하지만, 이런 뼈아픈 교훈들은 안타깝게도 급격한 실력의 변화를 주지는 못하던 것 같습니다. 


최근에 읽었던 [소프트웨어 장인], [구글 리쿠르팅 데이의 타 회사 세션] 등의 내용을 참고하면, 앞에서 끌어주는 [메이저 주니어 이상급의 개발자]들의 활동은 무시할 수 없어보였습니다. 이를테면 페어 프로그래밍이나 코드 리뷰, 본질에 가까운 OOP&디자인 패턴 교육 등은 주니어들의 레벨을 올리는 것에 크게 기여하는 것 같아 보였습니다.


결론은 모두가 뼈아픈 교훈을 얻어갈 필요는 없는 것 같습니다. :-)

이 블로그의 글들은 대단하지 않으며 꽃길로 인도할 수도 없지만, 조금이나마 진흙을 덜 밟는데 도움이 되길 바랍니다.


감사합니다.










반응형
Posted by N'

지난 포스팅에서는 특정 주제의 변화에 따라 여러 클래스가 어떤 행위를 해야할 때, 즉 이벤트 처리를 하기 위한 대표적인 패턴인 Observer 패턴에 대해 알아보았습니다.


간단한 예제 프로그램도 한 번 작성해보았죠? :-)


해당 내용과 관련된 정보는 아래에서 참고! 



이번 포스팅에서는 지난 스터디에서 작성한 코드에 대한 약간의 리팩토링을 담을 예정입니다.


조금 더 유연한 구조를 한번 제시해 볼 생각이며, 작업 대상이 되는 프로젝트는 "실무 활용 패턴 (하) [Observer 패턴] + 추가내용" 의 하단에서 다운로드 하실 수 있습니다.


일단, 고민이 되는 이슈부터 기술을 해보도록 하죵...



1. IObserver 인터페이스의 메소드 서명은 적절한가?


구체화 된 View 컴포넌트들에게 DataManager 의 상태 변화를 알리고자, DIP 원리에 따라 추상적인 개념인 IObserver 를 만들었습니다.


아래와 같이 말이죠..


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
 * 옵저버 인터페이스 제작
 *
 * Created by Doohyun on 2017. 6. 17..
 */
public interface IObserver {
 
    /**
     * 주체의 데이터가 변경될 때, 이 메소드를 실행
     *
     * <pre>
     *     - 업데이트 이벤트를 이 메소드를 통해 받을 수 있음.
     *     - 변경된 데이터가 파라미터로 넘어오는 것을 보장. 이 방식 PUSH 방식 옵저버 패턴이라고 함.
     * </pre>
     *
     * @param memberVoList
     * @param approvalDocList
     * @param messageVoList
     */
    void update(List<MemberVo> memberVoList, List<ApprovalDoc> approvalDocList, List<MessageVo> messageVoList);
}
cs


DataManager 는 통보할 대상을 IObserver 로 관리함으로써 각 ViewComponent 들과의 직접적인 의존관계를 끊을 수 있었고, ViewComponent 들 역시 IObserver 를 구현함으로써 DataManager 에게 쉽게 구독여부를 등록할 수 있었습니다.


하지만, 이런 고민을 해볼 수 있습니다.


- 구체화된 View 컴포넌트들은 사실 모든 정보가 필요하지 않습니다. 

  

테스트로 구현해본 [DemoViewComponent_V1 은 구성원정보와 전자결재 정보]만 필요했습니다. 또한 [DemoViewComponent_V2 는 메시지 정보]만 필요했죠..


- 데이터 형식 추가에 취약해보입니다.


현재 배포할 버전에서는 구성원, 전자결재, 메시지 정보만 필요하지만, 추 후 근태정보, 평가정보 등 다른 정보가 추가되어야 한다면 IObserver::update 서명을 수정해야합니다.


인터페이스 서명의 변경은 구현된 모든 클래스들도 변경해야 함을 의미합니다.


결국, DataManager 의 통보를 하기 위한 방식에 조금 문제가 있어보이네요.

큰 구조에서 봤을 때 Subject-Observer 의 관계는 잘 나누었지만, 디테일한 부분을 조금 더 리팩토링해주면 좋을 것 같습니다.


다행히, 아직 View 컴포넌트들이 많이 생성되지 않았으니 구조를 조금 변경해볼까요? :-)



2. 통보방식의 변경


현재 IObserver:update 의 메소드 서명을 보면, 상태의 변화사실과 함께 변경된 데이터를 같이 전달하는 방식입니다. 지난 시간에 이 방식을 PUSH 방식의 Observer 패턴이라고 설명을 했었습니다.


하지만 이 방식은 결국 전달할 데이터들을 메소드 서명에 명시해야하며, 이는 전달할 데이터 형식에 유연할 수 없음을 의미합니다. 유연할 수 없는 데이터 형식 때문에 데이터 형식의 추가/삭제가 힘들고, 모든 관찰자(Observer)는 원하지도 않는 데이터들을 강제로 받아야 하죠.


그렇다면, 관찰자들이 조금은 능동적으로 본인이 원하는 정보만 취할 수 있다면 어떨까요?

주제(Subject)는 관찰자들에게 변경사실만 알리고, 관찰자들이 알아서 주제로부터 상태를 조회하는 방식이죠.


인터페이스를 다음과 같이 변경해보겠습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
 * 옵저버 인터페이스 제작
 *
 * Created by Doohyun on 2017. 6. 17..
 */
public interface IObserver {
 
    /**
     * 주체의 데이터가 변경될 때, 이 메소드를 실행
     *
     * <pre>
     *     - 업데이트 이벤트를 이 메소드를 통해 받을 수 있음.
     *     - 이 메소드에서는 직접적으로 변경된 데이터를 보내지 않음.
     *     - Subject 인스턴스를 전달하여, 관찰자들이 능동적으로 원하는 방식을 취하는 방식.
     *     - 이 방식 Pull 방식 옵저버 패턴이라고 함.
     * </pre>
     *
     * @param dataManager
     */
    void update(DataManager dataManager);
}
cs


변경된 IObserver::update 는 통보와 함께 변경된 데이터들을 전달하는 것이 아닌, 주제 클래스를 전달하고 있습니다. 


각 IObserver 들의 구현체들은 변경을 통보 받을 시, 전달받은 주제(DataManager) 클래스로부터 원하는 데이터를 유연하게 조회할 수 있을 것입니다. 

이와 같이, 주제는 변경에 대한 통보만 하고 데이터는 관찰자들이 주제로부터 직접적으로 데이터를 조회하는 방식 PULL 방식 옵저버 패턴이라고 합니다.


구성원 데이터와 전자결재 데이터가 필요했던, DemoViewComponent_V1 을 저는 다음과 같이 수정해 보았습니다.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/**
 * 데모 View 갱신 컴포넌트 (V1)
 *
 * <pre>
 *     - 구성원과 전자결재 화면을 업데이트.
 * </pre>
 *
 * Created by Doohyun on 2017. 6. 17..
 */
public class DemoViewComponent_V1 implements IObserver {
 
    /**
     * 화면 갱신.
     *
     * @param dataManager
     */
    @Override
    public void update(DataManager dataManager) {
        // 구성원 정보 업데이트.
        {
            // 유연한 구성원 데이터 조회
            final List<MemberVo> memberVoList = dataManager.getMemberList();
            viewUpdateByMember(memberVoList);
        }
 
        // 전자결재 정보 업데이트.
        {
            // 유연한 전자결재 데이터 조회
            final List<ApprovalDoc> approvalDocList = dataManager.getApprovalDocList();
            viewUpdateByApprovalDoc(approvalDocList);
        }
    }
 
    /**
     * 구성원 화면 업데이트
     *
     * @param memberVoList
     */
    public void viewUpdateByMember(List<MemberVo> memberVoList) {
        System.out.println("데모1 구성원 View 화면 갱신 중..");
 
        for (MemberVo memberVo : memberVoList) {
            System.out.printf("[%s] 갱신 중\n", memberVo.getName());
        }
 
        System.out.println("데모1 구성원 View 화면 갱신 완료!!\n");
    }
 
    /**
     * 전자결재 화면 업데이트
     *
     * @param approvalDocList
     */
    public void viewUpdateByApprovalDoc(List<ApprovalDoc> approvalDocList) {
        System.out.println("데모1 전자결재 View 화면 갱신 중..");
 
        for (ApprovalDoc memberVo : approvalDocList) {
            System.out.printf("[%s] 갱신 중\n", memberVo.getTitle());
        }
 
        System.out.println("데모1 전자결재 View 화면 갱신 완료!!\n");
    }
}
 
cs


PULL 방식 옵저버 패턴을 통해, 각 View 컴포넌트들은 원하는 데이터들만 주제로부터 유연하게 조회할 수 있겠군요. 


또한 데이터 형식이 추가된다 하더라도 IObserver 인터페이스를 수정할 필요가 없습니다. 

더이상 IObserver:update 에서 데이터 형식에 대한 서명을 명시할 필요가 없기 때문이죠.


이와 같이 상태변화를 통보하는 방식에 따라 PUSH 와 PULL 방식이 존재합니다. 

실전에서 이 패턴을 쓰기 전에, 이 두 방식에 대해 조금 더 Zoom-In 해서 볼 필요가 있을 것 같네요.



3. PUSH vs PULL


앞써, 기술한 것과 같이 상태변화 통보 방식에 따라 Observer 패턴을 [PUSH 과 PULL], 두 방식으로 크게 나눌 수 있습니다. 


두 방식에는 다음과 같은 특징이 존재합니다.


- PUSH


주제가 상태변화를 통보를 할 때, 관찰자에게 변화된 정보까지 제공하는 방식입니다.


관찰자들은 주제가 어떤 녀석인지 알 필요도 알고 싶지도 않습니다. 

단지, 무언가에 의해 통보사실과 함께 관심있는 데이터를 이용해 원하는 행위를 취하면 되죠.

소프트웨어 공학적으로 말하면, 모듈 간의 결합도(Coupling)를 낮출 수 있습니다.

좋은 프로그램은 모듈 간 낮은 결합도와 높은 응집성을 갖는 것이 이상적 입니다.


하지만, 통보받은 새 정보 중에는 알고 싶지 않은 정보도 포함되어 있습니다. 

또한 정보타입의 추가에 유연할 수가 없습니다.


- PULL


주제는 단지 상태 변화만을 통보하며, 변화된 정보는 관찰자가 주제로 부터 별도로 정보를 요구하는 방식입니다.


관찰자 입장에서는 원하는 정보를 유연하고 편리하게 요구할 수 있습니다.

또한, 정보 타입 추가에도 별도로 관찰자들을 수정을 하지 않아도 됩니다. (OCP 하군요..)


하지만, 관찰자들은 주제로 부터 정보를 별도로 요구해야 하기 때문에 주제에 대해 많은 것을 알아야 합니다. 즉 모듈 간 결합도가 증가했습니다. (tight-Coupling)


극단적인 경우, 동시성 처리를 할 시 제공받는 정보의 질이 다를 수 있습니다. 

[상태 변화 당시의 정보]와 [별도로 요구할 때의 정보]가 Thread-safe 하지 않을 수 있습니다. 


보통 권장하는 스타일은 변화에 보다 유연한 PULL 방식의 옵저버 패턴이지만, 실전에서 필요한 요구사항에 따라 적절한 방식을 선택해야 겠죠? 



오늘 포스팅에서는 추가로 제안되는 PULL 방식의 Observer 패턴을 다뤄 보았습니다.


변경된 소스는 아래 프로젝트 파일을 참고!


STUDY_OOP7.zip


Observer 패턴 자체도 많이 사용하기 때문에 중요한 패턴이지만, PUSH vs PULL 의 개념 등은 패턴 외에도 큰 모듈들 간의 관계 자체에서도 흔하게 등장하기 때문에 더욱 소개하고 싶었습니다.


또한, 지난 포스팅에서 다룬 이벤트 감지 방법인 Polling vs Interrupt 개념도 중요합니당..


흔히, 사용하는 Source-Tree 도 [프로젝트 상태 변경 사실을 표시]하고, 우리가 [PULL 을 받도록] 하죠? 프로젝트 상태 변경 사실은 [주기적으로 체크하는 Polling 방식]을 사용합니다.


이렇게 우리가 흔히 사용하는 응용 프로그램에서도 이 개념들을 많이 찾아볼 수 있습니다.


그래서 이번 주제는 단지, 디자인 패턴 뿐 아니라 소프트웨어 공학적인 여러 개념까지 다뤄 볼 수 있는 기회 였던 것 같아 뿌듯하네요.. ㅎㅎ


이 글을 보는 많은 분들에게 도움이 되었으면 좋겠습니다.:-)


반응형
Posted by N'