2023-11-06-TIL | Spring

이번 노트부터는 Spring core만을 사용하여(즉, 순수 자바만을 이용하여) 프로젝트를 만들어 갈 것이다.

SpringBoot 설정은 아래와 같이 어떠한 Dependencies도 들어가지 않는다.

만약 스프링 부트 3.0을 선택하려면, 1. Java 17 이상을 사용해야 한다. 2. 오라클과 자바 라이센스 문제로 모든 javax 패키지 이름을 jakarta로 변경해야 한다.

---

비즈니스 요구사항<회원>과 설계

요구사항

회원

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

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

설계

설계는 크게 세 가지로 그려진다.

회원 도메인 협력 관계

협력 관계 다이어그램은 기획자들도 참고할 수 있다.

클라이언트가 서비스를 호출하고, 서비스가 리포지토리를 호출한다.

서비스의 역할은 회원가입과 회원조회이고, 회원 저장소는 회원 데이터를 저장하는데, 회원의 요구사항에 따르면 회원 데이터는 자체 DB를 구축할 수도 있고, 나중에 외부 시스템과 연동할 수도 있는 등 미확정 상태이므로, 회원 저장소 계층을 인터페이스와 구현으로 나누어야 한다. 또한, 아직은 확정된 DB가 없는데 당장의 개발을 위해서는 DB를 구현해야 하므로 [메모리 회원 저장소]를 구현하고 나중에 구현체를 갈아끼우는 식으로 진행한다.

회원 도메인 클래스 다이어그램

협력 관계 다이어그램을 구체화하여 개발자가 클래스 다이어그램을 그려낸다.

클래스 다이어그램은 실제 서버에 실행시킨 상황을 가정하지 않은 개념적인 다이어그램이다. MemberRepository로 MemoryMemberRepository를 쓸지, DbMemberRepository를 쓸지는 런타임 때 동적으로 결정되는 부분이다. 즉 이 부분은 클래스 다이어그램만으로는 판단하기 어렵다.

도메인 설계에 따라 실제 구현을 위한 클래스 다이어그램을 그린다.

MemberService도 인터페이스로 두고, MemberRepository도 인터페이스로 둔다.

회원 객체 다이어그램

객체 다이어그램은 서버가 실제로 실행 중일 때, 객체가 실제로 사용하는 객체가 무엇인지를 파악할 수 있게 한다. 즉, 실제 new에 의해 메모리에 올라가게 된 인스턴스들끼리의 참조를 나타낸다.

즉 클라이언트 객체가 서비스 객체를 참조하고, 서비스 객체가 리포지토리 객체를 참조하는 상황을 나타낸다.

개발

개발은 회원 도메인 클래스 다이어그램을 기반으로 한다.

참고로, 김영한님만의 스타일인지는 모르겠지만 보통 도메인과 리포지토리를 먼저 만드는 경향이 있다.

enum

package hello.core.member;

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/member/Grade.java
public enum Grade {
    BASIC,
    VIP
}

요구사항: 회원은 일반과 VIP 두 가지 등급이 있다.

도메인

package hello.core.member;

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/member/Member.java
public class Member {
    private int id;
    private String name;
    private Grade grade;

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

    public int getId() {
        return id;
    }

    public void setId(int 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;
    }
}

데이터베이스 요구사항은 정해지지 않은 상태지만, 멤버 도메인 객체는 일단은 위와 같이 한다.

기본적으로 멤버 변수와 생성자, Getter, Setter를 가진다는 점에서는 대동소이하다.

리포지토리

• 인터페이스

package hello.core.member;

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/member/MemberRepository.java
public interface MemberRepository {
    void save(Member member);
    Member findById(Long id);
}

이제 리포지토리 인터페이스를 만든다.

• 구현체

package hello.core.member;

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

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/member/MemoryMemberRepository.java
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 id) {
        return store.get(id);
    }
}

리포지토리 인터페이스의 구현체로 인메모리 데이터베이스 방식을 구현한다.

위 코드는 예외처리도 안되어 있고, 동시성 이슈를 컨트롤할 수 없는 자료구조를 사용하고 있다는 문제가 있지만 예제라서 일단은 넘어간다.

단, static을 반드시 빼먹어서는 안 된다.

서비스

• 인터페이스

package hello.core.member;

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/member/MemberService.java
public interface MemberService {
    void join(Member member);
    Member findMember(Long id);
}

이제 서비스 인터페이스를 만든다. 서비스는 회원을 가입하고 조회할 수 있다. 라는 요구사항을 만족해야 한다.

• 구현체

package hello.core.member;

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/member/MemberServiceImplementation.java
public class MemberServiceImplementation implements MemberService{
    private final MemberRepository memberRepository = new MemoryMemberRepository();
    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

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

서비스 인터페이스를 구현하는 구현체를 만든다. 이 구현체는 리포지토리와 상호작용해야 하기 때문에 리포지토리를 만들어준다. 단, 위 방식은 생성자 주입 방식이 아닌 강한 결합 방식을 사용하는 것이다.

실행(테스트)

• main으로 테스트

package hello.core;

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

// /Users/dohk/Dropbox/Spring/project/core/src/main/java/hello/core/MemberApp.java
public class MemberApp {
    public static void main(String[] args) {
        MemberService memberService = new MemberServiceImplementation();
        Member tedd = new Member(1L, "TEDD", Grade.VIP);
        
        memberService.join(tedd);
        Member foundMember = memberService.findMember(tedd.getId());
        System.out.println("tedd = " + tedd.getName());
        System.out.println("foundMember = " + foundMember.getName());
    }
}

// tedd = TEDD
// foundMember = TEDD

순수 자바로 개발하여 테스트한 결과다.

• 테스트 코드로 테스트

package hello.core.member;

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

import static org.junit.jupiter.api.Assertions.*;

// /Users/dohk/Dropbox/Spring/project/core/src/test/java/hello/core/member/MemberServiceImplementationTest.java
class MemberServiceImplementationTest {
    MemberService memberService = new MemberServiceImplementation();

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

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

        // then
        Assertions.assertThat(tedd).isEqualTo(member);
    }
}

---

비즈니 요구사항<주문/할인>과 설계

요구사항

주문과 할인 정책

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

설계

주문/할인 도메인 협력 관계

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

실제로는 주문 데이터를 DB에 저장하겠지만, 예제가 너무 복잡해 질 수 있어서 생략하고, 단순히 주문 결과 를 반환한다.

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

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

주문/할인 객체 다이어그램

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

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

개발

package hello.core.discount;

import hello.core.member.Member;

// /Users/dohyung/Dropbox/Spring/project/core/src/main/java/hello/core/discount/DiscountPolicy.java
public interface DiscountPolicy {
    int discount(Member member, int price);
}

할인 정책을 적용하기 위한 인터페이스를 만든다. 그리고 이 인터페이스에 대한 여러 정책들이 구현체가 된다.

package hello.core.discount;

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

// /Users/dohyung/Dropbox/Spring/project/core/src/main/java/hello/core/discount/FixDiscountPolicy.java
public class FixDiscountPolicy implements DiscountPolicy{
    private int discountFixAmount = 1000;
    @Override
    public int discount(Member member, int price) {
        if (member.getGrade() == Grade.VIP) {
            return 1000;
        } else {
            return 0;
        }
    }
}

고정 할인 금액 정책을 구현하는 구현체다. 참고로, ENUM에는 ==을 써서 비교하는 것이 맞다.

package hello.core.order;

// /Users/dohyung/Dropbox/Spring/project/core/src/main/java/hello/core/order/Order.java
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 +
                '}';
    }
}

주문 도메인 객체를 만든다. 이 객체에는 멤버 변수와 생성자, Getter, Setter 외에 toString과 calculatePrice를 만든다.

package hello.core.order;

// /Users/dohyung/Dropbox/Spring/project/core/src/main/java/hello/core/order/OrderService.java
public interface OrderService {
    Order createOrder(Long memberId, String itemName, int itemPrice);
}

주문을 처리하기 위한 비즈니스 로직 인터페이스를 만든다.

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;

// /Users/dohyung/Dropbox/Spring/project/core/src/main/java/hello/core/order/OrderServiceImplementation.java
public class OrderServiceImplementation 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);
    }
}

주문을 처리하기 위한 인터페이스를 구현하는 구현체를 만든다. 이 구현체에서는 요구사항(Untitled)에 따라 회원의 id와 물건 이름, 물건 가격을 받아서 할인 금액까지 적용된 최종 금액을 가진 주문 객체를 만들어 반환해주는 discount 메서드를 구현한다. 회원의 정보가 필요하므로 MemberRepository가 필요하고, 할인 정책이 적용된 금액이 필요하므로 DiscountPolicy가 필요하다. 이 각각의 인터페이스들은 각각 MemoryMemberRepository와 FixDiscountPolicy라는 구현체들에도 의존하는 설계이다.

discountPolocy.discount(…)에서 member와 itemPrice만을 넘기면 최종 할인 적용 금액을 알아서 얻게 되고, 할인 정책의 변화가 생기더라도 서비스 객체에는 수정이 필요하지 않게 된다.

package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImplementation;
import hello.core.order.Order;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImplementation;

// /Users/dohyung/Dropbox/Spring/project/core/src/main/java/hello/core/OrderApp.java
public class OrderApp {
    public static void main(String[] args) {
        MemberService memberService = new MemberServiceImplementation();
        OrderService orderService = new OrderServiceImplementation();
        
        Long memberId = 1L;
        Member tedd = new Member(memberId, "TEDD", Grade.VIP);
        memberService.join(tedd);

        Order order = orderService.createOrder(memberId, "IPhone 15 Pro", 1500000);
        System.out.println("order = " + order);
        System.out.println("order.calculatePrice() = " + order.calculatePrice());
    }
}
//order = Order{memberId=1, itemName='IPhone 15 Pro', itemPrice=1500000, discountPrice=1000}
//order.calculatePrice() = 1499000

이제 실행단계다.

최상단에서는 Repository와 직접적으로 소통하지 않으며, Service와 소통하는 것을 볼 수 있다.

또한, soutv에서 toString을 오버라이딩 했기 때문에, order를 출력해도 order.toString()의 결과가 나온다.

package hello.core.order;

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

import static org.junit.jupiter.api.Assertions.*;

// /Users/dohyung/Dropbox/Spring/project/core/src/test/java/hello/core/order/OrderServiceImplementationTest.java
class OrderServiceImplementationTest {
    MemberService memberService = new MemberServiceImplementation();
    OrderService orderService = new OrderServiceImplementation();

    @Test
    void createOrder() {
        Long memberId = 1L;
        Member member = new Member(memberId, "TEDD", Grade.VIP);
        memberService.join(member);

        Order order = orderService.createOrder(memberId, "IPhone 15 Pro", 1500000);

        Assertions.assertThat(order.getDiscountPrice()).isEqualTo(1000);
    }
}

테스트 코드도 App 코드와 마찬가지로, Repository와 직접적인 상호작용을 하지 않고 있다. 이는 비즈니스 로직을 테스트하기 때문이다.