스프링 입문 - 회원 관리 예제 #3

비지니스 요구사항 정리

• 데이터: 회원 ID, 이름

• 기능: 회원 등록, 조회

• 아직 데이터 저장소가 선정되지 않음(가상의 시나리오)

• 컨트롤러 : 웹MVC의 컨트롤러 역활

• 서비스: 핵심 비지니스 로직 구현

• 리포지토리: 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리

• 도메인: 비지니스 도메인 객체, 예) 회원, 주문, 쿠폰 등등 주로 데이터베이스에 저장하고 관리됨

• 아직 데이터 저장소가 선정되지 않아서, 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계

• 데이터 저장소는 RDB, NoSQL 등등 다양한 저장소를 고민중인 상황으로 가정

• 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용

회원 도메인과 리포지토리 만들기

• Member 도메인 생성

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;
    }
}

• MemberRepositoy interface 생성
  • Optional이란?
    • Java8에 들어간 기능이며, 값이 null로 반환될 때 Optional으로 감싸서 반환한다.

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 name); // 이름으로 회원을 찾는다.
    List<Member> findByAll(); // 회원 전체를 리스트로 찾는다.
}

• MemberRepository interface 를 상속 받는 MemoryMemberRepository 생성

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> findByAll() {
        return new ArrayList<>(store.values());
    }
}

회원 리포지토리 테스트 케이스 작성

• 개발한 기능을 실행해서 테스트 할 때 자바의 main 메서드 또는 웹 어플리케이션의 컨트롤러를 통해 실행한다.

단점 ❗ 이러한 방법은 준비하고 실행하는데 오래 걸리고 반복적, 여러 테스트를 한번에 실행하기가 어렵다.

자바는 JUnit이라는 프레임워크로 테스트를 실행하여 이러한 문제를 해결한다.

• src/test/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;

import java.util.List;

import static org.assertj.core.api.Assertions.*;

class MemoryMemberRepositoryTest {

    MemoryMemberRepository repository = new MemoryMemberRepository();

    @AfterEach
    public void afterEach() {
        repository.clearStore();
        // test가 실행되고 끝날 때 마다 저장소를 모두 지운다!
        // 테스트는 순서와 관계없이 설계를 하여 실행이 되어야 한다.
    }

    @Test
    public void save() {
        Member member = new Member();
        member.setName("spring");

        repository.save(member);

        Member result = repository.findById(member.getId()).get();
        // System.out.println("result = " + (result == member));
        // Assertions.assertEquals(member, result);
        // Assertions.assertEquals(member, null); null이 들어가면 오류 값 출력
        assertThat(member).isEqualTo(result); // static import를 적용함!
    }

    @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);
    }

    @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.findByAll();

        assertThat(result.size()).isEqualTo(2);
    }
}

• 주의! 한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다.
• 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다. @AfterEach 를 사용하면 각 테스트가 종료될 때 마다 이 기능을 실행한다. 여기서는 메모리 DB에 저장된 데이터를 삭제한다.
• 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.

    @AfterEach
    public void afterEach() {
        repository.clearStore();
        // test가 실행되고 끝날 때 마다 저장소를 모두 지운다!
        // 테스트는 순서와 관계없이 설계를 하여 실행이 되어야 한다.
    }

회원 서비스 개발

• Service 는 비지니스에 의존적으로 설계를 해야 한다.

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.findByAll();
    }

    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

회원 서비스 테스트

• 테스트는 저장이 되는것도 중요하지만 예외 처리 가 더 중요하다!
• MemberService 입장에서 동일한 memberRepository → 회원 서비스 코드를 DI 가사용 할 수 있도록 변경한다.

public class MemberService {

    private final MemberRepository memberRepository;

    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

• 동일한 MemberService 객체로 테스트를 진행하여, 동일한 이름으로 가입이 되는지 테스트를 진행한다.

• 테스트를 진행할 때 메소드명은 직관적이게 한글로 진행하여도 괜찮다.

• 테스트를 진행할 때 머리/가슴/배와 같이 순서대로 진행할 수 있다.

  • given - 무언가를 주어졌을 때
  • when - 이 코드를 실행했을 때
  • then - 이 결과가 나와야 한다.

• @BeforeEach : 각 테스트 실행 전에 호출된다. 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어준다

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 java.util.Optional;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

class MemberServiceTest {

    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach
    public void beforeEach() {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }

    @AfterEach
    public void afterEach() {
        memberRepository.clearStore();
        // test가 실행되고 끝날 때 마다 저장소를 모두 지운다!
        // 테스트는 순서와 관계없이 설계를 하여 실행이 되어야 한다.
    }

    @Test
    void 회원가입() {
        //given
        Member member = new Member();
        member.setName("spring");

        //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 findByOne() {
    }
}