[Spring] 스프링 입문하기 (3) - 회원 관리 예제 - 백엔드 개발

본 포스팅은 인프런의 스프링 강의 "스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술" 섹션 3. 회원 관리 예제 - 백엔드 개발을 정리한 것이다.

비즈니스 요구사항 정리

• 데이터: 회원 ID, 이름
• 기능: 회원 등록, 조회
• 데이터 저장소는 아직 선정되지 않음

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

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

클래스 의존관계

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

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

회원 객체 (Member)

• src/main/java/hello.hellospring 에 Package domain 생성
• 생성한 Package domain에 Java class 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;
    }
}

Attribute

• Long id: 회원 ID
• String name: 이름

회원 리포지토리 인터페이스 (MemberRepository)

• src/main/java/hello.hellospring 에 Package resporitory 생성
• 생성한 Package resporitory에 File 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 name);
    List<Member> findAll();
}

Method

• save: Member를 저장하는 메서드
• findById: Member의 Attribute인 id를 입력했을 때 해당하는 Member를 반환하는 메서드
• findByName: Member의 Attribute인 name을 입력했을 때 해당하는 Member를 반환하는 메서드
• findAll: 저장된 모든 Member를 List로 반환하는 메서드

회원 리포지토리 메모리 구현체 (MemoryMemberRepository)

• src/main/java/hello.hellospring 의 Package resporitory에 Java sclas MemoryMemberRepository.java 생성 후 다음 소스코드 추가

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

    public void clearStore(){
        store.clear();
    }
}

Attribute

• Map<Long, String> store: HashMap으로 Member를 저장
  • key=id, value=name으로 설정
• long sequence: Member의 id에 사용됨

Method

인터페이스 MemberRepository에 선언된 Method 구현

• save
  • setId로 Member의 id 설정 (sequence++)
  • store에 Member 추가
  • Member 객체 반환
• findById
  • 입력된 id가 store에 저장된 Member의 id라면 해당 Member 객체 반환
• findAll
  • store에 저장된 모든 Member 객체를 List로 반환
• findByName
  • 입력된 name이 store에 저장된 Member의 name이면 해당 Member의 객체를 반환

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

• 개발한 기능을 실행해서 테스트할 때 자바의 main 메서드를 통해서 실행하거나, 웹 애플리케이션의 컨트롤러를 통해서 해당 기능을 실행한다.
• 이러한 방법은 주비하고 실행하는데 오래 걸리고, 반복 실행하기 어렵고 여러 테스트틑 한번에 실행하기 어렵다는 단점이 있다.
• 자바는 JUnit이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다.

회원 리포지토리 메모리 구현 케이스 (MemoryMemberRepository)

• src/test/java/hello.hellospring 에 Package repository생성
• 생성한 Package repository에 Java class MemoryMemberRepositoryTest 생성 후 다음 코드 추가

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

import java.util.List;
import java.util.Optional;

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

class MemoryMemberRepositoryTest {
    MemoryMemberRepository repository = new MemoryMemberRepository();

    @AfterEach
    public void afterEach(){
        repository.clearStore();
    }

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

        repository.save(member);

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

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

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

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

  • given: 어떤 상황이 주어졌는지
  • when: 주어진 상황에서 무엇을 할 것인지
  • then: 수행 결과는 무엇인지

Method

• save: 리포지토리에 Member 객체를 잘 저장하는지 확인한다.

  • given: 회원 이름으로 Member 객체를 생성한다.
  • when: repository에 생성한 Member 객체를 저장한다.
  • then: 앞서 생성한 객체의 id에 해당되는 객체를 repository에서 반환한다. 리포지토리에서 반환된 객체와 생성한 객체가 동일한지 확인한다.

• findByName: 리포지토리에서 입력된 name에 해당되는 객체를 반환하는지 확인한다.

  • given: name이 각각 "spring1", "spring2"인 Member 객체를 생성하고 repository에 저장한다.
  • when: repository에서 name이 "spring1"인 Member를 반환한다.
  • then: 리포지토리에서 반환된 객체와 생성한 객체가 동일한지 확인한다.

• findAll: 리포지토리에 저장된 모든 객체를 반환하는지 확인한다.

  • given: name이 각각 "spring1", "spring2"인 Member 객체를 생성하고 repository에 저장한다.
  • when: repository에 저장된 모든 Member 객체 리스트를 반환한다.
  • then: 리스트에 저장된 Member 객체 개수와 생성한 객체 개수가 같은지 확인한다.

회원 서비스 개발 (MemberService)

• src/main/java/hello.hellospring 에 Package service 생성
• 생성한 Package service에 Java class MemberService 생성 후 다음 코드 추가

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;

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

    /*
    * 회원 가입
    * */
    public Long join(Member member){
        validatedDuplicateMember(member);   // 중복 회원 검증
        memberRepository.save(member);
        return member.getId();
    }

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

Attribute

• MemberRepository memberRepository: Member를 저장하고 관리할 리포지토리

Constructor

• 입력한 MemberRepository를 MemberService의 attribute인 memberRepository으로 설정해주는 생성자

Method

• join: 회원 가입
  • 입력한 member를 리포지토리에 저장하고 저장한 멤버의 id를 반환한다.
• validatedDuplicateMember: 중복 멤버 확인
  • 입력한 멤버의 name이 리포지토리에 저장된 멤버의 name과 중복인지 확인한다.
  • name이 중복일 경우 IllegalStateException를 반환한다.
• findMembers: 전체 회원 조회
  • 리포지토리에 저장된 전체 회원을 반환한다.
• findOne: 입력한 id에 해당되는 멤버 반환
  • 입력된 id에 해당되는 멤버를 리포지토리에서 반환한다.

회원 서비스 테스트 (MemberService)

• src/test/java/hello.hellospring 에 Package `servicec생성
• 생성한 Package service에 Java class MemberServiceTest 생성 후 다음 코드 추가

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
    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) {
//            Assertions.assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
//        }

        // then
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

• @BeforeEach
  • 각 테스트 실행 전에 호출된다.
  • 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 맺어준다.
  • 리포지토리 객체를 생성한다.
  • 리포지토리 객체를 입력하여 멤버서비스 객체를 생성한다.
• @AfterEach
  • 리포지토리 객체를 초기화한다.

Method

• 회원가입: MemberService의 join 메서드로 Member 객체를 잘 저장하는지 확인한다.
  • given: name이 hello인 객체를 생성한다.
  • when: 생성한 객체를 MemberService의 join으로 리포지토리에 추가한다.
  • then: 생성한 객체의 이름을 리포지토리에서 검색한 후 반환된 객체와 생성된 객체가 동일한지 확인한다.
• 중복_회원_예외: name이 중복일 경우 예외 처리를 하는지 확인한다.
  • given: name이 "spring"인 Member 객체 두 개를 생성한다.
  • when & then: 첫 번째 Member를 회원가입한 후 두 번째 Member를 회원가입할 때 IllegalStateException 예외가 발생하는지 확인한다.