TIL (2022.01.30)

DAY 10

🔖 오늘 읽은 범위 : 5장, 형식 맞추기 (~p.116)

😃 책에서 기억하고 싶은 내용을 써보세요.

• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
• 형식을 맞추는 목적
  • 코드 형식은 중요하다! (...) 너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안 된다.
  • 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적
    인 의무다.
  • 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
• 적절한 행 길이를 유지하라
  • 표 5-1 이 우리에게 무엇을 말하느냐고? 500줄을 넘지 않고 대부분 20여줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다.
  • 신문 기사처럼 작성하라
    • 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
    • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
    • 신문이 사실, 날짜, 이름 등을 무작위로 뒤섞은 긴 기사 하나만 싣는다면 아무도 읽지 않으리라.
  • 개념은 빈 행으로 분리하라
    • 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
    • 빈 행은 새로운 개념을 시작한다는 시각적 단서다.
  • 세로 밀집도
    • 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
  • 수직 거리
    • 서로 밀접한 개념은 세로로 가까이 둬야 한다.
    • 타당한 근거가 없다면 서로 밀집한 개념은 한 파일에 속해야 마땅하다 . 이게 바로 protected 변수를 피해야 하는 이유 중 하나다.
    • 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
    • 변수 선언
      • 변수는 사용하는 위치에 최대한 가까이 선언한다.
      • 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.
    • 인스턴스 변수
      • 반면, 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 많은 (혹은 대다수) 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
      • 일반적으로 C++에서는 모든 인스턴스 변수를 클래스 마지막에 선언한다는 소위 가위 규칙(scissors rule)을 적용한다. 하지만 자바에서는 보통 클래스 맨 처음에 인스턴스 변수를 선언한다.
      • 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다.
    • 종속 함수
      • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
      • 참고로, 위(여기서는 아래) 코드는 상수를 적절한 수준에 두는 좋은 예제다. getPageNameOrDefault 함수 안에서 "FrontPage" 상수를 사용하는 방법도 있다. 하지만 그러면 기대와는 달리 잘 알려진 상수가 적절하지 않은 저차원 함수에 묻힌다.

        private String getPageNameOrDefault ( Request request, String defaultPageName)
        {
        	String pageName = request.getResource();
        	if (StringUtil.isBlank(pageName))
        		pageName = defaultPageName;
        
        	return pageName;
        }

    • 개념적 유사성
      • 친화도가 높을수록 코드를 가까이 배치한다 .
      • 친화도가 높은 요인은 여러 가지다.
        • 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 한 예다.
        • 변수와 그 변수를 사용하는 함수도 한 예다.
        • 비슷한 동작을 수행하는 일군의 함수가 좋은 예다.
  • 세로 순서
    • 일반적으로 함수 호출 종속성을 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
• 가로 형식 맞추기
  • 프로그래머는 명백하게 짧은 행을 선호한다. 그러므로 짧은 행이 바람직하다.
  • 가로 공백과 밀집도
    • 가로로는 공백을 사용해 밀집한 개념과 느슨한 개념을 표현한다.
    • int lineSize = line.length();
      • 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
    • lineWidthHistogram.addline(lineSize, lineCount);
      • 반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문이다.
      • 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.
    • return (-b - Math. sqrt(determinant) ) / (2*a) ;
      • 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.
      • 승수 사이는 공백이 없다. 곱셈은 우선순위가 가장 높기 때문이다.
      • 항 사이에는 공백이 들어간다. 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.
  • 가로 정렬
    • 하지만 나는 위와 같은 정렬이 별로 유용하지 못하다는 사실을 깨달았다. 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.

      public class FitNesseExpediter 加plements ResponseSender
      {
      		// 변수 유형은 무사하고 변수 이름부터 읽게 된다.
      		private Socket           socket;
      		private InputStream      input;
      		private OutputStream     output;
      		private Request          request;
      		...
      }
      
      public FitNesseExpediter(Socket          s,
      												 FitNesseContext context) throws Exception
      {
      		// 할당 연산자는 보이지 않고 오른쪽 피연산자에 눈이 간다.
      		this.context =     context;
      		socket =           s;
      		input =            s.getInputStream();
      		output =           s.getOutputStream();
          ...
      }

    • 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
  • 들여쓰기
    • 이렇듯 범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
    • 프로그래머는 이런 들여쓰기 체계에 크게 의존한다. 왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다. 그러면 이 범위에서 저 범위로 재빨리 이동하기 쉬워진다.
    • 들여쓰기한 파일은 구조가 한눈에 들어온다.
    • 들여쓰기 무시하기
      • 이런 유혹에 빠질 때마다 나는 항상 원점으로 돌아가 들여쓰기를 넣는다.
  • 가짜 범위
    • 때로는 빈 while 문이나 for 문을 접한다. 나는 이런 구조를 좋아하지 않기 에 가능한 한 피하려 애쓴다.
    • 세미콜론(;)은 새 행에다 제대로 들여써서 넣어준다. 그렇게 하지 않으면 눈에 띄지 않는다.
• 팀 규칙
  • 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
  • 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
  • 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. (...) 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.
• 밥 아저씨의 형식 규칙
  • 코드 자체가 최고의 구현 표준 문서가 되는 예다.

🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 오늘은 한 챕터를 하루에 읽는 스케쥴이다보니 생각보다 다 읽는데 시간이 빠듯했다.
• 이상적인 ‘코드 형식’에 대해 공부하면서 느낀 점은, 이 형식은 나만 알고 있으면 무의미하다는 점이다. 실제로 일을 할 때 코드를 보면, 여러 사람이 참여하는 만큼 네이밍 스타일이나 코드 형식이 모두 제각각이라 어려움을 겪을 때가 많다. 사람마다 코드를 작성하는 스타일, 혹은 이상적으로 생각하는 스타일이 다르기 때문에 어쩌면 당연한 결과이다. 그렇기 때문에 밥 아저씨의 말처럼 팀은 한 가지 규칙(팀 규칙)에 합의 해야한다고 생각한다. 그래야 일관적인 소프트웨어를 유지하여 생산성을 높일 수 있으니까.

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• Java 접근 제어자(Access Modifier)

  • 접근 제어자를 사용하는 이유는 클래스의 내부에 선언된 데이터를 보호하기 위해서이다.
  • 이것을 데이터 감추기라고 하며 객체지향 개념에선 캡슐화(encapsulation)이라 한다.
  • 접근 제어자 종류 1) private : 같은 클래스 내에서만 접근 가능 2) default : 같은 패키지 내에서만 접근 가능 3) protected : 같은 패키지 내에서, 그리고 다른 패키지의 자손 클래스에서 접근 가능 4) public : 접근 제한이 전혀 없다.
    
  • 참고 링크: https://88240.tistory.com/448

• protected 변수를 피해야 한다?

  protected의 경우,
  해당 class에 선언된 친구가 아닌 변수를 자유롭게 호출 가능해지고, 심지어 외부 패키지의 변수를 갑자기 사용하는 케이스가 생길 수 있으므로, 밀접한 개념이 세로로 가까워야한다는 원칙에 벗어나기 때문이다.

소감 3줄 요약

• 코드 형식은 의사소통의 일환이다.
• 코드는 신문 기사처럼 작성하라. 고차원적인 개념을 먼저 다루고, 아래로 내려갈수록 저차원적인 내용을 다뤄라.
• 코드 자체가 최고의 구현 표준 문서가 되게 하라. (코드를 읽기 쉬운 문서로 만들어라!)