[스프링 핵심 원리 - 기본편] #3. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용

[seyxxn]

3_스프링 핵심 원리 이해 2 - 객체 지향 원리 적용

새로운 할인 정책 개발

새로운 할인 정책을 개발하여 적용시키기로 하자
기존의 정액 할인 정책에서 정율 할인 정책으로의 변경이 필요함

• RateDiscountPolicy 파일 추가

package hello.core.discount;
import hello.core.member.Grade;
import hello.core.member.Member;

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;
        }
    }
}

테스트 작성을 위해 jUnit을 이용한다.
이때, 단축키 command + shift + T 하면 jUnit 테스트 파일을 쉽게 생성 하도록 도와주는 창이 뜬다.

• RateDiscountPolicyTest 파일

package hello.core.discount;

import hello.core.member.Grade;
import hello.core.member.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

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가 아니면 할인이 적용되지 않아야 한다")
    void vip_x(){
        // given
        Member member = new Member(2L, "memberBASIC", Grade.BASIC);
        // when
        int discount = discountPolicy.discount(member, 10000);
        // then
        // Assertions.assertThat(discount).isEqualTo(1000);
        // -> BASIC 등급은 할인이 되면 안되기 때문에 1000을 넣으면 오류가 발생함
        Assertions.assertThat(discount).isEqualTo(0);
        // -> BASIC 등급은 할인이 되는 금액이 없기 때문에 0원이어야 함
    }

}

⭐ Assertions.assertThat() 구문에서 static import 하여 코드를 변경하는 것이 좋음

맥에서는 option + enter 단축키를 통해 static import로 바꾸면 코드가 간결해진다.

// 변경 전
Assertions.assertThat(discount).isEqualTo(1000);
// 변경 후
assertThat(discount).isEqualTo(1000);

// 변경 전
Assertions.assertThat(discount).isEqualTo(0);
// 변경 후
assertThat(discount).isEqualTo(0);

새로운 할인 정책 적용과 문제점

위에서는 새로운 할인 정책인 정률 할인 정책에 관련된 파일을 생성했다.
위에서 추가한 할인 정책을 적용 시키기 위해 코드를 수정해야 한다.

• OrderServiceImpl 내의 코드를 변경

// 변경 전
private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); 
// 변경 후 -> 위의 코드는 주석처리 하고 객체를 정률 할인 정책 클래스로 한다. 
 private final DiscountPolicy discountPolicy = new RateDiscountPolicy(); 

• 위의 코드에서의 문제점 ?

  • 역할과 구현을 충실하게 분리했다. (O)
    • 할인 정책에 대한 인터페이스(역할)를 구현했고, 구현할 수 있는 2가지 방법인 정액 할인 방법, 정률 할인 방법을 나누어 잘 개발했다.
  • 다형성을 활용하고, 인터페이스 구현 객체를 분리했다. (O)
  • OCP, DIP 같은 객체지향 설계 원칙을 충실히 준수했다. (X)
    • DIP : OrderServiceImpl에서 추상(인터페이스)인 DiscountPolicy 뿐만아니라 구체(구현)클래스인 FixDiscountPolicy나 RateDiscountPolicy를 의존하고 있다.
    • OCP : 변경하지 않고 확장할 수 있어야하는데, 지금 코드로서는 클라이언트 코드인 OrderServiceImpl 내의 코드를 변경해야하기 때문에 OCP를 위반하고 있다.

• 기대했던 의존 관계
  

OrderServiceImpl이 단순히 인터페이스인 DiscountPolicy만을 의존한다고 생각했다.

• 실제 의존 관계
  

실제로는 OrderServiceImpl이 DiscountPolicy 인터페이스 뿐만 아니라 FixDiscountPolicy인 구체 클래스도 함께 의존하고 있다. -> DIP 위반

• 따라서, FixDiscountPolicy를 RateDiscountPolicy로 변경하는 순간 OrderServiceImpl의 소스 코드도 함께 변경해야 한다. (위의 코드 참고) -> OCP 위반

✔️ 문제 해결 방법

이 문제를 해결하려면 누군가 클라이언트인 OrderServiceImpl에 DiscountPolicy의 구현 객체를 대신 생성하고 주입해주어야 한다.

• 인터페이스에만 의존하도록 설계를 변경
  

public class OrderServiceImpl implements OrderService {
    //private final DiscountPolicy discountPolicy = new RateDiscountPolicy();
    private DiscountPolicy discountPolicy;
}

이렇게하면, 인터페이스에만 의존하게 된다.
하지만 구현체가 존재하지 않아서 실제 실행을 해보면 NPE(Null Pointer Exception)이 발생한다.
-> 누군가 클라이언트인 OrderServiceImpl에 DiscountPolicy의 구현 객체를 대신 생성하고 주입해주어야 한다.

관심사의 분리

'관심사의 분리'란 ?

• 역할(인터페이스)과 객체(구현체)가 각자의 책임을 분리해야한다는 것을 의미한다.
• 즉, 인터페이스는 그 안에서의 일을 충실히해야하는 것이지 객체를 선택하는 일까지 책임져서는 안된다는 것을 의미한다.
• 애플리케이션을 하나의 공연으로 비유하자면,
  • 배우의 역할은 인터페이스이고 실제 배우는 구현체이다.
  • 이때, 어떤 배우를 쓸 것인지는 역할을 하는 배우가 선택하는 것이 아니라 배우를 지정하는 책임을 담당하는 별도의 기획자가 하는 일 이다.
  • 여기서의 이 기획자의 역할을 하는 AppConfig가 등장한다.

AppConfig의 등장

애플리케이션의 전체 동작 방식을 구성하기 위해, 구현 객체를 생성하고, 연결하는 별도의 설정 클래스이다.

• AppConfig 파일 생성

package hello.core;
import hello.core.discount.FixDiscountPolicy;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;

public class AppConfig {
    public MemberService memberService() {
        return new MemberServiceImpl(new MemoryMemberRepository());
    }
    public OrderService orderService() {
        return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
    }
}

이 파일에서는 애플리케이션에서 필요한 구현 객체를 생성한다.

• MemberServiceImpl
• MemoryMemberRepository
• OrderServiceImpl
• FixDiscountPolicy

그리고 객체 인스턴스의 참조를 생성자를 통해 주입한다.

• MemberServiceImpl -> MemoryMemberRepository
• OrderServiceImpl -> MemoryMemberRepository, FixDiscountPolicy

❗ 현재 MemberServiceImpl내의 문제점

• 변경 전 코드

public class MemberServiceImpl implements MemberService{

    private final MemberRepository memberRepository = new MemoryMemberRepository();
    // 여기서 의존하고 있음 !
    
    // 코드 생략 ...
}

현재 코드에서는 MemberServiceImpl이 MemoryMemberRepository를 의존하고 있다는 문제점이 존재한다.
구현체를 의존하고 있는 것은 좋지 않기 때문에 설계를 변경한다.

• 변경 후 코드

public class MemberServiceImpl implements MemberService{
    
    private final MemberRepository memberRepository;

    // 생성자 코드 추가 **
    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    // 코드 생략 ...
}

변경 후 코드에서는 MemberServiceImpl이 MemoryMemberRepository를 의존하지 않고 있다. 단지 MemoryRepository 인터페이스에만 의존하고 있다.
이 경우, MemberServiceImpl의 입장에서는 어떤 객체가 주입될지 모른다. -> 자신의 역할만을 충실하게 잘 해내고 있다 !
MemberServiceImpl의 생성자를 통해서 어떤 객체를 주입할 지는 오직 외부인 AppConfig에서 결정된다. -> AppConfig가 배역을 책임지는 역할만을 충실히 하고 있다 !

• 클래스 다이어그램

이로써, 객체의 생성과 연결은 AppConfig가 담당하게 되었다.
DIP가 완성되었다. MemberServiceImpl은 구현체가 아닌, 추상 인터페이스인 MemberRepository에만 의존하면 된다.

DIP를 잠깐 잊었을까봐 ... 🥲

• 의존역전원칙
• 즉, 구현체를 직접 참조하는 것이 아니라 그 대상의 상위 요소인 추상 인터페이스를 참조해야하는 원칙

❗ 현재 OrderServiceImpl 내의 문제점

• 변경 전 코드

public class OrderServiceImpl implements OrderService{
    // 2가지가 필요
    private final MemberRepository memberRepository = new MemoryMemberRepository(); // 회원 찾기
    private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); // 할인 정책
    
    // 코드 생략 ..
}

현재 코드에서는 OrderServiceImpl이 MemoryMemberRepository와 FixDiscountPolicy를 의존하고 있다.

• 변경 후 코드

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에서 더 이상 MemoryMemberRepository와 FixDiscountPolicy를 의존하지 않고, 인터페이스인 MemberRepository와 DiscountPolicy만 의존하고 있다.
이 경우, OrderServiceImpl 입장에서는 생성자를 통해 어떤 구현 객체가 들어올 지는 알 수 없다. -> 자신의 역할만을 충실하게 잘 해내고 있다 !!!
OrderServiceImpl의 생성자를 통해서 어떤 객체를 구현할 지는 오직 외부인 AppConfig에서 결정한다. -> AppConfig가 배역을 책임지는 역할만을 충실히 하고 있다 !!!

AppConfig 실행을 위해 변경해야하는 부분

• MemberApp 코드 내 수정

AppConfig appConfig = new AppConfig();
MemberService memberService = appConfig.memberService();
// MemberService memberService = new MemberServiceImpl();

기존 코드를 주석처리하고, 코드를 추가한다.

• OrderApp 코드 내 수정

AppConfig appConfig = new AppConfig();
MemberService memberService = appConfig.memberService();
OrderService orderService = appConfig.orderService();
// MemberService memberService = new MemberServiceImpl();
// OrderService orderService = new OrderServiceImpl();

Test 코드에서의 수정

• MemberServiceTest 내의 코드 수정

public class MemberServiceTest {
    MemberService memberService;

    @BeforeEach // 테스트가 실행되기 전에 무조건 실행 된다.
    public void beforeEach(){
        AppConfig appConfig = new AppConfig();
        memberService = appConfig.memberService();
    }
    // 코드 생략 ...
}

• OrderServiceTest 내의 코드 수정

public class OrderServiceTest {

    MemberService memberService;
    OrderService orderService;

    @BeforeEach
    public void beforeEach(){
        AppConfig appConfig = new AppConfig();
        memberService = appConfig.memberService();
        orderService = appConfig.orderService();
    }
    // 코드 생략 ...
}

AppConfig 리팩터링

• 중복이 존재하고, 역할에 따른 구현이 잘 보이지 않는 기존의 AppConfig 파일을 리팩토링 한다.
• 기대하는 그림

역할과 구현이 잘 분리되어있는 그림을 기대하는데, 현재 AppConfig내의 코드에서는 그렇게 보이지 않는다.

• 리팩터링 전 코드

public class AppConfig {
    public MemberService memberService() {
        return new MemberServiceImpl(new MemoryMemberRepository());
    }
    public OrderService orderService() {
        return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
    }
}

위의 그림처럼 역할들을 드러나게 코드를 리팩터링하는 것이 좋다.

• 리팩터링 후 코드
  • 이전의 문제점
    1. 현재 회원 저장소 역할을 하는 인터페이스가 보여야하는데 보이지 않음
    2. 할인 정책 역할을 하는 인터페이스가 보여야하는데 보이지 않음

public class AppConfig {
    public MemberService memberService(){
        return new MemberServiceImpl(memberRepository());
    }

    // 1번 문제점을 해결하기 위해 memberRepository(인터페이스 역할)을 따로 뺴고
    private MemberRepository memberRepository() {
        return new MemoryMemberRepository(); // 구현체로 Memory~ 를 넘겨줌
    }

    public OrderService orderService(){
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
   
    // 2번 문제점을 해결하기 위해 discountPolicy(인터페이스 역할)을 따로 빼고
    public DiscountPolicy discountPolicy(){
        return new FixDiscountPolicy(); // 구현체로 Fix~를 넘겨줌
    }
}

이렇게 리팩터링하면 나중에 구현체를 변경해야할 일이 생겼을 때 그 부분의 코드만 변경해주면 된다.

새로운 구조와 할인 정책 적용

정액 할인 정책 -> 정률 할인 정책으로 변경해보자.
위에서의 AppConfig의 등장덕분에 애플리케이션이 사용 영역과 구성하는 영역으로 분리되었다.

• 사용과 구성의 분리
  

• 할인 정책의 변경
  

할인 정책의 변경을 위해 어떤 부분만 변경하면 되는가 ?
구성 영역의 코드만 변경하면 된다. FixDiscountPolicy로 구현체를 설정했던 것을 RateDiscountPolicy로만 변경하면 된다.
사용 영역에 있는 코드는 전혀 손댈 필요가 없다 !
-> 이로써 OCP, DIP를 모두 만족시키는 코드로 변경되었다.

전체 흐름 정리

새로운 할인 정책 개발

새로운 정률 할인 정책 코드를 추가로 개발하는 것 자체에는 아무런 문제 X

새로운 할인 정책 적용과 문제점

정률 할인 정책으로 적용시키려고 하니, 클라이언트 코드인 OrderServiceImpl(주문 서비스 구현체)를 함께 변경해야 했다.
왜냐하면 OrderServiceImpl에서 인터페이스인 DiscountPolicy 뿐만아니라, 구체 클래스인 FixDiscountPolicy도 함께 의존하고 있었기 때문이다. (클라이언트 코드인 주문 서비스 구현테가 너무 많은 역할을 하고 있었던 것)

관심사의 분리

AppConfig의 등장
애플리케이션의 전체 동작 방식을 구성하기 위해 구현 객체를 생성하고 연결하는 책임을 가진다.
이로 인해 클라이언트 객체는 자신의 역할을 실행하는 것에만 집중한다. 권한이 줄어들었다. (= 책임이 명확해짐)

AppConfig 리팩터링

역할과 구현을 명확하게 분리했다.
역할이 잘 들어날 수 있게 하였고 중복을 제거하였다.

새로운 구조와 할인 정책 적용

정액 할인 정책을 정률 할인 정책으로 변경하였다.
AppConfig의 등장으로 애플리케이션이 크게 사용 영역과, 객체를 생성하고 구성하는 영역으로 분리했다.
할인 정책을 변경하더라도 AppConfig 내의 구성 영역만 변경하면 되고, 사용 영역의 코드는 변경할 필요가 없다.

좋은 객체 지향 설계의 5가지 원칙의 적용

SRP 단일 책임 원칙

한 클래스는 하나의 책임만 가져야 한다.

• 구현 객체를 생성하고 연결하는 책임 -> AppConfig
• 클라이어트 객체는 실행하는 책임만 담당

DIP 의존 관계 원칙

추상화에 의존해야지 구체화에 의존하면 안된다.

• 추상화에 의존을 하고, 의존 관계에 대한 구체적인 클래스에 대한 선택을 외부에서 넣어줘야 한다.

OCP

소프트웨어 요소는 확장에는 열려있으나 변경에는 닫혀 있어야 한다.

• 애플리케이션을 사용 영역과 구성 영역으로 나눈다.
• 소프트웨어 요소를 새롭게 확장해도 사용 영역의 변경은 닫혀 있다.

IoC, DI 그리고 컨테이너

제어의 역전 Ioc(Inversion of Control)

• AppConfig의 등장으로 구현 객체는 자신의 로직을 실행하는 역할만을 담당하게 되었고, AppConfig는 제어의 흐름을 담당한다.
• ex) OrderServiceImpl은 필요한 인터페이스들을 호출하지만 어떤 구현 객체들이 실행될지는 모른다.
• 이렇게 프로그램의 제어 흐름을 직접 제어하는 것이 아니라 외부에서 관리하는 것을 제어의 역전(IoC)라고 한다.

프레임워크 VS 라이브러리

• 프레임워크 : 내가 코드를 제어하고 대신 실행하면 그것은 프레임워크
• 라이브러리 : 내가 작성한 코드가 직접 제어의 흐름을 담당하면 그것은 라이브러리

의존 관계 주입 DI(Dependency Injection)

• 의존 관계는 정적인 클래스 의존 관계와, 실행 시점에 결정되는 동적인 객체(인스턴스) 의존 관계 둘을 분리해서 생각해야 한다.

정적인 클래스 의존 관계

• 클래스가 사용하는 import 코드만 보고서도 의존관계를 쉽게 판단할 수 있다. (정적인 의존 관계는 애플리케이션을 실행하지 않아도 분석 가능)
• 클래스 다이어그램 사진을 보면, OrderServiceImpl은 MemberRepository와 DiscountPolicy에 의존한다는 것을 알 수 있다.
• 이러한 클래스 의존관계 만으로는 실제로 어떤 객체가 OrderServiceImpl에 주입될 지 알 수 없다.

동적인 객체 인스턴스 의존 관계

• 애플리케이션 실행 시점에 실제 생성된 객체 인스턴스의 참조가 연결된 의존 관계이다.

객체 다이어그램

• 애플리케이션 실행 시점(런타임)에 외부에서 실제 구현 객체를 생성하고 클라이언트에 전달해서 클라이언트와 서버의 실제 의존관계가 연결되는 것 -> 의존관계 주입
• 의존관계 주입을 사용하면 클라이언트 코드를 변경하지 않고, 클라이언트가 호출하는 대상의 타입 인스턴스를 변경할 수 있다.

IoC 컨테이너, DI 컨테이너

• AppConfig 처럼 객체를 생성하고 관리하면서 의존관계를 연결해주는 것을 IoC 컨테이너 또는 DI 컨테이너라고 한다.

스프링으로 전환하기

순수한 자바로만 잤던 코드를 스프링을 이용하도록 코드를 변경한다.

• AppConfig 코드 변경

// AppConfig에 설정을 구성한다는 뜻의 @Configuration 붙이기
@Configuration
public class AppConfig {
    // 각 메서드에 @Bean 붙이기 -> 스프링 컨테이너에 등록됨
    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }
    @Bean
    public OrderService orderService() {
        eturn new OrderServiceImpl(memberRepository(),discountPolicy());
    }
    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

• MemberApp에 스프링을 적용하기 위해 코드 변경

// AppConfig appConfig = new AppConfig();
// MemberService memberService = appConfig.memberService();
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
MemberService memberService = applicationContext.getBean("memberService", MemberService.class);

• OrderApp에 스프링을 적용하기 위해 코드 변경

// 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를 스프링 컨테이너라고 한다. ApplicationContext가 Bean이란 것을 모두 관리해준다.
• 기존에는 개발자가 AppConfig를 사용해서 직접 객체를 생성하고 DI(의존성 주입)를 했지만, 이제부터는 스프링 컨테이너를 통해서 사용한다.
• 스프링 컨테이너는 @Configuration이 붙은 AppConfig를 설정 정보로 사용한다.
• 여기서 @Bean이라 적힌 메서드를 모두 호출해서 반환된 객체를 스프링 컨테이너에 등록한다. 이렇게 스프링 컨테이너에 등록된 객체를 스프링 빈이라고 한다.
• 스프링 빈은 @Bean이 붙은 메서드 명을 스프링 빈의 이름으로 사용한다.
• 이전에는 개발자가 필요한 객체를 AppConfig를 사용하여 직접 조회했지만, 이제는 스프링 컨테이너를 통해 스프링 빈(객체)를 찾아야한다.
• 스프링 빈은 applicationContext.getBean() 메서드를 통해 찾을 수 있다.

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

-> 스프링 컨테이너를 생성해줌으로써 @Bean 붙은 것들은 스프링 컨테이너에 객체 생성한 것을 다 집어 넣어서 관리해준다.

MemberService memberService = applicationContext.getBean("memberService", MemberService.class);

-> getBean 메소드는 2개의 인자를 필요로 하는데, 첫번째 인자는 메소드 이름이고 두번쨰 인자는 타입이다.

• 기존에는 개발자가 AppConfig도 직접 만들고 자바 코드로 모든 것을 했지만, 이제부터는 Spring에게 환경 정보를 던져주고 찾을 때는 스프링 컨테이너를 통해서 가져온다.
• 스프링 컨테이너에서 필요한 것들을 읽고 관리한다.

[YuDeokRin]

오.. 빠르네요

[seyxxn]

얼리스터디어 입니다

[jih3508]

제일 먼저 올렸네요

[seyxxn]

이 템포 유지해보겠습니다 ..!!