[Spring 입문] 03. 회원 관리 예제

PADO·2021년 1월 20일
Spring
0

Spring 입문

목록 보기
4/8
post-thumbnail

🌱 회원 관리 예제

비즈니스 요구사항 정리

비즈니스 요구사항

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

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

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

클래스 의존관계

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

 

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

회원 객체

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

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

: 회원 객체를 저장하는 저장소 인터페이스

public interface MemberRepository {
    Member save(Member member);
    Optional<Member> findById(Long id);
    Optional<Member> findByName(Long id);
    List<Member> findAll();
}

Optional: null이 반환될 경우 null을 직접 반환하는 대신 Optional로 감싸 반환

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

: 리포지토리 인터페이스의 메모리 구현체

public class MemoryMemberRepository implements MemberRepository {

    /**
     * 동시성 문제가 고려되어 있지 않음,
     * 실무에서는 HashMap 대신 ConcurrentHashMap,
     * long 대신 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) {
        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());
    }
}

  • save()

    • (우선 메모리에 저장) Map을 사용, id가 Long 타입이니 HashMap<Long, Member>
      실무에선 공유되는 자원에서 동시성 문제가 있을 수 있으니 ConcurrentHashMap 사용
    • store에 저장하기 전에 id값을 증가시켜줌
      (name은 회원가입 시 user가 등록, id는 시스템이 부여해주는 번호)

  • findById()

    • null이 반환될 수 있으니 *Optional.ofNullable()*로 감싸 반환

  • findByName()

    store.values().stream()
                .filter(member -> member.getName().equals(name))
                .findAny();
    • store 해쉬 맵의 값들을(.values()) loop를 돌며(.stream()) 검사(.filter()), 넘어온 name과 값이 같은 경우에만 필터링, 찾으면 반환(.findAny()), 없으면 null → Optional로 반환

  • findAll()

    • HashMap의 value값들만 모아 ArrayList로 반환

 

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

: 앞서 작성한 리포지토리가 정상 동작하는지 테스트 해야함.

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

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

src/test/java 하위 폴더에 동등한 계층 구조로 생성한다.

class MemoryMemberRepositoryTest {

    MemoryMemberRepository repository = new MemoryMemberRepository();

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

    @Test
    public void save() {
        // testcase 생성
        Member member = new Member();
        member.setName("jeongwon-iee");

        // 수행
        repository.save(member);

        // 검증
        Member result = repository.findById(member.getId()).get();
        assertThat(result).isEqualTo(member);
        // 기대: 저장했던 member가 find 했을 때 반환되어야 함.
    }

    @Test
    public void findByName() {
        // testcase 생성
        Member member = new Member();
        member.setName("google");
        repository.save(member);

        Member member1 = new Member();
        member1.setName("clova");
        repository.save(member1);

        // 수행
        Member result = repository.findByName("google").get();

        // 검증
        assertThat(result).isEqualTo(member);
    }

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

        Member member1 = new Member();
        member1.setName("clova");
        repository.save(member1);

        List<Member> result = repository.findAll();
        assertThat(result.size()).isEqualTo(2);
    }
}

@AfterEach: 한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. (테스트는 임의의 순서로 실행됨) 이렇게 되면 다음 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다.

@AfterEach를 사용하면 각 테스트가 종료될 때 마다 이 기능이 실행된다. 여기서는 메모리 DB에 저장된 데이터를 삭제한다.

MemoryMemberRepository에 아래와 같은 clear 코드 생성 → @AfterEach에서 호출

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

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

 

회원 서비스 개발

회원 리파지토리와 도메인을 활용해 실제 비즈니스 로직을 수행

public class MemberService {

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

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

  • join()

    • 회원 가입

    • 같은 이름을 가진 중복된 회원이 없도록 한다.

      `ifPresent()`: Optional 안에 null이 아닌 값이 있다면 동작
      Optional<Member> result = memberRepository.findByName(member.getName());
        result.ifPresent(m -> {
            throw new IllegalStateException("이미 존재하는 회원입니다.");
        });

      Optional이 안 예쁘니 코드 정리

      memberRepository.findByName(member.getName())
                .ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });

      메소드 추출 (cmd + opt + m)

      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("이미 존재하는 회원입니다.");
            });
}

 

회원 서비스 테스트

class에서 cmd + shift + T → directory 구조에 맞게 새 test 생성

test: given - when - then 문법

// given, // when, // then 주석을 달아놓으면 추후 보기 편함

  • given 뭔가가 주어졌는데
  • when 이걸 실행했을 때
  • then 이게 나와야 해

정상 플로우 테스트

회원가입 하려는 회원이 제대로 저장되는가 테스트

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

        // when
        Long saveId = memberService.join(member);

        // then
        Member foundMember = memberService.findOne(saveId).get();
        Assertions.assertThat(saveId).isEqualTo(foundMember.getId());
    }

예외 플로우 테스트

중복된 회원이 가입하려고 했을 때 예외를 잘 던지는가 테스트

				// given
        Member member = new Member();
        member.setName("jeongwon");
        
        Member member1 = new Member();
        member1.setName("jeongwon");
        
        // when
        memberService.join(member);
        assertThrows(IllegalStateException.class, () -> memberService.join(member1));

코드 복붙 후 동일 변수명 전부 수정 단축키: 변수명 더블클릭하고 shift + f6

assertThrows(IllegalStateException.class, () -> memberService.join(member1));

→ memberService.join(member1)을 했을 때 IllegalStateException을 던지는지 확인.

memberService.join(member);
IllegalStateException exception = assertThrows(IllegalStateException.class, () -> memberService.join(member1));

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

반환값이 있을 때 변수로 받는 단축키: option + cmd + V

→ 반환값이 있어 메시지 내용도 확인 가능

테스트간 의존관계 삭제

MemoryMemberRepository memberRepository = new MemoryMemberRepository();

@AfterEach
    void afterEach() {
        memberRepository.clearAll();
    }

이전에 실행했던 것을 다시 실행하는 단축키: ctrl + R

회원 리포지토리 의존성 주입

기존의 코드

MemoryMemberRepository memberRepository = new MemoryMemberRepository();

현재는 store가 static이므로 단 하나 존재하지만, 다른 인스턴스를 생성하는 것은 좋은 방법이 아님.

문제: MemberService와 MemberServiceTest에서 사용하는 repository가 다른 인스턴스
→ DB가 static이 아니면 바로 문제가 생김, 같은 repository에 대해 test 하는 것이 맞음

문제 해결

public class MemberService {

    private final MemberRepository memberRepository;

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

		...
}
class MemberServiceTest {

    MemberService memberService;
    MemoryMemberRepository memoryMemberRepository;

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

		...
}

각 test가 실행될 때마다, 실행되기 전(@BeforeEach) MemoryMemberRepository를 생성해 주입
→ 같은 repository에 대해 실행될 것

profile
PADO
이전 포스트

[Spring 입문] 02. 스프링 웹 개발

다음 포스트

[Spring 입문] 04. 스프링 빈과 의존관계

0개의 댓글