스프링 핵심원리 - 기본편을 정리한 글입니다.
저번에 작성했던 회원, 주문 할인 정책을 객체 지향 원리를 적용해보자.
이번에는 새로운 할인 정책을 추가해야 한다.
막상 할인을 적용해보면 DIP, OCP를 위반하는 문제가 생긴다.
이번 장에서 이런 DIP, OCP를 해결하는 과정과 스프링이 왜 필요한지 이해해보자.
마지막에 순수한 자바 코드를 스프링 컨테이너에서 동작하도록 바꿔보자.
새로운 할인 정책 개발
이전에 구현했던 회원 주문 할인 정책에서 중요한 부분이 있었다.
- 할인 정책은 모든 VIP는 1000원을 할인해주는 고정 금액 할인을 적용해달라. (나중에 변경 될 수 있다.)
- 할인 정책은 변경 가능성이 높다. 회사의 기본 할인 정책을 아직 정하지 못했고, 오픈 직전까지 고민을 미루고 싶다.
최악의 경우 할인을 적용하지 않을 수 도 있다. (미확정)
기획자가 새로운 할인 정책을 개발해달라고 요청했다고 가정하자.
- VIP는 고정 금액이 아닌 정가에서 10%를 할인을 적용해달라.
이런 변경이 생겼어도 객체 지향 설계 원칙을 지키면 쉽게 구현할 수 있다.
- 앞서 인터페이스와 구현체를 분리하여 구현했다.
- 분리했기 때문에 구현체만 교체해주면 클라이언트에 문제가 발생하지 않을 것이다.
이제 새로운 할인 정책 코드를 구현해보자.
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;
}
}
}VIP면 10% 할인된 가격을 리턴하도록 메서드를 작성했다.
이제 테스트를 해보자.
테스트 하기에 앞서 기존에 test 패키지에서 생성하여 테스트했는데 인텔리제이 단축키를 활용하여 생성해보자.
메서드 영역에서 ctrl + shift + t 를 누르면 아래와 같은 선택창이 나타난다.
그 다음 선택하면
테스트하고 싶은 메서드를 선택하고 OK를 누르면
테스트 패키지에 자동으로 생성된다.
테스트 코드를 작성하자.
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
Assertions.assertThat(discount).isEqualTo(1000);
}
@Test
@DisplayName("VIP는 10% 할인이 적용되지 않아야 한다")
void vip_x() {
//given
Member member = new Member(1L, "memberBASIC", Grade.BASIC);
//when
int discount = discountPolicy.discount(member, 10000);
//then
Assertions.assertThat(discount).isEqualTo(1000);
}
}
회원 등급이 BASIC 이면 할인 금액은 0이어야 하는데 1000으로 했기 때문에 테스트를 통과하지 못했다.
0으로 수정하여 다시 실행하면 테스틀 통과한다.
이제 변경된 할인 정책을 적용해보자.
새로운 할인 정책 적용과 문제점
할인 정책을 변경하려면 클라이언트인 OrderServiceImpl 코드를 고쳐야 한다.
public class OrderServiceImpl implements OrderService {
// private final DiscountPolicy discountPolicy = new FixDiscountPolicy();
private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
}
문제점 발견
- 우리는 역할과 구현을 충실하게 분리했다. ➜ OK
- 다형성도 활용하고, 인터페이스와 구현 객체를 분리했다. ➜ OK
- OCP, DIP 같은 객체지향 설계 원칙을 충실히 준수했다.
➜ 그렇게 보이지만 사실은 아니다 - DIP: 주문서비스 클라이언트( OrderServiceImpl )는 DiscountPolicy 인터페이스에 의존하면서 DIP를 지킨 것 같은데?
➜ 클래스 의존관계를 분석해 보자. 추상(인터페이스) 뿐만 아니라 구체(구현) 클래스에도 의존하고 있다.- 추상(인터페이스) 의존: DiscountPolicy
- 구체(구현) 클래스: FixDiscountPolicy , RateDiscountPolicy
- OCP: 변경하지 않고 확장할 수 있다고 했는데!
➜ 지금 코드는 기능을 확장해서 변경하면, 클라이언트 코드에 영향을 준다! 따라서 OCP를 위반한다.
- 클라이언트인 OrderServiceImpl을 변경함으로써 확장에는 열려있고 변경에는 닫혀있어야 하는 OCP를 위반했다.
- 클라이언트가 구체 클래스에 의존하고있어서 DIP를 위반했다.
어떻게 해결할 수 있을까?
- DIP 위반 ➜ 추상에만 의존하도록 변경(인터페이스에만 의존)
- DIP를 위반하지 않도록 인터페이스에만 의존하도록 의존관계를 변경하면 된다.
public class OrderServiceImpl implements OrderService {
// private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
private DiscountPolicy discountPolicy;
}- 인터페이스에만 의존하도록 설계와 코드를 변경했다.
- 그런데 구현체가 없는데 어떻게 코드를 실행할 수 있을까?
- 실제 실행을 해보면 NPE(null pointer exception)가 발생한다.
해결 방안
누군가가 클라이언트인 OrderServiceImpl 에 DiscountPolicy 의 구현 객체를 대신 생성하고 주입해주어야 한다.
관심사의 분리
- 배우는 본인의 역할인 배역을 수행하는 것에만 집중해야 한다.
- 디카프리오는 어떤 여자 주인공이 선택되더라도 똑같이 공연을 할 수 있어야 한다.
- 공연을 구성하고, 담당 배우를 섭외하고, 역할에 맞는 배우를
지정하는 책임을 담당하는 별도의 공연 기획자가 나올시점이다. - 공연 기획자를 만들고, 배우와 공연 기획자의 책임을 확실히 분리하자
AppConfig
AppConfig 클래스는 OCP, DIP원칙을 없애고 구현체를 생성하고 연결하는 책임만 한다.
AppConfig를 통해 외부에서 구현체를 주입하도록 바꿔준다.
먼저 MemberService를 만들어 보자.
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl();
}
}이 전에는 객체를 생성하고 인터페이스에 어떤 구현체를 사용할지 MemberServiceImpl에서 직접했다.
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository = new MemoryMemberRpository();
}MemoryMemberRepository 를 MemberServiceImpl이 지정했다.
이러한 것들을 AppConfig에서 해주도록 한다.
MemberServiceImpl을 변경하고
private final MemberRepository memberRepository;
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}생성자를 통해서 MemberRepository에 어떤 구현체가 들어갈 지 정한다.
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl(new MemoryMemberRepository());
}
}memberService를 쓸 때 MemberServiceImpl이 생성되는데 MemoryMemberRepository를 사용한다.
같은 방식으로 OrderService를 만들어보자.
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;
}
}AppConfig
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl(new MemoryMemberRepository());
}
public OrderService orderService() {
return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
}
}AppConfig는 애플리케이션의 실제 동작에 필요한 구현 객체를 생성한다.
- MemberServiceImpl, MemoryMemberRepository, OrderServiceImpl FixDiscountPolicy
AppConfig는 생성한 객체 인스턴스의 참조(레퍼런스)를 생성자를 통해서 주입(연결)해준다.
- MemberServiceImpl ➜ MemoryMemberRepository
- OrderServiceImpl ➜ MemoryMemberRepository + FixDiscountPolicy
MemberServiceImpl - 생성자 주입
public class MemberServiceImpl implements MemberService {
private final MemberRepository memberRepository;
public MemberServiceImpl(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
@Override
public void join(Member member) {
memberRepository.save(member);
}
@Override
public Member findMember(Long memberId) {
return memberRepository.findById(memberId);
}
}- 설계 변경으로 MemberServiceImpl 은 MemoryMemberRepository 를 의존하지 않는다!
- 단지 MemberRepository 인터페이스만 의존한다.
- MemberServiceImpl 입장에서 생성자를 통해 어떤 구현 객체가 들어올지(주입될지)는 알 수 없다.
- MemberServiceImpl 의 생성자를 통해서 어떤 구현 객체를 주입할지는 오직 외부( AppConfig )에서 결정된다.
- MemberServiceImpl 은 이제부터 의존관계에 대한 고민은 외부에 맡기고 실행에만 집중하면 된다.
클래스 다이어그램
- 객체의 생성과 연결은 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 인터페이스만 의존한다.
- OrderServiceImpl 입장에서 생성자를 통해 어떤 구현 객체가 들어올지(주입될지)는 알 수 없다.
- OrderServiceImpl 의 생성자를 통해서 어떤 구현 객체을 주입할지는 오직 외부( AppConfig )에서 결정한다.
- OrderServiceImpl 은 이제부터 실행에만 집중하면 된다.
- OrderServiceImpl 에는 MemoryMemberRepository , FixDiscountPolicy 객체의 의존관계가 주입된다
AppConfig 실행
public class MemberApp {
public static void main(String[] args) {
// MemberService memberService = new MemberServiceImpl(); 기존 방식
AppConfig appConfig = new AppConfig();
MemberService memberService = appConfig.memberService();
}
}기존에 사용하던 방식을 AppConfig를 이용하여 외부에서 주입해줬다.
public MemberService memberService() {
return new MemberServiceImpl(new MemoryMemberRepository());
}
정리
- AppConfig를 통해서 관심사를 확실하게 분리했다.
- AppConfig는 구체 클래스를 선택하고 역할에 맞는 구현체를 선택한다.
- 각각의 구현체들은 기능을 실행하는 책임만 지면 된다.
AppConfig 리팩터링
현재 AppConfig는 중복이 있고, 역할에 따른 구현이 잘 안보인다.
코드를 리팩터링하여 중복을 제거하고 어떤 역할과 구현을 나타내는지 구체화하자.
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl(new MemoryMemberRepository());
}
public OrderService orderService() {
return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
}
}메서드 추출
MemoryMemberRepository가 중복되고 있다.
new MemoryMemberRepository() 를 메서드로 추출하기 위해 ctrl + alt + m 단축키를 실행하자.
public class AppConfig {
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
private static MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
public OrderService orderService() {
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
public DiscountPolicy discountPolicy() {
return new FixDiscountPolicy();
}
}- 각 메서드가 어떤 역할을 하는지 한눈에 확인 할 수 있다.
- 애플리케이션이 어떻게 구성되어있는지 빠르게 파악할 수 있다.
이제 이전에 변경된 할인 정책을 적용해보자.
새로운 구조와 할인 정책 적용
- 정액 할인 정책을 % 할인 정책으로 변경해보자.
- FixDicountPolicy ➜ RateDiscountPolicy
- 어떤 부분만 변경하면 될까?
AppConfig의 등장으로 애플리케이션의 영역이 분리되었다.
이제 할인 정책을 바꾸려면 AppConfig의 FixDiscountPolicy를 RateDicsountPolicy로 바꿔주기만 하면 된다.
public DiscountPolicy discountPolicy() {
// return new FixDiscountPolicy();
return new RateDiscountPolicy();
}
정상적으로 동작한다.
- AppConfig 에서 할인 정책 역할을 담당하는 구현을 FixDiscountPolicy RateDiscountPolicy 객체로 변경했다.
- 이제 할인 정책을 변경해도, 애플리케이션의 구성 역할을 담당하는 AppConfig만 변경하면 된다.
- 클라이언트 코드인 OrderServiceImpl 를 포함해서 사용 영역의 어떤 코드도 변경할 필요가 없다.
- 구성 영역은 당연히 변경된다. 구성 역할을 담당하는 AppConfig를 애플리케이션이라는 공연의 기획자로 생각하자. 공연 기획자는 공연 참여자인 구현 객체들을 모두 알아야 한다.
좋은 객체 지향 설계의 5가지 원칙의 적용
SRP 단일 책임 원칙
한 클래스는 하나의 책임만 가져야 한다.
- 클라이언트 객체는 직접 구현 객체를 생성하고, 연결하고, 실행하는 다양한 책임을 가지고 있음
- SRP 단일 책임 원칙을 따르면서 관심사를 분리함
- 구현 객체를 생성하고 연결하는 책임은 AppConfig가 담당
- 클라이언트 객체는 실행하는 책임만 담당
DIP 의존관계 역전 원칙
프로그래머는 “추상화에 의존해야지, 구체화에 의존하면 안된다.” 의존성 주입은 이 원칙을 따르는 방법 중 하나다.
- 새로운 할인 정책을 개발하고, 적용하려고 하니 클라이언트 코드도 함께 변경해야 했다. 왜냐하면 기존 클라이언트 코드( OrderServiceImpl )는 DIP를 지키며 DiscountPolicy 추상화 인터페이스에 의존하는 것 같았지만, FixDiscountPolicy 구체화 구현 클래스에도 함께 의존했다.
- 클라이언트 코드가 DiscountPolicy 추상화 인터페이스에만 의존하도록 코드를 변경했다.
- 하지만 클라이언트 코드는 인터페이스만으로는 아무것도 실행할 수 없다.
- AppConfig가 FixDiscountPolicy 객체 인스턴스를 클라이언트 코드 대신 생성해서 클라이언트 코드에 의존관계를 주입했다. 이렇게해서 DIP 원칙을 따르면서 문제도 해결했다.
OCP
소프트웨어 요소는 확장에는 열려 있으나 변경에는 닫혀 있어야 한다
- 다형성 사용하고 클라이언트가 DIP를 지킴
- 애플리케이션을 사용 영역과 구성 영역으로 나눔
- AppConfig가 의존관계를 FixDiscountPolicy RateDiscountPolicy 로 변경해서 클라이언트
- 코드에 주입하므로 클라이언트 코드는 변경하지 않아도 됨
- 소프트웨어 요소를 새롭게 확장해도 사용 영역의 변경은 닫혀 있다!
IoC, DI, 그리고 컨테이너
제어의 역전 IoC(Inversion of Control)
- 기존 프로그램은 클라이언트 구현 객체가 스스로 필요한 서버 구현 객체를 생성하고, 연결하고, 실행했다.
한마디로 구현 객체가 프로그램의 제어 흐름을 스스로 조종했다. - 반면에 AppConfig가 등장한 이후에 구현 객체는 자신의 로직을 실행하는 역할만 담당한다.
프로그램의 제어 흐름은 이제 AppConfig가 가져간다.
ex) OrderServiceImpl은 필요한 인터페이스들을 호출하지만 어떤 구현 객체들이 실행될지 모른다. - 프로그램에 대한 제어 흐름에 대한 권한은 모두 AppConfig가 가지고 있다.
OrderServiceImpl도 AppConfig가 생성한다. 그리고 AppConfig는 OrderServiceImpl이 아닌 OrderService인터페이스의 다른 구현 객체를 생성하고 실행할 수 도 있다. 그런 사실도 모른체 OrderServiceImpl은 묵묵히 자신의 로직을 실행할 뿐이다. - 이렇듯 프로그램의 제어 흐름을 직접 제어하는 것이 아니라 외부에서 관리하는 것을 제어의 역전 IoC라고 한다.
프레임워크 vs 라이브러리
- 내가 작성한 코드를 제어하고, 대신 실행하면 그것은 프레임워크다. (JUnit)
- 내가 작성한 코드가 직접 제어의 흐름을 담당한다면 라이브러리다.
의존관계 주입 DI(Dependency Injection)
- OrderServiceImpl은 DiscountPolicy 인터페이스에 의존한다.
실제 어떤 구현 객체가 사용될지는 모른다. - 의존관계는 정적인 클래스 의존 관계와, 실행 시점에 결정되는 동적인 객체(인스턴스) 의존 관계 둘을 분리해서 생각해야 한다.
정적인 클래스 의존관계
- 클래스가 사용하는 import 코드만 보고 의존관계를 쉽게 판단할 수 있다.
정적인 의존관계는 애플리케이션을 실행하지 않아도 분석할 수 있다.
- OrderServiceImpl은 MemberRepository, DiscountPolicy에 의존하는 것을 알 수 잇다.
- 그런데 이러한 클래스 의존관계 만으로는 실제 어떤 객체가 OrderServiceImpl에 주입 될지 알 수 없다.
동적인 객체 인스턴스 의존 관계
애플리케이션 실행 시점에 실제 생성된 객체 인스턴스의 참조가 연결된 의존 관계다.
- 애플리케이션 실행 시점에 외부에서 실제 구현 객체를 생성하고 클라이언트에 전달해서 클라이언트와 서버의 실제 의존관계가 연결 되는 것을 의존관계 주입이라 한다.
- 객체 인스턴스를 생성하고, 그 참조값을 전달해서 연결된다.
- 의존관계 주입을 사용하면 클라이언트 코드를 변경하지 않고, 클라이언트가 호출하는 대상의 타입 인스턴스를 변경할 수 있다.
- 의존관계 주입을 사용하면 정적인 클래스 의존관계를 변경하지 않고, 동적인 객체 인스턴스 의존관계를 쉽게 변경할 수 있다.
IoC 컨테이너, DI 컨테이너
- AppConfig 처럼 객체를 생성하고 관리하면서 의존관계를 연결해 주는 것을
IoC 컨테이너 또는 DI 컨테이너라 한다. - 의존관계 주입에 초점을 맞추어 최근에는 주로 DI 컨테이너라 한다.
스프링으로 전환하기
이제 위에서 구성한 AppConfig를 스프링 기반으로 변경해보자.
@Configuration
public class AppConfig {
@Bean
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
@Bean
private 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();
}
}@Configuration
애플리케이션의 설정, 구성 정보를 담당하는 뜻
@Bean
어노테이션된 메서드는 스프링 컨테이너에 등록된다.
스프링 컨테이너 적용하기
// 순수 자바로 작성한 AppConfig 활용
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);스프링 컨테이너
- ApplicationContext 를 스프링 컨테이너라 한다.
- 기존에는 개발자가 AppConfig 를 사용해서 직접 객체를 생성하고 DI를 했지만,
이제부터는 스프링 컨테이너를 통해서 사용한다. - 스프링 컨테이너는 @Configuration 이 붙은 AppConfig 를 설정(구성) 정보로 사용한다. 여기서 @Bean 이라 적힌 메서드를 모두 호출해서 반환된 객체를 스프링 컨테이너에 등록한다. 이렇게 스프링 컨테이너에 등록된 객체를 스프링 빈이라 한다.
- 스프링 빈은 @Bean 이 붙은 메서드의 명을 스프링 빈의 이름으로 사용한다. ( memberService , orderService )
- 이전에는 개발자가 필요한 객체를 AppConfig 를 사용해서 직접 조회했지만, 이제부터는 스프링 컨테이너를 통해서 필요한 스프링 빈(객체)를 찾아야 한다. 스프링 빈은 applicationContext.getBean() 메서드를 사용해서 찾을 수 있다.
- 기존에는 개발자가 직접 자바코드로 모든 것을 했다면 이제부터는 스프링 컨테이너에 객체를 스프링 빈으로 등록하고, 스프링 컨테이너에서 스프링 빈을 찾아서 사용하도록 변경되었다.
정리
- 새로운 할인 정책 적용의 문제점 ➜ DIP 위반
- 관심사의 분리를 위해 AppConfig 사용
- AppConfig는 구현 객체를 생성하고 연결하는 책임만 가진다.
- AppConfig로 외부에서 의존관계를 주입함으로써 OCP, DIP 위반 해결
- SRP, DIP, OCP 원칙 적용 성공
- ApplicationContext - 스프링 컨테이너와 @Bean을 사용하여 스프링 컨테이너에 객체 등록
- @Bean이라 적힌 메서드를 모두 호출해서 반한된 객체를 스프링 컨테이너에 등록
코드가 약간 더 복잡해진 것 같은데, 스프링 컨테이너를 사용하면 어떤 장점이 있을까?
