[Spring] 예제 만들기
해당글은 김영환 스프링 핵심 원리 - 기본편을 보고 요약, 정리하면서 개인적인 견해가 들어간 글입니다.
예제 만들기
프로젝트 생성
- Java 11 설치
- IDE: IntelliJ 또는 Eclipse 설치
필자는 Intellij 사용
스프링 부트 스타터 사이트로 이동해서 스프링 프로젝트 생성
설정은 아래와 같이 했다.
이후 Generate를 해서 압축 파일 다운 후 압축해제하여, 인텔리제이에서 파일을 실행시키면 된다.
인텔리제이에서는 File → Open → 압축해제한 파일 → build.gradle을 클릭하고 OK를 누르면 아래 화면이 뜬다.
Open as Project를 눌러주면 된다.
참고) 이상하게 Spring Boot를 3.0.5 버전으로 하면 에러가 발생한다.
Java 17 이상을 사용해야 하고, javax 패키지 이름도 바꿔야 한다. 필자는 귀찮아서 2.7.10으로 진행했다.
최초로 실행하기 때문에 파일을 설치하느라 시간이 걸린다.
설치가 다 된 후, CoreApplication에 들어가서 실행하면 이전 입문과 다르게 짧게 로그가 뜨고 끝난다.
⇒ 톰캣 서버가 없기 때문
추가로 File → Settings에 들어가서 gradle을 검색해서 설정을 아래와 같이 바꿔준다.
비즈니스 요구사항과 설계
요구사항
- 회원
- 회원을 가입하고 조회할 수 있다.
- 회원은 일반과 VIP 두 가지 등급이 있다.
- 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있다. (미확정)
- 주문과 할인 정책
- 회원은 상품을 주문할 수 있다.
- 회원 등급에 따라 할인 정책을 적용할 수 있다.
- 할인 정책은 모든 VIP는 1000원을 할인해주는 고정 금액 할인을 적용해달라. (나중에 변경 될 수있다.)
- 할인 정책은 변경 가능성이 높다. 회사의 기본 할인 정책을 아직 정하지 못했고, 오픈 직전까지 고민을 미루고 싶다. 최악의 경우 할인을 적용하지 않을 수 도 있다. (미확정)
설계
- 요구사항을 보면 회원 데이터, 할인 정책 같은 부분은 지금 결정하기 어려운 부분이다. 그렇다고 이런 정책이 결정될 때 까지 개발을 무기한 기다릴 수 도 없다. 우리는 앞에서 배운 객체 지향 설계 방법이 있지 않은가!
- 인터페이스를 만들고 구현체를 언제든지 갈아끼울 수 있도록 설계하면 된다. 그럼 시작해보자.
- 참고: 프로젝트 환경설정을 편리하게 하려고 스프링 부트를 사용한 것이다. 지금은 스프링 없는 순수한
자바로만 개발을 진행한다는 점을 꼭 기억하자! 스프링 관련은 한참 뒤에 등장한다.
회원 도메인 설계
- 회원 도메인 요구사항
- 회원을 가입하고 조회할 수 있다.
- 회원은 일반과 VIP 두 가지 등급이 있다.
- 회원 데이터는 자체 DB를 구축할 수 있고, 외부 시스템과 연동할 수 있다. (미확정)
- 회원 서비스: MemberServiceImpl
회원 도메인 개발
우선 member 패키지를 하나 만들어준다.
member 패키지 안에 Grade이름으로 Enum을 만들어 준다.
회원 등급
Grade의 코드는 아래와 같다.
package hello.core.member;
public enum Grade {
BASIC,
VIP
}회원 엔티티
이후 Member이름을 가진 Class도 하나 만들어준다.
코드는 아래와 같다.
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;
}
}회원 저장소 인터페이스
MemberRepository이름을 가진 인터페이스를 만들어준다.
코드는 아래와 같다.
package hello.core.member;
public interface MemberRepository {
void save(Member member);
Member findById(Long memberId);
}메모리 회원 저장소 구현체
그리고 MemberRepository이름을 가진 클래스를 만들어준다.
코드는 아래와 같다.
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을 사용한다고 한다.
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();
public void join(Member member) {
memberRepository.save(member);
}
public Member findMember(Long memberId) {
return memberRepository.findById(memberId);
}
}이러면 개발은 끝났다.
회원 도메인 실행과 테스트
회원 도메인 - 회원 가입 main
우선, hello.core에 MemberApp이름으로 Class를 하나 만들어준다.
코드는 아래와 같다.
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);
System.out.println("find Member = " + findMember);
}
}이후 main을 실행시켜보면 아래와 같이 나온다.
우리가 지금까지 순수 Java코드로 만들었다.
이렇게 애플리케이션 로직으로 테스트 하는 것은 좋은 방법이 아니다.
Junit 테스트 사용
회원 도메인 - 회원 가입 테스트
memberService이름을 가진 클래스를 만든다.
코드는 아래와 같다.
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);
}
}join을 실행시켜보면 잘 작동하는게 확인된다.
하지만 진짜 문제가 없을까?
회원 도메인 설계의 문제점
- 이 코드의 설계상 문제점은 무엇일까요?
- 다른 저장소로 변경할 때 OCP 원칙을 잘 준수할까요?
- DIP를 잘 지키고 있을까요?
- 의존관계가 인터페이스 뿐만 아니라 구현까지 모두 의존하는 문제점이 있음
- ⇒ 주문까지 만들고나서 문제점과 해결 방안을 설명
주문과 할인 도메인 설계
- 주문과 할인 정책
- 회원은 상품을 주문할 수 있다.
- 회원 등급에 따라 할인 정책을 적용할 수 있다.
- 할인 정책은 모든 VIP는 1000원을 할인해주는 고정 금액 할인을 적용해달라. (나중에 변경 될 수 있다.)
- 할인 정책은 변경 가능성이 높다. 회사의 기본 할인 정책을 아직 정하지 못했고, 오픈 직전까지 고민을미루고 싶다. 최악의 경우 할인을 적용하지 않을 수 도 있다. (미확정)
주문 도메인 협력, 역할, 책임
- 주문 생성: 클라이언트는 주문 서비스에 주문 생성을 요청한다.
- 회원 조회: 할인을 위해서는 회원 등급이 필요하다. 그래서 주문 서비스는 회원 저장소에서 회원을 조회한다.
- 할인 적용: 주문 서비스는 회원 등급에 따른 할인 여부를 할인 정책에 위임한다.
- 주문 결과 반환: 주문 서비스는 할인 결과를 포함한 주문 결과를 반환한다.
참고: 실제로는 주문 데이터를 DB에 저장하겠지만, 예제가 너무 복잡해 질 수 있어서 생략하고, 단순히 주문 결과를 반환한다
주문 도메인 전체
역할을 먼저 만들고 구현을 나중에 만들었다.
⇒ 역할과 구현을 분리했다.
즉, 역할과 구현을 분리했기 때문에 자유롭게 구현, 객체가 조립이 가능하다.
덕분에 회원 저장소와 할인 정책도 유연하게 변경이 가능하다.
주문 도메인 클래스 다이어그램
주문 도메인 객체 다이어그램1
회원을 메모리에서 조회하고, 정액 할인 정책(고정 금액)을 지원해도 주문 서비스를 변경하지 않아도 된다.
역할들의 협력 관계를 그대로 재사용 할 수 있다.
⇒ DB를 바꾸더라도 주문 서비스 구현체가 바뀌는일은 없다.
주문 도메인 객체 다이어그램2
회원을 메모리가 아닌 실제 DB에서 조회하고, 정률 할인 정책(주문 금액에 따라 % 할인)을 지원해도 주문 서비스를 변경하지 않아도 된다.
협력 관계를 그대로 재사용 할 수 있다
주문과 할인 도메인 개발
할인 정책 인터페이스
hello.core에 discount패키지를 만들고 DiscountPolicy인터페이스를 만들어준다.
코드는 아래와 같다.
package hello.core.discount;
import hello.core.member.Member;
public interface DiscountPolicy {
/**
* @return 할인 대상 금액
*/
int discount(Member member, int price);
}정액 할인 정책 구현체
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;
@Override
public int discount(Member member, int price) {
if (member.getGrade() == Grade.VIP) {
return discountFixAmount;
} else {
return 0;
}
}
}discountFixAmount에 1000을 넣어서 고정 금액이 변경이 가능함
주문 엔티티
hello.core에 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 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 +
'}';
}
}toString을 만들어서 편하게 값을 확인할 수 있다.
주문 서비스 인터페이스
order패키지에 OrderService클래스를 생성한다.
코드는 아래와 같다.
package hello.core.order;
public interface OrderService {
Order createOrder(Long memberId, String itemName, int itemPrice);
}Long memberId, String itemName, int itemPrice는 1. 주문 생성: 클라이언트는 주문 서비스에 주문 생성을 요청한다.
을 구현한것이다.
주문 서비스 구현체
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);
}
}주문이 들어오면 memberId를 찾고 가격을 할인된 가격으로 계산한다.
이때 vip가 아니면 할인이 안됨
return으로 아이디, 물건, 물건 원래 가격, 할인된 가격을 반환해준다.
주문과 할인 도메인 실행과 테스트
hello.core에서 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로 돌아가서 hello.core에 order패키지를 생성한다.
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);
}
}테스트를 실행하면 아래와 같이 뜬다.
이전에 만든 MemberServiceTest도 같이 실행해보자
