Spring - 회원 관리 예제: 백엔드 개발(3)

4 분 소요

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

비즈니스 요구사항

데이터 : 회원ID, 이름
기능 : 회원등록, 조회

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

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

클래스 의존관계

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

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

회원객체

src> main> java> hello.hellospring> domain패키지 생성후 > Member 클래스 생성

// Member.java
package hello.hellospring.domain;

public class Member {
    private Long id;
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }
}

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

src> main> java> hello.hellospring> repository패키지 생성후 > MemberRepository 클래스 생성

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

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

src> main> java> hello.hellospring> repository > 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;

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

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

위에 만든 회원 레포지토리 코드가 정상적으로 작동할지 검증하기위해 테스트케이스 작성

보통 테스트 하기위해 main 메서드를 통해서 실행하거나 웹 어플리케이션의 컨트롤러를 통해 기능을 테스트해본다.

이러한 방법은 준비하고 실행하는데 오래 걸리고, 반복 실행하기 어렵고 여러 테스트를 한번에 실행하기 어렵다는 단점이 있다.

자바는 JUnit이라는 프레임워크로 테스트를 실행하게되면 위와 같은 단점들을 해결할 수 있다.

테스트는 서로 의존관계 없이(순서와 상관없이) 설계되어야 한다.
테스트 하나를 끝내면 그 데이터를 지우고 다음 테스트로 넘어가도록 작성

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

test> java> hello.hellospring> repository > MemoryMemberRepositoryTest 클래스 생성

// MemoryMemberRepositoryTest.java
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.*;

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();
        // System.out.println("result =" + (result == member));
        // Assertions.assertEquals(member, result);
        assertThat(member).isEqualTo(result);
    }

    @Test
    public void findByName() {
        Member member1 = new Member();
        member1.setName("spring1");
        repository.save(member1);

        Member member2 = new Member();
        member2.setName("spring1");
        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("spring1");
        repository.save(member2);

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

Assertions.assertThat(a).isEqualTo(b) => a와 b가 같다면 True 다르면 False

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

이 부분없이 테스트케이스를 돌려보면 아래와 같이 오류가 나는 것을 확인할 수 있다.

이는 테스트를 확인하는 순서때문에 발생한 문제인데

findAll()에서 먼저 생성한 데이터 때문에 findByName()테스트가 실패한 것을 볼 수 있다.

따라서 앞에서 말했던대로 테스트는 서로 의존관계 없이(순서와 상관없이) 설계되어야 하므로 테스트 하나를 끝내면 그 데이터를 지우고 다음 테스트로 넘어가야한다. 이 방법이 위의 @AFterEach 이다.

회원 서비스 개발

src> main> java> hello.hellospring> service패키지 생성후 > MemberService 클래스 생성

서비스 클래스는 비즈니스에 가까운 용어로 지정해야 한다.

그래야 개발자던지 기획자던지 쉽게 매핑할 수 있다.

// MemberService.java

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

    /**
     * 회원 가입
     */
    public Long join(Member member) {
        // 같은 이름이 있는 중복 회원X
        validateDuplicateMember(member); // 중복 회원 검증 (단축키 ctrl + alt + m)
        memberRepository.save(member);
        return member.getId()
    }

    private void validateDuplicateMember(Member member) {
        Optional<Member> result = memberRepository.findByName(member.getName());
        result.ifPresent(m -> {
            throw new IllegalStateException("이미 존재하는 회원입니다.")
        });
    }

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

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

회원 서비스 개발 테스트

클래스 위에서 단축키(ctrl + shift + t) 입력후 create new Test 클릭하면

자동으로 service 패키지 생성후 MemberServiceTest 틀을 생성해준다.

// MemberServiceTest.java
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.Test;

import java.util.Optional;

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

class MemberServiceTest {

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

    @AfterEach
    void afterEach() {
        memoryMemberRepository.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
    void 중복_회원_예외() {
        Member member1 = new Member();
        member1.setName("spring");

        Member member2 = new Member();
        member2.setName("spring");

        memberService.join(member1);
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

/*
        try {
            memberService.join(member2);
            fail();
        } catch (IllegalStateException e) {
            assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
        }
        */
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

참고자료

인프런 - 스프링 입문 (김영한)

Twitter Facebook LinkedIn

배진수

Spring - 회원 관리 예제: 백엔드 개발(3)

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

비즈니스 요구사항

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

클래스 의존관계

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

회원객체

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

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

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

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

회원 서비스 개발

회원 서비스 개발 테스트

공유하기

댓글남기기

참고

spring boot - API 생성 방법

Web Service, soap vs rest

Spring - WEB 기본지식 HTTP

백준(9655) - 돌게임 Python