스프링 핵심 원리 - 기본편 [ 객체 지향 원리 적용 ]

문지원(JiwonMoon)·2021년 11월 7일
Spring스프링스프링 기본
0

스프링 핵심 원리 - 기본편

목록 보기
3/9
post-thumbnail
  1. 새로운 할인 정책 개발
  2. 새로운 할인 정책 적용과 문제점
  3. 관심사의 분리
  4. AppConfig 리팩터링
  5. 새로운 구조와 할인 정책 적용
  6. 좋은 객체 지향 설계의 5가지 원칙의 적용
  7. IoC, DI, 컨테이너
  8. 스프링으로 전환하기

새로운 할인 정책 개발

새로운 할인 정책을 확장
(가정)
기획자: 서비스 오픈 직전에 할인 정책을 지금처럼 고정 금액 할인이 아니라 좀 더 합리적인 주문 금액당 할인하는 정률% 할인으로 변경하고 싶다.
ex) 기존 정책은 VIP가 10000원을 주문하든 20000원을 주문하든 항상 1000원을 할인했는데, 이번에 새로 나온 정책은 10%로 지정해두면 고객이 10000원 주문시 1000원을 할인해주고, 20000원 주문시에 2000원을 할인해주는 것

“계획을 따르기보다 변화에 대응하기를”
< 애자일 소프트웨어 개발선언 >

RateDicountPolicy 추가

RateDicountPolicy 코드 추가

package hello.core.discount;
  import hello.core.member.Grade;
  import hello.core.member.Member;
public class RateDiscountPolicy implements DiscountPolicy { private int discountPercent = 10; //10% 할인
      @Override
      public int discount(Member member, int price) {
 	  	 if (member.getGrade() == Grade.VIP) {
               return price * discountPercent /  100;
          } else {
return 0; }
} }

테스트 작성

package hello.core.discount;
  import hello.core.member.Grade;
  import hello.core.member.Member;
  import org.junit.jupiter.api.DisplayName;
  import org.junit.jupiter.api.Test;
  import static org.assertj.core.api.Assertions.*;
  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
          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();
  }

문제점 통찰

  • 역할과 구현을 충실히 분리 O
  • 다형성도 활용하고, 인터페이스와 구현 객체를 분리 O
  • OCP, DIP 같은 객체지향 설계 원칙을 충실히 준수 X
    DIP: 클래스 의존관계를 분석해보면, 추상(인터페이스) 뿐만 아니라 구체(구현) 클래스에도 의존하고 있다.
    추상(인터페이스) 의존: DiscountPolicy
    구체(구현) 클래스: FixDiscountPolicy , RateDiscountPolicy
    OCP: 현재 코드는 기능을 확장해서 변경하면, 클라이언트 코드에 영향을 주기 때문에 OCP를 위반한다.

OCP 위반 문제

  • 클래스 다이어그램을 의존관계로 분석해보면,

기대했던 의존 관계

실제 의존관계

이므로 FixDiscountPolicy 를 RateDiscountPolicy 로 변경하는 순간 OrderServiceImpl 의 소스 코드도 함께 변경해야 하며! OCP 위반

OCP 문제 해결
클라이언트 코드인 OrderServiceImpl 은 DiscountPolicy 의 인터페이스 뿐만 아니라 구체 클래스도 함께 의존한다.
그래서 구체 클래스를 변경할 때 클라이언트 코드도 함께 변경해야 한다.
DIP 위반 추상에만 의존하도록 변경(인터페이스에만 의존)
DIP를 위반하지 않도록 인터페이스에만 의존하도록 의존관계를 변경하면 된다.

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

코드 변경

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

이에 따른 문제 발생

  • 구현체가 없는데 코드실행은 어떻게 해야할까?
  • 실행해보면 NPE(null pointer exception)가 발생한다.

위 문제 해결방안

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

관심사의 분리

여기서는 역할과 대상에 대해 고민해보아야 한다.

  • 만약 여러가지 역할(인터페이스, 캐릭터)를 하는 대상(구현체, 배우) 그를 연결 짓는 기획자(감독)이 존재한다면,
    - 대상은 하나의 역할을 수행하는 것에만 집중해야한다.
    • 역할의 대상은 변경되더도 똑같이 진행되어야한다. (대체가능성)
    • 역할과 대상을 지정하는 책임을 담당하는 기획자도 존재해야한다.
    • 기획자와 역할, 대상의 책임을 확실히 분리해야한다.

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

AppConfig의 동작과 목적

  • AppConfig는 애플리케이션의 실제 동작에 필요한 구현 객체를 생성한다.

  • AppConfig는 생성한 객체 인스턴스의 참조(래퍼런스)를 생성자를 통해서 주입(연결)한다.

    MemberServiceImpl- 생성자 주입

    package hello.core.member;
   public class MemberServiceImpl implements MemberService {
       private final MemberRepository memberRepository;
       public MemberServiceImpl(MemberRepository memberRepository) {
           this.memberRepository = memberRepository;
}
       public void join(Member member) {
           memberRepository.save(member);
}
       public Member findMember(Long memberId) {
           return memberRepository.findById(memberId);
} }
  • 설계 변경으로 MemberServiceImpl 은 MemoryMemberRepository 를 의존하지 않게 된다.
    클래스 다이어그램

객체의 생성과 연결은 AppConfig가 담당한다.
DIP 완성: MemberServiceImpl은 MemberRepository인 추상에만 의존하면 된다.
이제 구체 클래스를 몰라도 된다.
관심사의 분리: 객체를 생성하고 연결하는 역할과 실행하는 역할이 명확히 분리되었다.

회원객체 인스턴스 다이어그램

  • appConfig객체는 memoryMemberRepository 객체를 생성하고 그 참조값을 memberServiceImpl 을 생성하면서 생성자로 전달한다.
  • 클라이언트인 memberServiceImpl 입장에서 보면 의존관계를 마치 외부에서 주입해주는 것 같다고 해서 DI(Dependency Injection) 우리말로 의존관계 주입 또는 의존성 주입이라 한다.

OrderServiceImpl- 생성자 주입

package hello.core.order;
  import hello.core.discount.DiscountPolicy;
  import hello.core.member.Member;
  import hello.core.member.MemberRepository;
  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;
      }
      @Override
      public Order createOrder(Long memberId, String itemName, int itemPrice) {
                 Member member = memberRepository.findById(memberId);
          int discountPrice = discountPolicy.discount(member, itemPrice);
          return new Order(memberId, itemName, itemPrice, discountPrice);
      }
}
  • 설계 변경으로 OrderServiceImpl은 FixDiscountPolicy를 의존하지 않는다 (단지 DiscountPolicy 인터페이스만 의존한다.)
  • OrderServiceImpl입장에서 생성자를 통해 어떤 구현 객체가 들어올지(주입될지)는 알 수 없다.
  • OrderServiceImpl의 생성자를 통해서 어떤 구현 객체을 주입할지는 오직 외부(AppConfig)에서 결정한다.
  • OrderServiceImpl은 이제부터 실행에만 집중하면 된다.
  • OrderServiceImpl에는 MemoryMemberRepository, FixDiscountPolicy객체의 의존관계가 주입된다.

AppConfig 실행
사용클래스 - MemberApp

package hello.core;
  import hello.core.member.Grade;
  import hello.core.member.Member;
  import hello.core.member.MemberService;
  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());
      }
}

사용클래스 - OrderApp

package hello.core;
  import hello.core.member.Grade;
  import hello.core.member.Member;
  import hello.core.member.MemberService;
  import hello.core.order.Order;
  import hello.core.order.OrderService;
  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);
      }
}

테스트 코드 오류 수정
MemberServiceTest 

class MemberServiceTest {
 MemberService memberService;
      @BeforeEach
      public void beforeEach() {
          AppConfig appConfig = new AppConfig();
          memberService = appConfig.memberService();
      }
}

OrderServiceTest

class OrderServiceTest {
      MemberService memberService;
      OrderService orderService;
      @BeforeEach
      public void beforeEach() {
          AppConfig appConfig = new AppConfig();
          memberService = appConfig.memberService();
          orderService = appConfig.orderService();
} }

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

리팩터링 후

package hello.core;
  import hello.core.discount.DiscountPolicy;
  import hello.core.discount.FixDiscountPolicy;
  import hello.core.member.MemberRepository;
  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(memberRepository());
}
      public OrderService orderService() {
          return new OrderServiceImpl(
                  memberRepository(),
                  discountPolicy());
  }
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
}
      public DiscountPolicy discountPolicy() {
          return new FixDiscountPolicy();
} }
  • new MemoryMemberRepository()이 부분이 중복 제거되었다.
    이제 MemoryMemberRepository 를 다른 구현체로 변경할 때 한 부분만 변경하면 된다.
  • AppConfig를 보면 역할과 구현 클래스가 한눈에 들어온다.
    애플리케이션 전체 구성이 어떻게 되어있는지 빠르게 파악할 수 있다.

리펙터링을 한 이유 :
Appconfig 클래스 내에서 전체 흐름을 알 수 있도록 변경하고, 관심사의 분리를 정확하게 하기 위함.

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

사용, 구성의 분리

할인 정책의 변경

할인 정책 변경 구성 코드

package hello.core;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
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(memberRepository());
}
    public OrderService orderService() {
        return new OrderServiceImpl(
                memberRepository(),
                discountPolicy());
}
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
}
 	public DiscountPolicy discountPolicy() {
        // return new FixDiscountPolicy(); // 할인정책의 변경
        return new RateDiscountPolicy();
    }
}

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

여기서 3가지 SRP, DIP,OCP 적용

  • SRP 단일 책임 원칙
    • 한 클래스는 하나의 책임만 가져야 한다.
  • DIP 의존관계 역전 원칙
    • 프로그래머는 "추상화에 의존해야지, 구체화에 의존하면 안된다." 의존성 주입은 이 원칙을 따르는 방법 중 하나다.
  • OCP
    • 소프트웨어 요소는 확장에는 열려 있으나 변경에는 닫혀 있어야 한다.
    • 다형성을 사용하고 클라이언트가 DIP를 지킴
    • 애플리케이션을 사용 영역과 구성 영역으로 나눔

IoC, DI, 컨테이너

제어의 역전 IoC(Inversion of Control)

  • 기존 프로그램은 클라이언트 구현 객체가 스스로 필요한 서버 구현 객체를 생성하고, 연결하고, 실행했다.
    한마디로 구현 객체가 프로그램의 제어 흐름을 스스로 조종했고, 개발자 입장에서는 자연스러운 흐름이다.

  • 반면에 AppConfig가 등장한 이후에 구현 객체는 자신의 로직을 실행하는 역할만 담당한다.
    프로그램의 제어 흐름은 이제 AppConfig가 가져간다.
    예를 들어서 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 스프링 기반으로 변경

package hello.core;
  import hello.core.discount.DiscountPolicy;
  import hello.core.discount.RateDiscountPolicy;
  import hello.core.member.MemberRepository;
  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;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  @Configuration // AppConfig에 설정을 구성한다는 뜻
  public class AppConfig {
       // 스프링 컨테이너에 스프링 빈으로 등록한다. 
      @Bean
      public MemberService memberService() {
          return new MemberServiceImpl(memberRepository());
      }
      @Bean
      public OrderService orderService() {
          return new OrderServiceImpl(
                  memberRepository(),
                  discountPolicy());
}
      @Bean
      public MemberRepository memberRepository() {
          return new MemoryMemberRepository();
      }
      @Bean
      public DiscountPolicy discountPolicy() {
          return new RateDiscountPolicy();
} }

MemberApp에 스프링 컨테이너 적용

package hello.core;
  import hello.core.member.Grade;
  import hello.core.member.Member;
  import hello.core.member.MemberService;
  import org.springframework.context.ApplicationContext;
  import
  org.springframework.context.annotation.AnnotationConfigApplicationContext;
  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());
          }
}

OrderApp에 스프링 컨테이너 적용

package hello.core;
  import hello.core.member.Grade;
  import hello.core.member.Member;
  import hello.core.member.MemberService;
  import hello.core.order.Order;
  import hello.core.order.OrderService;
  import org.springframework.context.ApplicationContext;
  import
  org.springframework.context.annotation.AnnotationConfigApplicationContext;
  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", 10000);
          System.out.println("order = " + order);
      }
}

스프링 컨테이너

  • ApplicationContext 를 스프링 컨테이너라 한다. ("컨테이너는 객체관리를 주로 수행하는 공간정도")

  • 기존에는 개발자가 AppConfig 를 사용해서 직접 객체를 생성하고 DI를 했지만, 이제부터는 스프링 컨테이너를 통해서 사용한다.

  • 스프링 컨테이너는 @Configuration 이 붙은 AppConfig 를 설정(구성) 정보로 사용한다. 여기서 @Bean 이라 적힌 메서드를 모두 호출해서 반환된 객체를 스프링 컨테이너에 등록한다.
    이렇게 스프링 컨테이너에 등록된 객체를 스프링 빈이라 한다.

  • 스프링 빈은 @Bean 이 붙은 메서드의 명을 스프링 빈의 이름으로 사용한다. (memberService , orderService)

  • 이전에는 개발자가 필요한 객체를 AppConfig 를 사용해서 직접 조회했지만, 이제부터는 스프링 컨테이너를 통해서 필요한 스프링 빈(객체)를 찾아야 한다. 스프링 빈은 applicationContext.getBean() 메서드를 사용해서 찾을 수 있다.

  • 이전에는 개발자가 직접 자바코드로 모든 것을 했다면 이제부터는 스프링 컨테이너에 객체를 스프링 빈으로 등록하고, 스프링 컨테이너에서 스프링 빈을 찾아서 사용하도록 변경되었다.

코드가 역간 더 복잡해 진 것 같은데, 스프링 컨테이너를 사용하면 어떤 장점이 있을까?

  • 스프링 컨테이너는 자바 객체의 생명 주기를 관리하며, 생성된 자바 객체들에게 추가적인 기능을 제공하는 역할을 한다. 여기서 말하는 자바 객체를 스프링에서는 빈(Bean)이라고 부른다. 그리고 IoC와 DI의 원리가 이 스프링 컨테이너에 적용된다.

  • 개발자는 new 연산자, 인터페이스 호출, 팩토리 호출 방식으로 객체를 생성하고 소멸시킬 수 있는데, 스프링 컨테이너가 이 역할을 대신해준다. 즉, 제어 흐름을 외부에서 관리한다는 것

  • 객체들 간의 의존관계를 스프링 컨테이너가 런타임 과정에서 알아서 만들어 준다. DI는 생성자, setter @Autowired를 통해 적용한다. 즉 객체 간의 의존성을 낮추기 위해 바로 Spring 컨테이너가 사용된다.

References (참고 자료)

profile
문지원(JiwonMoon)
이전 포스트

스프링 핵심 원리 - 기본편 [ 예제 ]

다음 포스트

스프링 핵심 원리 - 기본편 [ 스프링 컨테이너 & 스프링 빈 ]

0개의 댓글