본문 바로가기

Spring Introduction/스프링 핵심 원리 - 기본

02. 스프링 핵심 원리 이해 1 - 순수 자바 코드로 예제 만들기

💡 본 게시글은 김영한님의 인프런(Inflearn) 강의 스프링 핵심 원리 - 기본편에 대해 공부하고, 정리한 내용입니다.

1. 스프링 프로젝트 생성 및 설정

1) 필요한 설치 항목

  • Java 11
  • IntelliJ

 

2)  프로젝트 생성

(1) 스프링 부트 스타터 사이트로 이동: [https://start.spring.io](https://start.spring.io]

(2) 프로젝트 설정:

  • Project: Gradle Project
  • Spring Boot: 2.3.x
  • Language: Java
  • Packaging: Jar
  • Java: 11

(3) 프로젝트 메타데이터 설정:

  • groupId: hello
  • artifactId: core

(4) Dependencies: 선택하지 않음

 

3)  프로젝트 동작 확인

  • 기본 메인 클래스(CoreApplication.main())를 실행하여 프로젝트가 정상적으로 동작하는지 확인

 

4) IntelliJ 설정 변경

  • 최신 버전의 IntelliJ는 기본적으로 Gradle을 통해 프로그램을 실행하지만, 이는 실행 속도가 느릴 수 있습니다. IntelliJ 설정을 변경하여 자바로 직접 실행하면 더 빠른 실행 속도를 얻을 수 있습니다.

※ 설정 변경 방법

(1) IntelliJ의 Preferences로 이동

(2) Build, Execution, Deployment > Build Tools > Gradle 메뉴로 이동

(3) Build and run using: 'Gradle'을 'IntelliJ IDEA'로 변경

(4) Run tests using: 'Gradle'을 'IntelliJ IDEA'로 변경


2. 비지니스 요구사항 및 설계

1) 회원

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

 

2) 주문 및 할인 정책

  • 회원은 상품을 주문할 수 있습니다.
  • 회원 등급에 따라 할인 정책 적용이 가능합니다.
  • 할인 정책: VIP 회원에게는 1000원의 고정 금액 할인이 적용됩니다. (변경 가능성 있음)
  • 할인 정책은 아직 확정되지 않았으며, 변경 가능성이 높습니다. 최악의 경우에는 할인을 적용하지 않을 수도 있습니다. (미확정)

=> 위와 같은 요구사항에서 회원 데이터와 할인 정책은 변경될 가능성이 있음을 확인할 수 있습니다. 그러나, 이런 정책이 결정될 때까지 개발을 무기한 대기할 수는 없습니다. 따라서, 앞서 배운 객체 지향 설계 방법을 활용하여 인터페이스를 만들고, 구현체를 언제든지 변경할 수 있도록 설계하게 됩니다.

참고: 프로젝트 환경 설정을 쉽게하기 위해 스프링 부트를 사용했습니다. 하지만 현재는 스프링 없이 순수 자바만으로 개발을 진행하고 있습니다. 스프링 관련 내용은 뒷부분에서 등장합니다.

3. 회원 도메인 설계

1) 회원 도메인 협력 관계

  • 회원을 가입하고 조회할 수 있어야 합니다.
    • 이를 위해 회원 서비스에서 회원 가입, 회원 조회 기능을 제공합니다.
  • 회원은 일반과 VIP 두 가지 등급이 있어야 합니다.
    • 이 부분은 회원 도메인 계층에서 설계합니다.
  • 회원 데이터는 자체 DB를 구축할 수도 있고, 외부 시스템과 연동할 수도 있습니다. (미확정)
    • 이를 위해 회원 저장소라는 인터페이스를 별도로 만들고, 이를 통해 세 가지 경우를 처리합니다.
    • 자바 코드로 구현한 메모리 회원 저장소를 임시로 사용합니다. (관련 부분이 확정되면 그때 교체)

 

2) 회원 클래스 다이어그램

  • 협력 관계 설계가 완료되면, 이를 기반으로 클래스 다이어그램을 작성합니다.
  • MemberService 역할은 인터페이스로 정의하고, 이를 MemberServiceImpl에서 구현합니다.
  • MemberRepository 역할을 인터페이스로 정의하고, 이를 MemoryMemberRepository나 DbMemberRepository에서 구현합니다.

 

3) 회원 객체 다이어그램

  • 실제 메모리 참조 관계를 나타냅니다.
  • 클라이언트는 회원 서비스를 참조하고, 회원 서비스는 메모리 회원 저장소를 참조합니다.

4. 회원 도메인 개발

1) 회원 엔티티

  • 회원 등급 (Grade) : 이 부분은 회원의 등급을 나타내는 열거형(enum)이며, BASIC과 VIP 두 가지 등급이 있습니다.
package hello.core.member;
public enum Grade {
	BASIC,
	VIP 
}

 

  • 회원 엔티티 (Member) : 회원 정보를 표현하는 클래스입니다. 각 회원은 고유한 ID, 이름, 그리고 등급을 가지고 있습니다. 이 정보는 private 변수로 저장되며, getter와 setter 메소드를 통해 접근합니다.
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;
    }
}


2) 회원 저장소

  • 회원 저장소 인터페이스(MemberRepository) : 회원 정보를 저장하고 검색하는 기능을 정의하는 인터페이스입니다. 현재는 save(회원 저장)와 findById(아이디로 회원 찾기) 두 가지 메서드가 정의되어 있습니다.
package hello.core.member;

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

 

  • 메모리 회원 저장소 구현체(MemoryMemberRepository) : MemberRepository 인터페이스를 구현한 클래스입니다. HashMap을 사용하여 메모리에서 회원 정보를 관리합니다. HashMap은 동시성 이슈가 발생할 수 있으므로, 이런 경우 ConcurrentHashMap을 사용할 수 있습니다.
ackage 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을 사용합니다.

2) 회원 서비스

  • 회원 서비스 인터페이스(MemberService) : 회원 가입(join)과 회원 조회(findMember) 기능을 정의하는 인터페이스입니다.
package hello.core.member;

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

 

  • 회원 서비스 구현체(MemberServiceImpl) : MemberService 인터페이스를 구현한 클래스입니다. MemoryMemberRepository를 사용하여 회원 정보를 메모리에 저장하고 조회합니다.
package hello.core.member;

public class MemberServiceImpl implements MemberService{
    private final MemberRepository memberRepository = new MemoryMemberRepository();

    @Override
    public void join(Member member) {
        memberRepository.save(member);
        // MemoryMemberRepository 구조체 안에 save 메서드 호출하여 member 저장
    }

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

5. 회원 도메인 실행과 테스트

1) 회원 도메인 - 회원 가입 main

  • 밑의 코드는 새로운 회원을 생성하고, 이를 가입시키는 과정을 테스트합니다. 하지만, 이렇게 애플리케이션 로직으로만 테스트를 진행하는 것은 바람직하지 않습니다. 이를 보완하기 위해 JUnit 테스트를 사용해보겠습니다.
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());
        // 순수 java로 구현
    }
}

 

2) 회원 가입 JUnit 테스트 코드

  • 이 코드는 회원 가입에 대한 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);
    }
}

 

3) 회원 도메인 설계의 문제점

- 회원 도메인 설계에는 몇 가지 문제점이 존재합니다. 코드의 설계상 어떤 문제점들이 있는지에 대해 고민이 필요합니다. 이 문제점을 어떻게 해결할 수 있을지에 대한 고민이 필요하며, 이는 주문을 만든 후에 다시 진행될 예정입니다.

 

(1) 다른 저장소로 변경할 때 OCP(Open-Closed Principle) 원칙을 잘 준수하고 있는지 확인해야 합니다.

  • OCP는 소프트웨어 요소는 확장에 대해서는 열려 있어야 하고, 수정에 대해서는 닫혀 있어야 한다는 원칙입니다.
  • 즉, 이미 개발된 코드에 대해서는 수정이 아닌, 확장을 통해 기능을 추가하거나 변경해야 합니다. - 현재의 코드에서는 다른 저장소로 변경할 때(즉, 확장할 때) 코드를 수정해야 하는 상황이 발생합니다. 이는 OCP 원칙을 위반하는 것입니다. 

(2) DIP(Dependency Inversion Principle)를 잘 지키고 있는지 확인이 필요합니다.

  • DIP는 고차원 모듈이 저차원 모듈에 의존하면 안 되고, 둘 다 추상화에 의존해야 한다는 원칙입니다.
  • 현재의 코드에서는 MemberService가 MemberRepository 인터페이스뿐 아니라 그 구현체인 MemberRepositoryImpl에도 의존하고 있습니다. 이는 DIP 원칙을 위반하는 것입니다.

6. 주문과 할인 도메인 설계

- 주문 도메인의 주요 특징, 역할 및 책임에 대해 알아보겠습니다. 주요 포인트는 주문과 할인 정책입니다.

 

1) 주문과 할인 정책에 대한 기본 규칙

  • 회원은 상품을 주문할 수 있습니다.
  • 회원 등급에 따라 할인 정책을 적용할 수 있습니다. 
  • 현재의 할인 정책은 모든 VIP 회원에게 1000원의 고정 금액 할인이 적용됩니다. (단, 이는 변경될 수 있습니다.)
  • 할인 정책은 변경 가능성이 높으며, 회사의 기본 할인 정책은 아직 확정되지 않았습니다. 따라서 할인 정책은 오픈 직전까지 미루어 결정될 수 있으며, 최악의 경우 할인을 전혀 적용하지 않을 수도 있습니다.

 

2) 주문 프로세스

  • 주문 생성: 클라이언트는 주문 서비스에 주문 생성을 요청하며, 이때 회원 ID, 상품명, 상품 가격을 넘겨줍니다.
  • 회원 조회: 할인 적용을 위해 회원 등급이 필요합니다. 따라서 주문 서비스는 회원 저장소에서 회원을 조회합니다. 회원 조회는 `findById`를 이용해 진행됩니다.
  • 할인 적용: 주문 서비스는 회원 등급에 따른 할인 여부를 할인 정책에 위임합니다.
  • 주문 결과 반환: 주문 서비스는 할인 결과를 포함한 주문 결과를 반환합니다.

3) 주문 도메인 전체

  • 역할구현이 분리되어 있어, 객체를 자유롭게 조립할 수 있게 설계되어 있습니다. 미확정된 부분에 대해 유연하게 대처할 수 있습니다.
  • 다음 다이어그램은 4단계 과정으로 설명할 수 있습니다:
    • (1) 요청 수신: 클라이언트(브라우저)에서 서버로 요청이 전송됩니다. 이 요청에는 사용자가 입력한 정보(회원id, 상품명, 상품 가격)가 포함될 수 있습니다.
    • (2) 회원 조회: 서버는 요청받은 정보를 바탕으로 회원 정보를 조회합니다. 이 과정은 메모리 내 회원 저장소나 데이터베이스(DB) 회원 저장소를 사용할 수 있으며, 이 선택은 시스템의 구성이나 설계에 따라 다릅니다.
    • (3) 회원 정보 처리: 조회된 회원 정보를 기반으로 필요한 처리를 합니다. 이 과정은 할인 정책에 따라 회원의 결재 금액이 달라집니다.
    • (4) 결과 반환: 처리된 결과는 클라이언트로 반환됩니다. 이때, 웹 서비스 응답을 통해 성공, 오류 메시지 등의 결과가 클라이언트에 전달됩니다.

 

 

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

  • OrderService (인터페이스): 주문 서비스에 대한 인터페이스로, 주문과 관련된 핵심 기능을 정의합니다.
  • OrderServiceImpl (클래스): OrderService 인터페이스의 구현체로, 주문 서비스의 실제 로직을 담당합니다.
  • MemberRepository (인터페이스): 회원 정보에 접근하기 위한 인터페이스로, 회원 데이터에 대한 추상화된 접근 방법을 정의합니다.
  • MemoryMemberRepository (클래스): MemberRepository 인터페이스의 메모리 기반 구현체로, 회원 데이터를 메모리에 저장합니다.
  • DbMemberRepository (클래스): MemberRepository 인터페이스의 데이터베이스 기반 구현체로, 회원 데이터를 데이터베이스에 저장합니다.
  • DiscountPolicy (인터페이스): 할인 정책에 대한 인터페이스로, 할인 로직에 대한 규약을 정의합니다.
  • FixDiscountPolicy (클래스): DiscountPolicy 인터페이스의 고정 할인 금액을 적용하는 구현체입니다.
  • RateDiscountPolicy (클래스): DiscountPolicy 인터페이스의 비율 할인을 적용하는 구현체입니다.

 

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

  • 회원을 메모리에서 조회하고, 정액 할인 정책(고정 금액)을 지원하더라도 주문 서비스를 변경하지 않아도 됩니다. 이는 역할들의 협력 관계를 재사용할 수 있기 때문입니다.

 

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

  • 회원을 메모리가 아닌 실제 DB에서 조회하고, 정률 할인 정책(주문 금액에 따라 % 할인)을 지원하더라도 주문 서비스를 변경하지 않아도 됩니다. 이는 각각 역할 간의 협력 관계가 그대로 유지되기 때문입니다.


7. 주문과 할인 도메인 개발

1) 할인 정책 인터페이스

  • `DiscountPolicy.java` 인터페이스를 생성하였습니다.
  • 이 인터페이스는 할인 대상 금액을 반환하는 `discount` 메소드를 선언하고 있습니다. 
package hello.core.discount;

import hello.core.member.Member;

public interface DiscountPolicy {

    // 이걸 호출하고 나면 결과로 할인 금액을 리턴해준다.
    /*
     * @return 할인 대상 금액
     *  */
    int discount(Member member, int price);
}

 

2) 정액 할인 정책 구현체

  • `DiscountPolicy` 인터페이스를 구현한 `FixDiscountPolicy.java` 클래스를 생성하였습니다.
  • 이 클래스는 VIP 회원에게 1000원의 할인을 적용하며, 그 외 회원은 할인을 적용하지 않습니다.
package hello.core.discount;

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

public class FixDiscountPolicy implements DiscountPolicy {

    private int discountFixAmount = 1000; // 1000원 할인

    // VIP 이면 1000원, 아니면 0원을 반환.
    @Override
    public int discount(Member member, int price){
        if (member.getGrade() == Grade.VIP){
            return discountFixAmount;
        } else {
            return 0;
        }
    }
}

 

3) 주문 엔터티

  • `Order.java` 클래스를 생성하였으며, 이는 주문 정보를 담고 있습니다.
  • 주문 정보는 회원 ID, 상품 이름, 상품 가격, 그리고 할인 가격을 포함하고 있습니다. 또한, `calculatePrice` 메소드는 상품 가격에서 할인 가격을 뺀 최종 가격을 계산하여 반환합니다.
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;
    }

    // 비즈니스 계산 로직(계산된 결과)
    // ex) 10000 - 1000 = 9000원
    public int calculatePrice(){
        return itemPrice - discountPrice;
    }

    // getter, setter
    public Long getMemberId() {
        return memberId;
    }

    public String getItemName() {
        return itemName;
    }

    public int getItemPrice() {
        return itemPrice;
    }

    public int getDiscountPrice() {
        return discountPrice;
    }

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

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

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

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

    @Override
    // 출력할 때 보기 쉽게 하기 위해서 생성
    // command + n 누른 뒤, toString 검색
    public String toString() {
        return "Order{" +
                "memberId=" + memberId +
                ", itemName='" + itemName + '\'' +
                ", itemPrice=" + itemPrice +
                ", discountPrice=" + discountPrice +
                '}';
    }
}

 

3) 주문 서비스 인터페이스

  • `OrderService` 인터페이스를 생성하였으며, 이는 주문을 생성하고 그 결과를 반환하는 createOrder 메소드를 선언하고 있습니다.
package hello.core.order;

public interface OrderService {

    // 최종 주문 결과를 반환하는 기능
    Order createOrder(Long memberId, String itemName, int itemPrice);
}

 

4) 주문 서비스 구현체

  • 주문 서비스 구현체 `OrderService` 인터페이스를 구현한 `OrderServiceImpl.java` 클래스를 생성하였습니다.
  • 이 클래스는 주문 생성 요청이 들어오면, 회원 정보를 조회하고, 할인 정책을 적용한 후 주문 객체를 생성하여 반환합니다.
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);
    }
}

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

1) 주문 및 할인 정책 실행

  • `hello.core.OrderApp.java` 클래스를 생성하였습니다.
  • 이 클래스는 VIP 회원을 생성하고, 주문을 생성하여 주문 정보와 최종 가격을 출력합니다.
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.OrderServiceImpl;

public class OrderApp {

    public static void main(String[] args) {
        MemberService memberService = new MemberServiceImpl();
        OrderServiceImpl 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 테스트 프레임워크를 사용하여 테스트를 실행해보겠습니다.

 

2) 주문 및 할인 정책 테스트

  • `hello.core.order.OrderServiceTest.java` 테스트 클래스를 생성하였습니다.
  • 이 클래스는 VIP 회원을 생성하고, 주문을 생성하여 할인된 가격이 1000원인지 검증합니다.
  • Assertions를 import 할 때는 `org.assertj.core.api.Assertions`를 사용하였습니다.
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을 사용하면 null을 넣을 수가 없습니다.
        // (DB 생성시 null을 사용할 수 있기 때문에 미리 대처하였습니다.)
        Long memberId = 1L;
        Member member = new Member(memberId, "memberA", Grade.VIP);
        memberService.join(member);

        Order order = orderService.createOrder(memberId, "itemA", 10000);
        
        // VIP인 경우 할인 금액인 1000원이 맞는지 검증합니다.
        Assertions.assertThat(order.getDiscountPrice()).isEqualTo(1000);
    }

}