[Spring] 입문-3. Domain / Repository / Service / 테스트케이스

Jina·2023년 5월 16일
Spring
0

Spring

목록 보기
3/9
post-thumbnail

다음의 모든 내용은 김영한님의 스프링 입문 강의에서 가져온 것임을 밝힙니다.

📍 비즈니스 요구사항

가장 단순한 요구사항으로 스프링 전반을 빠르게 배워보자!

  • 데이터 : 회원ID, 이름

  • 기능 : 회원 등록, 조회

  • 아직 (RDB, NoSQL 등) DB가 선정되지 않았다는 시나리오 -> 리포지토리를 인터페이스로 설계하며, 메모리 기반의 가벼운 DB 사용!

- 웹 어플리케이션의 계층 구조

다음의 것들을 차례차례 구현해보자!

  • Controller
  • Domain : 도메인 객체(ex. 회원, 주문, 쿠폰). 주로 DB에 저장되어 관리된다.
  • Repository: 저장소
  • Service : 핵심 비즈니스 로직이 포함된다. (ex. 회원 중복가입 불가)
  • DB

📍 Domain & Repository

먼저 Domain을 만들어보자.
/main/java/hello.hellospring 하위에 domain package를 생성하고, Memeber Class를 만든다.

../domain/Member.java

package hello.hellospring.domain;

public class Member {

    //요구 데이터
    private Long id;        //회원 id
    private String name;    //회원 이름

    //getter and setter
    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;
    }
}

다음은 Repository이다.
/main/java/hello.hellospring 하위에 repository package를 생성하고, MemeberRepository Interface를 만든다.

/repository/MemeberRepository.java

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import java.util.*;

public interface MemberRepository {

    //4가지 기능
    Member save(Member member);
    Optional<Member> findById(Long id);
    Optional<Member> findByName(String name);
    List<Member> findAll();
}

이후 MemoryMemberRepository class를 생성한다. MemeberRepository 인터페이스를 implements하고 모든 메소드를 전부 Override한다. (by cmd+enter)

/repository/MemoryMemberRepository.java

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import java.util.*;

/**
 * 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
 */
public class MemoryMemberRepository implements MemberRepository{

    private static Map<Long, Member> store = new HashMap<>();   //저장공간 store
    private static long sequence = 0L;              //key 값 0, 1, 2, ...

    @Override
    public Member save(Member member) {
        member.setId(++sequence);   //key값을 1 올려주며 id 설정
        store.put(member.getId(), member);

        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        return Optional.ofNullable(store.get(id));  //데이터가 NULL인 경우를 대비하여 Optional 사용함
    }

    @Override
    public Optional<Member> findByName(String name) {
        return store.values().stream()
                .filter(member -> member.getName().equals(name))    //파라미터로 받은 name과 동일한 경우에만 filter됨
                .findAny(); //찾으면 반환
    }

    @Override
    public List<Member> findAll() {
        return new ArrayList<>(store.values());
    }
}

데이터가 NULL인 경우를 대비하여, Optional.ofNullable(데이터)로 감싸기!

java Map 타입

java List 타입

- 테스트 케이스(@Test)

자바에서는 JUit 프레임워크를 통해 간단히 테스트할 수 있다! 이제 /src/test를 활용할 차례!

/src/test/java/hello.hellospring 하위에 repository package를 생성하고, MemoryMemberRepositoryTest class 를 생성해주자. 테스트용이므로 public을 지워줘도 괜찮다.

@Test를 붙여준 뒤, 좌측의 ▶ 버튼을 누르면 테스트 화면이 아래에 나타난다.

앞에서 만든 save() 기능을 테스트 해보자.

/test/../repository/MemoryMemberRepositoryTest.java

package hello.hellospring.repository;

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

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

class MemoryMemberRepositoryTest {

    MemberRepository repository = new MemoryMemberRepository();

    //save 기능 테스트
    @Test
    public void save(){
        Member member = new Member();
        member.setName("name1");

        repository.save(member);
        Member result = repository.findById(member.getId()).get();
        
        //Assertions 기능 사용 -> member와 result가 같다면 초록 체크가 나타남
        //위에서 static으로 Assertions import 함
        assertThat(member).isEqualTo(member);
    }
}

findByName 테스트는 다음 코드를 추가해주었다.

 //findByName 기능 테스트
    @Test
    public void findByName(){
        Member member1 = new Member();
        member1.setName("name1");
        repository.save(member1);

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

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

        assertThat(result).isEqualTo(member1);

Class 앞의 ▶ 버튼을 클릭하거나, package에서 Run Tests in...을 클릭하면 해당되는 test들을 모두 실행해볼 수 있다. 다음과 같이 모두 체크 표시가 나타나면 테스트를 모두 통과한 것!

마지막으로 findAll()을 테스트하는 코드도 추가했다.

//findAll 기능 테스트
    @Test
    public void findAll(){
        Member member1 = new Member();
        member1.setName("name1");
        repository.save(member1);

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

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

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

- @AfterEach

그런데 세개를 한번에 테스트하니 오류가 발생했다!

이유는 findAll()에서 이미 member1과 member2를 설정했고, 이것이 지워지지 않은 상태로 findByName() 테스트가 실행되었기 때문이다. 따라서 각 테스트가 끝나면 이 메모리를 지워주는 코드가 필요하다.

한번에 여러 테스트 실행시, 메모리 DB에 직전 테스트 결과가 남아있어 오류가 발생할 수 있다! 따라서 @AfterEach로 각 테스트 종료시마다 메모리 DB에 저장된 데이터를 삭제하기

MemoryMemberRepositoryTest.java에 다음 함수를 추가한다.

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

clearStore()함수는 MemoryMemberRepository.java에 새로 추가한 함수이다.

    //테스트시 메모리 DB에 저장된 데이터를 삭제하기 위한 것
    public void clearStore(){
        store.clear();
    }

📍 Service

이제 만든 회원 도메인과 리포지토리를 이용하여, 필요한 비즈니스 로직을 Service로 구현해보자! /main/java/hello.hellospring 하위에 service package를 생성했다.

service 클래스는 repository보다 비즈니스에 가까운 네이밍을 하는 것이 좋다! 그래야 기획자도 개발자도 매칭 가능 o(￣▽￣)ブ

MemberService.java

package hello.hellospring.service;

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

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) {

        //같은 이름의 중복 회원은 불가
        validateDuplicateMember(member);    //중복 회원 검증
        memberRepository.save(member);      //저장
        return member.getId();
    }

    //중복회원 검증 함수
    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName())   //Optional 값임
                .ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });
    }

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

    /**
     * 회원 이름으로 조회
     */
    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }

}

- 테스트 케이스(@Test)

클래스에서 Ctrl+Shift+T 를 하면 테스트 클래스를 손쉽게 만들 수 있다 !!

여기서 Create New Test를 클릭해서

JUnit을 선택하고, 클래스명과 원하는 메소드를 선택하면 끝이다!

테스트 케이스는 다음 순서로 작성하는 것을 추천 (/▽＼)
//given : 이러한 데이타가 주어졌을 때
//when : 다음을 실행하면
//then : 이렇게 나와야 한다!

../test/../service/MemberServiceTest.java

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemoryMemberRepository;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

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

class MemberServiceTest {
    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach
    public void beforeEach(){
        //테스트 실행 전마다 리포지토리를 생성해서 MemberService에 넣어준다
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }

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

    @Test
    void 회원가입() {
        //given
        Member member = new Member();
        member.setName("홍길동");

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

        //then
        Member findMember = memberService.findOne(saveId).get();
        assertThat(member.getName()).isEqualTo(findMember.getName());

    }

    @Test
    void 중복_회원_예외(){
        //given
        Member member1 = new Member();
        member1.setName("홍길동");

        Member member2 = new Member();
        member2.setName("홍길동");

        //when
        memberService.join(member1);

        //중복 회원이 join하려 하면 IllegalStateException이 터져야 한다
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

        //then
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

테스트 코드는 한글로 작성하는 경우도 왕왕 있다

Controller와 DB는 다음과 다다음 포스팅에서 다루겠다. (～￣▽￣)～

profile
Jina
이전 포스트

[Spring] 입문-2. 정적 컨텐츠 / MVC와 템플릿엔진 / API

다음 포스트

[Spring] 입문-4. Controller / 스프링 Bean

0개의 댓글