개발 다이어리

모든 소프트웨어를 직접 개발하는 경우는 드물다.

패키지를 사기도 하고, 오픈 소스를 사용하기도 한다. 때로는 사내 컴포넌트를 사용한다.

어떤 식으로든 외부 코드를 우리 코드애 깔끔하게 통합해야만 한다.

이 장에서는 소프트웨어 경계를 깔끔하게 처리하는 기법과 기교를 살펴본다

외부 코드 사용하기

인터페이스 , 패키지 , 프레임워크

제공자와 사용자 사이 시스템 경계에서 문제가 발생할 소지가 많다.

java.util.map 살펴보면 많은 인터페이스를 제공, 기능성과 유연성을 제공하지만 위험성도 제공한다.

clear()는 모든 데이터를 지울수 있다. Map을 여기 저기로 넘긴다고 생각해보자.

어딘가에서 누군가가 clear()를 호출하지 않으리라 보장할수 있을까?

 또한 Map은 저장할 때 Object타입 객체를 저장하므로 객체유형을 제한하지 않는다.

현재는 지네릭으로 이문제는 없다없다.(지네 릭스는자바 5부터 지원)

만약 너무 많은 기능을 제공하거나 래거시 코드가 지네릭을 지원을 안 하는데 적용하고 싶다면

이 또한 래퍼 클래스로 많은 부분을 해결할 수 있다.

예를 들어, Map을 사용하지만 Map의 clear() 호출을 못하게 하고 싶다면

래퍼클래스로 감싸고, clear() 메서드를 호출 못하게 메서드로 만들지 않거나, private으로 만든다.

class Legecy {
	//Map 기능을 제한하고 싶다.
	//public HashMap map = new HashMap();
    Wrapper wrapper = new Wrapper();
}
/*****************/
class Wrapper {
	private HashMap map = new HashMap();
	/*외부에 노출하고 싶은 메서드 정의*/
}

여기서 중요한 것은 Map clear()메서드 따위가 아니다.

Map과 같은 유사한 경계 인터페이스를 여기저기 넘기지 말라는 말이다.

경계 살피고 익히기

외부 코드 사용의 강점은 적은 시간에 많은 기능을 구현할 수 있다는 것

만약 외부코드를 사용하고 싶다면 어디서부터 시작해야할까?

외부 패키지 테스트는 우리 책임이 아니지만 우리 자신을 위해 테스트하는 편이 바람직하다

API문서를 먼저 읽으면서 사용법을 결정 이후 예상대로 동작하는 지 확인이 아닌 반대로

우리 쪽코드를 작성해 외부 코드를 호출하는 대신 먼저 간단한 테스트 케이스를 작성해 외부 코드를 익힌다.

이를 학습 테스트라 한다.

학습 테스트는 프로그램에서 사용하려는 방식대로 외부 API를 호출한다. 즉, 사용하려는 목적에 초점을 맞춘다.

학습 테스트는이상이다.

학습 테스트에 드는 비용은 없다. 어쨌든 API를 배워야하기 때문이다.

오히려 필요한 지식만 확보하는 손쉬운 방법이다.

학습 테스트는이해도를 높여주는 정확한 실험이다

패키지가 신규 버전이 나온다면 학습 테스트는 패키지가 예상대로 도는지 검증한다.

패키지가 우리 코드와 호환되리라는 보장이 없기 때문이다.

학습 테스트가 호환되지 않는 코드를 곧바로 밝혀줄 것이다.

아직 존재하지 않는 코드를 사용하기

경계와 관련해 또 다른 유형은 아는 코드와 모르는 코드를 분리하는 경계다.

때로는 우리 지식이 경계를 너머 미치지 못하는 코드 영역도 있다.

때로는 적어도 지금은 알려고 해도 알 수가 없다.

이럴 때 미래 존재할 API 기능을 정의한 인터페이스를 만들고, 작업을 시작한다.

후에 API가 만들어졌으면, ADAPTER 패턴을 이용해 실제 API객체를 사용하도록 만들면 된다.

스프링은 기능은 같지만 서로 다른 라이브러리 호출 방법을 하나의 방법으로 호출하기 위해 어댑터 패턴을 사용한다.

깨끗한 경계

경계에서는 변경이 자주 이루어진다.

소프트웨어 설계가 우수하다면 변경에 많은 비용이 들지 않는다.

통제하지 못하는 코드를 사용할 때는 너무 많은 투자를 하거나 향후 변경 비용이 지나치게 커지지 않도록 각별히 주의해야한다.

예로 라이브러리는 *.class 내가 코드를 통제 못함

따라서, 감싸기 클래스로 해당 클래스 인스턴스를 생성해 우리 메서드안에서 외부클래스 메서드를 호출

경계에 위치하는 코드는 깔끔히 분리한다. 또한 기대치를 정의하는 테스트 케이스도 작성한다.

이쪽 코드에서 외부 패키지를 세세하게 알아야 할 필요가 없다.

통제가 불가능한 외부 패키지에 의존하는 대신 통제가 가능한 우리 코드에 의존하는 편이 훨씬 좋다.

외부 패키지를 호출하는 코드를 가능한 줄여 경계를 관리하자.

Map에서 봤듯이 새로운 클래스로 감싸거나 ADAPTER 패턴을 사용해 우리가 원하는 인터페이스를 패키지가 제공하는 인터페이스로 변환하자

팀으로 일한다면 그 규칙을 따라야 한다.

형식을 맞추는 목정

코드 형식은 의사소통의 일환이다. 오늘 구현한 코드는 변경될 가능성이 높다.

이 과정에서 코드는 변경되어도 처음에 잡아둔 코드 형식은 남아 유지보수 용이성과 확장성에 영향을 미친다.

코드는 사라져도 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

대부분 프로젝트의 코드는 500줄을 넘지 않고 최빈도는 200줄 미만이다.

즉, 200~500줄 코드로도 커다란 시스템을 구축할 수 있다.

반드시 지켜야 할 엄격한 규칙은 아니지만 바람직한 규칙이다.

일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

좋은 신문 기사는 최상단에 기사를 몇 마디로 요약하는 표제가 나온다.

독자는 표제를 보고서 기사를 읽을지 말지를 결정한다.

첫 문단은 전체 기사 내용을 요약한다.

세세한 사실은 숨기고 커다란 그름을 보여준다.

쭉~ 읽으며 내려가면 세세한 사실이 조금씩 드러난다.

소스 파일도 신문기사와 비슷하게 작성한다.

이름은 간단하면서 설명이 가능하게 짓는다. 이름만 보고 올바른 모듈을 살펴보는지 판단할 수 있어야 한다.

소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.

아래로 갈수록 세세하게 묘사한다. 가장 마지막에는 가장 저 차원 함수와 세부 내역이 나온다.

개념은 빈행으로 분리하라

각 행은 수식이나 절이고 일련의 행 묶음은 완결된 생각 하나이다.(메서드)

생각 사이는 빈행을 넣어야 한다. 

세로 밀집도

줄 바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.

즉, 서로 연관된 코드는 가까이 위치해야 한다.

수직 거리

함수 연관 관계와 동작 방식을 이해하려고 스크롤을 드르륵드르륵 거린 적 있는가?

서로 연관된 코드는 수직 거리가 가까워야 한다.

서로 밀접한 개념은 한 파일에 속해야 마땅하다.

클래스를 뒤적거리는 것은 안 좋다.

인스턴스 변수는 클래스 맨 처음에 선언하고 변수 간에 세로로 거리를 두지 않는다.

가장 중요한 것은 인스턴스 변수들은 클래스 맨 앞에 뭉쳐있어야한다.

종족 함수

한 함수가 다른 함수를 호출한다면 세로로 가까이 배치한다.

가능하면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

개념적 유사성

친화도가 높을수록 코드를 가까이 배치한다.

한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 친화도가 높은 예시다.

변수와 그 변수를 사용하는 함수도 좋은 예시다.

세로 순서

함수 호출 종속성은 아래방향으로 유지된다. 즉, 호출하는 함수부터 오고 호출되는 함수가 아래에 배치된다

따라서 자연스럽게 고차원함수가 위에 저차원함수가 아래에 배치된다.

이는 다른 개발자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다. 세세한 사항까지 파고들 필요가 없다.

가로 형식 맞추기

100~120자 수준이 적당

가로 공백과 밀집도

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다

들여 쓰기

범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.

들여 쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.

팀 규칙

팀 규칙이 우선이다. 각자의 스타일이 먼저가 절대 아니다. 일관성이야 말로 좋은 가독성을 보장한다.

대다수의 주석이 이 범주에 속한다.

허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등

주절거리는 주석

특별한 이유 없이 의무감으로 다는 주석

의미를 파악하려면 결국 코드를 뒤져보는 수밖에 없다.

주석을 달기로 했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

오해할 여지가 있는 주석

의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.

이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

이력을 기록하는 주석

이력을 관리하는 주석은 없애버리는 게 좋다. 이제는 소스코드 관리시스템이 있기 때문이다.

공로를 돌리거나 저자를 표시하는 주석도 소스코드관리시스템에 맡기는 게좋다.

주석으로 처리한 코드도 소스코드관리시스템에 맡긴다.

있으나 마나 한 주석

쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석

이런 주석은 개발자가 주석을 무시하는 습관에 빠지게 할 수도 있다.

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

함수나 변수로 표현할 수 있다면주석을 달지 마라

위치를 표시하는 주석

때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.

// 수정필요///////////////////////////////////////////

일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.

특히, 뒷부분 슬래시(/) 주석은 최악이다.

닫는 괄호에 다는 주석

중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만,

우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐이다.

그러므로 달아야겠다는 생각이 든다면 함수를 줄이려 시도하자

요즘은  IDE가 괄호 파악을 잘해줘서 더욱 불필요할 것

try{
	while(true){
    	...
    }//while 끝
	...
}//try 끝

공로를 돌리거나 저자를 표시하는 주석

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다.

저자 이름으로 코드를 오염시킬 필요가 없다.

주석이 있으면 다른 사람이 물어볼 수 있으니 유용하다 생각할지 모르겠다.

하지만 현실적으로 이런 주석은 그냥 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.

그냥 소스 코드 관리 시스템에 맡기는 편이 옳다.

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.

이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다.

결국 쓸모 없는 코드가 점차 쌓여간다.

1960년대 즈음에는 주석으로 처리한 코드가 유용했었다. 하지만 우리는 오래전부터 우수한 소크 코드 관리 시스템을 사용해왔다. 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.

너무 많은 정보

너무 많은 정보를 다는 주석은 않좋다.

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않겠는가?

함수 헤더

짧은 함수는 긴 설명이 필요 없다.

짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.

시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요는 없다.

유용하지 않을 뿐만 아니라 Javadocs주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.