[Spring/기본편] 2. 순수한 자바로 SOLID특징 지키며 설계하기

2021. 12. 22. 11:40

목표

순수한 자바를 이용하여 역할(인터페이스)와 구현(구현체)를 나누어서 개발을 해보며 객체 지향 프로그래밍과 스프링에 대해 이해합니다.
실제 요구사항에 맞춰서 유연하게 변경이 가능한가를 확인하여 자바의 다형성에 대해 이해합니다. (스프링에서의 개방-폐쇄, 의존관계 역전 원칙이 잘 지켜지는지 확인합니다.)

프로젝트 생성

아래의 웹사이트에서 스프링 부트 프로젝트를 생성할 수 있습니다.

https://start.spring.io/

해당 웹사이트에서 아래와 같이 프로젝트 언어, 부트 버전(SNAPSHOT은 정식 릴리즈되지 않은 버전입니다.), 메타데이타, 디펜던시(아무것도 선택하지 않으면 기본적인 코어만 가지고 프로젝트가 생성된다고 합니다.)를 선택해 주었습니다.

해당 페이지 하단에 GENERATE를 클릭하면 선택한 버전대로 스프링부트 프로젝트가 생성됩니다. 저는 IntelliJ, Java 11버전을 통해 프로그램을 실행시켰습니다. 버전이 다른 경우 잘 되지 않을수도 있다고 합니다.

비즈니스 요구사항과 설계

요구사항

회원
- 회원을 가입하고 조회할 수 있습니다.
- 회원은 일반과 VIP 두 가지 등급이 있습니다.
- 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있습니다. (확정되지 않은 부분입니다.)
주문과 할인 정책
- 회원은 상품을 주문할 수 있습니다.
- 회원 등급에 따라 할인 정책을 적용할 수 있습니다.
- 할인 정책은 모든 VIP는 1000원을 할인해주는 고정 금액 할인을 적용합니다. (나중에 변경될 수 있는 부분입니다.)
- 할인 정책은 변경 가능성이 높습니다. 회사의 기본 할인 정책을 아직 정하지 못했고, 오픈 직전까지 고민을 미루고 싶어합니다. 최악의 경우 할인을 적용하지 않을 수 도 있습니다. (할인은 확정되지 않은 부분입니다.)

요구사항을 보면 확정되지 않은 부분은 지금 결정하기 어려운 부분이라고 가정합니다. 하지만 결정될 때 까지 개발자는 기다릴 수 없다는 가정을 두고선 앞서 배운 객체 지향 설계 방법에 따라서 개발을 진행해보도록 하겠습니다. 현재는 스프링이 없는 순수한 자바로만 개발을 진행할 것 입니다.

회원 도메인 설계

앞서 말한 회원에 대한 요구 사항에 맞춰 설계합니다.

회원 도메인 협력 관계

회원 저장소인 회원데이터에 접근하는 부분을 interface로 두는 이유는 자체 DB를 구축할지, 외부 시스템과 연동할지 정확하게 확정되지 않은 부분이기 때문입니다. 확정되지 않은 구현체는 메모리 회원 저장소라는 임의의 구현체를 통해 개발을 진행하도록 하였습니다.

회원 클래스 다이어그램

위의 회원 도메인을 실제 구현할 다이어그램입니다. 회원서비스는 고려하는 여러개의 구현체가 없기때문에 MemberServiceImpl이라는 구현체로 구현하고, 회원데이터를 저장할 회원저장소인 MemberRepository 인터페이스의 구현체는 MemoryMemberRepository라는 임의의 구현체로 구현합니다. 추후에 확장하기위해 DbMemberRepository라는 자체 DB구현체와 그림에는 없지만 외부시스템 구현체도 포함합니다.

회원 객체 다이어그램

테스트 프레임워크

애플리케이션 로직으로 테스트를 하는 것은 좋은 로직이 아니기 떄문에 Junit이라는 테스트 프레임워크를 사용하여 작성한 코드의 테스트를 진행해보겠습니다.

먼저 모든 코드는 위의 회원 클래스 다이어그램에 따라서 작성이된 후 입니다.

main패키지가 아닌 test패키지에 hello.core패키지 안에 member라는 패키지를 만들고 MemberServiceTest라는 멤버서비스를 테스트할 객체를 생성합니다. 그 후 given,when,then에 따라 테스트 코드를 작성한 뒤 테스트를 진행해줍니다. 실행했을 때 정상적으로 프로그램이 종료되면 테스트는 성공적으로 끝난 것 입니다.

package hello.core.member;

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

public class memberServiceTest {
    MemberService memberService = new MemberServiceImpl();

    @Test
    void join() {
        //given      ~~이런게 주어지고
        Member member = new Member(1L, "memberA", Grade.VIP);

        //when      ~~이렇게 했을 때
        memberService.join(member);
        Member findMember = memberService.findMember(1L);

        //then        이렇게 된다.
        Assertions.assertThat(member).isEqualTo(findMember);
    }

}

회원 모메인 설계의 문제점

위의 설계상 문제점은 무엇일까요?? 현재까지 작성한 코드는 순수한 자바로 작성된 코드입니다. 전에 이해한 다형성으로 해결하지 못하는 개방-폐쇄, 의존관계 역전 원칙을 여전히 잘 지키지 못하는 모습을 볼 수 있습니다.

주문과 할인 도메인 설계

주문과 할인 정책
- 회원은 상품을 주문할 수 있습니다.
- 회원 등급에 따라 할인 정책을 적용할 수 있습니다.
- 할인 정책은 모든 VIP는 1000원을 할인해주는 고정 금액 할인을 적용합니다. (나중에 변경될 수 있는 부분입니다.)
- 할인 정책은 변경 가능성이 높습니다. 회사의 기본 할인 정책을 아직 정하지 못했고, 오픈 직전까지 고민을 미루고 싶어합니다. 최악의 경우 할인을 적용하지 않을 수 도 있습니다. (할인은 확정되지 않은 부분입니다.)

위의 정책에 따라서 설계합니다.

주문 도메인 협력, 역할, 책임

주문 도메인 전체

역할과 구현을 분리했기때문에 자유롭게 구현 객체를 조립할 수 있게 설계했습니다. 덕분에 회원 저장소는 물론이고, 할인 정책도 유연하게 변경할 수 있습니다.

주문 도메인 클래스 다이어그램

주문 도메인 객체 다이어그램1

회원을 메모리에서 조회하고, 정액 할인 정책(고정 금액)을 지원해도 주문 서비스를 변경하지 않아도 됩니다. 역할들의 협력관계를 그대로 재사용할 수 있습니다. 이는 MemoryMemberRepository가 DbMemberRepository로 변경되도 주문 서비스 구현체는 변경하지 않아도 된다는 것을 의미합니다.

주문 도메이 객체 다이어그램2

회원을 메모리가 아닌 실제 DB에서 조회하고, 정률 할인 정책(주문 금액에 따라 % 할인)을 지원해도 주문 서비스를 변경하지 않아도 됩니다. 즉, 협력 관계를 그대로 재사용할 수 있습니다.

객체 지향 원리 적용

새로운 할인 정책 개발

악덕 기획자가 서비스 오픈 직전에 할인 정책을 지금처럼 고정 금액 할인이 아니라 좀 더 합리적인 주문 금액당 할인하는 정률 % 할인으로 변경하고 싶다고 합니다. 이 때 객체 지향 설계 원칙을 준수하지 않았다면 많은 코드를 수정하겠지만, 유연한 설계가 가능한 객체지향 설계 원칙을 준수했다면 쉽게 요구사항을 변경할 수 있습니다.

RateDiscountPolicy 추가

기존 고정 할인 금액이던 FIxDiscountPolicy 구현체를 RateDidscountPolicy로 변경합니다.

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

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

할인 정책을 변경하려면 클라이언트인 OrderServiceImpl 클래스의 코드를 고쳐야 합니다. 여기서 문제점은 개방-폐쇄, 의존관계 역전 원칙을 준수하려고 했지만, 실제로 지켜지지 못한 모습을 볼 수 있습니다.

의존관계 역전 원칙 : 주문 서비스 클라이언트(OrderServiceImpl)는 DiscountPolicy 인터페이스에 의존하면서 의존관계 역전 원칙을 지킨 것 같지만, 인터페이스 뿐만 아닌 구현체 클래스에도 의존하는 모습을 볼 수 있습니다.
개방-폐쇄 원칙 : 변경하지 않고 확장하면 된다고 했지만, 클라이언트 코드를 변경해야하는 모습을 볼 수 있습니다.

왜 클라이언트 코드를 변경해야 될까??

기대했던 의존관계

지금까지 단순히 DiscountPolicy 인터페이스만 의존한다고 생각하며 코딩을 했습니다.

실제 의존관계

하지만, 인터페이스 뿐만이 아닌 구현체에도 의존하고 있는 모습을 볼 수 있습니다. (의존관계 역전 위반)

구현체 변경

또한, 구현체를 변경하는 순간 OrderServiceImpl의 소스 코드를 함께 변경해야 합니다. (개방-폐쇄 원칙 위반)

이 문제를 해결하기 위해서는 클라이언트가 추상(인터페이스)에만 의존하도록 변경하면됩니다.

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

실제로 인터페이스에만 의존하도록 코드를 변경해보면 위와 같이 변경할 수 있습니다. 하지만, 실제 실행해보면 Null pointer exception이 발생합니다. 그러면 두 원칙을 지킬 수 없는 것인가??에 대한 의문이 듭니다.

이 문제를 해결하려면 누군가가 클라이언트인 OrderServiceImpl 클래스에 DiscountPolicy의 구현체를 대신 생성하고 주입해주면 가능합니다.

관심사의 분리

현재까지 구현한 애플리케이션을 하나의 공연에 빗대어서 생각해봅시다. 로미오와 줄리엣 공연을 하면 로미오, 줄리엣 역할을 누가할지는 배우들이 정하는게 아닙니다. 애플리케이션도 마찬가지입니다. 하지만, 현재까지 구현한 코드는 로미오 역할(인터페이스)를 하는 무명 배우(구현체, 배우)가 줄리엣 역할(인터페이스)을 하는 무명 배우(구현체, 배우)를 직접 초빙하는 것과 같습니다. 이를 해결하기 위해서는 관심사를 분리할 필요가 있습니다.

관심사를 분리하자

배우는 본인의 역할인 배역을 수행하는 것에만 집중해야 합니다.
남자 주인공은 어떤 여자 주인공이 선택되더라도 똑같이 공연을 할 수 있어야합니다.
공연을 구성하고, 담당 배우를 섭외하고, 역할에 맞는 배우를 지정하는 책임을 담당하는 별도의 공연 기획자가 나올 시점입니다.
공연 기획자를 만들고, 배우와 공연 기획자의 책임을 확실히 분리합시다.

AppConfig 등장

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

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는 애플리케이션의 실제 동작에 필요한 구현 객체를 생성하며, 생성한 객체 인스턴스의 참조를 생성자를 통해서 주입(연결)해 줍니다.

아래 코드를 보면 실제 클라이언트에서는 구현체에 대한 코드가 포함되지 않고 정상적으로 돌아가는 것을 볼 수 있습니다.

public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

클래스 다이어그램

객체의 생성과 연결은 AppConfig가 담당합니다.
의존관게 역전 원칙 완성 : MemberServiceImpl은 MemberRepository인 추상에만 의존하면 됩니다.
관심사의 분리 : 객체를 생성하고 연결하는 역할과 실행하는 역할이 명확히 분리되었습니다.

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

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

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

}

new MemoryMemberRepository()의 중복이 있습니다. 또한, 역할에 따른 구현이 잘 보이지 않습니다.

리펙터링 후

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

    private MemberRepository getMemberRepository() {
        return new MemoryMemberRepository();
    }

    public OrderService orderService() {
        return new OrderServiceImpl(
                getMemberRepository(),
                getDigcountPolicy());
    }

    public DiscountPolicy getDigcountPolicy() {
        return new FIxDiscountPolicy();
    }
}

new MemoryMemberRepository()의 중복을 제거하였고, MemoryMemberRepository를 다른 구현체로 변경할 때 한 부분만 변경하면 되도록 하였습니다. 또한, 역할과 구현 클래스가 한 눈에 들어옵니다. 이를 통하여 애플리케이션 전체 구성이 어떻게 되어있는지 빠르게 파악할 수 있습니다.

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

기존 고정액 할인 정책을 정률 % 할인 정책으로 변경하는 일을 하려고합니다.

구성의 분리

할인 정책의 변경

FixDiscountPolicy -> RateDiscountPolicy로 변경해도 구성 영역만 영향을 받기때문에 사용 영역의 다른 코드는 바꾸지 않아도 됩니다.

실제 바꾼 코드

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

    private MemberRepository getMemberRepository() {
        return new MemoryMemberRepository();
    }

    public OrderService orderService() {
        return new OrderServiceImpl(
                getMemberRepository(),
                getDigcountPolicy());
    }

    public DiscountPolicy getDigcountPolicy() {
        //return new FIxDiscountPolicy();
        return new RateDiscountPolicy();
    }
}

실제로 주석만 한줄 만들고, 새로운 한줄만 추가하면 프로젝트는 정상적으로 돌아갑니다.

정리

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

여기서 3가지 SRP, DIP, OCP를 적용했습니다.

SRP - 단일 책임 원칙

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

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

DIP - 의존관게 역전 원칙

프로그래머는 "추상화에 의존해야지, 구체화에 의존하면 안된다." 의존성 주입(DI)은 이 원칙을 따르는 방법 중 하나 입니다.

새로운 할인 정책을 개발하고, 적용하려고 하니 클라이언트 코드도 함께 변경해야 했습니다. 이유는 클라이언트는 추상화 인터페이스에만 의존하는 것 같았지만, 구체화 구현 클래스도 함꼐 의존했기 떄문이였습니다.
클라이언트 코드가 추상화 인터페이스에만 의존하도록 할 필요가 있었습니다.
하지만 클라이언트 코드는 인터페이스만으로는 아무것도 실행할 수 없었습니다.(구현체를 넣지 못했기 떄문)
이를 해결하기 위해 AppConfig를 만들어주었고, 구현 객체 인스턴스를 클라이언트 코드 대신 생성해서 클라이언트 코드에 의존관계를 주입하는 방식으로 해결했습니다. 이에따라 DIP 원칙을 따르게 할 수 있었습니다.

OCP - 개방폐쇄 원칙

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

다형성 사용하고 클라이언트가 DIP를 지킵니다.
애플리케이션을 사용 영역과 구성영역으로 나누어주었습니다.
AppConfig가 의존관계를 변경해서 클라이언트 코드에 주입하기 때문에 클라이언트 코드는 변경하지 않아도 됩니다.

출처

스프링 핵심 원리 - 기본편 - 인프런 | 강의

스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., - 강의 소개 | 인프런...

www.inflearn.com

'spring > 인프런 강의 정리' 카테고리의 다른 글

[Spring/기본편] 6. 의존관계 자동 주입 (0)	2021.12.25
[Spring/기본편] 5. 컴포넌트 스캔 (0)	2021.12.24
[Spring/기본편] 4. 싱글톤 컨테이너 (0)	2021.12.23
[Spring/기본편] 3. 순수한 자바 프로젝트를 Spring으로 변경(Bean) (0)	2021.12.22
[Spring/기본편] 1. 객체 지향 프로그래밍 및 스프링 개념 정리 (0)	2021.12.19

선장 일지