본 게시글은 김영한 강사님의 [스프링 핵심 원리 - 기본편]을 수강하며 작성한 글입니다.
새로운 할인 정책 개발
어느 날 기획자가 새로운 할인 정책인 정률 할인 정책을 추가해달라고 요구한다. 구현체를 하나 추가로 개발하면 될 듯 하지만, 몇 가지 문제점이 발생한다. 이 문제점을 해결하다 보면 여러 과정을 거치게 되고 자연스럽게 스프링의 핵심 기능인 스프링 컨테이너가 왜 탄생했는지 알게 된다.
정률 할인 정책 개발
public class RateDiscountPolicy implements DiscountPolicy{
private int discountPercent = 10;
@Override
public int discount(Member member, int price) {
if (member.getGrade() == Grade.VIP) {
return price * discountPercent / 100;
} else {
return 0;
}
}
}
테스트
discount() 메서드가 잘 작동하는지 확인하기 위해서 할인이 적용되어야 하는 경우와 할인이 적용되지 않아야 하는 경우 2가지를 테스트하는 메서드를 만든다.
class RateDiscountPolicyTest {
RateDiscountPolicy discountPolicy = new RateDiscountPolicy();
@Test
@DisplayName("VIP는 10% 할인이 적용되어야 한다.")
void vip_o() {
// given
Member member = new Member(1L, "memberVIP", Grade.VIP);
// when
int discount = discountPolicy.discount(member, 10000);
// then
assertThat(discount).isEqualTo(1000);
}
@Test
@DisplayName("VIP가 아니면 할인이 적용되지 않아야 한다.")
void vip_x() {
// given
Member member = new Member(2L, "memberBASIC", Grade.BASIC);
// when
int discount = discountPolicy.discount(member, 10000);
// then
assertThat(discount).isEqualTo(0);
}
}
새로운 할인 정책 적용과 문제점
정률 할인 정책 적용하기
할인 정책을 고정 할인 정책 → 정률 할인 정책으로 변경하려면 클라이언트인 OrderServiceImpl 클래스의 코드를 수정해야 한다.
public class OrderServiceImpl implements OrderService {
// private final DiscountPolicy discountPolicy = new FixDiscountPolicy();
private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
}
문제점 발견
새로운 정책을 추가하여 적용했을 때 문제점은 없는지 확인해보자.
- 역할과 구현을 충실하게 분리했는가? ⭕
- 다형성을 활용하고, 인터페이스와 구현 객체를 분리했는가? ⭕
- OCP, DIP와 같은 객체지향 설계 원칙을 충실히 준수했는가? ❌
- OCP 원칙
정률 할인 정책으로 변경하려면 코드를 수정해야 하므로 클라이언트(OrderServiceImpl) 코드에 영향을 준다. - DIP 원칙
인터페이스 뿐만 아니라 구체 클래스에도 의존하고 있다.
- 인터페이스 의존: discountPolicy
- 구체 클래스 의존: FixDiscountPolicy / RateDiscountPolicy
- OCP 원칙
클라이언트 코드를 변경해야 하는 이유
- 기대했던 의존 관계
- 실제 의존 관계
실제로 OrderServiceImpl은 DiscountPolicy 인터페이스와 FixDiscountPolicy 구체 클래스도 의존하고 있다. → DIP 위반
- 정책 변경
FixDiscountPolicy를 RateDiscountPolicy로 변경하는 순간 OrderServiceImpl의 소스 코드도 함께 변경해야 한다. → OCP 위반
어떻게 해결할 것인가?
클라이언트(OrderServiceImpl)가 인터페이스에만 의존하도록 의존 관계를 변경하면 된다.
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository = new MemoryMemberRepository();
private DiscountPolicy discountPolicy;
...
}
하지만 실행해보면 **NPE(NullPointException)**이 발생한다. 구현체가 없기 때문이다.
이 문제를 해결하기 위해선 누군가가 클라이언트에 DiscountPoilcy 구현 객체를 대신 생성하고 주입해야 한다.
관심사의 분리
"애플리케이션 = 공연, 각 인터페이스 = 배역(역할), 구현 객체 = 배우" 라고 생각해보자.
그런데 실제 배역에 맞는 배우를 선택하는 것은 누구의 역할일까?
이전 코드는 로미오 역할(인터페이스)를 하는 레오나르도 디카프리오 배우(구현 객체)가 줄리엣 역할(인터페이스)를 하는 배우(구현 객체)를 직접 초빙하는 것과 같다. 디카프리오는 공연도 해야하고 동시에 여자 주인공도 직접 초빙해야하는 다양한 책임을 갖고 있다.
결론적으로 관심사를 분리해야 한다.
배우는 본인의 역할인 배역을 수행하는 것에만 집중해야 하고, 어떤 여자 주인공이 선택되어도 똑같이 공연할 수 있어야 한다.
공연을 구성하고, 배우를 섭외하고 지정하는 것은 별도의 공연 기획자가 할 일이다. 공연 기획자를 만들고 배우와 공연 기획자의 책임을 확실하게 분리하자.
AppConfig 등장
애플리케이션도 마찬가지다. 애플리케이션의 전체 동작 방식을 구성하기 위해 구현 객체를 생성하고 연결하는 책임을 가지는 별도의 설정 클래스(AppConfig)를 만들자.
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl(new MemoryMemberRepository());
}
public OrderService orderService() {
return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
}
}
1. AppConfig는 애플리케이션의 실제 동작에 필요한 구현 객체를 생성한다.
MemberServiceImpl / MemoryMemberRepository / OrderServiceImpl / FixDiscountPolicy
2. AppConfig는 생성한 객체 인스턴스의 참조(레퍼런스)를 생성자를 통해서 주입(연결)해준다.
OrderServiceImpl → MemoryMemberRepository / FixDiscountPolicy
MemberServiceImpl → MemoryMemberRepository
MemberServiceImpl - 생성자 주입
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
...
}
MemberServiceImpl는 MemoryMemberRepository를 의존하지 않고 MemberRepository 인터페이스만 의존한다.
오직 AppConfig에서 주입할 구현 객체를 결정하기 때문에 MemberServiceImpl 입장에서는 생성자를 통해 어떤 구현 객체가 주입될 지 알 수 없다. MemberServiceImpl은 이제부터 의존관계에 대한 고민은 AppConfig에 맡기고 실행에만 집중하면 된다.
클래스 다이어그램
객체의 생성과 연결은 AppConfig가 담당한다.
- DIP 완성: MemberServiceImpl은 MemberRepository 인터페이스만 의존한다.
- 관심사의 분리: 객체를 생성, 연결하는 역할 & 실행하는 역할이 분리되었다.
회원 객체 인스턴스 다이어그램
- appConfig 객체는 memoryMemberRepository 객체를 생성하고 그 참조값을 memberServiceImpl을 생성하면서 생성자로 전달한다.
- 클라이언트인 memberServiceImpl 입장에서 보면 의존관계를 외부에서 주입해주는 것 같다고 해서 DI(Dependency Injection), 우리말로 의존관계 주입 또는 의존성 주입이라 한다.
OrderServiceImpl - 생성자 주입
public class OrderServiceImpl implements OrderService {
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
...
}
OrderServiceImpl는 FixDiscountPolicy를 의존하지 않고 DiscountPolicy 인터페이스만 의존한다.
오직 AppConfig에서 주입할 구현 객체를 결정하기 때문에 OrderServiceImpl 입장에서는 생성자를 통해 어떤 구현 객체가 주입될 지 알 수 없다. OrderServiceImpl은 이제부터 실행에만 집중하면 된다.
AppConfig 실행
- MemberApp
public class MemberApp {
public static void main(String[] args) {
AppConfig appConfig = new AppConfig();
MemberService memberService = appConfig.memberService();
Member member = new Member(1L, "memberA", Grade.VIP);
memberService.join(member);
Member findMember = memberService.findMember(1L);
System.out.println("new Member = " + member.getName());
System.out.println("find member = " + findMember.getName());
}
}
MemberServiceImpl을 직접 생성하지 않고 생성한 AppConfig를 이용하여 MemberServiceImpl을 생성하고 MemberService에 연결해준다.
- OrderApp
public class OrderApp {
public static void main(String[] args) {
AppConfig appConfig = new AppConfig();
MemberService memberService = appConfig.memberService();
OrderService orderService = appConfig.orderService();
Long memberId = 1L;
Member member = new Member(memberId, "memberA", Grade.VIP);
memberService.join(member);
Order order = orderService.createOrder(memberId, "itemA", 10000);
System.out.println("order = " + order);
}
}
OrderServiceImpl을 직접 생성하지 않고 생성한 AppConfig를 이용하여 OrderServiceImpl을 생성하고 OrderService에 연결해준다.
- MemberServiceTest
public class memberServiceTest {
MemberService memberService;
@BeforeEach
public void beforeEach() {
AppConfig appConfig = new AppConfig();
memberService = appConfig.memberService();
}
...
}
💡 테스트 코드에서 @BeforeEach는 각 테스트를 실행하기 전에 호출된다.
- OrderServiceTest
public class OrderServiceTest {
MemberService memberService;
OrderService orderService;
@BeforeEach
public void beforeEach() {
AppConfig appConfig = new AppConfig();
memberService = appConfig.memberService();
orderService = appConfig.orderService();
}
...
}
AppConfig를 통해 관심사를 확실하게 분리했다.
AppConfig가 구현 객체를 선택하여 주입해주면 OrderServiceImpl는 맡은 기능을 수행하는 책임만 지면 된다.
AppConfig 리팩터링
현재 AppConfig는 중복이 있고 역할에 따른 구현이 명확하게 보이지 않는다.
- 전체 설계 그림
리팩터링 전
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl(new MemoryMemberRepository());
}
public OrderService orderService() {
return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
}
}
- MemoryMemberRepository()를 2번 new 하는 중복이 존재한다.
- MemberService와 OrderService 역할에 대한 구현만 보이고 DiscountPolicy와 MemberRepository 역할에 대한 구현은 명확하게 보이지 않는다.
리팩터링 후
public class AppConfig {
// MemberService 역할
public MemberService memberService() {
return new MemberServiceImpl(MemberRepository());
}
// OrderService 역할
public OrderService orderService() {
return new OrderServiceImpl(MemberRepository(), discountPolicy());
}
// MemberRepository 역할
private static MemberRepository MemberRepository() {
return new MemoryMemberRepository();
}
// DiscountPolicy 역할
public DiscountPolicy discountPolicy() {
return new FixDiscountPolicy();
}
}
- new MemoryMemberRepository() 중복을 제거하고, 역할에 대한 구현이 잘 보이게 하였다.
MemoryMemberRepository를 다른 구현체로 변경할 때 MemberRepository 역할을 하는 메서드 내부만 변경하면 된다. - DiscountPolicy 역할에 따른 구현이 잘 보이게 하였다.
FixDiscountPolicy를 다른 구현체로 변경할 때 DiscountPolicy 역할을 하는 메서드 내부만 변경하면 된다.
중복을 제거하고 역할에 따른 구현이 잘 보이도록 리팩터링하였다.
AppConfig를 보면 역할과 구현 클래스가 한눈에 들어온다. 이를 통해 애플리케이션 전체 구성이 어떻게 되어있는지 빠르게 파악할 수 있다. 또한 설계에 대한 그림이 구성 정보에 그대로 드러난다.
새로운 구조와 할인 정책 적용
정액 할인 정책(FixDiscountPolicy)을 정률 할인 정책(RateDiscountPolicy)으로 변경한다.
어떤 부분을 변경하면 될까? 애플리케이션의 구성 영역을 담당하는 AppConfig의 코드를 수정하면 된다.
AppConfig의 등장으로 애플리케이션이 크게 사용 영역과 객체를 생성하고 구성하는 구성 영역으로 분리되었다.
따라서 할인 정책을 변경해도 구성 영역만 영향 O, 사용 영역은 영향 X
public class AppConfig {
...
public DiscountPolicy discountPolicy() {
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
}
AppConfig에서 할인 정책 역햘을 담당하는 구현을 FixDiscountPolicy → RateDiscountPolicy로 변경했다. 클라이언트 코드인 OrderServiceImpl을 포함해서 사용 영역의 어떤 코드도 변경할 필요가 없다. 오직 구성 영역의 코드만 변경된다.
좋은 객체 지향 설계의 5가지 원칙의 적용
여기서 SRP, DIP, OCP 3가지가 적용되었다.
SRP
하나의 클래스는 하나의 책임만 가져야 한다.
이전까지의 클라이언트 코드는 직접 구현 객체를 생성해서 연결하고, 로직을 실행하는 다양한 책임을 가지고 있었다. AppConfig를 추가로 두어 관심사(사용, 구성)를 분리했다. 따라서 구현 객체를 생성하고 연결하는 책임은 AppConfig가 담당하고, 클라이언트 객체는 기능 실행이라는 하나의 책임만을 담당한다.
DIP
프로그래머는 “추상화에 의존해야지, 구체화에 의존하면 안된다.” 의존성 주입은 이 원칙을 따르는 방법 중 하나다.
기존 방식에서는 새로운 할인 정책을 개발하고 적용하려고 하니 클라이언트의 코드도 함께 변경해야 했다. 기존 클라이언트 코드는 인터페이스에도 의존하고 구현 객체에도 의존했기 때문이다.
클라이언트 코드가 인터페이스에만 의존하도록 코드를 변경했다. 하지만 클라이언트 코드는 인터페이스만으로 아무것도 실행할 수 없으므로 외부에서 구현 객체를 주입해줘야 한다. AppConfig가 클라이언트 코드 대신 구현 객체를 생성해서 클라이언트 코드에 의존관계를 주입했다. AppConfig의 등장으로 DIP 원칙을 따르면서 구현 객체 주입 문제를 해결했다.
OCP
소프트웨어 요소는 확장에는 열려 있으나 변경에는 닫혀 있어야 한다.
애플리케이션을 사용 영역과 구성 영역으로 나눴고, 구성 영역을 책임지는 AppConfig가 구현체를 생성하고 클라이언트에 의존관계를 주입하므로 클라이언트 코드는 변경될 일이 없다. 새로운 구현체를 추가해도 사용 영역은 변경에 닫혀있고 오직 구성 영역의 변경만 있을 뿐이다.
IoC, DI, 그리고 컨테이너
제어의 역전 IoC(Inversion of Control)
기존의 프로그램에서는 클라이언트 구현객체가 스스로 필요한 서버 구현 객체를 생성, 연결, 실행했다. 즉, 구현 객체가 프로그램의 제어 흐름을 스스로 조종했으며, 이는 개발자 입장에서는 자연스러운 흐름이다.
반면에, AppConfig가 등장한 이후에 클라이언트 구현 객체는 자신의 로직을 실행하는 역할만 담당하며, 프로그램의 전체적인 흐름 제어는 AppConfig에서 담당한다. 어떤 인터페이스에 어떤 구현 객체를 선택할지 정해준다.
ex) 기존에는 클라이언트 구현 객체(OrderServiceImpl)에서 서버 구현 객체(MemoryMemberRepository, FixDiscountPolicy)들을 직접 생성하여 실행하였다. 반면, AppConfig의 등장 이후 클라이언트 구현 객체(OrderServiceImpl)는 필요한 인터페이스를 호출할 때 어떤 구현 객체들이 호출될 지 전혀 알지 못한다.
이렇게 프로그램의 제어 흐름을 구현 객체들이 직접 제어하는 것이 아니라 외부에서 관리하는 것을 제어의 역전(IoC)이라 한다.
프레임워크 vs 라이브러리
프레임워크가 내가 작성한 코드를 제어하고, 대신 실행하면 그것은 프레임워크가 맞다. (ex. JUnit)
반면에 내가 작성한 코드가 직접 제어의 흐름을 담당한다면 그것은 프레임워크가 아니라 라이브러리다.
의존관계 주입 DI(Dependency Injection)
구현 객체는 인터페이스에만 의존한다.
OrderServiceImpl 클래스에서는 DiscountPolicy, MemberRepository 인터페이스에 의존하지만, 실제 어떤 구현 객체가 사용될 지는 모른다.
의존관계는 정적인 클래스 의존관계와, 실행 시점에 결정되는 동적인 객체(인스턴스) 의존관계 2가지를 분리하여 생각해야 한다.
정적인 클래스 의존관계
애플리케이션을 실행하지 않아도 클래스가 사용하는 import 코드만 보고 의존관계를 쉽게 파악할 수 있다. 그러나 클래스 의존관계 만으로 실제 어떤 구현 객체가 주입될 지는 알 수 없다. (OrderServiceImpol에 주입되는 구현 객체가 FixDiscountPolicy일지 RateDiscountPolicy일지)
- 클래스 다이어그램
동적인 객체 인스턴스 의존관계
애플리케이션 실행 시점(런타임)에 외부에서 실제 구현 객체를 생성하고, 클라이언트에 전달(주입)하여 클라이언트와 서버의 실제 의존관계가 연결되는 것을 의존관계 주입이라고 한다.
외부에서 객체 인스턴스를 생성하고, 그 참조값을 전달해서 연결된다.
DI를 사용하면 클라이언트 코드를 변경하지 않고도 클라이언트가 호출하는 객체를 변경할 수 있다. 또한, 정적인 클래스 의존관계를 변경하지 않고 동적인 객체 인스턴스 의존관계를 쉽게 변경할 수 있다.
클래스 의존관계에는 실행 시점(런타임)의 의존관계는 드러나지 않는다. 실행 시점의 의존관계는 외부(AppConfig)에서 결정한다. 외부에서 실제 구현 객체(사용할 객체에 대한 참조)를 생성하고 클라이언트에 전달(주입)함으로써 의존관계가 연결되는 것이다.
- 객체 다이어그램
IoC 컨테이너, DI 컨테이너
- AppConfig 처럼 객체를 생성하고 관리하면서 의존관계를 연결해주는 것을 IoC 컨테이너 또는 DI 컨테이너라고 한다. 최근에는 의존관계 주입에 초점을 맞추어 주로 DI 컨테이너라 한다.
- Assembler, Object Factory라고도 불린다.
스프링으로 전환하기
지금까지는 순수 자바 코드로 DI를 적용했지만, 이제는 스프링을 사용해보자.
AppConfig을 스프링 기반으로 변경
@Configuration
public class AppConfig {
@Bean
public MemberService memberService() {
return new MemberServiceImpl(MemberRepository());
}
@Bean
public static MemberRepository MemberRepository() {
return new MemoryMemberRepository();
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(MemberRepository(), discountPolicy());
}
@Bean
public DiscountPolicy discountPolicy() {
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
}
- AppConfig에 설정 정보 파일을 의미하는 @Configuration을 붙여준다.
- 각 메소드에 @Bean을 붙여주면, 스프링 컨테이너에 스프링 빈으로 등록된다.
MemberApp에 스프링 컨테이너 적용
public class MemberApp {
public static void main(String[] args) {
// AppConfig appConfig = new AppConfig();
// MemberService memberService = appConfig.memberService();
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
MemberService memberService = applicationContext.getBean("memberService", MemberService.class);
Member member = new Member(1L, "memberA", Grade.VIP);
memberService.join(member);
Member findMember = memberService.findMember(1L);
System.out.println("new Member = " + member.getName());
System.out.println("find member = " + findMember.getName());
}
}
ApplicationContext는 AppConfig에 등록된 객체(Bean)를 관리해주는 스프링 컨테이너다. 스프링 컨테이너를 통해 스프링 빈(MemberService)을 조회하여 사용한다.
⇒ 즉, AppConfig에서 직접 꺼내지 않고 스프링 컨테이너에서 꺼내서 사용한다.
- ApplicationContext: AppConfig.class를 파라미터로 넘겨서 스프링 컨테이너를 생성
- applicationContext.getBean(): 스프링 컨테이너에서 (이름, 타입)인 스프링 빈을 조회
OrderApp에 스프링 컨테이너 적용
public class OrderApp {
public static void main(String[] args) {
// AppConfig appConfig = new AppConfig();
// MemberService memberService = appConfig.memberService();
// OrderService orderService = appConfig.orderService();
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
MemberService memberService = applicationContext.getBean("memberService", MemberService.class);
OrderService orderService = applicationContext.getBean("orderService", OrderService.class);
Long memberId = 1L;
Member member = new Member(memberId, "memberA", Grade.VIP);
memberService.join(member);
Order order = orderService.createOrder(memberId, "itemA", 20000);
System.out.println("order = " + order);
}
}
스프링 컨테이너
스프링 컨테이너는 스프링 빈을 생성하고 관리하는 컨테이너로, ApplicationContext를 스프링 컨테이너라 한다.
- @Configuration이 붙은 AppConfig를 설정(구성) 정보로 사용한다.
- @Bean이라 적힌 메서드를 모두 호출해서 반환된 객체를 스프링 컨테이너에 스프링 빈으로 등록한다.
스프링 빈은 @Bean이 붙은 메서드 명을 스프링 빈의 이름으로 사용한다. - applicationContext.getBean() 메서드로 스프링 컨테이너를 통해 필요한 스프링 빈(객체)를 조회한다.
기존에는 개발자가 AppConfig를 사용해 직접 객체를 생성하고 DI를 했지만, 스프링 컨테이너에 객체를 스프링 빈으로 등록하고 스프링 컨테이너에서 스프링 빈을 찾아 사용하도록 변경하였다.
Q. 코드가 약간 더 복잡해진 것 같은데, 스프링 컨테이너를 사용하면 어떤 장점이 있을까?
싱글톤을 직접 구현하지 않아도 된다.
'Courses > Spring' 카테고리의 다른 글
[스프링 핵심 원리 - 기본편] 4. 스프링 컨테이너와 스프링 빈 (1) | 2023.12.05 |
---|---|
[스프링 핵심 원리 - 기본편] 2. 스프링 핵심 원리 이해 1 - 예제 만들기 (0) | 2023.10.16 |
[스프링 핵심 원리 - 기본편] 1. 객체 지향 설계와 스프링 (0) | 2023.10.06 |
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 7. AOP (0) | 2023.09.24 |
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 6. 스프링 DB 접근 기술 (0) | 2023.09.24 |