이 글에서 분류한 기준은 책의 내용을 바탕으로 주관적인 견해로 재정리해본 것입니다.

클래스 체계

표준 자바 관례에 따르면

• 가장 먼저 변수 목록이 나와야 한다.
  • 1) public static 상수
  • 2) private static 변수
  • 3) 비공개 인스턴스 변수
  • 4) 공개 변수
  • 공개 변수가 필요한 경우는 거의 없다.
• 그 다음으로 함수가 나와야 한다.
  • 1) 공개 함수
  • 2) 공개 함수에서 호출되는 비공개 함수
  • 즉, 추상화 단계가 순차적으로 내려간다.

캡슐화

• 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 좋다. (캡슐화)
• 하지만 캡슐화를 풀어주는 결정이 필요할 때도 있다.
  • 같은 패키지 안에서 테스트 코드가 함수를 호출하거나 변수를 사용해야 한다면, 그 함수나 변수를 protected로 선언하거나 패키지 전체로 공개하여 테스트 코드에 접근을 허용하기도 한다.
  • 비공개 상태를 유지할 방법을 강구하고, 최후의 수단으로 캡슐화를 풀어주어야 한다.

깨끗한 클래스

클래스의 크기

클래스 크기의 기준

• 클래스는 작아야 한다.
• 함수가 물리적인 행 수로 크기를 측정한다면, 클래스는 맡은 책임을 센다.
  • 함수의 개수가 아닌 책임

클래스의 책임

• 클래스 이름은 해당 클래스의 책임을 기술해야 한다.
  • 클래스 크기를 줄이는 첫 번째 관문
  • 간결한 이름이 떠오르지 않는다면 클래스의 크기가 너무 큰 것이다.
  • 클래스 이름이 모호하다면 클래스의 책임이 너무 많아서이다.
• 클래스 설명은 만일(if), 그리고(and), -하며(or), 하지만(but)을 사용하지 않고서 25자 단어 내외로 가능해야 한다.
  • 나쁜 예) SuperDashboard 클래스는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 매커니즘을 제공한다.

단일 책임 원칙

Single Responsibility Principle (SRP)

큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다. 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

• 클래스나 모듈을 변경할 이유가 단 하나 뿐이어야 한다.
• SRP는 책임이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.
• 클래스는 책임, 즉 변경할 이유가 하나여야 한다.

응집도 Cohesion

응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미이다.

응집도를 높이는 법: 인스턴스 변수

• 클래스는 인스턴스 변수 수가 작아야 한다.
• 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
• 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
  • 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
• 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다면 새로운 클래스로 쪼개야 한다.

응집도를 유지하기

• 응집도를 유지하면 작은 클래스 여럿이 나온다.
• 클래스가 응집도를 잃는다면 쪼개야 한다.
  • 큰 함수를 작은 함수 여럿으로 나눌 때, 빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용할 경우
  • 네 변수를 클래스 인스턴스 변수로 승격한다면 함수를 쪼개기 쉬워지나, 클래스는 응집력을 잃는다.
  • 이 경우 독자적인 클래스로 분리하면 된다.

리팩터링 시

• 리팩터링한 프로그램은 좀 더 길고 서술적인 변수 이름을 사용한다.
• 리팩터링한 프로그램은 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용한다.
• 가독성을 높이고자 공백을 추가하고 형식을 맞춘다.

변경하기 쉬운 클래스

• 대다수 시스템은 지속적인 변경이 가해진다.
• 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다.
• 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.

클래스 개선

• 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사한다.
• 하지만 실제로 개선에 뛰어드는 계기는 시스템이 변해서라야 한다.
• 클래스를 논리적인 완성으로 여긴다면 책임을 분리하려 시도할 필요가 없다.

Open Closed Principle (OCP)

클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다.

• 새 기능을 추가(책에서는 ‘수정’이라고 되어있으나, 이 편이 맞는 말인 듯하다)하거나 기존 기능을 변경할 때 건드릴 코드가 최소힌 시스템 구조가 바람직하다.
  • 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지 않는다.

결합도

변경으로부터 격리

• 요구사항은 변하므로 코드도 변하기 마련이다.
• 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리해야 한다.
  • 상세한 구현(코드)를 포함하는 구체적인(concrete) 클래스와 개념만 포함하는 추상(abstract) 클래스가 있다.
  • 이때, 구체적인 클래스는 구현이 바뀌면 위험에 빠진다.
• 상세한 구현에 의존하는 코드는 테스트가 어렵다.

결합도를 낮추기

결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미이다.

• 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.
• 시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 쉬워진다.

Dpendency Inversion Principle (DIP)

클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙

• 결합도를 최소로 줄이면 자연스럽게 DIP를 따르는 클래스가 나온다.
• 추상화로 구체적인 사실을 모두 숨긴다.

Reference

참고 서적

📔 Clean Code