[스프링 입문] Section 03 - 회원 관리 예제(백엔드 개발)
카테고리: Spring-Tutorial
비즈니스 요구사항 정리
- 데이터: 회원 ID, 이름
- 기능: 회원 등록, 조회
- 아직 Database를 결정하지 않았다고 가정
- 일반적인 Web Application 계층 구조
Controller: 웹 MVC의 컨트롤러 역할Service: 핵심 비즈니스 로직 구현, 비즈니스 도메인 객체를 가지고 서비스 로직이 돌아가도록 구현한 계층(ex. 회원은 중복 가입이 안 된다거나 하는 등의 것들)Repository: 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리함Domain: 비즈니스 도메인 객체 (ex. 회원, 주문, 쿠폰 등등 주로 데이터베이스에 저장하고 관리됨)
- 클래스 의존관계
- 아직 Database가 선정되지 않은 상황이므로, Interface로 구현 클래스롤 변경할 수 있도록 설계
- Database는 RDB, NoSQL 등등 다양한 경우를 고민중인 상황으로 가정
- 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용
File Tree 참고하기
회원 도메인과 리포지토리 만들기
- Member 객체
// Member.java
package hello.hellospring.domain;
public class Member {
private Long id; // 사용자 지정이 아닌 시스템이 지정해주는 id
private String name;
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;
}
}
- MemberRepository 인터페이스
// MemberRepository.java
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.List;
import java.util.Optional;
public interface MemberRepository {
Member save(Member member);
// 회원의 id나 name이 없을 경우, 단순히 null을 반환하는 대신, optional로 감싸서 반환하는 방식이 요즘 더 선호됨
Optional<Member> findById(Long id);
Optional<Member> findByName(String name);
List<Member> findAll();
}
- MemoryMemberRepository 구현체
// MemoryMemberRepository.java
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.*;
public class MemoryMemberRepository implements MemberRepository{
// 실무에서는 동시성 문제가 있을 수 있어서 이렇게 공유되는 변수일 때는...
private static Map<Long, Member> store = new HashMap<>(); // ConcurrentHashMap을 사용함
private static long sequence = 0L; // AtomicLong을 사용함
@Override
public Member save(Member member) {
member.setId(++sequence); // sequence로 id 설정
store.put(member.getId(), member); // store라는 map 객체에 <id, member>인 객체 추가
return member;
}
@Override
public Optional<Member> findById(Long id) {
return Optional.ofNullable(store.get(id)); // 해당 id를 가진 객체가 없는데 조회를 할 경우, null 처리를 위해 ofNullable로 감싸줌
}
@Override
public Optional<Member> findByName(String name) {
return store.values().stream() // 3. 반환
.filter(member -> member.getName().equals(name)) // 1. member.getName() 과 name이 같은지 확인하여
.findAny(); // 2. 같은 걸 하나라도 찾으면
}
@Override
public List<Member> findAll() { // store는 map인데, 반환은 리스트로 되어 있음 -> java에서 실무할 땐 루프 돌리기도 쉽고 해서 리스트를 많이 쓴다고 함
return new ArrayList<>(store.values());
}
public void clearStore(){
store.clear();
}
}
회원 서비스 개발
- MemberService 객체
// MemberService.java
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import java.util.List;
import java.util.Optional;
public class MemberService {
// private final MemberRepository memberRepository = new MemoryMemberRepository(); // 기존 방식: MemberService가 MemoryMemberRepository를 직접 생성하게 함
private final MemberRepository memberRepository;
public MemberService(MemberRepository memberRepository) { // MemberService 코드를 DI 가능하게 변경한다.
this.memberRepository = memberRepository;
}
/**
* 회원가입
*/
public Long join(Member member) {
validateDuplicateMember(member); // 중복 회원 검증
memberRepository.save(member);
return member.getId();
}
private void validateDuplicateMember(Member member) {
memberRepository.findByName(member.getName()) // 회원 리포지토리에서 멤버 이름으로 찾아서
.ifPresent(m -> { // 만약 존재한다면
throw new IllegalStateException("이미 존재하는 회원입니다."); // 이미 존재한다고 예외를 던지게끔 설계
});
}
/**
* 전체 회원 조회
*/
public List<Member> findMembers() {
return memberRepository.findAll();
}
public Optional<Member> findOne(Long memberId) {
return memberRepository.findById(memberId);
}
}
java에서 테스트를 실행하는 방법
개발한 기능을 실행해서 테스트 할 때
1) 자바의 main 메서드
2) 웹 애플리케이션의 컨트롤러
등을 통해 해당 기능을 실행한다.
앞선 방법은 준비 및 실행하는데 오래 걸리고, 반복 실행이 어려우며, 여러 테스트를 한번에 실행하기 어렵다는 단점이 있다.
따라서, 자바는
JUnit이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다!
- 테스트 작성 시 주의사항!
한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있어 제대로 테스트 케이스가 실행되지 않을 수 있다. 따라서, 메모리 DB에 저장된 데이터를 삭제해주어야 한다.
@BeforeEach: 각 테스트가 실행되기 전 마다 이 기능 실행
@AfterEach: 각 테스트가 종료될 때 마다 이 기능 실행
테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아님!
- 참고 1: Test를 먼저 만들고 구현코드를 만드는 것을 ‘테스트 주도 개발(TDD)’라고 한다.
- 참고 2: 실무에서는 Test를 build tool이랑 엮어서 Test case를 통과하지 못하면 아예 빌드가 되지 않게끔 만든다고 한다.
MemberRepository 테스트 케이스 작성
// MemoryMemberRepositoryTest.java
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test; // junit 프레임워크로 테스트
import java.util.List;
import static org.assertj.core.api.Assertions.*; // static import를 통해 assertThat을 바로 쓸 수 있다.
class MemoryMemberRepositoryTest {
MemoryMemberRepository repository = new MemoryMemberRepository();
@AfterEach // 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.
public void afterEach() {
repository.clearStore(); // 한 번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 따라서 메모리 DB에 저장된 데이터를 삭제해준다.
}
@Test
public void save(){
Member member = new Member();
member.setName("spring"); // 1. 이름을 세팅하고
repository.save(member); // 2. member repository에 저장한 뒤
Member result = repository.findById(member.getId()).get(); // 3. id로 찾아낸 member와 비교
// System.out.println("result = " + (result == member)); // 4. 비교 결과를 콘솔에 출력..할 수도 있지만 항상 콘솔에서 볼 수는 없으니
//Assertions.assertEquals(result, member); // 5. junit에서 제공하는 assertions를 통해 검증(앞: expected, 뒤: actual)
assertThat(member).isEqualTo(result); // 5. assertj에서 제공하는 assertThat을 사용
}
@Test
public void findByName() {
// given
Member member1 = new Member();
member1.setName("spring1");
repository.save(member1);
Member member2 = new Member();
member2.setName("spring2");
repository.save(member2);
// when
Member result = repository.findByName("spring1").get();
// then
assertThat(member1).isEqualTo(result);
}
@Test
public void findAll() {
// given
Member member1 = new Member();
member1.setName("spring1");
repository.save(member1);
Member member2 = new Member();
member2.setName("spring2");
repository.save(member2);
// when
List<Member> result = repository.findAll();
// then
assertThat(result.size()).isEqualTo(2);
}
}
MemberService 테스트 케이스 작성
// MemberServiceTest.java
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemoryMemberRepository;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.*;
class MemberServiceTest {
/*
MemberService memberService = new MemberService();
MemoryMemberRepository memberRepository = new MemoryMemberRepository();
*/
MemberService memberService;
MemoryMemberRepository memberRepository;
@BeforeEach
public void beforeEach() {
memberRepository = new MemoryMemberRepository();
memberService = new MemberService(memberRepository); // DI 방식으로 memberRepository를 미리 생성하고 생성자에서 받게 함
}
@AfterEach // 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.
public void afterEach() {
memberRepository.clearStore(); // 한 번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 따라서 메모리 DB에 저장된 데이터를 삭제해준다.
}
@Test
void 회원가입() { // join()
// given
Member member = new Member();
member.setName("hello");
// when
Long saveId = memberService.join(member);
// then
Member findMember = memberService.findOne(saveId).get();
assertThat(member.getName()).isEqualTo(findMember.getName());
}
@Test
void 중복_회원_예외() { // validateDuplicateMember() 검증
// given
Member member1 = new Member();
member1.setName("spring");
Member member2 = new Member();
member2.setName("spring");
// when
memberService.join(member1);
IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2)); // 예외 메시지를 변수 e로 받아서
// then
assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
}
}
댓글 남기기