반응형
『Clean Code(클린 코드) 애자일 소프트웨어 장인 정신 - 로버트 C. 마틴』 을 읽고 요약한 내용입니다.
코드의 표현력과 그 코드로 이루어진 함수에 아무리 신경쓸지라도 좀 더 차원 높은 단계까지 신경 쓰지 않으면 깨끗한 코드를 얻기는 어렵다.
- 클래스 체계
클래스를 정의하는 표준 자바 관례 : 변수 목록 → 정적 static 공개 public 상수 → 정적 비공개private 변수 → 비공개 인스턴스 변수 → 공개 변수 (필요한 경우는 거의 없다.) 변수 목록 다음에는 공개 함수 → 비공개 함수
즉, 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.
- 캡슐화
변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다. 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다.
캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.
- 캡슐화
- 클래스는 작아야 한다!
얼마나 작아야 하는가? 함수는 물리적인 행 수로 크기를 측정했다면 클래스는 클래스가 맡은 책임을 센다.
클래스 이름은 해당 클래스 책임을 기술해야 한다. 작명이 크기를 줄이는 첫 번째 관문이다. 클래스 이름에 Processor, Manager, Super 등과 같이 모호한 단어가 있다면 클래스에다 여러 책임을 떠안겼다는 증거다.
클래스 설명은 만일(if), 그리고(and), -하며(or), 하지만(but)을 사용하지 않고 25단어 내외로 가능해야 한다.
- 단일 책임 원칙 SRP (Single Responsibility Principle)
클래스나 모듈을 변경할 이유가 단 하나 뿐이어야 한다는 원칙이다. ‘책임’이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.
책임, 즉 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다.
큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다. 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다. - 응집도 Cohesion
클래스는 인스턴스 변수 수가 작아야 한다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다. 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다. 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
일반적으로 이처럼 응집도가 가장 높은 클래스는 가능하지도 바람직하지도 않다. 그렇지만 우리는 응집도가 높은 클래스를 선호한다. 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미기 때문이다. - 응집도를 유지하면 작은 클래스 여럿이 나온다
큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다. 큰 함수 일부를 작은 함수로 빼내고 변수를 클래스 인스턴스 변수로 승격한다면 작은 함수는 인수가 필요없다. 그만큼 쪼개기 쉬워진다. 하지만 응집력을 잃는다. 클래스가 응집력을 잃는다면 쪼개라!
- 리팩터링한 프로그램은 좀 더 길고 서술적인 변수 이름을 사용한다.
- 리팩터링한 프로그램은 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용한다.
- 가독성을 높이고자 공백을 추가하고 형식을 맞추었다.
- 단일 책임 원칙 SRP (Single Responsibility Principle)
- 변경하기 쉬운 클래스
대다수 시스템은 지속적인 변경이 가해진다. 그리고 뭔가 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다. 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
변경하기 쉬운 클래스는 OCP (Open-Closed Principle)도 지원한다. 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙이다.
새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 구조가 바람직하다. 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지 않는다.
- 변경으로부터 격리
요구사항은 변하기 마련이다. 따라서 코드도 변하기 마련이다. 객체지향 프로그래밍 입문에서 우리는 구체적인 concrete 클래스와 추상 abstract 클래스가 있다고 배웠다. 구체적인 클래스는 상세한 구현(코드)을 포함하며 추상 클래스는 개념만 포함한다고도 배웠다. 그래서 우리는 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
상세한 구현에 의존하는 코드는 테스트가 어렵다.
상세한 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다. 결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미이다. 시스템 요소가 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다.
결합도를 최소로 줄이면 자연스럽게 또 다른 클래스 설계원칙인 DIP (Dependency Inversion Principle)를 따르는 클래스가 나온다. 본질적으로 DIP는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.
- 변경으로부터 격리
반응형