후라이

[Spring Boot] - 스프링 입문 (4) 본문

Spring

[Spring Boot] - 스프링 입문 (4)

힐안 2024. 1. 21. 15:39

 

이번 포스트에서는 회원 관리 시나리오를 통해

백엔드 개발의 전반적인 과제를 알아봅시다.

 


 

* 비즈니스 요구사항 정리

 

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

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

 

 

 

- 컨트롤러 : 웹 MVC의 컨트롤러 역할

- 서비스 : 핵심 비즈니스 로직 구현

- 리포지토리 : 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리

- 도메인 : 비즈니스 도메인 객체 

 


 

 

 

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

 

domain 폴더 -> Member 클래스 만들기

 

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


}

 

 

Repository -> MemberRepository 클래스 만들기

 

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(); //지금까지 저장된 모든 회원을 find
}

 

Member 엔티티를 저장하고 조회하는 기능을 정의한 인터페이스

 

- save(Member member)

회원 정보를 저장하는 메서드

파라미터로 전달된 member 객체를 저장하고 저장된 회원 객체를 반환

 

- findById(Long id) :

주어진 아이디에 해당하는 회원을 찾아 반환

해당하는 회원이 없다면 Optional.empty()를 반환

해당하는 회원이 있으면 Optional<Member>를 반환

 

- findByName(String name) :

주어진 이름에 해당하는 회원을 찾아 반환하는 메서드

해당하는 회원이 없다면 Optional.empty()를 반환

해당하는 회원이 있으면 Optional<Member>를 반환

 

- findAll() :

현재까지 저장된 모든 회원을 리스트 형태로 반환

저장된 회원이 없을 경우 빈 리스트를 반환

 

Repository는

주로 데이터의 저장 및 조회와 관련된 로직을 다룸. 

데이터베이스나 다른 영속적인 저장소에서 데이터를 읽고 쓰는 역할을 수행

 

 

Repository : 데이터베이스와의 상호 작용에 집중

Service : 데이터 조작을 바탕으로 실제 비즈니스 동작을 처리

 


 

 

Repository -> MemoryMemberRepository 클래스 만들기

 

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.stereotype.Repository;

import java.util.*;

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

 

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

 

개발한 기능을 실행해서 테스트 -> 

main 메서드를 실행하거나, 웹 어플리케이션 컨트롤러로 실행하면 시간이 오래 걸리고 반복하기 번거로움

--> JUnit 프레임워크로 테스트를 실행

 

 

Test -> MemoryMemberRepositoryTest 클래스 만들기

 

package hello.hellospring.repository;

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

import java.util.List;
import java.util.Optional;
import static org.assertj.core.api.Assertions.*;

class MemoryMemberRepositoryTest {
    MemoryMemberRepository repository = new MemoryMemberRepository();

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

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

        //when
        repository.save(member);

        //then
        Member result = repository.findById(member.getId()).get();
        Assertions.assertThat(result).isEqualTo(member);
    }

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

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

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

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

    }

    @Test
    public void findAll() {

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

 

 

@AfterEach : 한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있음

-> 다음 테스트가 실패할 수 있는 것을 방지하기 위해 @AfterEach를 사용하여 메모리 DB에 저장된 데이터 삭제

 

테스트는 각각 독립적으로 실행되어야 함

-> 테스트 순서에 의존관계가 있는 것은 좋지 않음

 

 


 

 

3. 회원 서비스 개발

 

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

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

    //private final MemberRepository memberRepository;
    //public MemberService(MemberRepository memberRepository) {
          //this.memberRepositsory = memberRepository
    // }
    /**
     *  회원가입
     */

    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 Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

 

 

4. 회원 서비스 테스트 케이스 작성

 

기존에는 회원 서비스가 메모리 회원 리포지토리를 직접 생성하게 함

public class MemberService {

	private final MemberRepository memberRepository = new MemoryMemberRepository();
    
}

 

회원 서비스 코드를 DI (의존성 주입)가 가능하게 변경

 

public class MemberService {

	private final MemberRepository memberRepository;
    
    public MemberSerive(MemberRepository memberRepository) {
    	this.memgerRepository = memberRepository;
    }
    
	...
    
}

 

회원 서비스 테스트

 

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() {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }

    @AfterEach
    public void afterEach() {
        memberRepository.clearStore();
    }
    @Test
    public void 회원가입() throws Exception {

        //Given
        Member member = new Member();
        member.setName("hello");

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

        //Then
        Member findMember = memberRepository.findById(saveId).get();
        assertEquals(member.getName(), findMember.getName());

    }
    @Test
    public void 중복_회원_예외() throws Exception {
        //Given

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

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

        //When
        memberService.join(member1);
        IllegalStateException e = assertThrows(IllegalStateException.class,()
        -> memberService.join(member2));

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

}

 

@BeforeEach : 각 테스트 실행 전에 호출 -> 테스트가 서로 영향이 없도록 항상 새로운 객체 생성, 의존관계를 새로 맺어