Knowledge Map

클린코드 - 3장 함수 본문

기타

클린코드 - 3장 함수

2016. 6. 15. 13:25

출처 : 클린 코드

3장 함수


ㅇ작게 만들어라.


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

중첩구조가 생길 만큼 함수가 커져서는 안된다. 함수에서 들여쓰기 수준은 1~2단을 넘어서면 안된다.


ㅇ한가지만 해라!

함수는 한 가지를 해야한다. 그 한가지를 잘해야 한다. 그 한가지만을 해야한다.


1. 지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 하는 것이다. 

2. 의미있는 이름으로 다른 함수를 추츨할 수 있다면 그 함수는 여러 작업을 하는 셈이다.


ㅇ함수 당 추상화 수준은 하나로!

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.

한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다. 

근본 개념과 세부사항을 뒷ㄲ기 시작하면 사람들이 함수에 세부사항을 점점 더 추가한다.


위에서 아래로 코드읽기 : 내려가기 규칙

코드는 위에서 아래로 이야기처럼 읽혀야 좋다. 한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.

이렇게 위에서 아래로 내려갈수록 한단계씩 낮아지는 규칙을 '내려가기' 규칙이라 부른다.


추상화 수준이 하나인 함수를 구현하기란 쉽지 않지만 핵심은 짧으면서도 '한 가지'만 하는 함수이다.


ㅇ서술적인 이름을 사용하라!

길고 서술적인 이름이 짧고 어려운 이름이나 길고 서술적인 주석보다도 좋다.

함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.

이름을 붙일 때는 일관성이 있어야 한다. 모듈내에 함수 이름은 같은 문구, 명사, 동사를 사용한다.


- 함수 인수

함수에서 이상적인 인수 개수는 0개다. 다음은 1개, 다음은 2개이다. 3개 이상은 가능한 피하는 게 좋다.  4개부터는 사용하면 안된다. 

인수가 많을 수록 테스트 케이스를 만들어 보는게 더욱 어려워진다.출력 인수는 입력 인수보다 이해하기 어렵다.

최선은 입력 인수가 없는 경우이며 차선은 1개뿐인 경우다.


출력 인수는 입력 인수보다 이해하기 어렵다. 대개 함수에서 인수로 결과를 받으리라 기대하지 않기 때문에 출력 인수는 코드를 재차 확인하게 만든다.


함수에 인수 1개를 넘기는 가장 흔한 경우는 2가지 이다.


하나는 인수에 질문을 던지는 경우이다. 다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우다.


함수 이름을 지을 때는 이 두가지 경우를 분명히 구분하고 언제나 일관적인 방식으로 두 형식을 사용한다. 또 다른 단항 함수 형식으로는 이벤트가 있다.이벤트 함수는 입력 인수만 있으며 출력 인수는 없다. 


프로그램은 함수 호출을 이벤트로 해석해 입력 인수로 시스템 상태를 바꾼다. 하지만 이 함수는 조심해서 사용해야 하며 이벤트라는 사실이 코드에 명확히 드러나야 한다. 이러한 경우들을 제외하고는 단항 함수를 가급적 피하는게 좋다. 입력 인수를 변환하는 함수라면 void 같은 것을 쓰지 말고 변환 결과를 반환값으로 돌려준다. 


설사 입력 인수를 그대로 돌려주는 함수라 할지라도 변환 함수 형식을 따르는 편이 좋다. 적어도 변환 형태는 유지하지 때문이다.

- 플래그 인수

플래그 인수는 좋지 않다고 하는데 함수로 bool값을 넘기는 것은 함수가 한꺼번에 여러 가지를 처리한다는 것을 명시하는 셈이다.


- 이항 함수

인수가 2개인 함수는 단항 함수보다 이해하기가 어렵다. 이항 함수가 무조건 나쁘다는 것은 아니다. 불가피한 경우도 생기기 때문이다. 하지만 2항 함수가 내포하는 잠재적 위험을 인식하고 되도록이면 단항함수로 바꿔 쓸수 있어야 한다.


- 삼항 인수

삼항 함수는 더 이해하기 어려우며 순서, 주춤, 무시로 야기되는 문제가 2 배 이상 늘어나기에 삼항 함수를 만들 땐 신중히 고려하는게 좋다.


- 인수 객체

인수가 2-3개가 필요하다면 일부를 독자적인 클래스 변수로 선언해서 사용하는 것도 좋다. 객체를 생성해 인수를 줄이는 방법이 눈속임이라 여겨질지 모르지만 하나의 변수에 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.


- 인수 목록

인수 개수가 가변적인 함수도 필요하다. 가변 인수를 위하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있지만 이를 넘어서는 인수를 사용할 경우에는 문제가 있다.


- 동사와 키워드

함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수이다.
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다. 예를 들면 write( name ), writeField( name )와 같은 방식이다.
함수이름에 키워드를 추가하는 형식도 있다. 즉 함수 이름에 인수 이름을 넣는다. 

예를 들어서 assertEquals 보다 assertExpectedEqualsActual( expected, actual ) 이 좋다. 그러면 인수 순서를 기억할 필요가 없어진다.

- 부수 효과를 일으키지 마라!

부수효과는 명시되지 않은 다른 짓을 하거나 클래스 변수를 수정하고 인수, 전역변수를 수정해 버린다. 많은 경우 시간적인 결합 temporal coupling 이나 순서 종속성 order dependency 을 초래한다.

- 출력 인수

일반적으로 우리는 인수를 함수 입력으로 해석한다. 하지만 출력 인수로 사용되어 질때 우리는 함수 선언부를 찾아보고 나서야 알게되는 경우가 많다. 객체 지향 프로그래밍이 나오기 전에는 출력 인수가 불가피한 경우도 있었지만 객체 지향 언어에서는 출력 인수를 사용할 필요가 거의 없다. 출력 인수로 사용하라고 설계한 변수가 바로 ㅂthis이기 때문이다. 일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.

ㅇ명령과 조회를 분리하라!

함수는 뭔가를 수행하거나 뭔가에 다바거나 둘 중 하나만 해야한다. 둘다 하면 안된다. 객체 상태를 변경 OR 객체 정보를 반환하거나 둘중 하나다!
둘다 하면 혼란을 초개한다.

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

오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.

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



/* 오류 코드를 사용 */
if ( deletePage( page ) == E_OK ) {
 
    if ( registry.deleteReferece( 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( "deleteReferec from registry failed" );
    }
 
else {
    logger.log( "delete failed" );
    return E_ERROR;
}
 
 


/* 예외를 사용 */ 
 
try {
 
    deletePage( page );
    registry.deleteReference( page.name );
    configKeys.deleteKey( page.name.makeKey() );
}
    catch( Exception e ) {
    logger.log( e.getMessage() );
}
cs


- Try / Catch 블록 뽑아내기

try / catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 이 블록을 별도 함수로 뽑아내는 편이 좋다.


/* try / catch 를 별도 함수로 처리 */
 
private void deletePageAndAllReferences( Page page ) throws Exception {
 
    deletePage( PAGE );
    registery.deleteReferece( page.name );
    configKeys.deleteKey( page.name.makeKey() );
}
 
private void logError( Exception e ) {
    logger.log( e.getMessage() );
}
cs


위에서 deletePageAndAllRefereces함수는 예외를 처리하지 않는다. 페이지를 제거할 분이다.

이렇게 정상 동작과 오류 처리 동작을 분리하면 코드를 이해하고 수정하기 쉬워진다.


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

즉 함수에 키워드 try가 있다면 함수는 try문으로 시작해서 catch/finally문으로 끝나야 한다는 것이다.


오류 코드는 Error enum을 import 해서 사용해야 하므로 Error enum이 변한다면 Error enum 사용하는 클래스 전부를 재컴파일 하고 재배치해야 한다. 그래서 Error 클래스 변경이 어려워진다. 이렇기에 기존 오류 코드를 재사용하게 된다.


오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생되므로 재컴파일 / 재배치 없이도 새 예외 클래스를 추가할 수 있다.


- 반복하지 마라!

중복이 발생하면 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 손봐야 하기 때문이다. 게다가 오류가 발생할 확률도 높아진다.
많은 원칙과 기법들이 중복을 없애거나 제어할 목적으로 나왔다. 관계형 데이터 베이스에 정규형식을 만든 점, 객체 지향 프로그래밍에서 코드를 부모 클래스로 몰아 중복을 없애는 점, 구조적 프로그래밍, AOP (Aspect Oriented Programing ), COP ( Component Oriented Programming ) 도 모두 어떤 면에서 중복 제거 전략이다.

- 구조적 프로그래밍

에츠허르 데이크스트라 ( Edsger Dijkstra ) 의 구조적 프로그래밍 원칙에서는 모든 함수와 함수 내 모든 블록의 입구와 출구가 하나만 존재해야 한다고 한다. 즉 함수는 return 문이 하나여야 한다는 것이며 루프 안에서 break, continue를 사용하면 안되며 특히 goto는 절대로 안된다. 하지만 구조적 프로그래밍의 목표와 규율은 함수가 작을때는 별이익이 없지만 함수가 아주 클 때만 상당한 이익을 제공한다.

따라서 함수를 작게 만든다면 return, break, continue를 여러 차례 사용해도 된다.  오히려 때로는 단일 입/출구 규칙 보다 의도를 표현하기 쉬워진다.

- 함수를 어떻게 만들까?

소프트웨어를 짜는 행위는 글짓기와 비슷하다. 초안은 대개 서투르고 어수선 하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다. 

함수를 짤 때도 마찬가지이다. 처음에는 길고 복잡하다. 들여쓰기 단계도 많고 중복된 루프도 많으며 인수 목록도 아주 길고 이름도 즉흥적, 중복 코드가 있다. 하지만 이러한 코드를 빠짐 없이 테스트 하는 단위 테스트 케이스도 만든다. 

그런다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거하고 메서드를 줄이고 순서를 마꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.




ㅇ결론

모든 시스템은 특정 응용 분야 시스템을 기술할 목적으로 프로그래머가 설계한 도메인 특화 언어 ( Domain Specific Language, DSL )로 만들어진다. 함수는 그 언어에서 동사며, 클래스는 명사이다. 프로그래밍의 기술은 언제나 언어 설계의 기술이다.


마스터 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다. 시스템에서 발생하는 모든 동작을 설명하는 함수 계층이 바로 그 언어에 속한다.


함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 것을 항상 기억하자.




 
package fitness.html;
 
import fitnesse.reponders.run.SuiteResponder;
import fitnesse.wiki.*;
 
puclib class SetupTeardownIncluder {
 
    private PageData pageData;
    private boolean isSuite;
    private WikiPage testPage;
    private StringBuffer newPageContent;
    private PageCrawler pageCrawler;
 
    public static String render ( Page Data 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 String buffer();
    }
 
    private String render ( boolean isSuite ) throws Exception {
        this.isSuite = isSuite;
        if ( isTestPage() ) 
        includeSetipAndTeardownPages();
        return pageData.getHtml();
    }
 
    private boolean isTestPage(0 throw Exception {
        return pageData.hasAttribute("Test");
    }
 
    private void includeSetipAndTeardownPages() throws Exception {
        includeSetupPages();
        icludePageContent();
        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 ((is Suite)
            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.setContent( newPageContent.toString() );
    }
 
    private void include( String pageName, String arg ) throws Exception {
        WikiPage inheritedPage = findInheeritedPage( pageName);
        if ( inheritedPage != null ) {
            String pagePathName = getPathNameForPage ( inheritedPage );
            buildIncludeDirective( pagePathName, arg );
        }
    }
 
    private WikiPage indInheritedPage( String pageName ) throws Exception {
        return PageCrawlerImpl.getInheritedPage( pageName, testPage );
    }
 
    private String getPathNameForPage( WikiPage page ) throws Excpetion {
        WikiPagePath pagePath = pageCrawler.getFullPath( page );
        return PathParser.render( pagePth) ;
    }
 
    private void buildIncludeDirective( String pagePathName, String arg ) {
        newPageContent
            .append("\n!include ")
            .append(arg)
            .appent(" .")
            .append(pagePathName)
            .append("\n");
    }
}
cs

'기타' 카테고리의 다른 글

프로그래밍 종류  (0) 2016.06.19
폴더 권한 관련  (0) 2016.06.17
[VirtualBox] 시스템에서 VT-x/AMD-V 하드웨어 가속을 사용할 수 없습니다  (0) 2016.04.21
리눅스 netstat  (0) 2016.03.31
티스토리에 코드 입력하기  (1) 2016.02.28
Comments