[Clean Code]형식 맞추기, 객체와 자료구조

Clean Code

형식 맞추기

적절한 행 길이를 유지하라

• 파일 길이가 짧아도, 커다란 시스템을 구축할 수 있다.
• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

개념은 빈 행으로 분리하라

• 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
• 생각 사이는 빈 행을 넣어 분리해야 마땅하다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

세로 밀집도

• 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다.

수직 거리

• 서로 밀접한 개념은 세로로 가까이 둬야 한다.
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
• 변수 선언
  • 변수는 사용하는 위치에 최대한 가가이 선언한다.
• 인스턴스 변수
  • 클래스 맨 처음에 선언한다.
  • 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
• 종속 함수
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  • 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

가로 형식 맞추기

120자 정도로 행 길이를 제한한다.

• 가로 공백과 밀집도
  • 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
• 들여쓰기
  • 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다. 이렇듯 범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
  • 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.

객체와 자료 구조

자료 추상화

• 변수를 private으로 선언하더라도 각 값마다 조회(get) 함수와 설정(set)함수를 제공한다면 구현을 외부로 노출하는 셈이다.
• 변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지는 않는다. 구현을 감추려면 추상화가 필요하다.
• 추상 인터페이스를 제공해 사용자가 구현을 모른 채 자료의 핵심을 조작할 수 있어야 진정한 의미의 클래스다.

    구체적인 Point 클래스
    public class Point{
        public double x;
        public double y;
    }
  
    추상적인 Point 클래스
    public interface Point{
        double getX();
        double getY();
        void setCartesian(double x, double y);
        double getR();
        double getTheta();
        void setPolar(double r, double theta);
    }
  
    구체적인 Vehicle 클래스
    public interface Vehicle{
        double getFuelTankCapacityInGallons();
        double getGallonsOfGasoline();
    }
  
    추상적인 Vehicle 클래스
    public interface Vehicle{
        double getPerccentFuelRemaining();
    }
  

• 자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 편이 좋다.

자료/객체 차이

• 객체: 추상화 뒤로 자료를 숨긴 채 자료를 다루는 함수만 공개한다.
• 자료 구조: 자료를 그대로 공개하며 별다른 함수를 제공하지 않는다.

자료/객체 비대칭

• (자료 구조를 사용하는) 절차적인 코드
  • 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다.
  • 반면, 새로운 자료 구조를 추가하기 어렵다. 모든 함수를 고쳐야 한다.
• (interface를 사용하는) 객체 지향 코드
  • 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.
  • 반면, 새로운 함수를 추가하기 어렵다. 모든 클래스를 고쳐야 한다.

새로운 함수가 아니라 새로운 자료 타입이 필요한 경우 -> 클래스와 객체 지향 기법이 적합
새로운 자료 타입이 아니라 새로운 함수가 필요한 경우 -> 절차적인 코드와 자료구조가 적합

디미터 법칙

• 디미터 법칙은 잘 알려진 휴리스틱으로, 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다.
• 메서드가 반환하는 개체의 메소드는 호출하면 안 된다.
  • final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();
    위와 같은 코드를 기차 충돌이라 부른다.
    Options opts = ctxt.getOptions();
    File scratchDir = opts.getScratchDir();
    final String outputDir = scratchDir.getAbsolutePath();
    다음과 같이 나누는 편이 좋다.

• 자료 구조는 무조건 함수 없이 공개 변수만 포함하고, 객체는 비공개 변수와 공개 함수를 포함하면 간단해진다.

• 잡종 구조
  단순한 자료구조에도 조회 함수와 설정 함수를 정의하라 요구하는 프레임워크와 표준(ex: bean)이 존재하기에 객체와 자료구조가 섞인 잡종 구조가 나오는데, 이는 새로운 함수, 새로운 자료 구조 둘 다 추천하기 어려운 단점만 모아놓은 구조로 피하는 편이 좋다.

• 구조체 감추기
  ctxt, options, scratchDir이 객체라면 위와 같이 체이닝을 해서는 안된다. 객체는 내부 구조를 감춰야 하기에 내부를 노출하는 get 함수는 썩 내키지 않는다.

    String outFile = outputDir + "/" + className.replace('.','/')+".class";
    FileOutputStream fout = new FileOutputStream(outFile);
    BufferedOutputStream bos = new BufferedputStream(fout);
  

  임시 디렉터리의 절대 경로를 얻으려는 이유가 임시 파일을 생성하기 위한 목적이라는 사실이 드러난다. 그렇다면, ctxt 객체에 임시 파일을 생성하라고 시키면 어떨까?

    BufferedOutputStream bos = ctxt.createScratchFileStream(ClassFileName);
  

  ctxt는 내부 구조를 드러내지 않으며, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다. 따라서 다미터 법칙을 위반하지 않는다.

자료 전달 객체

• 자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스다.
• 이런 자료 구조체를 때로는 자료 전달 객체 DTO라 한다.
• DTO는 데이터베이서에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체다.
• 활성 레코드
  • DTO에서 save나 find와 같은 탐색 함수도 제공한다.
  • 활성 레코드에 비즈니스 규칙 메소드를 추가 하면 잡종 구조가 되기 때문에 바람직하지 않다.