회원 관리 예제 - 백엔드 개발

비즈니스 요구사항 정리

비즈니스 요구사항

• 데이터: 회원ID, 이름
• 기능: 회원 등록, 조회
• 아직 데이터 저장소가 선정되지 않음 (가상의 시나리오)

웹 어플리케이션 계층 구조

• 컨트롤러: 웹 MVC의 컨트롤러 역할
• 서비스: 핵심 비지니스 로직 구현
• 리포지토리: DB에 접근, 도메인 객체를 DB에 저장하고 관리 (DAO 생각하면 됨)
• 도메인: 비지니스 도메인 객체, Ex)회원, 주문, 쿠폰 등 주로 DB에 저장하고 관리됨

클래스 의존 관계

• 아직 데이터 저장소가 선정되지 않아서, 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계
• 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용, Ex) HashMap
  

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

회원 객체

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

회원 리포지토리 인터페이스

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

• Null일 거 같은 값은 Optional로 감싸서 처리한다. Optional은 Java 8에서 나온 기능.

회원 리포지토리 메모리 구현체

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import java.util.*;

public class MemoryMemberRepository implements MemberRepository {

    /**
     * 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
     */

    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) {
        //Null일 수 있는 경우 Optional로 감싸서 return한다.
        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();
    }
}

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

• 개발한 기능을 Java 메서드나 웹 어플리케이션을 실행해서 테스트하면, 실행하는데 오래걸리고, 반복 실행하기 어렵고, 여러 테스트를 한 번에 실행하기 어렵다는 단점이 있다.
• JUnit이라는 프레임워크로 테스트하면 이러한 문제점들을 해결할 수 있다.
• CI/CD에서 Test할 때 Fail이 되면 Build하지 않고 배포하지 않는다.

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

• 클래스에 커서를 두고, Alt + Enter를 누르면 Create Test로 손쉽게 테스트 클래스를 생성할 수 있다.

• 테스트 코드는 보통 given, when, then으로 나뉘어 진다.
  given: 주어진 값
  when: 조건
  then: 기대되는 결과

• @AfterEach: 한 번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 이렇게 되면 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다. @AfterEach를 사용하면 각 테스트가 종료될 때 마다 이 기능을 실행한다. 여기서는 메모리 DB에 저장된 데이터를 삭제한다.

• 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.

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를 끝날 떄마다 Repository를 깨끗하게 지워줘야 에러가 나지 않는다. (매우 중요)
    //공용 데이터를 깔끔하게 지워줘야 한다.
    @AfterEach
    public void afterEach(){
        repository.clearStore();
    }

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

        //when
        repository.save(member);

        //then
        Member result = repository.findById(member.getId()).get();
        assertThat(member).isEqualTo(result);
    }

    @Test
    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(result).isEqualTo(member1);
    }

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

회원 서비스 개발

회원 서비스

• 저장, 조회 삭제와 같은 Repository의 메서드 이름과 다르게 서비스의 메서드 이름은 비즈니스 중심이다.

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;

    //외부에서 Repository를 넣어줄 수 있도록 생성자 생성. 
    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    //회원 가입
    public Long join(Member member) {
        //같은 이름이 있는 중복 회원 X
        validateDuplicateMember(member);

        memberRepository.save(member);
        return member.getId();
    }

    //메서드 추출: Ctrl + Alt + M
    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);
    }

}

Dependency Injection (DI)

• 기존에는 회원 서비스의 메모리 회원 리포지트리를 직접 생성하게 했다.

public class MemberService {

 private final MemberRepository memberRepository = new MemoryMemberRepository();

}

• Test할 때 memberService의 내부 memberRepository와 Test 클래스의 memberRepository는 final이나 static이 아니었으면 서로 다른 객체이다.
• 서로 다른 객체로 테스트를 하는 위험이 생길 수 있다.

class MemberServiceTest {
    
    MemberService memberService = new MemberService();
    MemoryMemberRepository memberRepository = new MemoryMemberRepository();

}

• 따라서 Service의 Repository를 외부에서 넣어주는 방식으로 변경하기 위해, Service에 Repository 생성자를 만들어 준다.

public class MemberService {

    private final MemberRepository memberRepository;

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

• 테스트할 때, Repository 인스턴스를 생성한 후, 서비스 인스턴스 생성 할 때 넣어준다.

• 이렇게 외부에서 객체를 만들어 집어넣어 주는 방식을 Dependency Injection (DI) 라고 한다.

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

class MemberServiceTest {
    
    MemberService memberService;
    MemoryMemberRepository memberRepository = new MemoryMemberRepository();

    //Test 동작하기 전에 memberRepository를 memberService에 넣어준다.
    @BeforeEach
    public void beforeEach() {
        memberRepository = new MemoryMemberRepository();
        //이런 것을 Dependency Injection(DI)라고 한다.
        memberService = new MemberService(memberRepository);
    }

회원 서비스 테스트

• Test 코드는 Build할 때 포함되지 않으므로 한글로 작성해도 된다.

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 = new MemoryMemberRepository();

    //Test 동작하기 전에 memberRepository를 memberService에 넣어준다.
    @BeforeEach
    public void beforeEach() {
        memberRepository = new MemoryMemberRepository();
        //이런 것을 Dependency Injection(DI)라고 한다.
        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
    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
        //Try-Catch 대신 assertThrows 사용
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

    }
    
}