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

[6om1n]

프로젝트 생성

• 스프링 부트 스타터 사이트로 이동해서 스프링 프로젝트 생성
  • http://start.spring.io

• Project Metadata

  • groupId : hello
  • artifactId : core

• 스프링 부트 3.0 이상, JDK는 17 이상 사용하기

• CoreApplication.main() 을 실행하여 동작 확인

• Build and run using, Build tests using 을 Gradle로 설정
• Gradle JVM을 새로 설치한 자바 17로 변경

---

비즈니스 요구사항과 설계

• 회원

  • 회원은 가입하고 조회할 수 있다.
  • 회원은 일반과 VIP 두 가지 등급이 있다.
  • 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있다.

• 주문과 할인 정책

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

• 아직 결정되지 않은 부분들이 많지만 인터페이스를 만들고 구현체를 갈아끼울 수 있도록 설계를 하여 문제점을 해결하자 !

---

회원 도메인 설계

• 회원 도메인 요구사항

  • 회원을 가입하고 조회할 수 있다.
  • 회원은 일반과 VIP 두 가지 등급이 있다.
  • 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있다.

• 회원 도메인 협력 관계

• 클라이언트 역할, 회원 서비스 역할, 회원 저장소 역할
• 클라이언트가 회원 서비스를 호출한다.
• 회원 서비스에는 회원가입과 회원조회 기능이 있다.
• 회원 저장소라는 회원 데이터에 접근할 수 있는 계층을 따로 만든다.
• 회원 저장소는 인터페이스로 만들며 회원 저장소 역할의 구현은 메모리 회원 저장소 , DB 회원 저장소 , 외부 시스템 연동 회원 저장소 이렇게 세 가지로 한다.
• 메모리 회원 저장소는 서버를 껐다 키면 데이터가 사라지기 때문에 개발용으로만 사용하고, DB나 외부 저장소가 선택이 되면 그 때 정보를 옮긴다.

• 회원 클래스 다이어그램

• 회원 서비스 정보를 구현하는 MemberService 인터페이스와 MemberServiceImpl 구현체
• 회원 저장소를 구현하는 MemberRepository 인터페이스와 MemoryMemberRepository , DbMemberRepository 구현체
  - 외부 시스템 연동 서비스를 추가할 수도 있다.
• 클래스 다이어그램은 실제 서버를 실행하지 않고도 클래스만 분석해서 볼 수 있는 정적인 다이어그램이다.

• 회원 객체 다이어그램

• 객체 다이어그램이란 실제 유효한 인스턴스끼리의 참조를 나타낸 동적 다이어그램이다.
• 즉, 실제 객체 간의 참조가 어떻게 되는 지를 그린 그림이다.

---

회원 도메인 개발

회원 엔티티

• 회원 등급 member/Grade

package hello.core.member;

public enum Grade {
    BASIC,
    VIP
}

• 회원 엔티티 member/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;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Grade getGrade() {
        return grade;
    }

    public void setGrade(Grade grade) {
        this.grade = grade;
    }
}

회원 저장소

• 회원 저장소 인터페이스 member/MemberRepository

package hello.core.member;

public interface MemberRepository {
    void save(Member member);

    Member findById(Long memberId);
}

• 메모리 회원 저장소 구현체 member/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);
    }
}

• DB가 아직 확정이 안된 상태에서는 가장 단순한 메모리 회원 저장소를 구현
• HashMap 은 동시성 이슈가 발생할 수 있기에 ConcurrentHashMap 을 이용하는 것이 좋다.

회원 서비스

• 회원 서비스 인터페이스 member/MemberService

package hello.core.member;

public interface MemberService {
    void join(Member member);

    Member findMember(Long memberId);
}

• 회원 서비스 구현체 member/MemberServiceImpl

package hello.core.member;

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository = new MemoryMemberRepository();
    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

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

• 구현체가 하나만 있을 때는 인터페이스명 뒤에 Impl 라고 관례상 많이 사용한다.
• MemberServiceImpl join 에서 호출을 하면 다형성에 의해서 MemoryMemberRepository 에 있는 save 가 호출이 된다. -> 즉, 오버라이드 한 것이 호출된다.
• 실제 할당하고 있는 부분이 구현체를 의존하고 있다. 추상화에도 의존하고 구체화에도 의존하고 있기에 DIP를 위반하고 있다.

---

회원 도메인 실행과 테스트

• 회원 도메인 - 회원 가입 main

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

• long 타입이기에 1L 이렇게 작성해야한다.
• 매번 애플리케이션 로직으로 테스트하는 것은 좋은 방법이 아니기에 JUnit 테스트 프레임워크를 사용한다.

• 회원 도메인 - 회원 가입 테스트

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

• 실행 결과

• 회원 도메인 설계의 문제점
• 의존 관계가 인터페이스 뿐만 아니라 구현까지 모두 의존하는 문제점이 있다.

---

주문과 할인 도메인 설계

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

1. 주문 생성 : 클라이언트는 주문 서비스에 주문 생성을 요청한다.
2. 회원 조회 : 할인을 위해서는 회원 등급이 필요하다. 그래서 주문 서비스는 회원 저장소에 회원을 조회한다.
3. 할인 적용 : 주문 서비스는 회원 등급에 따른 할인 여부를 할인 정책에 위임한다.
4. 주문 결과 반환 : 주문 서비스는 할인 결과를 포함한 주문 결과를 반환한다.

• 참고 ! 실제로는 주문 데이터를 DB에 저장하지만, 복잡한 예제를 막기 위해 단순히 주문 결과를 반환한다.

• 주문 도메인 전체

• 역할과 구현을 분리해서 자유롭게 구현 객체를 조립할 수 있도록 설계가 되었다.
• 위와 같은 설계로 인해 회원 저장소는 물론이고, 할인 정책도 유연하게 변경할 수 있다.

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

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

• 클라이언트가 주문 서비스 구현체를 호출하고 메모리 회원 저장소를 호출한다.
• 할인 정책은 FixDiscountPolicy 인 정액 할인 정책이다.
• 회원을 메모리에서 조회하고, 정액 할인 정책을 지원해도 주문 서비스를 변경하지 않아도 된다.
• 즉, 역할들의 협력 관계를 그대로 재사용 할 수 있다.

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

• 회원을 메모리가 아닌 실제 DB에서 조회하고, 정률 할인 정책을 지원해도 주문 서비스를 변경하지 않아도 된다.
• 협력 관계를 그대로 재사용할 수 있다.

---

주문과 할인 도메인 개발

• 할인 정책 인터페이스 main/discount/DiscountPolicy

package hello.core.discount;
import hello.core.member.Member;
public interface DiscountPolicy {
    /**
     *
     @return 할인 대상 금액
     */
    int discount(Member member, int price);
}

• 정액 할인 정책 구현체 main/discount/FixDiscountPolicy

package hello.core.discount;

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

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

}

• VIP면 1000원 할인, VIP가 아니면 할인 없다.

• 주문 엔티티 main/order/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 calculaterPrice() {
        return itemPrice - discountPrice;
    }

    public Long getMemberId() {
        return memberId;
    }

    public void setMemberId(Long memberId) {
        this.memberId = memberId;
    }

    public String getItemName() {
        return itemName;
    }

    public void setItemName(String itemName) {
        this.itemName = itemName;
    }

    public int getItemPrice() {
        return itemPrice;
    }

    public void setItemPrice(int itemPrice) {
        this.itemPrice = itemPrice;
    }

    public int getDiscountPrice() {
        return discountPrice;
    }

    public void setDiscountPrice(int discountPrice) {
        this.discountPrice = discountPrice;
    }

    @Override
    public String toString() {
        return "Order{" +
                "memberId=" + memberId +
                ", itemName='" + itemName + '\'' +
                ", itemPrice=" + itemPrice +
                ", discountPrice=" + discountPrice +
                '}';
    }
}

• 주문 서비스 인터페이스 main/order/OrderService

package hello.core.order;
public interface OrderService {
    Order createOrder(Long memberId, String itemName, int itemPrice);
}

• 주문 서비스 구현체 main/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 {

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

• 주문 생성 요청이 오면, 회원 정보를 조회하고, 할인 정책을 적용한 다음 주문 객체를 생성해서 반환한다.
• 메모리 회원 리포지토리 와 고정 금액 할인 정책 을 구현체로 생성한다.

---

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

• 주문과 할인 정책 실행 main/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);
    }
}

• 실행 결과

• 할인 금액이 잘 출력되는 것을 확인할 수 있다.
• 애플리케이션 로직으로 이렇게 테스트 하는 것은 좋은 방법은 아니다. 따라서 JUnit 테스트 프레임워크를 사용하는 것이 좋다.

• 주문과 할인 정책 테스트 test/order/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;
import static org.junit.jupiter.api.Assertions.*;
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);
    }
}