본 게시글은 김영한님의 [스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술]을 수강하며 작성한 글입니다.
1. 비즈니스 요구사항 정리
1) 요구사항
- 데이터: 회원 ID, 이름
- 기능: 회원 등록, 회원 조회
- 데이터 저장소: 메모리 기반의 데이터 저장소 사용
2) 웹 어플리케이션 계층 구조
- 컨트롤러: 웹 MVC의 컨트롤러 역할
- 서비스: 핵심 비즈니스 로직 구현
- 리포지토리: DB에 접근하여 도메인 객체를 저장하고 관리
- 도메인: 비즈니스 도메인 객체
2. 회원 도메인과 리포지토리 만들기
1) 도메인 만들기
/main/java/hello.hellospring 하위에 domain package를 생성하고, Memeber Class를 만든다.
package hello.hellospring.domain;
public class Member {
private Long 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;
}
}
2) 리포지토리 만들기
1. /main/java/hello.hellospring 하위에 repository package를 생성하고, MemeberRepository Interface를 만든다.
package hello.hellospring.domain;
public class Member {
private Long 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;
}
}
2. MemoryMemberRepository class를 생성한다.
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<>();
private static long sequence = 0L;
@Override
public Member save(Member member) {
member.setId(++sequence);
store.put(member.getId(), member);
return member;
}
@Override
public Optional<Member> findById(Long id) {
return Optional.ofNullable(store.get(id));
}
@Override
public Optional<Member> findByName(String name) {
return store.values().stream()
.filter(member -> member.getName().equals(name))
.findAny();
}
@Override
public List<Member> findAll() {
return new ArrayList<>(store.values());
}
}
- MemeberRepository 인터페이스를 implements하고 모든 메소드를 전부 Override한다.
- Optional.ofNullable(store.get(id));
값이 NULL인 경우를 대비하여 Optional.ofNullable()로 감싼다.
3. 회원 리포지토리 테스트 케이스 작성
구현한 리포지토리가 정상적으로 동작하는지 확인하기 위해 테스트 케이스를 작성하여 검증한다.
💡 자바에서는 JUit 프레임워크를 통해 간단히 테스트를 실행한다. 자바의 main 메서드나 웹 애플리케이션의 컨트롤러를 통해 해당 기능을 실행하여 테스트하는 방식은 준비하고 실행하는데 오래걸리고, 반복 실행하기 어렵고, 여러 테스트를 한번에 실행하기 어렵다는 단점이 존재한다.
/src**/test/**java/hello.hellospring 하위에 repository package를 생성하고, MemoryMemberRepositoryTest class를 생성한다.
@Test를 붙여준 뒤, 좌측의 ▶ 버튼을 누르면 테스트 화면이 아래에 나타난다.
1) save() 기능 테스트
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
class MemoryMemberRepositoryTest {
MemberRepository repository = new MemoryMemberRepository();
@Test
public void save() {
Member member = new Member();
member.setName("spring");
repository.save(member);
Member result = repository.findById(member.getId()).get();
Assertions.assertEquals(result, member);
}
}
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
class MemoryMemberRepositoryTest {
MemberRepository repository = new MemoryMemberRepository();
@Test
public void save() {
Member member = new Member();
member.setName("spring");
repository.save(member);
Member result = repository.findById(member.getId()).get();
Assertions.assertThat(member).isEqualTo(result);
}
}
2) findByName() 기능 테스트
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import java.util.Optional;
import static org.assertj.core.api.Assertions.*;
class MemoryMemberRepositoryTest {
MemberRepository repository = new MemoryMemberRepository();
@Test
public void findByName() {
Member member1 = new Member();
member1.setName("spring1");
repository.save(member1);
Member member2 = new Member();
member2.setName("spring2");
repository.save(member2);
Member result = repository.findByName("spring1").get();
assertThat(result).isEqualTo(member1);
}
}
3) findAll() 기능 테스트
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import java.util.List;
import java.util.Optional;
import static org.assertj.core.api.Assertions.*;
class MemoryMemberRepositoryTest {
MemberRepository repository = new MemoryMemberRepository();
@Test
public void findAll() {
Member member1 = new Member();
member1.setName("spring1");
repository.save(member1);
Member member2 = new Member();
member2.setName("spring2");
repository.save(member2);
List<Member> result = repository.findAll();
assertThat(result.size()).isEqualTo(2);
}
}
4) 클래스 단위로 모든 기능 한번에 테스트
3개의 기능을 한 번에 테스트하니 아래와 같이 오류가 발생한다.
이미 findAll()에서 member1과 member2를 추가했고, 이것이 지워지지 않은 상태로 findByName() 테스트가 실행되었기 때문이다.
따라서 각 테스트가 끝나면 @AfterEach로 각 테스트 종료시마다 메모리 DB에 저장된 데이터를 삭제해야 한다.
1. MemoryMemberRepositoryTest.java에 afterEach() 메서드 추가
@AfterEach
public void afterEach() {
repository.clearStore();
}
2. MemoryMemberRepository.java에 clearStore() 메서드 추가
public void clearStore() {
store.clear();
}
⇒ 테스트는 기능의 순서와 의존관계 없이 수행되어야 한다.
4. 회원 서비스 개발
1) 서비스 만들기
/main/java/hello.hellospring 하위에 service package를 생성하고, 하위에 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();
/**
* 회원 가입
*/
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);
}
}
5. 회원 서비스 테스트
💡 Test 클래스 생성 단축키 : commend + shift + t
💡 테스트 케이스를 작성하는 기본 틀
// given: 이러한 데이터가 주어졌을 때
// when: 이거를 실행했을 때
// then: 이렇게 결과가 나와야 한다.
1) 회원가입 기능 테스트
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
class MemberServiceTest {
MemberService memberService = new MemberService();
MemberRepository memberRepository = new MemoryMemberRepository();
@Test
void 회원가입() {
// 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());
}
}
2) 회원가입 기능 예외 테스트
- try ~ catch 문
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
class MemberServiceTest {
MemberService memberService = new MemberService();
@Test
public void 중복_회원_예외() {
// given
Member member1 = new Member();
member1.setName("spring");
Member member2 = new Member();
member2.setName("spring");
// when
memberService.join(member1);
try {
memberService.join(member2);
fail("예외가 발생해야 합니다.");
} catch (IllegalStateException e) {
assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
}
// then
}
}
- assertThrows
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;
class MemberServiceTest {
MemberService memberService = new MemberService();
@Test
public void 중복_회원_예외() {
// 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));
assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
// then
}
}
3) 클래스 단위로 모든 기능 한번에 테스트
메모리 클리어
1. memberRepository 선언
MemoryMemberRepository memberRepository = new MemoryMemberRepository();
2. afterEach 메서드 추가
@AfterEach
public void afterEach() {
memberRepository.clearStore();
}
인스턴스 하나로 통일
현재 MemberService와 MemberServiceTest에 MemoryMemberRepository() 인스턴스가 각각 생성되어 있다. 인스턴스 내용물이 달라지는 것을 방지하기 위해 하나의 인스턴스로 통일할 필요가 있다.
1. MemberService 파일 수정
수정 전
private final MemberRepository memberRepository = new MemberRepository();
수정 후
private final MemberRepository memberRepository;
public MemberService(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
dependency injection이 발생한다.
2. MemberServiceTest 파일 수정
수정 전
MemberService memberService = new MemberService();
MemoryMemberRepository memberRepository = new MemoryMemberRepository();
수정 후
MemberService memberService;
MemoryMemberRepository memberRepository;
@BeforeEach
public void beforeEach() {
memberRepository = new MemoryMemberRepository();
memberService = new MemberService(memberRepository);
}
각 테스트를 수행하기 전에 beforeEach() 메서드를 실행한다.
해당 메서드 실행을 통해 같은 메모리의 레포지터리를 사용할 수 있게 된다.
'Courses > Spring' 카테고리의 다른 글
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 6. 스프링 DB 접근 기술 (0) | 2023.09.24 |
---|---|
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 5. 회원 관리 예제 MVC 개발 (0) | 2023.09.24 |
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 4. 스프링 빈과 의존관계 (0) | 2023.09.21 |
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 2. 스프링 웹 개발 기초 (0) | 2023.09.21 |
[스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술] 1. 프로젝트 환경설정 (0) | 2023.09.19 |