[Spring] 회원 관리 예제 01 - 비즈니스 요구사항 정리, domain & repository 생성 → Test code 작성

🌳 비즈니스 요구사항 정리

데이터

 : 회원ID, 이름

기능

 : 회원 등록, 회원 조회

DB

 : 아직 어떤 DB를 사용할지 정해지지 않은 가상의 시나리오

▪ 따라서 인터페이스로 구현 클래스를 변경할 수 있도록 설계

   → 구현체를 통해 가벼운 메모리 기반의 데이터 저장소 사용

▪ 테스트 프레임워크 → junit

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

▪ controller → 웹 MVC의 컨트롤러 역할

▪ service → 핵심 비즈니스 로직 구현

▪ repository → 데이터베이스에 직접 접근, 도메인 객체를 DB에 저장하고 관리

   → Node에서 사용했던 model과 비슷한 역할이라고 생각하면 될 듯 하다

▪ domain → 비즈니스 도메인 객체

   → 회원, 주문 등등 주로 DB에 저장하고 관리되어지는 객체

클래스 의존관계

🌳 회원 도메인과 레포지토리

→ 일반적 계층형 구조대로 작성

회원 도메인 생성

main/domain/Member

public class Member {
    private Long id;  // 시스템상에서 저장하는 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;
    }
}

레포지토리 인터페이스 생성

main/repository/MemberRepository

public interface MemberRepository {
    Member save(Member member);
    Optional<Member> findById(Long id); // optional기능 공부
    Optional<Member> findByName(String name);
    List<Member> findAll();
}

레포지토리에 4가지 기능을 만들어주었다.

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

DB가 선정되지 않았으므로 일시적으로 생성한 회원 리포지토리 구현체

main/repository/MemoryMemberRepository

@Repository
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);   // id setting
        store.put(member.getId(), member);  // store
        return member;
    }

    // id로 찾기
    @Override
    public Optional<Member> findById(Long id) {
        return Optional.ofNullable(store.get(id));
    }

    // name으로 찾기
    @Override
    public Optional<Member> findByName(String name) {
        return store.values().stream()
                .filter(member -> member.getName().equals(name))
                .findAny();
    }

    // 모두 찾기
    @Override
    public List<Member> findAll() {
        // values <-> members
        return new ArrayList<>(store.values());
    }

    // test용
    public void clearStore(){
        store.clear();
    }
}

▪ hashmap을 사용하여 저장

   → 실무에서는 공유되는 hashmap을 사용할 때 동시성 문제를 해결하기 위해 concreteHashmap을 사용한다고 한다

▪ Long 타입으로 키값(pk) 생성

▪ Optional.ofNullable

   → 값이 null인지 아닌지 확신할 수 없는 객체를 담고있는 Optional객체 생성

   → 결과값이 null일 수도 있다면 Optional로 감싸주어 생성해야 한다

▪ List<Member>

   → 실무에서도 List를 많이 사용한다고 한다

🌳 테스트 케이스 작성

▪ 실무에서 test code 없이는 작업이 불가능할 정도로 중요하다고 한다⭐

▪ JUnit으로 테스트를 실행하며 번거로움을 줄인다

▪ JUnit : 자바용 단위 테스트 작성을 위한 프레임워크

   → 같은 패키지 내에 테스트 대상 클래스와 테스트 클래스가 위치하도록 설계한다

   → 보통 패키지, 클래스 이름 등 모두 같게 test에도 작성해준다

   → @Test 어노테이션을 선언하여 메소드가 단위 테스트 메소드임을 선언한다

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

▪ 테스트 케이스는 기본적으로 given → when → then 패턴으로 작성하는것이 좋다.

  given ↔ 주어진 상황에서

  when ↔ 이것을 실행했을 때

  then ↔ 이런 결과가 나와야한다!

 

test/repository/MemoryMemberRepositoryTest

( ↔ main/repository/MemoryMemberRepository 에 대한 test code)

 

save 테스트

MemoryMemberRepository repository = new MemoryMemberRepository();

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

▪ get()으로 Optional객체를 꺼내서 given member와 같은지 비교하는 메소드

▪ assertThat(member).isEqualTo(result)

   → 요즘 많이 사용하는 메소드로, 방향성이 헷갈리지 않는다는 장점

   → .assertEquals(member, result) 메소드도 같은 기능

 

findByName 테스트

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

        Member member2 = new Member();
        member2.setName("spring1");
        repository.save(member2);

        // when
        Member result = repository.findByName("spring1").get();

        // then
        assertThat(result).isEqualTo(member1);
    }

given ↔ spring1, spring2라는 회원이 가입된 상황

when ↔ “spring1” 객체를 꺼냈을 때 (있는지 없는지 모르니까 Optional 객체)

then ↔ isEqualTo() 로 비교

 

findAll 테스트

    **@Test
    public void findAll(){
        // given
        Member member1 = new Member();
        member1.setName("spring1");
        repository.save(member1);

        Member member2 = new Member();
        member2.setName("spring1");
        repository.save(member2);

        // when
        List<Member> result = repository.findAll();

        // then
        assertThat(result.size()).isEqualTo(2);
    }**

▪ 객체 2개 모두 잘 저장되었나 확인하는 메소드

 

이제 테스트 해보자

그런데

테스트가 findAll → findByName 순서로 실행되었기 때문에 발생한 에러이다.

(findAll() 실행되면서 이미 spring1, spring2 객체가 저장되었기 때문에 findByName에서 문제 발생)

▪ 메소드는 순서대로 돌아가지 않는다,, 알아서 돌아가기 때문에

   → 순서 의존적으로 설계하면 절대 안된다!

▪ 이런 문제를 해결하기 위해 테스트를 한 번 돌릴 때마다 데이터를 클리어 해주어야 한다.

 

@AfterEach를 통한 콜백함수

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

각 테스트가 종료될 때마다 이전의 테스트에 의해 저장된 데이터들을 삭제해주어야 한다.

▪ test 클래스부터 만들고 나서 repository를 만드는 방법을 테스트 주도 개발 TDD라고 한다.

▪ 특히 여러명이서 개발할 때는 testcode가 필수이기 때문에 깊이있게 공부하는 것을 추천한다고 한다.

 

 

자료 출처

인프런 - 스프링 입문 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 (김영한)