Whiteship's Note


Form Template Method



각각의 서브 클래스에, 동일한 순서로 비슷한 단계를 행하지만 단계가 완전히 같지는 않은 두 메소드가 있다면,
그 단계를 동일한 시그너처를 가진 메소드로 만들어라.
이렇게 하면 원래의 두 메소드는 서로 같아지므로, 수퍼클래스로 올릴 수 있다.

동기
상속을 통해서 중복을 제거할 때 서브 클래스들에 있는 비슷한 메소드들을 본질적인 차이점만을 남겨놓고 중복을 제거할 수 있다. 이와 관련된 패턴으로 Template Method 패턴이 있다.

절차
1. 메소드를 분해해서 동일 한 부분과 다른 부분을 나눈다.
2. 동일한 부분을 Pull Up Method를 사용하여 수퍼클래스로 올린다.
3. 다른 부분을 정의한 메소드를 수퍼클래스에서 추상 메소드로 선언한다.
4. 서브 클래스에는 다른 부분을 정의한 메소드를 제외하고 모두 제거한다.
5. 각 단계마다 컴파일, 테스트를 한다.

예제
예제 코드는 Extract Superclass에서 사용했던 코드를 그대로 사용합니다.
0. Extract Superclass로 상위 클래스를 만듭니다.
사용자 삽입 이미지

1. 메소드를 고정적인 부분과 유동적인 부분으로 분해합니다.
- before
사용자 삽입 이미지
- Alt + Shift + M 을 사용하여 메소드로 빼낼 수 있습니다.
사용자 삽입 이미지
- after
사용자 삽입 이미지

2. Pull Up Method를 사용하여 공통된 부분을 상위 클래스로 옮깁니다.
- 이 때 Alt + Shift + T 로 리팩토링 메뉴를 열고 Pull Up Method를 사용할 수 있습니다.
사용자 삽입 이미지

3. 수퍼클래스에서 추상 메소드로 변경되는 내용을 지닌 메소드를 만들어 줍니다.
- 변경되는 부분의 메소드가 올라가지 않았기 때문에 수퍼클래스에서 에러가 납니다. 에러가 발생한 라인에서 퀵 픽스(Ctrl + 1)를 사용하여 만들 수 있습니다.
사용자 삽입 이미지
- abstract protected void doService(Task task);
메소드에 abstract를 붙여주면 클래스도 추상 클래스가 되어야 하며 그럼 추상 클래스의 이름 앞에도 Abstract를 붙여주는 것이 좋겠습니다. Package Explorer에서 클래스르 선택하고 F2 를 클릭하여 클래스 이름을 변경할 수 있습니다.
사용자 삽입 이미지
4. 서브클래스를 정리합니다.
- 현재 작업한 서브 클래스는 전부 변경이 되었겠지만 다른쪽 서버클래스는 별다른 작업이 없었기 때문에 공통 부분을 제거하고 추상 메소드를 구현해 줍니다. 이때도 퀵 픽스를 사용하면 편리합니다.


'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top


Extract Super Class



비슷한 메소드와 필드를 가진 두 개의 클래스가 있다면, 슈퍼클래스를 만들어서 공통된 메소드와 필드를 수퍼클래스로 옮겨라.
동기
중복을 제거 할 수 있습니다.

절차
1. 빈 수퍼 클래스를 만들고 원래 클래스들이 이것을 상속하도록 한다.
2. Pull Up Filed, Pull Up Method, Pull Up Contruct Body들을 사용하여 공통 요소들을 옮긴다.
3. 옮길 때 마다 테스트를 한다.
4. 공통된 부분이 있다면 Extract Method를 사용한 뒤에 Pull Up Method를 사용할 수 있다.

예제
리팩터링 대상이 된 두 개의 클래스들
- AddController.java

more..

- UpdateController.java

more..


리팩터링
1. 상위 클래스를 만들고 각각의 클래스들이 그 클래스를 상속 받도록 한다.
Eclipse를 사용하신다면 리팩터링 대상이 된 클래스에서 Alt + Shift + T를 클릭하여 리팩터링 메뉴를 띄우고 Extract Super Class를 선택할 수 있습니다.
사용자 삽입 이미지

2. 상위 클래스의 이름을 설정하고 상위로 빼낼 멤버들을 선택합니다.
사용자 삽입 이미지

3. Eclipse의 리팩터링 기능을 사용하여 만들어진 클래스를 상속 받도록 수정 되었습니다.
사용자 삽입 이미지

4. 다른 클래스는 수동으로 상속 받고 있는 클래스를 수정해 주거나 상속 하도록 코드를 수정하고 공통 요소를 하나 둘 빼내거나 Pull Up XXX 리팩토링 기능을 사용하여 옮길 수 있습니다.

참조 : Refactoring

'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top


Introduce Parameter Object



참조 : http://www.refactoring.com/catalog/introduceParameterObject.html

여러개의 파라미터를 가지는 메소드의 경우 그 일련의 파라미터들을 가지는 새로운 객체 타입을 받도록 변경할 수 있습니다.

사용자 삽입 이미지

Eclipse의 refactoring 기능 중에 저런 리팩터링을 지원하는 것이 없는지 찾아봤지만 못찾았습니다. 있으면 좋으련만...
http://dev.eclipse.org/mhonarc/lists/eclipse-pmc/msg00188.html
http://download.eclipse.org/eclipse/downloads/drops/S-3.3M7-200705031400/eclipse-news-M7.html
위 글들을 보니 Eclipse3.3의 refactoring 기능에 추가해 줄 것 같습니다.

하나의 메소드 안에 뭉탱이로 들어가는 인자들이 있다면 그 인자들끼리 관계가 밀접할 수 있으며 해당 객체에서 따로 빼내는 것이 애플리케이션을 더 유연하게 만들 수 있습니다.

메소드에 넘겨줄 인자가 단순해집니다.

'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top


Extract Class




두 개의 클래스가 해야 할 일을 하나의 클래스가 하고 있는 경우,
새로운 클래스를 만들어서 관련 있는 필드와 메소드를 예전 클래에서 새로운 클래스로 옮겨라.

동기

클래스가 너무 많은 메소드와 데이터를 가지고 있어서 쉽게 이해할 수 없는 경우가 있다. 이때 데이터의 부분집합과 메소드의 부분집합이 몰려 다닌다면 새로운 클래스로 분리할 수 있다는 좋은 신호다.

절차
  1. 클래스의 책임을 어떻게 나눌지를 결정하라.
  2. 분리된 책임을 떠맡을 새로운 클래스를 만든다.
    • 책임을 분리한 후 이전 클래스의 책임이 이름과 더 이상 맞지 않는다면, 이전 클래스의 이름을 변경한다.
  3. 이전 클래스에서 새로 만든 클래스에 대한 링크를 만든다.
    • 양방향 링크가 필요할지도 모른다. 그러나 필요해지기 전에는 새로 만든 클래스에서 이전 클래스로 링크를 만들지 마라.
  4. 옮기고자 하는 각각의 필드에 대해 Move Field를 사용한다.
  5. 각각의 필드를 옮길 때마다 컴파일, 테스트를 한다.
  6. Move Method를 사용해서 이전 클래스에서 새로 만든 클래스로 메소드를 옮긴다. 저수준 메소드(호출하기 보다는 호출되는 메소드)부터 시작해서 짐점 고수준의 메소드에 적용한다.
  7. 각각의 메소드를 옮길 때마다 컴파이르 테스트를 한다.
  8. 각 클래스를 검토하고, 인터페이스를 줄인다.
    • 양방향 링크를 가지고 있다면, 단바양 링크로 만들 수 있는지 알아본다.
  9. 새로운 클래스를 공개할지 결정한다. 새로운 클래슬 공개하기로 결정했다면, 참조 객체로 드러낼지 또는 불변성 값 객체(immutable value object)로 드러낼지를 결정한다.
예제

코드보기



위 예제 코드를 보시면 officeAreaCode와 officeNumber 데이타가 몰려 다니고 거기에 따른 getter와 setter들이 몰려 다니는 것을 볼 수 있습니다. 이것을 TelephoneNumber라는 class로 따로 뽑아내기 위해 먼저 TelephoneNumber 클래스를 만들고 Move Field를 사용합니다.

이클립스에서 클래스를 만들고 이동하고자 하는 필드를 선택하고 Alt + Shift + v 를 클릭하면 다음과 같은 팝업창이 뜨게 되고 이동시킬 클래슬 선택할 수 있다.


하지만 단순히 데이터만 옮겨 줄뿐 거기에 딸린 getter와 setter를 같이 옮겨 주지 않는 것은 조금 아쉬웠다. 이번에는 옮기고 싶은 것을 통째로 드래그를 해보았다. 그러나 메소드를 옮기는 일이 쉽지가 않은 듯하다.

결국 잘라내기 붙여넣기를 사용하여 아래와 같이 두개의 클래로 분리하였다.

Person 클래스 보기


TelephoneNumber 클래스 보기




'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top


Substitute Algorithm



알고리즘을 보다 명환한 것으로 바꾸고 싶을 때는, 메소드의 몸체를 새로운 알고리즘으로 바꾼다.



위 코드를 보시면 people이라는 문자열 배열안에 Don, John, Kent라는 이름이 있는지 확인하고 만약에 있다면 해당하는 이름을 반환하는 메소드 입니다. 이것을 좀더 명확하게 표현하자면 아래와 같이 변경할 수 있습니다.


동기

어떤 것을 할 때 여러가지 방법이 있다면 그 중에 쉬운 것이 있다면 그것을 선택할 것입니다. 알고리즘도 마찬가지로 여러가지 방법 중에 좀더 명확한 방법을 선택하여야 합니다. 이 작업을 할 때는 가능한 많이 메소드를 분해해 두어야 합니다. 크고 복잡한 알고리즘을 바꾸는 것은 어렵기 때문이죠.

절차
  1. 대체 알고리즘을 준비한다. 적용하여 컴파일한다.
  2. 알고리즘을 테스트한다. 만약 결과가 같다면 작업은 끝난 것이다.
  3. 만약 결과가 같지 않다면, 테스트에서 비교하기 위해 예전의 알고리즘을 사용하여 디버깅한다.
    • 예전 알고리즘과 새 알고리즘에 대해 각각의 테스트 케이스를 실행시키고 두 결과를 본다. 이것은 어떤 테스트 케이스가 어떻게 문제를 일으키는지 찾는 데에 도움을 줄 것이다.

'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top


Pull Up Method



동일한 일을 하는 메소드를 여러 서브클래스에서 가지고 있다면, 이 메소드를 수퍼클래스로 옮겨라.


동기
  • 중복된 동작을 제거해야 하기 때문입니다. 한쪽은 바꿨는데 다른 쪽은 그대로 라면 수정하기도 번거롭고 나중에 버그가 될 가능성이 높을 것입니다.
Pull Up Method가 필요한 경우는 서브클래스에 있는 메소드가 수퍼클래스에 있는 메소드를 오버라이드하는데 여전히 같은 일을 하는 때입니다.
이 때 성사긴 것은 서브클래스의 메소드에서 수퍼클래스에 없는 메소드나 변수를 참조할 때입니다. 이 때는 메소드도 같이 일반화하거나 수퍼클래스에 추상 메소드를 만들 수 있습니다. (이럴 때 메소드의 시그너쳐를 변경하거나 위임 메소드(?)를 만들어야 할 지도 모른다고 합니다.)
비슷하지만 동일한 메소드가 아닐때는 Form Template Method를 사용할 수 있을지도 모릅니다.

절차
  1. 메소드들을 조사해서 그것이 동일한지 확인한다.
    • 만약 같은 일을 하지만 코드가 다른경우 메소드들 중 하나에 Substitute Algorithm을 사용하여 코드가 동일하게 만들어라.
  2. 메소드가 서로 다른 시그너쳐를 가지고 있다면, 수퍼 클래스에서 사용하고 싶은 시그너처로 바꾼다.
  3. 수퍼클래스에 새로운 메소드를 만들고, 메소드들 중 하나의 몸체를 새로운 메소드에 복사해서 적절히 수정한 후 컴파일한다.
    • 그 메소드가 수퍼클래스에 없는 메소드를 호출한다면, 수퍼클래스에 추상 메소드를 만들어라.
    • 수퍼클래스에 없는 필드를 사용한다면, Pull Up Field 또는 Self Encapsulate Field를 사용하고 추상 get메소드를 선언하여 사용하라.
  4. 서브클래스 중 하나를 골라서 메소드를 삭제한다.
  5. 컴파일, 테스트를 한다.
  6. 수퍼 클래스 메소드만 남을 떄까지 서브클래 메소드를 삭제하고 테스트를 계속한다.
  7. 필요한 타입을 수퍼클래스로 변경할 수 있는지 살펴보기 위해서 이 메소드의 호출부를 살펴본다.
예제

두 개의 서브클래스(RegularCustomer, PreferredCustomer)를 가진 Customer 클래스가 있다. 그리고 두 서브클래스에 있는 createBill 메소드는 둘다 다음과 같은 코드로 동일하다.

void createBill(Date date) {
   double chargeAmount = chatgeFor(lastBillDate, date);
   addBill(date, charge);
}


색칠 된 부분의 코드가 모두 중복되고 있지만 둘 중에 녹색으로 칠해진 chargeFor 메소드는 위로 복사해서 옮길 수가 없습니다. 클래스 몸체가 서브클래스마다 다르기 때문입니다. 이때는 수퍼클래스에 추상 메소드로 선언합니다.


addBill 메소드는 수퍼클래스로 옮겼고 chargeFor 메소드는 수퍼클래스에 추상 메소드로 선언했습니다.(UML 표기상 추상 메소드는 이탤릭체로 표기합니다. 그리고 추상 메소드를 가진 클래스는 추상 클래스가 되기 때문에 클래스 이름도 이탤릭체로 표기했습니다.)

'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top


Extract Method



그룹으로 함꼐 묶을 수 있는 코드 조각이 있으면 코드의 목적이 잘 드러나도록 메소드의 이름을 지어 별도의 메소드로 뽑아낸다.


동기

지나치게 긴 메소드나 주석이 필요한 코드를 보면 그 부분을 하나의 메소드로 뽑는다.(Martin Fowler 曰).
  1. 메소드가 잘게 쪼개져 있을 때 다른 곳에서 사용하기 좋다.
  2. High-level의 메소드를 보면 주석을 읽는 것 같은 느낌이 들도록 할 수 있다.
  3. 오버라이드 하는 것도 훨씬 쉽다.
작은 메소드들은 작명을 잘했을 때 그 진가를 드러내므로 이름을 잘 짓도록 하자.

절차
  1. 메소드를 새로 만들고, 무엇을 하는지를 나타내도록 이름을 정한다.
  2. 원래 메소드에서 뽑아내고자 했던 부분을 복사하여 새 메소드로 옮긴다.
  3. 원래 메소드에서 사용되고 있는 지역변수가 뽑아낸 코드에 있는지 확인한다. 있으면 새로운 메소드의 임시변수로 선언한다.
  4. 뽑아낸 코드 안에서 지역변수의 값이 변화는지 확인한다. 만약에 하나의 지역변수만 수정 된다면, 뽑아낸 코드를 질의(query)로 보고, 수정된 결과를 관련된 변수에 대입할 수 있는지 본다. 이렇게 하는 것이 이상하거나, 값이 수정되는 지역변수가 두개 이상 있다면 쉽게 메소드로 추출할 수 없는 경우이다. 이럴 때는 Split Temporary Variable을 사용한 다음 다시 시도해야 한다. 임시변수는 Replace Temp with Query로 제거할 수 있다.
  5. 뽑아낸 코드에서 읽기만 하는 코드는 파라미터로 넘긴다.
  6. 지역변수와 관련된 사항을 다룬 후에는 컴파일을 한다.
  7. 원래 메소드에서 새로 만든 메소드를 호출하도록 바꾼다.
  8. 컴파일과 테스트를 한다.
예제 : 지역변수가 없는 경우
위 코드에서 처음에 수정할 부분은 노란색으로 표시된 부분입니다. 매우 단순한 경우이기 때문에 잘라서 새로운 메소드로 붙여넣고 저 노란 부분에서 새로운 메소드를 호출하면 되겠습니다.

이클립스에서 리팩토링 할 부분을 드래그 한 상태에서 Alt + Shift + m 을 클릭합니다. 그리고 새로운 메소드의 이름을 적어 줍니다.
그리고 OK 버튼을 클릭하면...
짠... 멋지게 처리해 주는 군요.. 주석만 빼고. ^^; 주석은 Ctrl + d (행삭제)를 사용하여 지워줍시다.

예제 : 지역변수가 포함되어 있는 경우

지역변수가 옮겨질 코드에 들어있는 경우 중에 가장 쉬운 경우가 바로 그 지역변수를 읽기만 하는 경우입니다.  이런 경우에는 변수를 파라미터로 넘겨주면 됩니다.


이번에는 저 노란 부분을 메소드로 뽑아 낼 것입니다. 보아하니 _name이라는 변수와 outstanding이라는 변수를 사용하고 있는데 outstanding만 지역변수고 _name은 필드네요. 따라서 outstanding만 넘겨주면 되겠습니다. 메소드  이름은 printDetails로 하는군요. 이번에도 뽑아내고 싶은 부분을 드래그 하고 Alt + Shift + m ...와오..


똑똑한 이클립스... 파라미터가 필요한 줄 알고.. 그것도 딱 지역변수만.. 아 정말 똑똑하네요. 역시 OK만 누르면..


대단합니다. 이클립스.

예제 : 지역변수에 다른 값을 여러 번 대입하는 경우 (마지막입니다. :)

이 경우는 복잡한데 이런 경우 중 임시변수에 대해서만 생각을 해봅니다. (파라미터에 다른 값을 대입하는 코드가 있다면 즉시 Remove Assignments to Parameters를 적용해야 한다.)만약에 그 임시변수가 뽑아내는 코드에서만 사용이 된다면 뽑아낸 코드로 그냥 그 임시변수까지 이동하면 되겠습니다. 하지만 그 임시변수가 뽑아내는 코드 밖에서도 사용이 된다면 뽑아낸 코드에서 그 값을 리턴해 주어야 합니다.
노란 부분을 보시면 each라는 임시변수는 뽑아내게 될 코드 안에서만 사용되는 것을 볼 수 있습니다. 그렇기 때문에 그냥 이동 시키면 되겠지요

위에 보이는 노란 부분이 뽑아 낼 부분입니다. 저 중에 each는 노란 부분에서만 쓰이기 때문에 당연히 그냥 빼내는 메소드로 이동하면 되겠습니다. 하지만 문제는 outstanding인데 이 변수가 printDetails 메소드에서 사용되고 있습니다. 따라서 위의 코드에서 계산 부분의 코드를 뽑아내고 outstaning의 값을 리턴하도록 합니다.

이번에는 이클립스의 덕을 잘 못보겠더군요.

임시변수가 너무 많아 코드를 뽑아내기 어려울 때는 Replace Temp with Query를 사용하여 임시변수를 줄이고 어떻게 해봐도 여전히 난처할 때는 Replace Method with Method Object를 사용한다. 이 리팩토링은 임시변수가 얼마나 많든, 그리고 뭘 하든 상관하지 않는다.


'Refactoring > 5~ 12장 Catalogue' 카테고리의 다른 글

Form Template Method  (0) 2007.07.06
Extract Super Class  (0) 2007.07.05
Introduce Parameter Object  (0) 2007.06.06
Extract Class  (0) 2006.10.08
Substitute Algorithm  (0) 2006.10.07
Pull Up Method  (0) 2006.10.07
Extract Method  (0) 2006.10.06
top