Clean Code 10장 클래스
코드의 표현력과 그 코드로 이루어진 함수에 아무리 신경 쓸지라도 좀 더 차우너 높은 단계까지 신경 쓰지 않으면 깨끗한 코드를 얻기는 어렵다
클래스 체계📝
자바 표준 클래스 정의에 따른 변수 순서
1. 정적 공개 상수
2. 정적 비공개 변수
3. 비공개 인스턴스 변수
4. 공개 변수 (필요한 경우 거의 x)
5. 공개 함수
6. 비공개 함수 (자신을 호출하는 공개 함수 직후에)
추상화 단계가 순차적으로 내려가게 짜여진다
캡슐화🔗
변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다. 때때로 필요하다면 캡슐화를 풀기도 한다. 하지만 그 전에 비공개 상태를 유지할 온갖 방법을 강구해야 한다.
캡슐화를 풀어주는 결정은 언제나 최후의 수단이다
클래스는 작아야 한다❗❗
클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다!!
클래스의 크기를 측정하는 기준은 클래스가 맡은 책임의 수이다. 클래스 안에 정의된 메서드의 수가 작다고 클래스의 크기가 작은 것이 아니다.
클래스 크기를 줄이는 법(책임을 작게 갖는 것)
-
클래스 이름은 해당 클래스 책임을 기술해야 한다
- 간결한 이름이 떠오르지 않으면 클래스가 너무 큰 것
- 클래스 이름에 모호한 단어 Manager, Super등이 들어간다면 클래스가 너무 많은 책임을 가지고 있다는 것
-
클래스 설명은 만일, 그리고, -하며, 하지만을 사용하지 않고서 35단어 내외로 가능해야 한다
- ex) SuperDashboard는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 메커니즘을 제공한다.
단일 책임 원칙🔗
단일 책임 원칙(SRP)
- 클래스나 모듈을 변경할 이유가 하나, 단 하나뿐이어야 한다는 원칙.
- 클래스는 단 하나의 책임만 가져야 한다.
책임, 즉 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다.
큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다.
응집도🔗
클래스는 인스턴스 변수 수가 작아야 한다. 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
'함수를 작게, 매개변수 목록을 짧게'라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 많아진다. 이는 새로운 클래스로 쪼개야 한다는 신호이다. 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼개준다.
응집도를 유지하면 작은 클래스 여럿이 나온다🔗
큰 함수를 작은 함수로 쪼갤 때 필요한 변수들을 클래스 인스턴스로 바꾸면 함수를 쪼개기 쉬워진다. 하지만 그만큼 한 함수에 몇몇 변수들만 사용하기 떄문에 클래스가 응집도가 낮아진다.
응집도가 낮아지면 한 클래스가 아니라 여러 클래스로 쪼갠다. 그래서 큰 함수를 여러 작은 함수로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다.
변경하기 쉬운 클래스💡
깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다. 새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다.
개방-폐쇄의 원칙(OCP)
- 확장에는 개방적이고 수정에 폐쇄적이어야 한다는 원칙
- 기존 코드를 변경하지 않으면서 기능을 추가할 수 있게 설계해야 한다.
변경으로부터 격리🔗
상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 변경에 큰 영향을 받는다. 그래서 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
낮은 시스템 결합도
- 각 시스템 요소가 다른 요소로부터, 변경으로부터 잘 격리되어 있다는 의미
- 시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다
- 유연성과 재사용성이 더 높아진다
의존-역전 원칙(DIP)
- 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙
- 인터페이스나 추상 클래스에 의존하게 만드는 것
ex) 자동차를 구현할 때 어떤 종류의 타이어를 가지게 할 것인가?
class TestCar {
private SandTire tire;
public void testSetTire(SandTire tire) {
this.tire = tire;
}
public String getTireType() {
return tire.getType();
}
}
class SandTire {
public String getType() {
return "SandTire";
}
}TestCar의 타이어가 구체적인 SandTire에 의존하고 있으므로 타이어의 종류를 바꾸고 싶을 때마다 계속해서 코드에 변경사항이 일어나게 된다. 이 경우 OCP 원칙은 물론이고 DIP원칙도 어기게 된다. 이를 Tire 인터페이스를 사용해서 수정할 수 있다.
class Car {
private Tire tire;
public void setTire(Tire tire) {
this.tire = tire;
}
public String getTireType() {
//System.out.println(this.tire.getType());
return this.tire.getType();
}
}
interface Tire {
public String getType();
}
class SandTire implements Tire {
@Override
public String getType() {
// TODO Auto-generated method stub
return "SandTire";
}
}
class SnowTire implements Tire {
@Override
public String getType() {
// TODO Auto-generated method stub
return "SnowTire";
}
}
class NormalTire implements Tire {
@Override
public String getType() {
// TODO Auto-generated method stub
return "NormalTire";
}
}이렇게 Tire 인터페이스를 이용해서 구현을 하게 되면 Car 클래스에서 타이어 종류를 바꿔서 사용하고 싶을 때 사용하는 클라이언트 클래스에서만 수정을 하면 된다. 따라서 쉽게 수정이 가능하다. 또한 다른 종류의 타이어를 사용하고 싶을 때는 구체적인 타이어 클래스가 Tire 인터페이스를 implements 하게 되므로 쉽게 추가할 수 있다. 따라서 OCP원칙과 DIP원칙을 모두 만족할 수 있다.
느낀점🙊
클래스라는 부분이 되게 되게 프로그램 설계에서 중요한 부분이다. 졸작을 하면서 직접 클래스를 설계하는 경험을 했는데, 생각보다 하나의 책임만을 클래스에 넣는다는 게 쉽지만은 않았다. 그래도 하는 프로젝트 자체가 어마무시하게 크기가 큰 건 아니다보니까 만드는 클래스 자체도 그렇게 크게 되지는 않았다.
사실 가장 큰 문제는 OCP 원칙이었다. 변경을 할 때 기존의 코드가 달라지면 안된다는 이 원칙은 항상 내가 코드에 변경을 할 때 위반되는 규칙이었다. 그만큼 나는 처음 코드를 짤 때 변경을 고려하지 않고 코드를 짠다는 것을 알 수 있었다.
그렇다보면 변경을 할 때면 코드 전체를 뒤엎게 되는 일이 일어나기도 했다. 하하핳.... 오히려 처음부터 만드는 게 더 쉽겠다 싶은 생각도 들었다... 하하핳... 처음에 설계가 잘못된 게 이렇게 큰 타격이 있구나도 알게되는 시간이었다. 그래서 요즘은 시간이 조금 오래 걸릴지라도 코딩을 하기 전에 구조를 먼저 짜려고 한다. 내가 만들고자 하는 기능이 어떤 것인지를 확실하게 알고, 구현하는 데 필요한 것들을 적는다. 그리고 수도 코드를 짜면서 논리를 만들고 세세하게 구현을 한다.
시간이 오래 걸리긴하지만 전체적인 코드 구조를 빠르게 짤 수 있고 이해하기 쉽고, 내 생각대로 되지 않는 부분을 정확하게 알 수 있다는 장점이 있다. 그래서 그 부분만 수정할 수 있어서 익숙해지기 위해 노력하는 중이다.
디자인패턴을 저번 학기에 배웠어서 이 책을 읽으면서 SRP, OCP, DIP 나오는 것들이 다시 중요하다는 것을 알게 되었다. 계속해서 내가 코드를 짤 때 응용할 수 있도록 노력해야겠다는 생각이 들었다.
