[스프링 핵심 원리 - 기본편] #2. 스프링 핵심 원리 이해1 - 예제 만들기

[seyxxn]

2_스프링 핵심 원리 이해1 - 예제 만들기

프로젝트 생성

• 스프링의 도움 없이 순수한 자바로만 설계할 예정

• 순수한 자바로만 개발을 진행했을 때 유연하게 변경이 가능한지 살펴볼 예정

• 기본 셋팅 후 프로젝트 생성 완료
  

비즈니스 요구사항 설계

• 회원, 주문, 할인 정책 (3가지 요구사항을 바탕으로 설계 예정)

• 회원

  • 회원을 가입, 조회할 수 있음
  • 회원은 일반회원과 VIP회원 2가지 등급이 존재
  • 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있음 (미정)

• 주문과 할인 정책

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

회원 도메인 설계

회원 도메인 협력 관계

• 주어진 회원 도메인 요구사항에 따라 가장 크게 그림을 그려본 구조
• 클라이언트의 역할을 하는 인터페이스가 존재하고, 회원과 관련된 서비스는 회원가입과 회원조회가 존재한다.
• 그리고 이 회원을 저장해줄 회원 저장소가 존재해야 한다. 회원 데이터를 어떻게 보관할 지는 아직 미정이기에 유동적으로 갈아끼울 수 있도록 구현해야 한다. (위 그림에서는 메모리에 저장할 수도, DB에 저장할 수도, 외부 저장소와 연동할 수도 있다는 것을 나타냄)

회원 클래스 다이어그램

• 위의 그림을 실제 파일로 표현한 그림이다.
• 서비스와 관련한 인터페이스 역할을 하는 MemberService가 존재하며, 이 인터페이스를 구현한 MemberServiceImpl 파일이 존재한다.
• 회원 저장소와 관련한 인터페이스 역할을 하는 MemberRepository가 존재하며, 이 인터페이스를 구현한 파일이 존재하는데 이때 저장소와 관련한 사항은 미정이기 때문에 MemoryMemberRepository를 구현할 수도 있고 DbMemberRepository로 구현할 수도 있다.
• MemberService에서는 회원에 대한 정보가 필요하기 때문에 MemberRepository를 의존하고 있다.

회원 객체 다이어그램

• 실제 구현체의 의존 관계를 나타낸 그림이다.
• 서버가 실제로 떠서, 클라이언트가 실제로 사용하는 인스턴스끼리의 참조를 뜻한다.
• 클라이언트는 회원 서비스를 의존하고 있고, 회원서비스는 메모리 회원 저장소를 의존하고 있다.

회원 도메인 개발

• 프로젝트 구성
  

• 회원 등급을 위한 Grade Enum 파일 생성

package hello.core.member;

public enum Grade {
    BASIC,
    VIP
}

• 회원 엔티티 정의를 위한 Member 클래스 파일 생성

package hello.core.member;

public class Member {
    private Long id;
    private String name;
    private Grade grade;

    public Member(Long id, String name, Grade grade) {
        this.id = id;
        this.name = name;
        this.grade = grade;
    }

    // get, set 함수 생략 ...
}

회원 저장소와 관련된 파일

• 회원 저장소 인터페이스 정의를 위한 MemberRepository 인터페이스 파일 생성

package hello.core.member;

public interface MemberRepository {
    void save(Member member);

    Member findById(Long memberId);
}

• 회원 저장소 구현체 정의를 위한 MemoryMemberRepository 클래스 파일 생성
  • 아직 database가 확정이 안되었기 때문에 MemoryMemberRepository로 생성

package hello.core.member;

import java.util.HashMap;
import java.util.Map;

public class MemoryMemberRepository implements MemberRepository{
    private static Map<Long, Member> store = new HashMap<>();

    @Override
    public void save(Member member) {
        store.put(member.getId(), member);
    }

    @Override
    public Member findById(Long memberId) {
        return store.get(memberId);
    }
}

회원 서비스와 관련된 파일

• 회원 서비스 인터페이스 정의를 위한 MemberService 인터페이스 파일 생성

package hello.core.member;

public interface MemberService {
    void join(Member member);
    Member findMember(Long memberId);
}

• 회원 서비스 구현체 정의를 위한 MemberServiceImpl 클래스 파일 생성
  • 참고) 인터페이스에 대한 구현체가 딱 하나만 존재한다면 보통 뒤에 Impl을 붙여 구현체 파일 이름을 정한다.

package hello.core.member;

public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository = new MemoryMemberRepository();
    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }
//  join에서 save를 호출하면 다형성에 의해서 인터페이스가 아니라 
//  MemoryMemberRepository에 있는 save가 호출이 된다. (오버라이드한 것이 호출된다.)

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

회원 도메인 실행과 테스트

• MemberApp 파일을 생성하여 테스트하는 방법

package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;

public class MemberApp {
    public static void main(String[] args) {
        MemberService memberService = new MemberServiceImpl();
        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());
    }
}

• 이렇게 애플리케이션 로직으로 메인 메소드로 테스트 하는 것은 좋지 않은 방법이기 때문에 JUnit이라는 테스트 프레임워크를 사용

• test폴더에서 MemberServiceTest파일을 생성하여 테스트 진행

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

회원 도메인 설계의 문제점

public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository = new MemoryMemberRepository();
    // 생략 ...
}

• MemberServiceImpl에서 보면 MemoryRepository 인터페이스를 분명히 의존하고 있다.
• 그런데 실제 할당하는 부분이 MemoryMemberRepository구현체를 의존하고 있다.
• 즉, MemberServiceImpl은 MemoryRepository도 의존하고 MemoryMemberRepository도 의존하고 있다. (추상화에도 의존하고 구체화에도 의존하고 있다.)
• DIP를 위반하고 있음

주문과 할인 도메인 설계

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

• 주문과 관련하여 주어진 설계 사항에 따라 그림을 그려보면 위 그림과 같다.
  1. 주문 생성 : 클라이언트는 주문 서비스에 주문 생성을 요청
  2. 회원 조회 : 할인을 위해서는 회원 등급이 필요하기에 주문 서비스는 회원 저장소에서 회원을 조회해야 함
  3. 할인 적용 : 주문 서비스는 회원 등급에 따른 할인 여부를 할인 정책에 위임
  4. 주문 결과 반환 : 주문 서비스는 할인 결과를 포함한 주문 결과를 반환

주문 도메인 전체

• 구현체까지 나타낸 그림이다.
• 역할과 구현을 분리해서 자유롭게 구현 객체를 조립할 수 있게 했다.
• 회원 저장소는 메모리나 DB 등을 구현하여 자유롭게 이용할 수 있고, 할인 정책 같은 경우도 역할을 하는 인터페이스만 제대로 구현해놓는다면 구현체로는 필요한 정책을 가져다가 사용 할 수 있다. 이떄 그림에서는 아직 미정인 할인 정책으로 정액 할인 정책과 정률 할인 정책 구현체를 나타내었다.

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

• 위에서 설명한 내용을 바탕으로 실제 파일들로 나타낸 그림이다.

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

• 실제 구현체들이 의존하는 협력 관계를 나타낸 그림이다.
• 회원을 메모리에서 조회하고, 정액 할인 정책(고정 금액)을 지원해도 주문 서비스는 변경하지 않아도 된다. 역할들의 협력 관계를 그대로 재사용할 수 있다.

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

• 또 다른 방식으로 구현체들을 나타낸 그림이다.
• 회원을 메모리가 아닌 실제 DB에서 조회하고, 정률 할인 정책(주문 금액에 따라 % 할인)을 지원해도 주문 서비스를 변경하지 않아도 된다. 협력 관계를 그대로 재사용할 수 있다.

주문과 할인 도메인 개발

• 할인 정책을 위한 인터페이스 역할로 DiscountPolicy 파일을 생성

package hello.core.discount;

import hello.core.member.Member;

public interface DiscountPolicy {
    /*
    * @return 할인 대상 금액 (얼마나 할인되는지 금액을 반환)
    * */
    int discount(Member member, int price);
}

• 구현체의 역할을 하는 FixDiscountPolicy 파일을 생성

package hello.core.discount;

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

public class FixDiscountPolicy implements DiscountPolicy{
    private int discountFixAmout = 1000; // 1000원 할인
    @Override
    public int discount(Member member, int price) {
        if (member.getGrade() == Grade.VIP){
            return discountFixAmout;
        } else {
            return 0;
        }
    }
}

• 주문 엔티티 생성을 위한 Order 파일

package hello.core.order;

public class Order {
    private Long memberId;
    private String itemName;
    private int itemPrice;
    private int discountPrice;

    // 주문하고 할인이 모두 다 끝났을 때 결과적으로 만들어지는 객체
    public Order(Long memberId, String itemName, int itemPrice, int discountPrice) {
        this.memberId = memberId;
        this.itemName = itemName;
        this.itemPrice = itemPrice;
        this.discountPrice = discountPrice;
    }

    // 계산로직 추가
    public int calculatePrice(){
        return itemPrice - discountPrice;
    }

    // getter, setter, toString 함수들 생략 ...
}

• 주문 서비스를 위한 인터페이스 OrderService 파일

package hello.core.order;

public interface OrderService {
    Order createOrder(Long memberId, String itemName, int itemPrice);
    // 회원Id, 아이템이름, 아이템금액을 넘겨주면 Order(최종 오더 결과)를 반환한다.
}

• 주문 서비스 구현을 위한 OrderServiceImpl 파일

package hello.core.order;

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

public class OrderServiceImpl implements OrderService{
    // 2가지가 필요
    private final MemberRepository memberRepository = new MemoryMemberRepository(); // 회원 찾기
    private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); // 할인 정책
    @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);
        // 이렇게 주문을 만들어서 반환해주기만 하면 오더서비스의 역할은 끝난다.
    }
}

주문과 할인 도메인 실행과 테스트

• OrderApp 파일을 생성하여 테스트 하는 방법

package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.order.Order;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;

public class OrderApp {
    public static void main(String[] args) {
        MemberService memberService = new MemberServiceImpl();
        OrderService orderService = new OrderServiceImpl();

        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);
        System.out.println("order.calculatePrice = " + order.calculatePrice());

    }
}

• 이렇게 애플리케이션 로직으로 메인 메소드로 테스트 하는 것은 좋지 않은 방법이기 때문에 JUnit이라는 테스트 프레임워크를 사용

• test폴더에서 orderServiceTest파일을 생성하여 테스트 진행

package hello.core.order;

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

public class OrderServiceTest {
    MemberService memberService = new MemberServiceImpl();
    OrderService orderService = new OrderServiceImpl();

    @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);

    }
}

[YuDeokRin]

역....시 크으.... 미리미리 ..정리도 깔끔