SpringBoot/기초

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

ewok 2023. 3. 10. 11:50

비즈니스 요구사항 정리

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

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

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

 

 

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

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

 

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

 

 

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

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

 

package hello.hellospring.repository;

import org.junit.jupiter.api.Test;

class MemoryMemberRepositoryTest {

    MemberRepository repository = new MemoryMemberRepository();

    @Test
    public void save() {

    }
}


package hello.hellospring.repository;

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

class MemoryMemberRepositoryTest {

    MemberRepository repository = new MemoryMemberRepository();

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

        repository.save(member);

        Member result = repository.findById(member.getId()).get();
        Assertions.assertEquals(member, result);
    }
}

 

 

 

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

 

Member result = repository.findByName("spring2").get();

 

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

 

assertThat(result.size()).isEqualTo(3);

 

 

클래스 전체를 한번에 테스트 실행할 수도 있다.

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.junit.jupiter.api.Test;

import java.util.List;

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

class MemoryMemberRepositoryTest {

    MemberRepository repository = new MemoryMemberRepository();

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

개별로 했을 때는 테스트가 다 통과가 되었는데 한 번에 돌리니 findByName()에서 실패가 발생했다. 실행 순서는 보장이 되지 않는다. 그래서 모든 테스트는 순서에 영향을 받지 않고 따로 동작하도록 설계를 해야 한다.

 

여기서 findAll()이 먼저 실행이 되어서 

member1.setName("spring1");
repository.save(member1);

member2.setName("spring2");
repository.save(member2);

이 두 개가 먼저 저장이 되었다. 그래서 findByName()을 테스트할 때 영향을 미친 것이다.

 

그래서 테스트가 하나 끝나면 데이터를 clear 해줘야 한다.

 

MemoryMemberRepository repository = new MemoryMemberRepository();

MemberRepository에서 MemoryMemberRepository로 바꾸고 MemoryMemberRepository로 가서

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

코드를 추가한다.

 

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

테스트로 돌아와서 위 코드를 추가한다.

@AfterEach는 테스트를 실행할 때마다 실행된다.

 

이제 모두 테스트를 통과한다.

 

 

테스트 클래스를 먼저 작성하고 실제 클래스를 작성할 수도 있다. 이것을 테스트 주도 개발(TDD)라고 한다.

 

 

회원 서비스 개발

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;

import java.util.Optional;

public class MemberService {

    private final MemberRepository memberRepository = new MemoryMemberRepository();

    /**
     * 회원 가입
     */
    public Long join(Member member) {
        // 같은 이름이 있는 중복 회원X
        memberRepository.findByName(member.getName())
                .ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });

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

이렇게 로직이 쭉 나오는 경우에는 메서드로 만드는 것이 좋다. (단축기 Ctrl+Alt+M) (리팩터링 목록은 Ctrl+Alt+Shift+T)

 

/**
 * 전체 회원 조회
 */
public List<Member> findMembers() {
    return memberRepository.findAll();
}
public Optional<Member> findOne(Long memberId) {
    return memberRepository.findById(memberId);
}

 

 

 

회원 서비스 테스트

Ctrl+Shift+t

package hello.hellospring.service;

import org.junit.jupiter.api.Test;

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

class MemberServiceTest {

    @Test
    void join() {
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

이렇게 자동으로 생성된다.

 

Ctrl+Alt+v

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import org.junit.jupiter.api.Test;

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

class MemberServiceTest {

    MemberService memberService = new MemberService();

    @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);
    try {
        memberService.join(member2);
        fail("예외가 발생해야 합니다.");
    } catch (IllegalStateException e) {
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
    }
    //then
}

assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.123");

@Test
public void 중복_회원_예외() {
    //given
    Member member1 = new Member();
    member1.setName("spring");
    Member member2 = new Member();
    member2.setName("spring");
    //when
    memberService.join(member1);
    Assertions.assertThrows(IllegalStateException.class, () -> memberService.join(member2));
    try {
        memberService.join(member2);
        fail("예외가 발생해야 합니다.");
    } catch (IllegalStateException e) {
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.123");
    }
    //then
}

Assertions.assertThrows(NullPointerException.class, () -> memberService.join(member2));

 

@Test
public void 중복_회원_예외() {
    //given
    Member member1 = new Member();
    member1.setName("spring");
    Member member2 = new Member();
    member2.setName("spring");
    
    //when
    memberService.join(member1);
    IllegalStateException e = Assertions.assertThrows(IllegalStateException.class, () -> memberService.join(member2));
    assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
    
    //then
}

 

MemoryMemberRepository memberRepository = new MemoryMemberRepository();

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

이번에도 값을 초기화하는 코드를 넣어줘야 한다.

 

 

public class MemberService {

    private final MemberRepository memberRepository = new MemoryMemberRepository();
class MemberServiceTest {

    MemberService memberService = new MemberService();
    MemoryMemberRepository memberRepository = new MemoryMemberRepository();

두 클래스의 memberRepository는 다른 인스턴스이다.

 

여기서는 아래 store가 static이기 때문이 별 문제가 없지만 static이 아니면 문제가 발생한다.

public class MemoryMemberRepository implements MemberRepository {

    private static Map<Long, Member> store = new HashMap<>();

 

 

그래서 같은 인스턴스를 사용하도록 변경해야 한다.

public class MemberService {

    private final MemberRepository memberRepository;

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

    MemberService memberService;
    MemoryMemberRepository memberRepository;

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