어떤 프로그램이든 가장 기본적인 단위는 함수이다.
//코드 3-1
//리팩토링 이전 소스
public static String testableHtml(PageData pageData, boolean includeSuiteSetup ) throws Exception {
WikiPage wikiPage = pageData.getWikiPage();
StringBuffer buffer = new StringBuffer();
if (pageData.hasAttribute("Test")) {
if(includeSuiteSetup) {
WikiPage suiteSetup = PageCrawlerImpl.getInheritedPage(SuiteResponder.SUITE_SETUP_NAME, wikiPage);
if (suiteSetup != null) {
WikiPagePath = pagePath = suiteSetup.getPageCrawler().getFullPath(suiteSetup);
String pagePathName = PathParser.render(pagePath);
buffer.append("!include -setup .")
.append(pagePathName)
.append("\n");
}
}
WikiPage setup = PageCrawlerImpl.getInheritedPage("SetUP", wikiPage);
if(setup != null) {
WikiPagePath setupPath = wikiPage.getPageCrawler().getFullPath(setup);
String setupPathName = PathParser.render(setupPath);
buffer.append("!include -setup .")
.append(setupPathName)
.append("\n");
}
}
buffer.append(pageData.getContent());
if(pageData.hasAttribute("Test")) {
WikiPage teardown = PageCrawlerImpl.getInheritedPage("TearDown", wikiPage);
if(teardown != null) {
WikiPagePath tearDownPath = wikiPage.getPageCrawler().getFullPath(teardown);
String tearDownPathName = PathParser.render(tearDownPath);
buffer.append("!include -setup .")
.append(tearDownPathName)
.append("\n");
}
if (includeSuiteSteup) {
WikiPage suiteTeardown = PageCrawlerImpl.getInheritedPage(SuiteResponder.SUITE_TEARDOWN_NAME, wikiPage);
if(teardown != null) {
WikiPagePath pagePath = suiteTeardown.getPageCrawler().getFullPath(suiteTeardown);
String pagePathName = PathParser.render(pagePath);
buffer.append("!include -setup .")
.append(pagePathName)
.append("\n");
}
}
}
pageData.setContent(buffer.toString());
return pageData.getHtml();
}
//코드3-2
//리팩토링 이후 소스
public static String renderPageWithSetupAndTeardowns (PageData pageData, boolean isSuite) throws Exception {
boolean isTestPage = pageData.hasAttribute("Test");
if(isTestPage) {
WikiPage testPage = pageData.getWikiPage();
StringBuffer newPageContent = new StringBuffer();
includeSetupPages(testPage, newPageContent, isSuite);
newPageContent.append(pageData.getContent());
includeTeardownPages(testPage, newPageContent, isSuite);
pageData.setContent(newPageContent.toString();
}
return pageData.getHtml();
}
위 두 코드는 모두 함수고 설정(setup) 페이지와 해제(teardown) 페이지를 테스트 페이지에 넣은 후 해당 테스트 페이지를 html로 렌더링하는 부분이다.
두 코드 중 리팩토링 이후 코드가 확연히 내용을 직관적으로 파악할 수 있다.
작게 만들어라!
함수를 만드는 첫째 규칙은 작게! 이다. 함수를 만드는 둘째 규칙은 더 작게! 이다.
위 리팩토링 이후 소스를 한번 더 줄일 수 있다.
//코드3-3
//최종 리팩토링 소스
public static String renderPageWithSetupAndTeardowns (PageData pageData, boolean isSuite) throws Exception {
if(isTestPage(pageData))
includeSetupAndTeardownPages(pageData, isSuite);
return pageData.getHtml();
}블록과 들여쓰기
if문, else문, while문 등에 들어가는 블록은 한 줄이어야 한다.
중첩 구조가 생길만큼 함수가 커지거나 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 읽고 이해하기 어려워진다.
한 가지만 해라!
함수는 한 가지를 해야한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
위 코드에서 3-1은 버퍼 생성, 페이지 호출, 상속된 페이지 검색, 경로 렌더링, 문자열 붙이기, html 생성 등의 작업을 처리하는 등 다양한 추상화 수준에서 여러 단계를 처리한다.
3-2역시 추상화 수준이 둘이다.
3-3은 설정 페이지와 해제 페이지를 테스트 페이지에 넣는 작업 하나만 수행한다.
함수가 '한 가지'만 수행하는지 판단하는 방법으로 단순히 다른 표현이 아니라 의미 있는 이름으로 다른 함수를 추출할 수 있는가를 기준으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업을 하고 있다고 판단한다.
함수 당 추상화 수준은 하나로!
함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
3-1의 경우 getHtml() > String pagePathName = PathParser.render(pagePath) > .append("\n") 순으로 다양한 추상화 수준을 섞어 사용한다.
위에서 아래로 코드 읽기: 내려가기 규칙
위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아지도록 코드를 구현하면 추상화 수준을 일관되게 유지하기가 쉬워진다.
코드 3-7을 참고하면 이해가 쉬워진다.
Switch문
switch나 if/else가 여러 개 이어지는 문은 작게 만들기 어렵다. 본질적으로 n가지를 처리한다. 그러나 다형성을 이용하여 각 switch문을 저차원 클래스에 숨기고 반복하지 않을 수는 있다.
아래 예제는 직원 유형에 따라 다른 값을 계산해 반환하는 함수이다.
//코드 3-4/Payroll.java
public Money calculatePay(Employee e) throws InvalidEmployeeType {
switch (e.type) {
case COMMISSIONED:
return calculateCommissionedPay(e);
case HOURLY:
return calculateHourlyPay(e);
case SALARIED:
return calculateSalariedPay(e);
default:
throw new InvalidEmployeeType(e.type);
}
}위 함수는 다음의 문제가 있다.
- 함수가 길다. 새 직원 유형을 추가하면 더 길어진다.
- '한 가지'작업만 수행하지 않는다.
- SRP(Single Responsibility Principle)을 위반한다.
코드를 변경할 이유가 여럿이기 때문이다. - OCP(Open Closed Principle)를 위반한다.
새 직원 유형을 추가할 때마다 코드를 변경하기 때문이다. - 위 함수와 구조가 동일한 함수가 무한정 존재한다.
이 문제를 해결한 것이 아래 코드이다.
//코드 3-5/Employee and Factory
public abstract class Employee {
public abstract boolean isPayday();
public abstract Money calculatePay();
public abstract void deliverPay(Money pay);
}
----------------------------------------
public interface EmployeeFactory {
public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType;
}
----------------------------------------
public class EmployeeFactoryImpl implements EmployeeFactory {
public Employee makeEmployee(EmployeeRecord r) throws InvalidEmployeeType {
switch (r.type) {
case COMMISSIONED:
return CommissionedEmployee(r);
case HOURLY:
return HourlyEmployee(r);
case SALARIED:
return SalariedEmployee(r);
default:
throw new InvalidEmployeeType(r.type);
}
}
}불가피한 상황을 제외하고, 이처럼 다형적 객체를 생성하는 코드 안에 작성하고 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.
📌 객체지향 설계의 5원칙 (SOLID)
- SPR(Single Responsibility Principle) : 단일 책임 원칙. 어떤 클래스를 변경해야 하는 이유는 오직 하나 뿐이어야 한다.
- SRP가 안지켜진 사례
변수 레벨 : 하나의 속성이 여러 의미를 갖는 경우, 어떤 곳에서는 쓰고 어떤 곳에선 안쓰는 속성이 있는 경우
메소드레벨 : 분기처리를 위한 if문이 많을 경우
- OCP(Open Closed Principle) : 개방 폐쇄 원칙. 소프트웨어 엔티티(클래스, 모듈, 함수 등)는 확장에 대해서는 열려 있어야 하지만 변경에 대해서는 닫혀 있어야 한다.
즉, 자신의 확장에는 열려있고, 주변의 변화에 대해서는 닫혀 있어야 한다는 것이다. 이것은 interface를 통해 구현하여 해결한다.
- LSP(Liskov Substitution Principle) : 리스코프 치환 원칙. 서브타입은 언제나 자신의 기반 타입으로 교체할 수 있어야 한다.
즉, 하위 클래스의 인스턴스는 상위형 객체 참조변수에 대입해 상위 클래스의 인스턴스 역할을 수행하는 데 문제가 없어야 한다.
- ISP(Interface Segregation Principle) : 인터페이스 분리 원칙. 클라이언트는 자신이 사용하지 않는 메소드에 의존 관계를 맺으면 안된다.
ex)class 사람 implements 군인인 경우,군인 홍길동 = new 사람()을 통해 군인 인터페이스의 메소드만을 사용하도록 제한한다.
- DIP(Dependency Inversion Principle) : 의존 역전 원칙. 추상화된 것은 구체적인 것에 의존하면 안된다.
자신보다 변하기 쉬운, 자주 변경되는 클래스에 의존하지 않아야 한다. 이 역시 구체적인 class가 아닌 인터페이스에 의존함으로써 해결할 수 있다.
서술적인 이름을 사용하라.
코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.
한 가지만 수행하는 작은 함수에 좋은 이름을 붙이면 이 원칙을 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
길고 서술적인 이름이 짧고 어려운 이름이나 길고 서술적인 주석보다 좋다. 함수 이름을 정할때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.
이름을 붙일 때는 일관성이 있어야 한다.
함수 인수
함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개(단항)고, 다음은 2개(이항)다. 3개(삼항)는 가능한 피하는 편이 좋으며, 4개 이상은 특별한 이유가 필요하다.
인수는 개념을 이해하기 어렵게 만든다.
최선은 입력 인수가 없는 경우이며, 차선은 입력 인수가 1개뿐인 경우이다.
많이 쓰는 단항 형식
- 인수에 질문을 던지는 경우
ex) boolean fileExists("MyFile") - 인수를 뭔가로 변환해 결과를 반환하는 경우
ex) InputStream fileOpen("MyFile") : String형의 파일 이름을 InputStream으로 변환 - 이벤트 함수(입력 인수만 있고 출력 인수는 없다.)
ex) passwordAttemptFailedNtimes(int attempts)
이 경우 이벤트라는 사실이 코드에 명확히 드러나야 하므로 이름과 문맥을 주의해서 선택한다.
이 경우가 아니라면 단항 함수는 가급적 피한다.
변환 함수에서 출력 인수를 사용하면 혼란을 일으킨다. 입력 인수를 변환하는 함수라면 변환 결과는 반환값으로 돌려준다.
ex) void transform(StringBuffer out)보다 StringBuffer transform(StringBuffer in)이 좋다.
플래그 인수
함수가 한꺼번에 여러 가지를 처리한다고 대놓고 말하는 셈이므로 되도록이면 사용하지 않는 것이 좋다.
이항 함수
대체적으로 인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다. 가능하면 단항 함수로 바꾸도록 애써야한다.
다만 직교 좌표계 Point p = new Point(0,0)처럼 인수 2개가 한 값을 표현하는 두 요소인 경우는 적절하다.
삼항 함수
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 오류가 발생할 확률이 두 배 이상 늘어난다.
인수 객체
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
객체를 생성해 인수를 줄이는 방법을 쓰기 위해 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.
인수 목록
때로는 인수 개수가 가변적인 함수도 필요하다.
String.format("%s worked %.2f" hours.", name, hours); 처럼 가변 인수 전부를 동등하게 취급하면 List형 인수 하나로 취급할 수 있다.
실제로 String.format 선언부를 살펴보면 이항 함수임을 알 수 있다.
이 외의 경우에는 문제가 발생한다.
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수이다.
- 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
ex) write(name):이름을 쓴다, writeField(name):'이름'이라는 필드를 쓴다 - 함수 이름에 키워드를 추가한다.
ex) assertEquals -> assertExpectedEqualsActual(expected, actual)로 변경 시 인수 순서를 기억할 필요가 없어진다.
부수 효과를 일으키지 마라!
부수 효과가 발생하면 예상치 못하게 클래스 변수를 수정하거나, 함수로 넘어온 인수나 시스템 전역 변수를 수정하는 경우가 발생할 수 있다. 많은 경우 시간적인 결합이나 순서 종속성을 초래한다.
아래 예제는 표준 알고리즘을 사용해 userName과 password를 확인하여 올바르면 true, 아니면 false를 반환한다. 그러나 부수 효과를 일으킨다.
//코드 3-6/UserValidator.java
public class UserValidator {
private Cryptographer cryptographer;
public voolean checkPassword(String userName, String password) {
User user = UserGateway.findByName(userName);
if(user != User.NULL) {
String codedPhrase = user.getPhraseEncodedByPassword();
String phrase = cryptographer.decrypt(codedPhrase, password);
if("Valid Password".equals(phrase)){
Session.initialize();
return true;
}
}
return false;
}
}여기서 발생하는 부수 효과는 Session.initialize() 호출이다. checkPassword 함수는 이름 그대로 암호를 확인하는데, 이름만으로는 세션을 초기화한다는 사실이 드러나지 않는데, 이 함수는 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다.
함수 이름만 보고 함수를 호출하는 사용자는 사용자를 인증하면서 의도하지 않게 세션 정보가 날아간다.
이를 방지하기 위해 함수 명을 checkPassword AndInitializeSesstion 으로 변경하는 편이 낫다.
출력 인수
일반적으로 인수를 함수의 입력으로 해석한다. 따라서 출력 인수는 피하는 편이 좋다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
ex) public void appendFooter(StringBuffer report)를
appendFooter(s);로 사용 시 s는 출력 인수이다.
-> report.appendFooter()로 변경해야 한다.
명령과 조회를 분리하라!
함수는 뭔가를 수행(객체 상태를 변경)하거나 뭔가에 답(객체 정보를 반환)하거나 둘 중 하나만 해야 한다. 둘 다 하면 혼란을 초래한다.
오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다. 자칫하면 if문에서 명령을 표현식으로 사용하기 쉽다.
if(deletePage(page) == E_OK) 이 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다.
오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
//오류 코드
if (deletePage(page) == E_OK) {
if (registry.deleteReference(page.name) == E_OK) {
if(configKeys.deleteKey(page.name.makeKey()) == E_OK) {
logger.log("page deleted");
}else{
logger.log("configKey not deleted");
}
} else {
logger.log("deleteReference from registry failed");
}
}else {
logger.log("delete faild");
return E_ERROR;
}
//예외 코드
try{
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}catch (Exception e) {
logger.log(e.getMessage());
}Try/Catch 블록 뽑아내기
try/catch 블록은 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞으므로 별도 함수로 뽑아내는 편이 좋다.
//예외코드 리팩토링
public void delete(Page page) {
try{
deletePageAndAllReferences(page);
}catch (Exception e) {
logError(e);
}
}
private void deletePageAndAllReferences(Page page) throws Exception {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}
private void logError(Exception e) {
logger.log(e.getMessage());
}이처럼 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.
오류 처리도 한 가지 작업이다.
함수는 '한 가지' 작업만 해야한다. 오류 처리도 '한 가지' 작업에 속한다.
Error.java 의존성 자석
오류 코드를 반환한다는 이야기는, 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.
public enum Error {
OK,
INVALID,
NO_SUCH,
LOCKED,
OUT_OF_RESOURCES,
WAITING_FOR_EVENT;
}위와 같은 클래스는 의존성 자석이다.
다른 클래스에서 Error enum을 import해 사용해야 하므로, 이가 변한다면 이를 사용하는 클래스 전부를 다시 컴파일 하고 다시 배치해야한다. 그래서 Error 클래스 변경이 어려워진다.
재컴파일/재배치는 번거로우므로 기존 오류 코드를 재사용하게 되는데, 오류코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생되므로 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.
반복하지 마라!
코드 3-1에서 같은 알고리즘이 4번 반복됨을 볼 수 있다. 코드 3-7에서는 include 방식으로 중복을 없앤다. 중복을 없애면 모듈 가독성이 올라간다.
구조적 프로그래밍
구조적 프로그래밍의 목표는 함수는 return문이 하나여야 한다는 것이다. 루프 안에서 break나 continue를 사용해선 안되며, goto는 절대 사용해서는 안된다.
다만, 함수가 작다면 위 규칙은 별 이익이 없으며 함수가 아주 클 때만 상당한 이익을 제공한다.
함수를 작게 만든다면 return, break, continue를 여러번 사용해도 괜찮으나, goto문은 큰 함수에서만 의미가 있으므로 작은 함수에서는 피해야만 한다.
함수를 어떻게 짜죠?
글짓기와 유사한 순서로 짠다. 이 순서를 거치며 최종적으로 이 장에서 설명한 규칙을 따르는 함수가 얻어진다.
초안 작성 → 단위 테스트 케이스 작성 → 코드 다듬기 → 함수 생성 → 이름 변경 → 중복 제거 → 메서드 줄이기 → 순서 변경 및 전체 클래스 쪼개기
- 초안 내용은 길고 복잡하며 들여쓰기 단계도 많고 중복된 루프도 많으며 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다.
- 단위 테스트 케이스는 초안 코드를 빠짐없이 테스트한다.
- 코드 다듬기부터 최종 순서 변경까지의 과정을 거치는 동안 코드는 항상 단위 테스트를 통과한다.
//코드 3-7/SetupTeardownIncluder.java
package fitnesse.html;
import fitnesse.respondesr.run.SuiteResponder;
import fitnesse.wiki.*;
public class SetupTeardownIncluder {
private PageData pageData;
private boolean isSuite;
private WikiPage testPage;
private StringBuffer newPageContent;
private PageCrawler pageCrawler;
public static String render(PageData pageData) throws Exception {
return render(pageData, false);
}
public static String render(PageData pageData, boolean isSuite) throws Exception {
return new SetupTeardownIncluder(pageData).render(isSuite);
}
private SetupTeardownIncluder(PageData pageData) {
this.pageData = pageData;
testPage = pageData.getWikiPage();
pageCrawler = testPage.getPageCrawler();
newPageContent = new StringBuffer();
}
private String render(boolean isSuite) throws Exception {
this.isSuite = isSuite;
if(isTestPage())
includeSetupAndTeardownPages();
return pageData.getHtml();
}
private boolean isTestPage() throws Exception {
return pageData.hasAttribute("Test");
}
private void includeSetupAndTeardownPages() throws Exception {
includeSetupPages();
includePageContent();
includeTeardownPages();
updatePageContent();
}
private void includeSetupPages() throws Exception {
if(isSuite)
includeSuiteSetupPage();
includeSetupPage();
}
private void includeSuiteSetupPage() throws Exception {
include(SuiteResponder.SUITE_SETUP_NAME, "-setup");
}
private void includeSetupPage() throws Exception {
include("SetUp", "-setup");
}
private void includePageContent() throws Exception {
newPageContent.append(pageData.getContent());
}
private void includeTeardownPages() throws Exception {
includeTeardownPage();
if(isSuite)
includeSuiteTeardownPage();
}
private void includeTeardownPage() throws Exception {
include("TearDown", "-teardown");
}
private void includeSuiteTeardownPage() throws Exception {
include(SuiteResponder.SUITE_TEARDOWN_NAME, "-teardown");
}
private void updatePageContent() throws Exception {
pageData.setConten(newPageContent.toString());
}
private void include(String pageName, String arg) throws Exception {
WikiPage inheritedPage = findInheritedPage(pageName);
if(ingeritedPage != null) {
String pagePathName = getPathNameForPage(inheritedPage);
buildIncludeDirective(pagePathName, arg);
}
}
private WikiPage findInheritedPage(String pageName) throws Exception {
return pageCrawlerImpl.getInheritedPage(pageName, testPage);
}
private String getPathNameForPage(WikiPage page) throws Exception {
private String pagePath = pageCrawler.getFullPath(page);
return PathParser.render(pagePath);
}
private void buildIncludeDirective(String pagePathName, String arg) {
newPageContent
.append("\n!include ")
.append(arg)
.append(" .")
.append(pagePathName)
.append("\n");
}
}