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

해당 카테고리는 인프런에 있는 김영한님의 '스프링 핵심 원리 - 기본편' 강의를 듣고 내용을 정리하기 위한 것으로 더 자세한 내용은 강의를 통해 확인할 수 있습니다.

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

---

📝 비즈니스 요구사항 설계

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

 

요구사항을 보면 회원 데이터, 할인 정책 같은 부분은 지금 결정하기 어려운 부분이다. 그렇다고 이런 정책이 결정될 때까지 개발을 무기한 기다릴 수도 없다. 따라서 우리는 앞에서 배운 객체 지향 설계 방법을 통해 인터페이스를 만들고 구현체를 언제든지 갈아 끼울 수 있도록 설계하면 된다.

 

참고 : 프로젝트 환경설정을 편리하게 하기 위해서 스프링 부트를 사용한 것이다. 지금은 스프링 없는 순수한 자바로만 진행한다는 점을 꼭 기억하자! 스프링 관련은 한참 뒤에 등장한다.

---

📝 회원 도메인 설계

• 회원 도메인 요구사항
  • 회원을 가입하고 조회할 수 있다.
  • 회원은 일반과 VIP 두 가지 등급이 있다.
  • 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있다. (미확정)

 

우리는 현재 회원 데이터의 저장 방식을 확정하지 못한 상태이므로 회원 저장소의 역할을 메모리 회원 저장소, DB 회원 저장소, 외부 시스템 연동 회원 저장소로 나누어 구현할 것이다. (역할과 구현)

 

즉, 이후에 데이터 저장 방식이 확정되면 그때 저장 방식에 따라 구현하고 갈아끼워 주는 방식으로 설계한 것이다.

 

회원 도메인 협력 관계

 

위 그림은 회원 도메인에 대한 큰 그림을 그린 것이었고, 실제 구현 레벨로 내려오면 아래와 같은 클래스 다이어그램이 그려지게 된다.

 

회원 클래스 다이어그램

 

우선 회원 서비스, 즉 MemberService라는 '역할'을 인터페이스로 만들고, 그것에 대한 구현체로 MemberServiceImpl 클래스를 만들었다. 또한 회원 저장소, 즉 MemberRepository라는 '역할'을 인터페이스로 만들고, 그것에 대한 구현체로 MemberMemoryRepository와 DbMemberRepository 클래스를 만들었다.

 

참고 : MemberServiceImpl에서 Impl은 구현하다(implement)의 뜻으로 주로 인터페이스를 구현하는 구현 클래스가 하나일 경우에 붙여주는 구문이다.

 

 

회원 객체 다이어그램

 

다음으로 회원 객체 다이어그램은 객체 간의 메모리 참조 관계를 나타내고 있다. 즉, 클라이언트는 회원 서비스를 바라보고 회원 서비스는 메모리 회원 저장소를 바라보게 된다.

---

📝 회원 도메인 개발

우선 Member라는 이름의 패키지를 하나 생성하고 해당 패키지 안에 등급을 설정하기 위한 Enum 타입의 Grade를 생성해준다.

 

위에서 작성한 요구사항을 살펴보면 회원 등급에는 BASIC과 VIP 총 두 가지 등급이 있는 것을 확인할 수 있다.

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

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

 

참고 : IntelliJ의 경우 생성자 또는 Getter, Setter를 구현할 때, Windows는 단축키 Alt + Ins 키를 활용하여 간편하게 생성할 수 있다.

 

다음으로는 회원 저장소의 역할을 정의하기 위한 MemberRepository 인터페이스를 만들고, 아래와 같이 구현한다.

package hello.core.member;

public interface MemberRepository {
    void save(Member member);
    Member findById(Long memberId);
}

 

이후 위 인터페이스를 구현하는 구현 클래스로 MemoryMemberRepository 클래스를 생성하여 아래와 같이 구현한다.

package hello.core.member;

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

 

참고 : 위에서 HashMap으로 생성한 store의 경우 일반적으로는 동시성 이슈를 방지하기 위해서 ConcurrentHashMap으로 생성하는 것이 바람직하나 여기서는 예제를 최대한 단순화하기 위해서 HashMap을 사용하였다.

 

다음으로 회원 서비스의 역할을 정의하기 위한 MemberService 인터페이스를 만들고 아래와 같이 구현한다.

package hello.core.member;

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

 

이후 위 인터페이스를 구현하는 구현 클래스로 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);
    }
}

---

📝 회원 도메인 실행과 테스트

위에서 작성한 내용을 간단히 테스트 해보기 위해 MemberApp 클래스를 생성하여 아래와 같이 구현한다.

package hello.core;

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

 

이후 실행해보면 다음과 같은 결과가 나타나는 것을 확인할 수 있다.

 

Result

 

다만 위처럼 메인 메서드로 로직을 테스트하는 데에는 한계가 있다. 따라서 우리는 'JUnit'이라는 테스트 프레임워크를 사용할 것이다.

 

기본적으로 세팅은 다 되어있으며 test 폴더 안에 패키지를 생성한 뒤 테스트를 위한 클래스를 생성하고 아래와 같이 구현해주면 된다.

package hello.core.member;

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

 

위와 같은 테스트 방법은 현대적인 어플리케이션 개발을 위해서는 선택이 아닌 필수적인 요소이다.

---

📝 회원 도메인 설계의 문제점

위 코드들의 설계상 문제점은 무엇일까?

• 다른 저장소로 변경할 때 OCP 원칙을 잘 준수할까?
• DIP를 잘 지키고 있을까?

 

위 코드들은 의존 관계가 인터페이스 뿐만 아니라 구현까지 모두 의존하는 문제점이 있다.

private final MemberRepository memberRepository = new MemoryMemberRepository();

 

이 부분은 주문 도메인까지 만들고 나서 문제점과 해결 방안을 설명하도록 한다.

---

📝 주문과 할인 도메인 설계

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

 

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

 

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

참고 : 실제로는 상품 객체를 따로 만들어 해당 객체를 통해 상품 데이터를 전달하고, 주문 데이터는 DB에 저장하겠지만, 예제가 너무 복잡해 질 수 있어서 생략하고, 상품 데이터는 단순히 데이터만 전달하고 주문 데이터는 단순히 주문 결과를 반환하는 것으로 한다.

 

 

주문 도메인 전체

 

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

 

 

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

 

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

 

회원을 메모리에서 조회하고, 정액 할인 정책(고정 금액)을 지원해도 주문 서비스를 변경하지 않아도 된다. 즉, 역할들의 협력 관계를 그대로 재사용 할 수 있다.

 

 

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

 

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

---

📝 주문과 할인 도메인 개발

우선 할인 정책의 역할을 정의하기 위해 새로운 패키지와 함께 DiscountPolicy 인터페이스를 아래와 같이 생성한다.

package hello.core.discount;

public interface DiscountPolicy {

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

 

이후 위 인터페이스를 구현하는 구현 클래스 FixDiscountPolicy 클래스(고정 금액 할인)를 생성한 뒤 아래와 같이 구현한다.

package hello.core.discount;

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

 

이제 주문 정보를 담기 위한 주문 객체 클래스를 아래와 같이 생성한다.

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

    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 +
                '}';
    }
}

 

다음으로 새로운 패키지와 함께 주문 서비스의 역할을 정의하기 위한 OrderService 인터페이스를 아래와 같이 생성한다.

package hello.core.order;

public interface OrderService {
    Order createOrder(Long memberId, String itemName, int itemPrice);
}

 

이후 위 인터페이스를 구현하는 구현 클래스 OrderServiceImpl 클래스를 생성하고 아래와 같이 구현한다.

package hello.core.order;

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

---

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

주문과 할인 도메인을 실행하고 테스트해보자.

 

먼저 메인 메소드를 통해 테스트 해보기 위해 위에서 했던 것과 마찬가지로 OrderApp 클래스를 생성하여 아래와 같이 구현해준다.

package hello.core;

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

 

실행 결과는 다음과 같다.

 

Result

 

 

이번에는 JUnit 프레임워크를 사용하여 테스트해보자.

 

우선 test 폴더에 Order 패키지를 새로 생성하고 해당 패키지에 테스트를 위한 OrderServiceTest 클래스를 생성하여 아래와 같이 구현한다.

package hello.core.order;

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

 

실행 결과를 통해 테스트가 잘 진행된 것을 확인할 수 있다.

 

Result