[Spring core] 스프링 회원정책 프로젝트 (객체 지향 원리 적용)

본 리뷰는 인프런 김영한씨의 스프링 핵심원리 - 기본편 리뷰를 한 포스팅입니다.

 

목차

• 새로운 할인 정책 개발
• 새로운 할인 정책 적용과 문제점
• AppConfig 등장 (문제 해결)
• 새로운 구조와 할인 정책 적용
• 좋은 객체 지향 설계의 원칙 적용 정리 (SRP, DIP, OCP 적용)

 

 

1. 새로운 할인 정책 개발

변경 전

일방적이었던 할인정책 (고정할인 정책)을 2가지의 정책을 구현클래스로 만들어 구현 클레스를 변경할 수 있도록 구현을 변경해주려고한다.

변경 후

-. 새로운 할인 정책

기존 포스팅의 할인 정책은 고정할인 정책을 시행하였지만, 이를 x%씩 할인 해주는 정책으로 변경하려고한다.

할인 정책은 동일하게 VIP회원에게만 적용이되고, BASIC회원에게는 적용을 해주지 않는다.

-. 할인 정책 인터페이스

package hello.core.discount;

import hello.core.member.Member;

public interface DiscountPolicy {

    /**
     * @return 할인 대상 금액
     */
    int discount(Member member, int price);
}

-. 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) {
        // 10% 할인을 적용하는 알고리즘
        if (member.getGrade() == Grade.VIP){
            return price * discountPercent / 100 ;
        }
        else{
            return 0;
        }
    }
}

-. Test작성

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.*;


class RateDiscountPolicyTest {

    RateDiscountPolicy discountPolicy = new RateDiscountPolicy();
    @Test
    @DisplayName("VIP는 10% 할인이 적용되어야 한다.")
    void discount() {
        //given
        Member memberVIP = new Member(1L, "memberVIP", Grade.VIP);

        //when
        int discount = discountPolicy.discount(memberVIP, 10000);

        //then
        assertThat(discount).isEqualTo(1000);
    }


    @Test
    @DisplayName("BASIC은 할인이 적용되지 않아야 한다.")
    void fail_discount() {
        //given
        Member memberBASIC = new Member(1L, "memberBASIC", Grade.BASIC);

        //when
        int discount = discountPolicy.discount(memberBASIC, 10000);

        //then
        assertThat(discount).isEqualTo(0);
    }
}

-. 테스트 완료

 

할인 정책 변경 테스트 완료

이렇게 테스트가 완료된 것을 확인할 수 있다.

2. 새로운 할인 정책 적용 및 문제점

-. 주문 기존 코드 (주문)

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

 

-. 해결한 점

1) 역할과 구현을 분리했다.

2) 다형성을 활용했다.

3) 인터페이스와 구현 객체를 분리했다.

 

-. 문제점

1) OCP를 위반했다.

구현에서 정책을 변경하기위해서 주석을 달아주어야 한다는 점에서 클라이언트 코드에 영향을 준다.

2) DIP을 위반했다.

클레스 의존관계는 인터페이스뿐아니라 구현 클레스에도 의존하고 있다.
(인터페이스: DiscountPolicy) (구현 클레스: FixDiscountPolicy, RateDiscountPolicy)

 

-. 기대했던 의존 관계 Diagram

기대했던 의존관계

-. 실제 의존관계 Diagram

실제 의존관계

 

-. 정책 변경 Diagram

실제 정책변경 의존관계

 

3. DI 컨테이너 (AppConfig 등장)

-. 해결방안

 

* Impl에 DiscountPolicy 구현객체를 대신 주입을 해주면된다!
* private DiscountPolicy discountPolicy; 인터페이스를 의존하면된다. (하지만 이는 null을 일으킴으로 오류가 발생한다.)
* 따라서 AppConfig를 생성하여 기획자와 같은 임무를 수행하도록 해준다.

 

 

-. 관심사의 분리

1) 클래스에서는 역할을 수행하는 것에만 집중해야한다.

2) 전반적인 구성을 담당하는 기획자와 같은 역할을 부여하는 AppConfig를 사용하자

 

-. AppConfig 등장

애플리케이션의 전반적인 동작 방식을 구성(configuration)하기 위해서 구현 객체를 생성하고, 연결하는 것을 책임지는 별도의 클래스를 설정한다.

 

AppConfig.class

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
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
public class AppConfig {
    /**
     * @Bean을 통하여 스프링 컨테이너에 등록한다.
     */

    /**
     * 의존관계 주입: DI
     * memberServiceImpl입장에서 보면 의존관계를 외부(AppConfig)가 주입해주는 것 같다.
     */
    @Bean
    public MemberService memberService(){
        // 생성자 주입
        return new MemberServiceImpl(MemberRepository());
    }

    //표현식 (MemoryMemberRepository)
    @Bean
    public MemoryMemberRepository MemberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService(){
        // 생성자 주입
        return new OrderServiceImpl(MemberRepository(), discountPolicy());
    }

    //표현식(FixDiscountPolicy or RateDiscountPolicy)
    @Bean
    public DiscountPolicy discountPolicy(){
//        return new FixDiscountPolicy();
        return new RateDiscountPolicy();
    }

}

 

AppConfig

1) 구현 객체 생성

-. MemberServiceImpl

-. MemoryMemberRepository

-. OrderServiceImpl

-. FixDiscountPolicy

 

2) 생성자를 통해서 연결(주입)

-. MemberServiceImpl 👉 MemoryMemberRepository 선택

-. OrderServiceImpl 👉 MemoryMemberRepository 와 RateDiscountPolicy 선택

 

MemberServiceImpl

package hello.core.member;

//인터페이스의 구현체 구현 
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 인터페이스를 의존한다.

따라서 의존관계에 대한 고민은 AppConfig에만 맡길 수 있고 본인의 역할에만 집중할 수 있도록 구현할 수 있다.

 

Class Diagram

AppConfig가 도입된 클래스 다이어그램

 

OrderServiceImpl

package hello.core.order;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;

public class OrderServiceImpl implements OrderService {



    /**
     * 역할과 구현을 충실히했다.
     * 다형성 활용하고 인터페이스와 구현 객체를 분리했다.
     * 준수하지 않은점: OCP, DIP
     * DIP: 클레스 의존관계는 인터페이스뿐아니라 구현 클레스에도 의존하고 있다.
     * (인터페이스: DiscountPolicy) (구현 클레스: FixDiscountPolicy, RateDiscountPolicy)
     * OCP: 주석을 달았지만 구현체에 변경이 있었기에 위반이다.
     */
    //    private final DiscountPolicy discountPolicy = new FixDiscountPolicy();
    //    private final DiscountPolicy discountPolicy = new RateDiscountPolicy();

    /**
     * OCP, DIP 해결방법
     * Impl에 DiscountPolicy 구현객체를 대신 주입을 해주면된다!
     * private DiscountPolicy discountPolicy; 인터페이스를 의존하면된다. (하지만 이는 null을 일으킴으로 오류가 발생한다.)
     * 따라서 AppConfig를 생성하여 기획자와 같은 임무를 수행하도록 해준다.
     */
    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은 Fix or RateDiscountPolicy에 의존하지 않고,

DiscountPolicy 인터페이스에만 의존한다.

따라서 의존관계에 대한 고민은 AppConfig에만 맡길 수 있고 본인의 역할에만 집중할 수 있도록 구현할 수 있다.

 

-. AppConfig 실행 (MemberApp 사용)

MemberApp

package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class MemberApp {
    public static void main(String[] args) {
        //AppConfig 사용하여 DI 해줌.
//        AppConfig appConfig = new AppConfig();
//        MemberService memberService = appConfig.memberService();

        //스프링 컨테이너 (AppConfig에 있는 환경설정 정보를 가지고 Bean이 붙은 것을 객체 생성하여 관리를 해준다. (스프링으로부터)
        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());
    }
}

MemberApp 실행 결과

멤버가 동일하다는 것을 확인할 수 있고, AppConfig에 있는 Bean을 통하여 객체를 생성하는 것을 확인할 수 있다.

 

MemberServiceTest

package hello.core.member;


import hello.core.AppConfig;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;

public class MemberServiceTest {
        AppConfig appConfig = new AppConfig();
        MemberService memberService = appConfig.memberService();

    @Test
    void join(){
        //given
        Member member = new Member(1L, "memberA", Grade.VIP);

        //when
        memberService.join(member);
        Member findMember = memberService.findMember(member.getId());

        //then
        Assertions.assertThat(member).isEqualTo(findMember);

    }

}

테스트 결과

OrderServiceTest

package hello.core.service;

import hello.core.AppConfig;
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.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;

class OrderServiceTest {
    AppConfig appConfig = new AppConfig();
    MemberService memberService = appConfig.memberService();
    OrderService orderService = appConfig.orderService();
    @Test
    void createOrder() {
        long memberId = 1L;
        Member member = new Member(memberId, "memberA", Grade.VIP);
        memberService.join(member);
        Order order = orderService.createOrder(memberId, "itemA", 10000);
        Assertions.assertThat(order.getDiscountPrice()).isEqualTo(1000);
    }
}

테스트 결과

 

 

-. AppConfig가 적용되었을 때, 전반적인 Diagram

AppConfig가 적용되었을 때, 전반적인 Diagram

 

4. 새로운 정책 적용

-. 사용영역과 구성영역의 분리

 

사용영역과 구성영역의 분리 Diagram

-. 할인 정책 변경했을 경우 Diagram

할인 정책 변경했을 경우 Diagram

 

- 두 Diagram을 비교해보았을 때, FixDiscountPolicy에서 RateDiscountPolicy로 변경을 하였을 경우, 사용영역, 즉 클라이언트 부분을 변경하지 않아도 구성영역에서 통제가 가능하도록 변경을 해준 모습니다.

- 구성 영역의 코드는 당연히 변경을 할 수밖에 없으며, AppConfig라는 Configuration을 통하여 Bean객체를 직접 생성을하고 그것을 사용영역에 영향을 주는 방식으로 코드가 변경된 것이다.

 

5. 좋은 객체 지향 설계의 원칙 적용 정리 (SOLID)

• SRP 단일 책임 원칙

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

• 클라이언트 객체는 직접 구현 객체를 생성하고, 연결하고, 실행하는 다양한 책임을 가지고 있음
• SRP 단일 책임 원칙을 따르면서 관심사를 분리함
• 구현 객체를 생성하고 연결하는 책임은 AppConfig가 담당
• 클라이언트 객체는 실행하는 책임만 담당

 

• DIP 의존관계 역전 원칙

추상화에 의존하고 구체화에는 의존하면안된다.

• 새로운 할인 정책을 개발하고, 적용하려고 하니 클라이언트 코드도 함께 변경해야 했다. 왜냐하면 기존 클라이언트 코드( OrderServiceImpl )는 DIP를 지키며 DiscountPolicy 추상화 인터페이스에 의존하는 것 같았지만, FixDiscountPolicy 구체화 구현 클래스에도 함께 의존했다.
• 클라이언트 코드가 DiscountPolicy 추상화 인터페이스에만 의존하도록 코드를 변경했다. 하지만 클라이언트 코드는 인터페이스만으로는 아무것도 실행할 수 없다.
• AppConfig가 FixDiscountPolicy 객체 인스턴스를 클라이언트 코드 대신 생성해서 클라이언트 코드에 의존관계를 주입했다. 이렇게해서 DIP 원칙을 따르면서 문제도 해결했다.

 

• OCP 개방폐쇄 원칙

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

• 다형성 사용하고 클라이언트가 DIP를 지킴
• 애플리케이션을 사용 영역과 구성 영역으로 나눔
• AppConfig가 의존관계를 FixDiscountPolicy RateDiscountPolicy 로 변경해서 클라이언트 코드에 주입하므로 클라이언트 코드는 변경하지 않아도 됨
• 소프트웨어 요소를 새롭게 확장해도 사용 영역의 변경은 닫혀 있다!

 

추가적으로 source는 github에 있습니다.