클린코드(Clean Code) 5, 6장 - 로버트 C. 마틴

book.naver.com/bookdb/book_detail.nhn?bid=7390287

Clean Code

 

---

5. 형식 맞추기

• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 함
  • 코드 형식을 맞추기 위한 간단한 규칙 정하고 따르기
• 형식을 맞추는 목적
  • 코드 형식은 의사소통의 일환
    • 너무 중요하므로 융통성 없이 맹목적으로 따르면 안 됨
  • 오늘 구현하는 기능은 다음 버전에서 변경될 수 있음
    • 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질(유지보수 용이성, 확장성)에 지대한 영향
    • 원래 코드는 사라지더라도 원래 코드의 흔적(개발자의 스타일과 규율)은 사라지지 않음
• 적절한 행 길이를 유지하라
• 500줄을 넘기지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 
  • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
• 신문 기사처럼 작성하라
  • 이름은 간단하면서도 설명이 가능하게 짓는다
    
    • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 수 있어야 함
  • 소스 파일의 첫 부분은 고차원 개념과 알고리즘을 설명함
  • 아래로 내려갈수록 의도를 세세하게 묘사함
  • 마지막에는 가장 저차원 함수와 세부 내역이 나옴
• 개념은 빈 행으로 분리하라
  • 일련의 행 묶음은 완결된 생각 하나를 표현함
    • 생각 사이는 빈 행을 넣어 분리해야 함
    • 빈 행은 새로운 개념을 시작한다는 시각적 단서
• 세로 밀집도
  • 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미 
  • 서로 밀접한 코드 행은 세로로 가까이 놓여야 함
    • 클래스 안에 2개의 인스턴스 변수가 있을 때, 의미 없는 주석으로 떨어뜨려 놓기보다는 변수 2개에 메서드 1개인 클래스가 잘 드러나도록 변수끼리 붙여주는 게 더 가독성이 좋음 

    • public class ReporterConfig {
          private String m_className;
          private List<Property> m_properties = new ArrayList<Property>();
          
          public void addProperty(Property property) {
          	m_properties.add(property)
          }
      }

• 수직 거리
  • 시스템이 무엇을 하는지 이해하고자 할 때, 이 조각 저 조각이 어디에 있는 찾고 기억하느라 시간과 노력을 소모하는 일이 없어야 함
  • 서로 밀접한 개념은 세로로 가까이 둬야 하지만, 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않음
    • 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 함
    • protected 변수(동일 패키지 내의 클래스+해당 클래스를 상속받은 외부 패키지의 클래스에서 접근 가능한 변수)를 피해야 하는 이유
  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현
    • 연관성 : 한 개념을 이해하는 데 다른 개념이 중요한 정도
    • 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
  • 변수 선언
    • 사용하는 위치에 최대한 가까이 선언
      • 지역 변수는 각 함수 맨 처음에 선언
      • 루프를 제어하는 변수는 흔히 루프 문 내부에 선언 (ex: for(Test each : tests){ } )
        
        • 드물게 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있음
  • 인스턴스 변수
    • 인스턴스 변수는 클래스 맨 처음에 선언함
      • 변수 간에 세로로 거리를 두지 않는다
      • 잘 설계한 클래스는 대다수 클래스 메서드가 인스턴스 변수를 사용
  • 종속 함수
    • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치
    • 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치
      • 예측 가능하므로 호출되는 함수를 찾기 쉬워지고 모듈 전체의 가독성이 높아짐
  • 개념적 유사성
    • 개념적인 친화도가 높을수록 코드를 가까이 배치함
      • 한 함수가 다른 함수를 호출해서 생기는 직접적인 종속성
      • 변수와 그 변수를 사용하는 함수
      • 비슷한 동작을 수행하는 일군의 함수 (ex: 메서드 오버로딩)

• 세로 순서
  • 호출되는 함수를 호출하는 함수보다 나중에 배치 (파스칼, C, C++과 정확히 반대)
    • 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려감
  • 가장 중요한 개념을 가장 먼저 표현, 세세한 사항은 가장 마지막에 표현
• 가로 형식 맞추기
  • 짧은 행이 바람직함
    • 한줄에 최대 120자 정도로 행 길이 제한
  • 가로 공백과 밀집도
    • 가로로는 공백을 사용해서 밀접한 개념과 느슨한 개념 표현
      • 할당문은 공백을 넣어서 왼쪽 요소와 오른쪽 요소를 분명히 나뉘게 함
      • 함수와 인수는 밀접하므로 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않음
      • 함수를 호출하는 코드에서 괄호 안 인수는 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해 공백으로 분리함 
      • 연산자 우선순위를 강조하기 위해서도 공백 사용(ex: b*b - 4*a*c)
  • 가로 정렬 
    • 정렬이 필요할 정도로 목록이 길다면 문제는 목록의 길이지 정렬 부족이 아님
  • 들여쓰기
    • 범위(scope)로 이뤄진 계층을 표현하기 위해 코드를 들여씀
    • 들여쓰기 무시하기
      • 간단한 if 문, 짧은 while 문, 짧은 함수에서도 들여쓰기를 넣음
    • 가짜 범위
      • 빈 while 문이나 for 문은 가능한 한 피함
        •  피하지 못할 경우 빈 블록을 올바로 들여쓰고 괄호로 감쌈
        • 세미콜론(;)은 눈에 띄도록 새 행에다 제대로 들여써서 넣어줌

        • while (dis.read(buf, 0, readBufferSize) != -1)
          ;

• 팀 규칙
  • 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어지고, 스타일은 일관적이고 매끄러워야 함
  • 어디에 괄호를 넣을지, 들여쓰기는 몇 자로 할지, 클래스와 변수와 메서드 이름은 어떻게 지을지 등 논의

 

---

 

6. 객체와 자료 구조

• 자료 추상화
  • 변수를 private로 선언하더라도 각 값마다 조회(get) 함수와 설정(set) 함수를 제공한다면 구현을 외부로 노출하는 셈

    • public interface Point {
          /* 인터페이스가 자료구조를 명백히 표현하고 있음 */
          double getX();
          double getY();
          void setCartesian(double x, double y);
          double getR();
          double getTheta();
          void setPolar(double r, double theta);
      }

  • 구현을 감추려면 추상화가 필요함
    • 추상 인터페이스를 제공해서 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스
  • 인터페이스나 조회/설정 함수만으로는 추상화가 이루어지지 않음
    • 자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 것이 좋음

    • public interface Vehicle {
          /* 자동차 연료 상태를 구체적인 숫자 값으로 알려줌 */
          double getFuelTankCapacityInGallons();
          double getGallonsOfGasoline();
      }

    • public interface Vehicle {
          /* 자동차 연료 상태를 백분율이라는 추상적인 개념으로 알려줌 */
          double getPercentFuelRemaining();
      }

• 자료/객체 비대칭
  • 객체는 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개함
  • 자료 구조는 자료를 그대로 공개하며 별다른 함수를 제공하지 않음
  • 객체와 자료 구조는 상반되는 성격
    • (자료 구조를 사용하는) 절차적인 코드
      • Square, Rectangle, Circle 클래스에서는 간단한 자료 구조로 아무 메서드를 제공하지 않고, Geometry 클래스에서 이 세 가지 도형 클래스를 함수를 통해 다룰 경우
        • Square, Rectangle, Circle에 있는 필드는 public으로 Geometry에서 직접 접근함(ex: s.side, r.height, c.radius)
      • 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다
      • 새로운 자료 구조를 추가하기 어렵다. 그러려면 모든 함수를 고쳐야 한다.
      • 새로운 함수가 필요한 경우, 절차적인 코드와 자료 구조가 좀 더 적합!
    • 객체 지향 코드
      •  Square, Rectangle, Circle 클래스에서 필드가 private이고 공통된 인터페이스인 Shape를 구현할 경우
      • 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다
        • 새 클래스 추가하고 인터페이스 Square에 정의된 공통 메서드를 다형적으로 구현
      • 새로운 함수를 추가하기 어렵다. 그러려면 모든 클래스를 고쳐야 한다.
        • 인터페이스 Square에 새로운 함수를 추가하면, Square, Rectangle, Circle 클래스를 모두 고쳐야 함
      • 새로운 자료 타입이 필요한 경우 클래스와 객체 지향 기법이 가장 적합!
    • 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉬우며, 절차적인 코드에서 어려운 변경은 객체 지향 코드에서 쉬움
• 디미터 법칙
  • 잘 알려진 휴리스틱으로, 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙 
  • 객체는 자료를 숨기고 함수를 공개한다. 객체는 조회함수로 내부 구조를 공개하면 안 된다.
  • 클래스 C의 메서드 f는 ① 클래스 C에 있는 다른 메서드, ② 메서드 f가 생성한 객체의 메서드, ③ 메서드 f의 인수로 넘어온 객체의 메서드, ④ C 인스턴스 변수에 저장된 객체의 메서드만 호출해야 한다.
    • 하지만 ①, ②, ③, ④ 메서드가 반환하는 객체의 메서드는 호출하면 안 됨
    • 디미터 법칙을 어긴 예시

      • /* getOptions() 함수가 반환하는 객체의 getStrachDir() 함수를 호출한 후
           getScartchDir() 함수가 반환하는 객체의 getAbsolutePath() 함수를 호출함 */
        final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

  • 기차 충돌(Train Wreck)
    • 위의 예시를 기차 충돌이라고 함. 여러 객차가 한 줄로 이어진 기차처럼 보임.
      • 조잡하다고 여겨지는 방식이므로 피하는 편이 좋음.
      • 기차 충돌 고치기

        • Options opts = ctxt.getOptions();
          File scratchDir = opts.getScratchDir();
          final String outputDir = scratchDir.getAbsolutePath();

      • 객체라면 내부 구조를 숨겨야 하지만, 자료 구조는 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않음

        • /* ctxt, Options, ScratchDir이 자료 구조일 경우 디미터 법칙 위반이 아님 */
          final String outputDir = ctxt.options.scratchDir.absolutePath;

  • 잡종 구조
    • 절반은 객체 절반은 자료 구조
    • 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어려움
    • 되도록 피해야 함. 프로그래머가 함수나 타입을 보호할지 공개할지 확신하지 못해서 어중간하게 내놓은 설계에 불과함.
  • 구조체 감추기
    • ctxt가 객체라면 뭔가를 하라고 말해야지 속을 드러내라고 말하면 안 됨
• 자료 전달 객체(Data Transfer Object, DTO)
  • 자료 구조체의 전형적인 형태 : 공개 변수만 있고 함수가 없는 클래스
  • DB에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음 사용하는 구조체가 DTO
  • 좀 더 일반적인 형태는 bean 구조
    • 비공개(private) 변수를 조회/설정 함수로 조작. 일종의 사이비 캡슐화.
  • 활성 레코드
    • DTO의 특수한 형태
      • 공개 변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료 구조지만, 대개 save나 find와 같은 탐색 함수도 제공함
      • 활성 레코드는 DB 테이블이나 다른 소스에서 자료를 직접 변환한 결과
    • 활성 레코드는 자료 구조로 취급한다.
      • 활성 레코드에 비즈니스 규칙 메서드를 추가해 이런 자료 구조를 객체로 취급하면 잡종 구조가 나옴 
      • 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성 (여기서 내부 자료는 활성 레코드의 인스턴스일 가능성이 높음)
• 결론
  • 객체는 동작을 공개하고 자료를 숨김
    • 기존 동작을 변경하지 않으면서 새 객체 타입을 추가하기는 쉬움(새로운 자료 타입을 추가하는 유연성)
    • 기존 객체에 새 동작을 추가하기는 어려움
  • 자료 구조는 별다른 동작 없이 자료 노출
    • 기존 자료 구조에 새로운 동작을 추가하기는 쉬움(새로운 동작을 추가하는 유연성)
    • 기존 함수에 새 자료 구조를 추가하기는 어려움