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

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

핵심 정리

핵심 요약:

프로젝트 생성:

스프링 부트 프로젝트를 생성하고, build.gradle 파일에 필요한 의존성 설정을 추가했다.

build.gradle 설정:

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}

회원 도메인 개발:

회원을 가입하고 조회하는 도메인 로직을 구현했다. 회원 엔티티와 저장소, 그리고 서비스 인터페이스와 그 구현체를 정의했다.

회원 엔티티:

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

    // constructor, getter, setter 생략
}

회원 저장소 인터페이스 및 구현체:

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

public class MemoryMemberRepository implements MemberRepository {
    private static Map<Long, Member> store = new HashMap<>();
    public void save(Member member) {
        store.put(member.getId(), member);
    }
    public Member findById(Long memberId) {
        return store.get(memberId);
    }
}

회원 서비스:

회원 서비스에서는 회원 가입과 조회 기능을 제공하며, 인터페이스와 그 구현체로 설계되었다.

회원 서비스 인터페이스 및 구현체:

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

public class MemberServiceImpl implements MemberService {
    private final MemberRepository memberRepository = new MemoryMemberRepository();
    public void join(Member member) {
        memberRepository.save(member);
    }
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

주문과 할인 도메인 개발:

할인 정책 인터페이스를 설계하고, 고정 금액 할인을 적용하는 구현체를 만들었다.
주문 서비스는 회원 정보를 조회하고 할인 정책을 적용한 후 주문을 생성한다.

할인 정책 인터페이스 및 구현체:

public interface DiscountPolicy {
    int discount(Member member, int price);
}

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

주문 서비스 구현:

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

문제점:
- 현재의 설계는 DIP(Dependency Inversion Principle)와 OCP(Open-Closed Principle)를 위반하고 있다. 즉, 구현 클래스에 직접 의존하고 있어, 할인 정책이나 저장소를 변경할 때 클라이언트 코드까지 수정해야 하는 문제가 있다.

핵심 키워드 설명:

DIP(Dependency Inversion Principle):
- 의존성 역전 원칙으로, 상위 모듈(예: OrderServiceImpl)이 하위 모듈의 구체적인 구현체에 의존하지 않고 인터페이스에 의존해야 한다. 현재 OrderServiceImpl은 구체적인 FixDiscountPolicy에 의존하고 있어 DIP를 위반하고 있다.
DIP 위반 코드 예시:
```
public class OrderServiceImpl implements OrderService {
    private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); // DIP 위반
}
```
OCP(Open-Closed Principle):
- 개방-폐쇄 원칙으로, 소프트웨어 구성 요소는 확장에는 열려 있고, 수정에는 닫혀 있어야 한다. 현재 할인 정책을 변경하려면 OrderServiceImpl을 수정해야 하므로 OCP를 위반하고 있다.
OCP 위반 예시:
```
public class OrderServiceImpl implements OrderService {
    private final DiscountPolicy discountPolicy = new FixDiscountPolicy(); // 변경 시 수정 필요
}
```
의존성 주입(Dependency Injection):
- 외부에서 객체의 의존성을 주입하여, 코드의 결합도를 낮추고 유연성을 높인다. DIP와 OCP를 준수하기 위해 스프링의 DI 컨테이너를 사용해 의존성을 주입하는 방식으로 개선 가능하다.
JUnit 테스트:
- 단위 테스트를 위해 사용되는 프레임워크로, 애플리케이션의 동작을 검증하고 각 기능이 올바르게 작동하는지 확인할 수 있다. 스프링에서는 @Test를 사용하여 테스트 케이스를 작성하고 실행할 수 있다.

프로젝트 생성

build.gradle

plugins {
    id 'org.springframework.boot' version '2.3.3.RELEASE'
    id 'io.spring.dependency-management' version '1.0.9.RELEASE'
    id 'java'
}
group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
repositories {
    mavenCentral()
}
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}
test {
    useJUnitPlatform()
}

비즈니스 요구 사항과 설계

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

회원 도메인 설계

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

회원 도메인 협력 관계

회원 클래스 다이어그램

회원 객체 다이어그램

회원 도메인 개발

회원 엔티티

회원 등급

package hello.core.member;

public enum Grade {
    BASIC,
    VIP
}

회원 엔티티

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

회원 저장소

회원 저장소 인터페이스

package hello.core.member;

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

메모리 회원 저장소 구현체

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

데이터베이스가 아직 확정이 안되었다. 그래도 개발은 진행해야 하니 가장 단순한, 메모리 회원 저장소를
구현해서 우선 개발을 진행하자.

참고: HashMap 은 동시성 이슈가 발생할 수 있다. 이런 경우 ConcurrentHashMap 을 사용하자.

회원 서비스

회원 서비스 인터페이스

package hello.core.member;

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

회원 서비스 구현체

package hello.core.member;

public class MemberServiceImpl implements MemberService {

    // DIP 위반 : 의존관계에서 MemberServiceImpl가 추상(인터페이스)(memberRepository) 뿐만 아니라 구체(구현) 클래스(MemoryMemberRepository)까지 모두 의존하는 문제점이 있음
    // OCP 위반 : MemoryMemberRepository의 기능을 확장해서 변경하면, 클라이언트 코드(MemberServiceImpl)에 영향을 준다!
    private final MemberRepository memberRepository = new MemoryMemberRepository();

    public void join(Member member) {
        memberRepository.save(member);
    }
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

회원 도메인 실행과 테스트

회원 도메인 - 회원 가입 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());
    }
}

애플리케이션 로직으로 이렇게 테스트 하는 것은 좋은 방법이 아니다. JUnit 테스트를 사용하자.

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

package hello.core.member;

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

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를 잘 지키고 있을까요?
-> 의존 관계가 인터페이스 뿐만 아니라 구현까지 모두 의존하는 문제점이 있음

주문과 할인 도메인 설계

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

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

주문 생성: 클라이언트는 주문 서비스에 주문 생성을 요청한다.
회원 조회: 할인을 위해서는 회원 등급이 필요하다. 그래서 주문 서비스는 회원 저장소에서 회원을 조회한다.
할인 적용: 주문 서비스는 회원 등급에 따른 할인 여부를 할인 정책에 위임한다.
주문 결과 반환: 주문 서비스는 할인 결과를 포함한 주문 결과를 반환한다.
참고: 실제로는 주문 데이터를 DB에 저장하겠지만, 예제가 너무 복잡해 질 수 있어서 생략하고, 단순히 주문 결과를 반환한다.

주문 도메인 전체

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

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

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

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

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

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

주문과 할인 도메인 개발

할인 정책 인터페이스

package hello.core.discount;

import hello.core.member.Member;

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

정액 할인 정책 구현체

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원 할인, 아니면 할인 없음

주문 엔티티

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 String getItemName() {
        return itemName;
    }

    public int getItemPrice() {
        return itemPrice;
    }

    public int getDiscountPrice() {
        return discountPrice;
    }

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

주문 서비스 인터페이스

package hello.core.order;

    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;

public class OrderServiceImpl implements OrderService {

    // DIP 위반 : 의존관계가 추상(인터페이스)(memberRepository) 뿐만 아니라 구체(구현) 클래스(MemoryMemberRepository)까지 모두 의존하는 문제점이 있음
    // OCP 위반 : 기능을 확장해서 변경하면, 클라이언트 코드(OrderServiceImpl)에 영향을 준다!
    private final MemberRepository memberRepository = new MemoryMemberRepository();

    // DIP 위반 : 의존관계가 추상(인터페이스)(discountPolicy) 뿐만 아니라 구체(구현) 클래스(RateDiscountPolicy, FixDiscountPolicy)까지 모두 의존하는 문제점이 있음
    // OCP 위반 : FixDiscountPolicy 를 RateDiscountPolicy 로 변경하는 순간 OrderServiceImpl 의 소스 코드도 함께 변경
    // 기능을 확장해서 변경하면, 클라이언트 코드(OrderServiceImpl)에 영향을 준다!
    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);
    }
}

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

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

주문과 할인 정책 실행

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

결과

order = Order{memberId=1, itemName='itemA', itemPrice=10000, discountPrice=1000}

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

주문과 할인 정책 테스트

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

Reference

인프런 김영한 강의 - 스프링 핵심 원리 - 기본편

'Web_Backend > 스프링 핵심 원리 - 기본편' 카테고리의 다른 글

6. 컴포넌트 스캔 (0)	2024.09.09
5. 싱글톤 컨테이너 (0)	2024.08.15
4. 스프링 컨테이너와 스프링 빈 (0)	2024.08.15
3. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용 (0)	2024.08.15
1. 객체 지향 설계와 스프링 (0)	2024.07.31

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