3장 함수

---

함수는 작게만드는것이 좋다 아래와 같이 너무 긴 코드는 이해하기 힘들다

public static String testableHtml(PageData pageData,

boolean includeSuiteSetup) 

throws Exception {

WikiPage wikiPage = pageData.getWikiPage();

StringBuffer buffer = new StringBuffer();

if (pageData.hasAtt ribute("Test")) {

if (includeSuiteSetup) {

WikiPage suiteSetup =

PageCrawlerlmpl.getlnheritedPage(

SuiteResponder.SUITE_SETUP_NAME, wikiPage)；

if (suiteSetup != null) {

WikiPagePath pagePath =

s니iteSetup.getPageCrawler().getFullPath(suiteSetup);

String pagePathName = PathParser.render(pagePath);

buffer.append("!include -setup .")

.append(pagePathName)

.append("\n");

}

}

WikiPage setup =

PageCrawlerlmpl.getInheritedPage("Setup", wikiPage);

if (setup != null) {

WikiPagePath setupPath =

wikiPage.get PageC rawle r().getFullPath(setup);

String setupPathName = PathParser.render(setupPath);

buffer.append("!include -setup .")

.append(setupPathName) 

.append("\n"); 

}

}

buffer.append(pageData.getContent());

if (pageData.hasAtt ribute("Test")) {

WikiPage teardown =

PageCrawlerlmpl.getInheritedPage("TearDown", wikiPage);

if (teardown != null) {

WikiPagePath tearDownPath =

wikiPage.get PageC rawle r().getFullPath(teardown);

String tearDownPathName = PathParser.render(tearDownPath);

buffer.append("\nM)

.append("!include -teardown .")

.append(tearDownPathName)

.append("\n");

}

if (includeSuiteSetup) {

WikiPage suiteTeardown =

PageCrawlerlmpl.getInheritedPage(

SuiteResponder.SUITE_TEARDOWN_NAME,

wikiPage

)；

if (suiteTeardown != null) {

WikiPagePath pagePath =

suiteTeardown.getPageCrawler().getFuVLPath (suiteTeardown);

String pagePathName = PathParser.render(pagePath);

buffer.append(11! include -teardown .")

.append(pagePathName)

.append("\n");

}

}

}

pageData.setContent(buffe r.toSt ring()); 

return pageData.getHtml();

}

위 코드를 다음과 같이 바꿔보았다

public static String renderPageWithSetupsAndTeardowns(

PageData pageData, 

boolean isSuite

) throws Exception {

boolean isTestPage = pageData.hasAttribute("Test");

if (isTestPage) {

WikiPage testPage = pageData.getWikiPage();

StringBuffer newPageContent = new StringBuffer();

includeSetupPages(testPagef newPageContent, isS니ite);

newPageContent.append(pageData.getContent());

includeTeardownPages(testPage, newPageContent, isSuite);

pageData.setContent(newPageContent.toString());

}

return pageData.getHtml();

}

조금 더 코드가 보기 쉬워졌다 하지만 한번에 이해할수있을 정도는 아닌거같다

어떻게 하면 모르는 사람이 봐도 한번에 이해할수있을까

작게만들어라

---

함수를 만드는 첫번째 규칙은 작게 만드는것이다. 

함수를 작게 만들면 한눈에 들어오고 이해하기 쉽다 

3~4줄의 코드가 가장 이상적이다

public static String renderPageWithSetupsAndTeardowns(

PageData pageData, boolean isSuite) 

throws Exception {

if (isTestPage(pageData))

includeSetupAndTeardownPages(pageData, isSuite);

return pageData.getHtml();

}

위의 코드를 3~4줄로 줄인 코드   시발 어떻게하냐 이거

블록과 들여쓰기

---

함수 내의 코드에서 들여쓰기가 2단을 넘어가선 안된다

2단을 넘어가면 함수를 읽고 이해하기 어려워진다.

한가지만 해라

---

함수는 반드시 한가지 작업만 수행해야하며 한가지 작업만을 잘해야한다

서술적인 이름을 사용

---

좋은이름이 주는 가치는 중요하다

함수를 짧게 만들수록 좋은이름을 붙이기 쉬워진다

이름은 일관되게 지어야한다 유사한것끼리는 유사하게 이름 작성

함수 인수

---

함수 인수는 적을수록 좋다 없는게 가장 좋고 그다음 1개, 2개

3개이상은 가능한 피하는게 좋다  

4개이상은 특별한 이유가 필요할때만 사용

인수가 있는것보다 없는게 코드를 이해하는데 더욱 쉽다

많이 쓰는 단항 형식

---

1. 인수로 주는값이 존재하거나 맞는지 확인할때

2. 인수로 주는값을 변환하여 변환된값을 받을때

3. 이벤트 함수

위 3가지 경우를 제외하고는 단항 함수는 사용하지않을것을 권한다

최선은 인수가 없는것이고 차선은 인수가 1개인것이다.

플래그 인수

---

플래그(부울값) 인수는 사용하지않는것을 권장

부울값을 인수로 넘긴다는것은 true면 뭘하고 false면 뭘하는 

함수 하나에 여러작업을 한다는것을 의미한다

사용 자제하자

이항 함수

---

인수가 2개인것 보다는 1개인것이 당연히 좋다  하지만 2개인것도 어쩔수없이 써야한다면 자연적인 순서에 맞는것을 사용하는게 좋다

 writeField(outputStream, name) 

위 함수를 예로들면 앞의 인수 outputStream은 name과 전혀 관계가없다

outputStream이 먼저와야 그다음 name이 오는 순서도 아니다

이렇게 되면 인수를 잘못 넣는 실수가 발생할수도있고 사람이 이 인수들에 대해 기억을 하고있어야한다 

2개의 인수가 하나의 요소를 나타내는 경우에는 사용하는것도 좋다

ex) point(1,2) 이런식으로 좌표값을 나타내는경우

왠만하면 이항함수는 단항함수로 사용하는것이 좋다 

writeField(outputStream, name) 이것도

outputStream.writeField(name) 이런식으로 outputStream 안에 넣어서 사용하는쪽으로 바꾸는게 좋다

삼항 함수

---

최대한 쓰지않는게 좋겠지만 사용해야한다면 주의해야한다

인수 객체

---

인수가 2~3개가 필요하다면 일부를 클래스 변수로 선언할 가능성을 생각해본다

ex) Circle makeCircle(double x, double y, double radius);

    Circle makeCircle(Point center, double radius);

인수 목록

---

때로는 인수개수가 가변적인 함수도 필요하다

ex) String.format("%s worked %.2f" hours.", name, hours);

    public String format(String format, Object… args)

가변 인수를 취하는 모든 함수에 위와 같은 원리가 적용된다

가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다. 

하지만 이를 넘이서는 인수를 사용할 경우에는 문제가 있다

void monad(Integer... args);

void dyad(String name, Integer… args);

void triad(String name, int count, Integer... args);

동사와 키워드

---

단항함수의 이름은 동사 인수는 명사가 쌍으로 이뤄지는게 좋다

ex) write(name)  이런식으로하면 이름을 쓴다라는것이 명확하게 보인다 

writeField(name) 이 이름이 훨씬 더 나은 이름이다

함수 이름에 키워드를 추가하는 방법도있다

함수이름에 인수를 넣는것이다

ex) writeName(name), assertEquals 보다 assertExpectedEqualsActual(expected, actual)이 더 좋다.

 이렇게하면 인수 순서를 기억하지않아도된다.

부수 효과를 일으키지 마라

---

함수는 한가지일만 해야하는데 남몰래 다른짓하는 코드(ex 인수 수정 등)를 추가하면 많은경우 시간적인 결합이나 순서 종속성을 초래한다

public class UserValidator {

private Cryptographer cryptographer;

public boolean checkPassword(St ring 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함수는 암호를 확인하는 함수인데 이름만 봐서는 세션을 초기화한다는것이 드러나지않는다 함수 이름만 보고 함수를 호출하면 기존세션정보를 지워버리는 위험에 처하게된다

이런 부수효과가 시간적인 결합을 초래

시간적인 결합은 혼란을 일으키기 때문에 

함수이름을 명확하게 나타내는게 좋다  checkPasswordAndlnitializeSession 함수가 한가지 일만 해야한다는것을위반하지만

출력 인수

---

일반적으로 출력인수는 사용하지않는게 좋다

객체지향 프로그래밍이 나오기전에는 불가피한경우도 있었지만 후에는 사용할 필요가없어졌다 

출력인수로 사용하라고 만든게 this이기 때문

public void appendFooter(StringBuffer report)

위의 출력인수를 없애고

report.appendFooter()

이와 같이 쓰는게 좋다

함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다

명령과 조회를 분리하라!

---

함수는 뭔가를 수정하거나 뭔가를 반환하거나 둘중 하나만 수행해야한다

둘다 하려고하면 혼란을 초래한다

오류 코드보다 예외를 사용하라!

---

if (deletePage(page) = E_OK) {

if (registry.deleteReference(page.name) = E_OK) {

if (configKeys.deleteKey(page.name.makeKey()) == E_0K){

logger.log("page deleted");

} else {

logger.log("configKey not deleted");

}

} else {

logger.logC'deleteReference from registry failed");

}

} else {

logger.log("delete failed");

return E_ERR0R;

}

위와 같이 오류코드를 반환하면 호출자는 즉시 오류코드를 처리해야한다는 문제에 부딪힌다

try {

deletePage(page);

registry.deleteReference(page.name);

configKeys.deleteKey(page.name.makeKey());

}

catch (Exception e) {

logger.log(e.getMessage());

}

위와 같이 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 깔끔해진다.

try/catch 블록 뽑아내기

---

try/catch 블록은 상당히 지저분하다 코드 구조에 혼란을 주며 정상동작과 오류 동작을 뒤섞는다 

그래서 try/catch를 별도의 함수로 뽑아내는편이 좋다

public void delete(Page page) {

try {

deletePageAndAHReferences(page);

}

catch (Exception e) {

logError(e);

}

}

private void deletePageAndAHReferences(Page page) throws Exception {

deletePage(page);

registry.deleteReference(page.name);

configKeys.deleteKey(page.name.makeKey());

}

private void logError(Exception e) {

logger.log(e.getMessage());

}

위에서 delete 함수가 모든 오류를 처리한다

실제로 페이지를 제거하는 함수는 deletePageAndAllReferences다. 

deletePageAndAllReferences 함수는 예외를 처리하지 않는다. 

이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하

기 쉬워진다

오류 처리도 한 가지 작업이다

---

함수는 한가지만 처리해야하며  오류처리도 한가지 작업에 속한다

오류를 처리하는 함수는 오류만 처리해야한다

반복하지 마라!

---

중복은 소프트웨어에서 모든 악의 근원이다

구조적 프로그래밍

---

어떤 프로그래머는 에츠허르 데이크스트라EasgerDijkstra의 구조적 프로그래밍 원칙을 따른다

데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다

즉. 함수는 return 문이 하나여야 한다는 말이다. 

루프 안에서 break나 continue를 사용해선 안 되며 

goto는 절대로，절대로 안 된다

구조적 프로그래밍의 목표와 규율은 공감하지만 함수가 작다면 위 규칙은 별이익을 제공하지 못한다. 

함수가 아주 클 때만 상당한 이익을 제공한다

그러므로 함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다

오히 려 때로는 단일 입/출구 규칙보다 의도를 표현하기 쉬워 진다. 

반면, goto 문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다

함수를 어떻게 짜죠?

---

처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많다. 

인수 목록도 아주 길다. 

이름은 즉흥적이고 코드는 중복된다. 

하지만 나는 그 서투른 코드를 빠짐 없이 테스트하는 단위 테스트 케이스도 만든다.

그런 다음 나는 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 

때로는 전체 클래스를 쪼개기도 한다. 

이와중에도 코드는 항상 단위 테스트를 통과한다.

결론

---

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한

도메 인 특화 언어 DSL로 만들어진다 함수는 그 언어에서

동사며 , 클래스는 명사다. 요구사항 문서에 나오는 명사와 동사를 클래스와 함

수 후보로 고려한다는 끔찍한 옛 규칙으로 역행하자는 이야가가 아니다. 아니，

이것은 오히려 훨씬 더 오래된 진실이다. 프로그래밍의 기술은 언제나 언어 설

계의 기술이다. 예전에도 그랬고 지금도 마찬가지다.

대가 프로그래머는 시스템을 (구현할) 프로그램이 아니라 (풀어갈) 이

야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현

력이 강한 언어를 만들어 이야기를 풀어간다. 시스템에서 발생하는 모든 동작을

설명하는 함수 계층이 바로 그 언어에 속한다. 재귀라는 기교로 각 동작은 바로

그 도메인에 특화된 언어를 사용해 자신만의 이야기를 풀어간다.

이 장은 함수를 잘 만드는 기교를 소개했다. 여기서 설명한 규칙을 따른다면

길이가 짧고，이름이 좋고, 체계가 잡힌 함수가 나오리라. 하지만 진짜 목표는 시

스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하기 바란다. 여러분이 작

성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를

풀어가기가 쉬워 진다는 사실을 기억하기 바란다

package fitnesse.html;

import fitnesse.responders.run.SuiteResponder;

import fitnesse.wiki.*;

public class SetupTeardownlncluder {

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 SetupTeardownlncluder(pageData).render(isSuite);

}

private SetupTeardownlncluder(PageData pageData) {

this.pageData = pageData;

testPage = pageData.getWikiPage();

pageCrawler = testPage.getPageCrawler();

newPageContent = new 5tringBuffer();

}

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 {

includeTea rdownPage();

if (isSuite)

includeSuiteTea rdownPage();

}

private void includeTeardownPage() throws Exception {

include("TearDown", "-teardown");

}

private void includeSuiteTeardownPage() throws Exception {

include(SuiteResponder.SUITE_TEARDOV^I_NAME, "-teardown");

}

private void updatePageContent() throws Exception {

pageData.setContent(newPageContent■toString());

}

private void include(String pageName, String arg) throws Exception {

WikiPage inheritedPage = findlnheritedPage(pageName);

if (inheritedPage != null) {

String pagePathName = getPathNameForPage(inheritedPage);

buildIncludeDirective(pagePathName, arg);

}

}

private WikiPage findInheritedPage(String pageName) throws Exception {

return PageC rawle rlmpl.getlnhe ritedPage(pageName, testPage);

}

private String getPathNameForPage(WikiPage page) throws Exception {

WikiPagePath pagePath = pageCrawler.getFullPath(page);

return PathParser.render(pagePath);

}

private void buildIncludeDirective(St ring pagePathName, String arg) {

newPageContent

.append("\n!include ")

.append(arg)

.append(" ■")

.append(pagePathName)

.append("\n");

}

}