[스프링 입문] #3. 회원 관리 예제 - 백엔드 개발

[6om1n]

비즈니스 요구사항 정리

데이터 : 회원ID, 이름
기능 : 회원 등록, 조회
아직 데이터 저장소가 선정되지 않았다고 가정

• 일반적인 웹 어플리케이션 계층 구조

컨트롤러 : 웹MVC의 컨트롤러 역할
서비스 : 핵심 비즈니스 로직 구현 (ex. 회원은 중복 가입이 안됨)
리포지토리 : 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리
도메인 : 비즈니스 도메인 객체 (ex. 회원 주문, 쿠폰 등등 주로 데이터베이스에 저장하고 관리됨)

• 클래스 의존관계

• 아직 데이터 저장소가 선정되지 않아서, 인터페이스로 구현 클래스를 변경할 수 있도록 설계
• 데이터 저장소는 RDB, NoSQL 등등 다양한 저장소를 고민중인 상황으로 가정
• 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용

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

• 회원 객체 Member 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;
    }
}

• 회원 리포지토리 인터페이스 MemberRepository Interface

 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> findAll(); //지금까지 저장된 모든 회원 리스트를 반환
}

• 회원 리포지토리 메모리 구현체 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; // 0,1,2 이렇게 키 값을 생성해줌

    @Override
    public Member save(Member member) {
        member.setId(++sequence); //아이디를 세팅
        store.put(member.getId(), member); // store에 저장함
        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());
    }
    public void clearStore() {
        store.clear();
    }
}

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

• 테스트 케이스 : 내가 원하는대로 정상적으로 동작하는 지를 검증하는
• test 이름을 만들 때는 실행하고 싶은 이름 뒤에 test 이름을 붙여서 생성
• Optional 에서 값을 꺼낼 때는 get을 사용해서 꺼낼 수 있음
• 개발한 기능을 테스트할 때 main 메소드를 통해서 실행하거나, 컨트롤러를 통해 실행할 수 있음. 그러나 너무 오래걸리고 반복 실행하기 어려운 문제점이 존재
• 따라서 자바는 JUnit 이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다.

• 회원 레포지토리 메모리 구현체 테스트

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;

class MemoryMemberRepositoryTest {
    MemoryMemberRepository repository = new MemoryMemberRepository();

    //test가 끝날때마다 한번씩 지운다. -> 이렇게하면 순서와 크게 상관이 없어진다.
    @AfterEach
    public void afterEach() {
        repository.clearStore();
    }

    @Test
    public void save() { //동작하는지 확인
        Member member = new Member();
        member.setName("spring");

        repository.save(member); //member를 저장하면 id가 자동 셋팅

        Member result = repository.findById(member.getId()).get();
        assertThat(member).isEqualTo(result);
    }
    @Test
    public void findByName() {
         //spring1, spring2가 멤버로 가입이 된 것임
        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(); // spring1을 지금 찾겠다는 의미

        assertThat(result).isEqualTo(member1);
    }
    @Test
    public void findAll() {
        //findAll이 먼저 실행이 되면, 여기서 spring1과 spring2가 이미 저장이 되어버림
        // 이런 문제를 해결하기 위해서 테스트가 하나 끝나고 나면 데이터를 클리어 해줘야함
        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);
    }
}

• @AfterEach : 한 번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트 결과가 남을 수 있다. 이럴 경우 다음 테스트가 실패할 가능성이 있다. 따라서 @AfterEach를 사용하면 test가 끝날때마다 한번씩 지워 순서와 크게 상관이 없어진다.
• 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.

회원 서비스 개발

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;

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

    /**
     * 회원 가입
     */
    public Long join(Member member) {
        //같은 이름이 있는 중복 회원 x
        //null이 아니라 어떤 값이 있으면 로직이 동작한다. (Optional이라 가능한 일이다.)

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

• 서비스는 비지니스에 의존적으로 설계를 하고, 리포지토리는 기계적으로 개발스러운 용어를 선택을 한다.

회원 서비스 테스트

• 기존에는 회원 서비스가 메모리 회원 리포지토리를 직접 생성하게 함

 public class MemberService {
    private final MemberRepository memberRepository = 
                                          new MemoryMemberRepository();
 }

• 회원 리포지토리의 코드가 회원 서비스 코드를 가능하게 변경한다.

public class MemberService {
 **
 private final MemberRepository memberRepository;
 public MemberService(MemberRepository memberRepository) {
 this.memberRepository = memberRepository;
    }
    ...
 }

• 회원 서비스 테스트

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.*;
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
    public void 회원가입() throws Exception {
        //Given
        Member member = new Member();
        member.setName("hello");
        //When
        Long saveId = memberService.join(member);
        //Then
        Member findMember = memberRepository.findById(saveId).get();
        assertEquals(member.getName(), findMember.getName());
    }
    @Test
    public void 중복_회원_예외() throws Exception {
        //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("이미 존재하는 회원입니다.");
    }
}

• test는 과감하게 한국어로 바꿔도 무방하다.
• build 될 때 테스트 코드는 실제 코드에 포함되지 않는다.
• @BeforeEach : 각 테스트 실행 전에 호출된다. 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어준다.
• test 코드를 작성할 때 Given, When, Then 을 사용하여 작성하는 것을 추천한다.

• given : 무언가가 주어진 상황에서
• when : 이거를 실행했을 때
• then : 결과가 이렇게 나와야함