1. 비즈니스 요구사항 정리
- 데이터 : 회원ID, 이름
- 기능 : 회원 등록, 조회
- 아직 데이터 저장소가 선정되지 않음(가상의 시나리오)
- 개발을 해야 하는데, 성능이 좋은 DB를 사용할지? NoSQL을 사용할지? 아직 정해지지 않은 상황에서 개발을 해야 하는 상황
일반적인 웹 애플리케이션 계층 구조
- 컨트롤러 : 웹 MVC의 컨트롤러 역할 (ex. 이벤트 처리 등)
- 서비스 : 핵심 비즈니스 로직 구현 (ex. 회원 중복 확인 등)
- 도메인 : 비즈니스 도메인 객체 (ex. 회원, 주문, 쿠폰 등), 주로 데이터베이스에 저장하고 관리됨
- 리포지토리 : 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리
클래스 의존관계
MemberService
- 회원 비즈니스 로직이 있는 회원 서비스 (서비스 클래스에 핵심 비즈니스 모델이 있음)
MemberRepository
- 리포지토리는 도메인 객체를 DB에 저장하고 관리하는데, 아직 DB가 선정되지 않은 상태이다. 따라서 구현체를 우선 Memory 구현체(Memory Member Repository)로 만든다. 개발을 해야 하기 때문에 메모리로 단순하게 저장하는 방식을 사용하자.
- 이후에 구체적인 기술이 선정되고 나면 Memory 구현체(Memory Member Repository)를 해당 기술로 교체가 필요하다. 이를 위해서 interface가 필요하다. 따라서 MemberRepository를 Interface로 정의한다.
2. 회원 도메인과 리포지토리 만들기
회원 객체
- java/hello.hellospring/domain/Member.java
package hello.hellospring.domain;
public class Member {
private Long id; // 회원이 정하는 id x, 데이터 구분을 위해 시스템이 정한 id
private String name; // 회원이 직접 정하는 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;
}
}
회원 리포지토리 인터페이스
- java/hello.hellospring/repository/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);
Optional<Member> findById(Long id);
Optional<Member> findByName(String id);
List<Member> findAll();
}
더보기
💡 Optional
Java8부터 Optional<T>클래스를 사용해 NPE(NullPointerException)를 방지할 수 있다.
Optional<T>는 null이 올 수 있는 값을 감싸는 Wrapper클래스로, 참조하더라도 NPE가 발생하지 않도록 도와준다.
즉, 예상치 못한 NPE예외를 제공되는 메소드로 간단히 회피할 수 있어 복잡한 조건문 없이도 null값으로 인해 발생하는 예외를 처리할 수 있다.
- Optional.empty() - 값이 Null인 경우
- Optional.of() - 값이 Null이 아닌 경우
- Optional.ofNullbale() - 값이 Null일수도, 아닐수도 있는 경우
- 명시된 값이 null이면 비어있는 Optional 객체를 반환한다.
회원 리포지토리 메모리 구현체
- java/hello.hellospring/repository/MemoryMemberRepository.java
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.*;
// 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
public class MemoryMemberRepository implements MemberRepository {
private static Map<Long, Member> store = new HashMap<>(); // save할 때 저장할 수 있는 곳
private static long sequence = 0L; // 시스템이 부여하는 id
@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)); // 결과가 null이 반환될 가능성이 있으므로 Optional.ofNullable로 감싸준다.
}
@Override
public Optional<Member> findByName(String name) {
return store.values().stream() // store(HashMap)의 value들. 즉, member 객체를 돌면서 확인한다.
.filter(member -> member.getName().equals(name)) // 회원의 name과 파라미터로 들어온 name과 일치하는 지 확인
.findAny(); // 하나라도 찾는다. 결과가 null이면 Optional로 감싸져서 반환된다.
}
@Override
public List<Member> findAll() {
return new ArrayList<>(store.values()); // Member 반환
}
public void clearStore() {
store.clear();
}
}
3. 회원 리포지토리 테스트 케이스 작성
개발한 기능을 실행해서 테스트할 때 자바의 main 메서드를 통해서 실행하거나, 웹 애플리케이션의 컨트롤러를 통해서 해당 기능을 실행한다. 이러한 방법은 준비하고 실행하는데 오래 걸리고, 반복 실행하기 어렵고 여러 테스트를 한 번에 실행하기 어렵다는 단점이 있다. 자바는 JUnit이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다.
더보기
💡 Given-When-Then 패턴
Given-When-Then은 테스트 코드를 작성하는 표현 방식이다.
- Given(준비) : 어떠한 데이터가 준비되었을 때
- When(실행) : 어떠한 함수를 실행하면
- Then(검증) : 어떠한 결과가 나와야 한다
💡 보통 테스트 코드를 작성할 때, 테스트 대상이 되는 것들의 이름은 그대로 따라가고 class의 경우 뒤에 Test를 붙여주는 것이 관례이다.
회원 리포지토리 메모리 구현체 테스트
- test/java/hello.hellospring/repository/MemoryMemberRepositoryTest.java
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import java.util.List;
import static org.assertj.core.api.Assertions.assertThat;
public class MemoryMemberRepositoryTest {
MemoryMemberRepository repository = new MemoryMemberRepository();
@AfterEach // 각 테스트가 끝나고 실행된다.
public void afterEach() {
repository.clearStore(); // 테스트가 끝날 때마다 데이터를 지워준다.
}
@Test
public void save() {
// given
Member member = new Member();
member.setName("hello");
// when
repository.save(member);
// then 검증 : 저장한 것과 꺼낸 것이 동일해야 한다.
Member result = repository.findById(member.getId()).get(); // 저장된 id를 찾아온다. findById의 반환 타입은 Optional. Optional에서 값을 꺼낼 때 get을 이용.
assertThat(result).isEqualTo(member);
}
@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(); // ctrl+alt+v
// then
assertThat(result).isEqualTo(member1);
}
@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);
Member member3 = new Member();
member3.setName("spring3");
repository.save(member3);
// when
List<Member> result = repository.findAll();
// then
assertThat(result.size()).isEqualTo(3);
}
}
- 테스트는 순서가 보장이 안 된다.
- 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.
- @AfterEach : 한 번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 이렇게 되면 다음 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다. @AfterEach를 사용하면 각 테스트가 종료될 때마다 이 기능을 실행한다. 여기서는 메모리 DB에 저장된 데이터를 삭제한다.
4. 회원 서비스 개발
- java/hello.hellospring/service/MemberService.java
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import java.util.List;
import java.util.Optional;
public class MemberService {
private final MemberRepository memberRepository = new MemoryMemerRepository();
/**
* 회원 가입
*/
public Long join(Member member) {
// 같은 이름이 있는 중복 회원X
// 꺼내고싶으면 get 쓰면 된다. 근데 바로 꺼내는것은 권장하지 않는다.
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. 회원 서비스 테스트
ctrl + shift + t : 테스트 클래스 생성
- MemberService.java 수정
- 기존코드 : 직접 메모리 회원 리포지토리를 생성했다.
public class MemberService {
private final MemberRepository memberRepository = new MemoryMemberRepository();
}
- 수정코드 : 외부에서 넣어주는 것으로 수정해주었다. (Dependency Injection : 의존성 주입)
public class MemberService {
private final MemberRepository memberRepository;
public MemberService(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
...
}
- test/java/hello.hellospring/service/MemberServiceTest.java
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemoryMemberRepository;
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.assertThrows;
class MemberServiceTest {
MemberService memberService;
MemoryMemberRepository memberRepository;
@BeforeEach // 각 테스트 시작 전에 호출된다.
public void beforeEach() {
memberRepository = new MemoryMemberRepository();
memberService = new MemberService(memberRepository);
}
@AfterEach
public void afterEach() {
memberRepository.clearStore();
}
@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());
}
@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("이미 존재하는 회원입니다.");
/*
try {
memberService.join(member2);
fail("예외가 발생해야 합니다.");
} catch (IllegalStateException e) {
assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
}
*/
}
@Test
void findMembers() {
}
@Test
void findOne() {
}
}
- @BeforeEach : 각 테스트 실행 전에 호출된다. 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어준다.