클래스를 설계할 때 참고할 수 있는 몇가지 원칙이 있음.
원칙을 따르지 않을 때 더 빨리 개발하기도 하지만 절약한 개발 시간보다 훨씬 많은 유지보수 시간이 필요할 지도 모른다.
그림 reference: https://blog.siner.io/2020/06/18/solid-principles/
1. 단일 책임 원칙(SRP: Single-Responsibility Principle)
"클래스를 변경해야 하는 이유는 오직 하나여야한다."
작성된 클래스는 하나의 기능만 가지며 클래스가 제공하는 모든 서비스는 그 하나의 책임을 수행하는데 집중되어야 한다는 원칙.
다른 말로 해석하자면, 단일의 책임을 갖기에 클래스 변경의 이유는 오직 하나(단일 책임 관련)란 뜻이다.
2. 개방 폐쇄 원칙(OCP: Open-Closed Principle)
"확장(상속)에는 열려 있고, 변경에는 닫혀있어야 한다."
소프트웨어 구성요소(컴포넌트, 클래스, 모듈, 함수)는 확장에는 열려있고, 변경에는 닫혀있어야 한다는 원칙.
3. 리스코프 교체의 원칙(LSP: Liskov Substitution Principle)
"기반 클래스는 파생 클래스로 대체할 수 있어야 한다."
자식 클래스는 언제나 자신의 부모 클래스를 대체할 수 있다는 원칙.
4. 의존 관계 역전 원칙(DIP: Dependency Inversion Principle)
"클라이언트는 구체 클래스가 아닌 추상 클래스(인터페이스)에 의존해야 한다."
의존 관계를 맺을 때 변화하기 쉬운 것 또는 자주 변화하는 것보다는 변화하기 어려운 것, 거의 변화가 없는 것에 의존하라는 것. 한마디로 구체적인 클래스보다 인터페이스나 추상 클래스와 관계를 맺으라는 원칙.
5. 인터페이스 분리의 원칙(ISP: Interface Segregation Principle)
"하나의 일반적인 인터페이스보다는 구체적인 여러 개의 인터페이스가 낫다."
어떤 클래스가 다른 클래스에 종속될 때에는 가능한 최소한의 인터페이스만을 사용해야 한다. 다른 말로 ISP를 하나의 일반적인 인터페이스보다는, 여러 개의 구체적인 인터페이스가 낫다라 정의할 수 있다.
좋은 설계는 모듈의 응집도를 높이고, 결합도를 낮추는 설계.
특히 객체지향에서는 클래스 하나가 단일 기능을 갖도록 설계해야 함.
하지만 실제로 설계를 하다보면 기능이 두 개 존재하는 경우가 종종 있음.
단일 책임 원칙은 "클래스는 한 가지 책임(기능)만 갖도록 설계한다."란 뜻이다. 클래스 안에 두 개의 책임(기능)이 있도록 설계하면 이는 '응집력'이 떨어지는 설계이다. 따라서 단일 책임(기능)을 갖도록 응집도가 높은 설계를 하자는 것이다.
이 원칙은 객체 수가 다소 늘어나고 구조가 복잡해지더라도 재사용 및 유지보수를 위해 지켜져야 할 원칙이다.
응집도가 낮으면..?
- 1. 이해하기 어렵다.
: 여러 책임이 혼재되어 있기에 코드 양도 방대할 뿐 더러 어느 부분이 어느 책임을 담당하는지 식별하기도 힘들 것이다.- 2. 재사용하기 힘들다.
: 특정 기능을 위해 재사용하려는데 응집도가 낮은 모듈은 여러 기능이 혼재되어 있다. 전체 SW의 크기도 무의미하게 커질 것이며, 기능을 수행하려는 특정 인터페이스를 식별하기도 힘들 것이다.- 3. 유지보수가 힘들다
- 3. 다른 모듈의 변화에 민감하다.
: 여러 책임은 곧 여러 다른 객체들과의 의존 관계 증가를 의미한다. 의존 관계의 증가는 필연적으로 수정될 수 있는 가능성을 더 크게 할 뿐이다.
(응집도와 결합도 관련 포스팅)
https://velog.io/@jinh2352/SW-%EC%84%A4%EA%B3%84%EC%9D%98-%EA%B3%A0%EA%B3%A0%ED%95%99#%EC%9D%91%EC%A7%91%EB%8F%84cohesion-%EA%B2%B0%ED%95%A9%EB%8F%84coupling
하나의 책임이라는 것은 모호하다. 중요한 기준은 변경이다. 변경이 있을 때 파급 효과가 적으면 단일 책임 원칙을 잘 따른 것이라 할 수 있다.
source: https://platis.solutions/blog/2020/06/22/how-to-write-solid-cpp/
// SRP 위반 예시
struct Camera {};
struct CloudProvider {};
struct Image {};
struct PhotoUploader {
PhotoUploader(Camera& camera, CloudProvider& cloudProvider);
Image getImage();
Image resizeImage(int x, int y, const Image* image);
void uploadImage(Image& image);
};
PhotoUploader 클래스는 Camera, CloudProvider 클래스라는 두 개의 리소스에 의존한다. 멤버 함수를 본다면 클래스에 둘 이상의 책임이 있음을 알 수 있다.
1) 사진을 찍고, 크기를 조절함
2) 이미지를 업로드
이 클래스의 문제는 '인터넷에 업로드하는 방식', '이미지 크기 또는 카메라를 사용하는 방식'이 변경되는 즉시 클래스를 수정해야 한다는 것이다. 결국 단일책임 원칙이 깨지게 된다.
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository = new MemoryMemberReopsitory();
// SRP를 잘 지킨 예
// 할인 정책이 바뀌면 주문 서비스 클래스 코드가 아닌 할인 정책 부분만 수정하면 된다.
private final DiscountPolicy dicountPolicy = new FixDiscountPolicy();
...
}
"클라이언트 입장(인터페이스나 추상 클래스를 참조하는)에선 변화에 견고하고, 모듈 개발자 입장에선 확장에 용이하게"
=> 이를 위해 "다형성"을 잘 활용하여야 한다.
=> "역할과 구현의 분리"
(https://velog.io/@jinh2352/%EB%8B%A4%ED%98%95%EC%84%B1%EC%9D%98-%EC%A7%84%EC%A7%9C-%EC%9D%98%EB%AF%B8)
기존의 코드를 변경하지 않으면서(서버 측의 인터페이스 코드와 기존 구현 코드) 기능을 추가(새로운 인터페이스 구현 코드 추가)할 수 있도록 설계되어야 한다는 원칙. 요구사항이 변경되었을 때 코드에서 변경되어야 하는 부분과 변경되지 않아야하는 부분을 명확히 구분하여, 변경되어야 하는 부분을 유연하게 작성하는 것(수정이 아닌 확장을 통해)을 의미한다.
개방 폐쇄 원칙을 지키지 않고 설계를 한다는 것은 하위 클래스의 특정 기능을 상위 클래스에서 미리 구현하는 것과 같다. 이로 인해 일부 기능이 필요 없는 다른 하위 클래스가 강제로 상속받게 되는 문제가 발생한다.
그러므로 자유롭게 상속하려면 추상 클래스와 구체 클래스를 분리하는 것이 좋다.
결국 "변경에는 닫혀 있다."라는 뜻은 특정 하위 클래스가 상위 클래스에 있는 공통의 기능을 변경하거나 간섭해서는 안된다는 뜻. 그러므로 이 원칙은 객체지향의 기본 개념인 "자유로운 상속을 통한 확장과 재사용성"을 추구하기 위한 원칙이라 할 수 있다.
개방 폐쇄 원칙은 쉽게 말해 "확장은 쉽게, 변경은 어렵게 클래스를 설계하자"는 것이다. 이를 위해선 '확장할 것'과 '변경하면 안되는 것'을 명확히 구분하여야 한다.
도형 면적 구하기 알고리즘 예시
왼쪽 클래스는 도형들의 면적을 구하는 메서드가 하나의 클래스에 모두 존재하는 경우이다. 여기서 클라이언트 측의 요구가 추가되었고, '사다리꼴 면적'을 구하는 알고리즘을 요구한다 생각해보자. 이 경우 '산출 알고리즘' 클래스 자체에 추가(수정)이 이루어져야 하며, 클라이언트가 호출해야 하는 메서드도 알려야 한다('사다리꼴 면적()').
반면 상속의 개념을 적용하여 오른쪽 그림과 같이 설계하면 추상 클래스에 의존하게 되므로, 단순히 추상 클래스를 상속받아 별도의 알고리즘 코드를 파생 클래스 형태로 추가할 수 있으며, 클라이언트 딴에서도 동일하게 '면적()' 메서드만 호출하면 된다.
결국, 개방 폐쇠의 원칙은 변경이 필요한 경우 기존 코드를 변경하지 않으면서 상속과 확장(+ 인터페이스 구현)을 통해 변경할 수 있게 설계하는 것이다. 또한 변경되는 클래스의 영향이 밖으로 미치지 않고 클라이언트에서는 동일한 접근 방식을 할 수 있기에 추상 클래스/인터페이스는 '완충 장치'의 역할으로도 볼 수 있다.
클라이언트 코드 변경의 문제점
(referece: 김영한의 '스프링 핵심 원리 -기본편' 강의)
아래 코드를 보면 다형성을 지키지만 클라이언트 코드가 변경됨을 피할 수 없다.// 기존 코드 MemberRepository m = new MemoryMemberRepository(); // 변경 코드 MemberRepository m = new JdbcMemberRepository();
위 코드를 보면 알 수 있듯이 구현 객체를 변경하려면 클라이언트 코드를 변경해야 한다.
분명 다형성을 사용했지만 OCP 원칙을 지킬 수 없다.
이러한 문제를 해결하기 위해 객체를 생성하고, 연관관계를 맺어주는 별도의 조립, 설정자가 필요하다.
이 별도의 무언가가 소위 '스프링 컨테이너'가 해주는 것이다. 이를 위해 IoC, DI 개념 등이 필요하다.
기반 클래스에 들어갈 자리에 파생 클래스를 넣어도 문제없이 잘 동작함을 의미한다. 달리 말해 자식 객체에 접근할 때 그 부모 객체의 인터페이스로 접근하더라도 아무런 문제가 없어야 한다는 것이다.
예를 들어, 기능이 추가된 물건이 새로 만들어 졌을 때, 사용자가 기존 방식대로 사용해도 불편함이나 문제없이 작동해야 한다는 뜻이다.
문서 편집기의 신버전이 출시되었을 때 구버전에서 작업한 내용을 신버전에서도 계속 사용할 수 있도록 설계.
리스코프 교체의 원칙은 서브 타입(상속받은 하위 클래스-신버전)은 어디에서나 자신의 기반 타입(상위 클래스-구버전)으로 교체할 수 있어야 함을 의미한다. 즉 하위 클래스가 상위 클래스의 메서드 중에서 일부를 거부하면 안된다. 대체가 불가능하면 이는 잘못된 상속이다. 그러므로 하위 클래스를 설계할 때는 기반 타입(상위 클래스-구버전)의 규칙을 잘 이해하여 설계하고 후에 서브 타입에 새로운 기능이 추가될 때 이를 기반 타입에서도 처리할 수 있어야 한다.
(referece: 김영한의 '스프링 핵심 원리 -기본편' 강의)
- 다형성에서 하위 클래스는 인터페이스 규약을 다 지켜야 한다는 것, 다형성을 지원하기 위한 원칙, 인터페이스를 구현한 구현체는 믿고 사용하려면, 이 원칙이 필요.
- 자동차 인터페이스 엑셀은 앞으로 가라는 기능, 뒤로 가게 구현하면 LSP 위반, 느리더라도 앞으로 가야함.
대표적인 LSP 위반 사례는 '직사각형(추상)' <- '정사각형(파생)' 사례이다.
아래 직사각형 클래스는 가로/세로 길이에 대한 get/set 및 면적 게산을 위한 멤버 함수를 가진다.
class Rectangle {
protected:
int width, height;
public:
Rectangle(const int width, const int height)
: width(width), height(height)
{}
int get_width() const {
return width;
}
int get_height() const {
return height;
}
virtual void set_width(const int width) {
this->width = width;
}
virtual void set_height(const int height) {
this->height = height;
}
int area() const {
return width * height;
}
};
그리고 이 직사각형 클래스를 상속하는 정사각형 클래스의 구현은 아래와 같다. 이 가로/세로 set 멤버 함수를 모두 오버라이딩 한다.
// 직사각형의 특별한 형태인 정사각형 클래스
class Square : public Rectangle {
public:
Square(int size)
: Rectangle(size, size)
{}
void set_width(const int width) override {
this->width = this->height = width;
}
void set_height(const int height) override {
this->height = this->width = height;
}
};
언뜻보기엔 문제될 것이 없지만 이러한 접근 방법은 문제를 일어킨다. 이 정사각형 객체를 부모인 직사각형 객체로서 접근하면 의도치 않은 상황이 발생한다.
void process(Rectangle& r) {
int w = r.get_width();
r.set_height(10);
cout << "직사각형의 세로 길이를 10으로 바꾼 후 넓이 구하기" << endl;
cout << "기대 값: " << w * 10 << endl;
cout << "실게 값: " << r.area() << endl;
}
int main() {
Rectangle r(3, 4); // 가로 길이가 3, 세로 길이가 4인 직사각형 객체
Square s(5); // 가로, 세로 길이가 5인 정사각형 객체
cout << "(가로 길이가 3, 세로 길이가 4인 직사각형 객체)" << endl;
process(r);
cout << endl;
cout << "(가로, 세로 길이가 5인 정사각형 객체)" << endl;
process(s);
return 0;
}
클라이언트의 process 함수는 매개변수로 받은 객체의 가로 길이를 가져오고, 세로를 10으로 설정하여 객체의 넓이를 구하는 함수이다.
이 객체가 직사각형 객체(기반 클래스의 객체)라면 정상 작동하나 정사각형 객체(구체 클래스의 객체)라면 의도치 않은 결과를 가져온다.
이는 "자식 객체에 접근할 때 그 부모 객체의 인터페이스로 접근하더라도 문제가 없어야 한다"는 LSP를 위반한 것이다.
비록 작위적인 예제이지만 여기서 교훈은 LSP를 준수하지 않으면 파생된 정사각형 구체 클래스를 그 부모 클래스인 직사각형 타입으로 활용할 때 당장은 괜찮을 수 있어도 나중에 문제가 발견될 수 있다는 것이다.
reference: https://defacto-standard.tistory.com/113
DIP의 첫 번째 의미는 의존 관계를 맺을 때 변화하기 쉬운 것 또는 자주 변화하는 것 보다는 변화하기 어려운 것에 의존하라는 의미이다.
변화하기 어려운 것이란 정책, 전략과 같은 어떠한 큰 흐름이나 개념과 같은 추상적인 것을 뜻하고, 반면 변화하기 쉬운 것이란 파생되는 구체적인 방식, 사물 등이 있다.
예를 들어 아이는 장남감을 가지고 놀며, 장난감은 여러 가지 종류가 있다. 아이가 장난감을 가지고 논다는 것이 '아이가 장난감에 의존한다'로 해석할 수 있다. 따라서 아래와 같은 클래스 다이어그램으로 표현할 수 있다.
여기서 로봇, 레고, RC카 등은 변화하기 쉬운 객체들이며, 이들이 변할 시 의존하고 있는 아이에게 영향을 준다. 즉 코드 관점에서 의존하는 객체의 코드에 영향을 준다는 것이다. 따라서 '장난감'이라는 상위 클래스를 추상 클래스 또는 인터페이스 형태로 두어 아이는 이 '장난감'에 의존하도록 해야 한다.
위와 같이 설계를 하면 변화하기 쉬운 것에 의존하는 것을 없애 파생되는 장난감들의 변경에 영향을 최소화 할 수 있음에 동시에 다형성 측면에서도 장점이 있다. 아이의 행위(메서드)는 어떠한 종류 장난감이든 상관없이 그저 '장난감'을 가지고 논다에 집중하면 된다.
추가로 DIP를 만족하면 의존성 주입(dependency injection)이라는 기술로 변화를 쉽게 수용할 수 있는 코드를 작성할 수 있다. 의존성 주입이란 클래스 외부에서 의존되는 것을 대상 객체의 멤버 변수에 주입하는 기술이다. 아래 포스팅에 간단한 의존성 주입 예제 코드를 볼 수 있다.
class Kid {
private:
Toy toy;
public:
void setToy(Toy toy) {
this->toy = toy;
}
void play() {
...
}
};
...
...
int main(){
Kid k;
Robot r;
Lego l;
k.setToy(r); // or k.setToy(l);
k.play();
}
의존성 주입에 대한 간단한 예제 코드: https://velog.io/@jinh2352/%EB%B2%94%EC%9A%A9%EC%A0%81%EC%9D%B8-%EC%84%A4%EA%B3%84-%EC%9B%90%EC%B9%99#%EC%9D%98%EC%A1%B4%EC%84%B1-%EC%A3%BC%EC%9E%85-dependency-injection
위 그림에서 왼쪽 설계는 구체 클래스에서 상속을 받는 구조이다. 구체 클래스는 추상 클래스(인터페이스)보다 변하기 쉽기에 이러한 설계는 지양해야 한다.
클라이언트는 변화에 직접 영향을 받는 구체 클래스를 상대로 상속 구조를 만들기보다 추상 클래스에 의존해야 한다. 즉 특정 클래스로부터 상속을 받아야 한다면, 기반 클래스(특정 클래스)를 추상 클래스로 만들어야 한다.
의존 관계를 구체 클래스에서 추상 클래스로 바꾸면 향후 변경에 따른 영향을 최소화할 수 있고, 느슨한 결합도를 유지할 수 있다. 오른쪽 그림의 설계와 같이 변화에 따른 충격에서 자유로울 수 있도록 추상 클래스를 만들고 그 추상 클래스와 상속 관계를 유지하도록 설계해야 한다.
정리하자면,
변동성이 큰 구체 클래스를 참조하지 말자
=> 추상 클래스 또는 인터페이스를 참조하라
변동성이 큰 구체 클래스로부터 파생하지 말자
=> 삼각형(추상), 이등변 삼각형, 정삼각형 ..(파생)과 같은 상속 구조보다 도형(추상), 원, 삼각형, 사각형 .. (파생)과 같은 상속 구조가 DIP에 부합하다.
클래스 간에는 인터페이스를 통해 서로 참조한다. 그런데 참조하려는 클래스의 메서드가 수십 개라면 사용자가 알아야 할 메서드가 너무 많고, 클래스 입장에서도 하나의 메서드를 변경하더라도 재컴파일을 해야 하는 번거로움이 있다. 또 그 클래스를 사용하는 다른 클라이언트는 관련된 메서드가 아닌, 전혀 관계없는 메서드의 변화에도 영향을 받게 된다. 따라서 클래스를 설계할 때 꼭 필요한 메서드만 갖도록 설계해야 좋은 설계가 된다. 그러려면 많은 메서드로 구성된 클래스에서 특정 메서드를 분리하는 것이 좋다.
ISP는 쉽게 말해 클라이언트는 자신이 사용하지 않는 메서드와 의존 관계를 맺으면 안된다'이다. 클래스는 사용자에게 꼭 필요한 메서드만 갖는 인터페이스를 제공해야 한다.
단일 책임의 원칙처럼 클래스를 분리할 수 있는 것으로 생각할 수 있는데, 인터페이스 분리의 원칙은 각 클라이언트에 맞는 인터페이스만 분리하여 사용하는 것.
(referece: 김영한의 '스프링 핵심 원리 -기본편' 강의)
자동차라는 인터페이스가 있다. 운전 관련 기능, 정비 관련 기능들이 있다. 운전, 정비 등 다양한 기능들이 하나의 인터페이스에 모두 존재하면 인터페이스가 너무 커지기에 이를 분리하자는 것이 ISP이다.
- 자동차 인터페이스 -> 운전 인터페이스, 정비 인터페이스로 분리
- 사용자 클라이언트 -> 운전자 클라이언트, 정비사 클라이언트로 분리
- 분리하면 정비 인터페이스 자체가 변해도 운전자 클라이언트에 영향을 주지 않음
- 인터페이스가 명확해지고, 대체 가능성이 높아짐
- 인터페이스 덩어리가 크면 당연히 구현도 더 커진다.
참조하기 좋은 포스팅: https://velog.io/@juhwan9408/%EA%B0%9D%EC%B2%B4-%EC%A7%80%ED%96%A5-%EC%84%A4%EA%B3%84-5%EC%9B%90%EC%B9%99-SOLID
referece: 김영한의 '스프링 핵심 원리 -기본편' 강의)
객체 지향의 핵심인 다형성만으로는 쉽게 부품을 갈아 끼우듯이 개발할 수 없다. 구현 객체를 변경할 때 클라이언트 코드도 함께 변경되기 때문이다.
즉, 다형성만으로는 OCP, DIP를 지킬 수 없다는 것이다.
// 기존 코드
MemberRepository m = new MemoryMemberRepository();
// 인터페이스에 의존하지만, 구현 클래스도 동시에 의존한다고 할 수 있다.
// => DIP 위반
// 메모리 저장소가 아닌 JDBC 저장소를 사용하려 코드 변경
MemberRepository m = new JdbcMemberRepository();
// 다형성을 활용해 인스턴스를 유연하게 갈아끼울 순 있지만, 결국 클라이언트 코드를 변경해야 한다.
// => OCP 위반
결국 객체를 생성하고, 연관관계를 맺어주는 별도의 조립, 설정자가 필요하다. 대표적으로 IoC, DI 개념/테크닉이 있다.