[SPRING]스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 섹션3 (회원 관리 예제 - 백엔드 개발)

💡비즈니스 요구사항 정리

데이터: 회원ID, 이름
기능: 회원 등록, 조회
아직 데이터 저장소가 선정되지 않음(가상의 시나리오) --> 데이터베이스로 할지 No SQL로 할지 이런게 아직 안 정해진 상황

💻웹 애플리케이션 계층 구조

 컨트롤러: 웹 MVC의 컨트롤러 역할과 API를 만드는 컨트롤러 역할을 한다.
서비스: 핵심 비즈니스 로직이 들어가 있어, 회원은 중복 가입이 안된다 등의 대한 로직들이다.
도메인: 데이터베이스에 주로 저장하고 관리되는 비즈니스 도메인 객체이다.
리포지토리: 비즈니스 도메인 객체를 가지고 핵심 비즈니스가 동작하도록 구현한 객체이다. 도메인 객체를 DB에 저장하고 관리
 
일반적인 계층형 구조를 따라간다.
 

💻클래스 의존관계

회원비즈니스 로직에는 회원서비스(MemberService)가 있고, 회원 리포지토리 회원을 저장하는 것은 인터페이스로 설계를 할 것이다. 아직 데이터 저장소가 선정되지 않았기 때문에, 우선 간단하게 메모리를 저장을 한 후에, 나중에 데이터 저장소 (DB)가 선정되면 메모리에 저장된 데이터를 DB로 바꿔주어야 하기 때문에 인터페이스(interface)로 설계한다.
 

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

💻 회원 객체

main/java/hello.hellospring 폴더에 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;
    }
}

회원 ID와 이름에 대한 getter setter를 만들어주었다.
 

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

위 경로에 repository 패키지와 MemberRepository 인터페이스를 만들어준다.
인터페이스는 DB연결을 위한 것이다.
 

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

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

public interface MemberRepository {
    Member save(Member member); //회원이 저장됨
    //첫 번째 Member는 메서드의 반환 타입을 나타내며, 이 경우 save 메서드가 호출되면 Member 객체를 반환합니다.
    // 두 번째 Member는 메서드의 매개변수 타입을 나타내며, member라는 이름의 Member 객체를 매개변수로 받아 메서드를 호출할 수 있음을 의미
    Optional<Member> findById(Long id); //findById, findByName으로 가져오는 값이 null일 수 있음.
    //요즘에는 null을 처리하는 방법에서 null을 그대로 반환하는 방법 대신 Optional 이라는 걸로 감싸서 반환하는 방법을 많이 선호
    Optional<Member> findByName(String name);
    List<Member> findAll(); //지금까지 저장된 모든 회원들의 리스트를 반환

 
요즘에는 null을 처리하는 방법에서 null을 그대로 반환하는 방법 대신 Optional 이라는 걸로 감싸서 반환하는 방법을 많이 선호한다고 한다.
 

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

위에서 만들었던 MemberRepository 인터페이스가 있는 repository 패키지 안에 MemoryMemberRepository 클래스를 만들어준다. 여기선 MemberRepository interface를 구현하기 위한 implements 메서드를 생성할 것이다.
 

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<>();
    //Long 타입의 키와 Member 객체를 값으로 가지는 HashMap 객체로 초기화
    private static long sequence = 0L;

    @Override
    public Member save(Member member) {
        member.setId(++sequence);
        store.put(member.getId(), member);
        //member 객체의 id를 키로 사용하고, member 객체 자체를 값으로 저장합니다.
        // 이렇게 하면 id를 사용하여 회원을 조회할 수 있게 됩니다.
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        return Optional.ofNullable(store.get(id)); //null이어도 감쌀 수 있음
    }

    @Override
    public Optional<Member> findByName(String name) {
        return store.values().stream()
                .filter(member -> member.getName().equals(name))
                .findAny();
    }
    //스트림을 통해 맵에 저장된 모든 Member 객체에 접근
    //스트림의 filter 메서드를 사용하여 조건을 만족하는 요소만 남깁니다. 여기서는 회원의 이름이 주어진 name과 동일한 경우만을 필터링
    //Optional로 'name'과 일치하는 회원을 못찾았을 때엔 빈 'Optional'반환
    //.findAny(): 필터링된 요소 중 하나를 찾음

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

코드 주석을 참고해주길 바란다.
 

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

위에서 만든 MemoryMemberRepository가 정상적으로 잘 돌아가는지 검증하기 위해 테스트 케이스를 작성한다.
자바의 JUnit이라는 프레임워크로 테스트를 실행한다.

위 경로에 repository패키지와 MemoryMemberRepositoryTest 클래스를 만들어준다.

package hello.hellospring.repository;

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

import java.util.List;

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

class MemoryMemberRepositoryTest { // 굳이 public 으로 할 필요없어서 지움

    // Test를 하기 위한 저장소
    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();
        //Assertions.assertEquals(member, result); //기대하는 것(expected), actual 순
        //result랑 member랑 똑같은지 확인해 볼 수 있음
        assertThat(member).isEqualTo(result);
    }

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

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

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

        assertThat(member1).isEqualTo(result);
    }

    @Test
    public void findAll(){
        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);
    }
}

각자 메서드가 정상적으로 작동이 되는지 확인하기 위해 save, findByName, findAll Test 코드를 작성해주었다.

모든 메소드들에 대해 Test를 한꺼번에 실행하고 싶다면 class 옆에 run 버튼을 누르거나,

hello.hellospring에 대해 Run을 돌려주면 된다.
 
위에 있는 AfterEach는 매우 중요한데, 만약 AfterEach가 없다면 

run을 했을 때 위와같은 에러가 발생한다.
이는 findAll과 findByName에서 모두 똑같은 member1과 member2 객체가 둘 다 생성 되었기 때문에, 무엇이 먼저 실행되었냐에 따라 에러가 발생한다.
 
하지만 AfterEach메서드를 만들어주면, 메서드 실행이 끝날 때마다 저장소의 내용들을 모두 삭제해줄 수 있다.

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

-> Test에 있는 MemoryMemberRepository에서.

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

-> main에 있는 MemoryMemberRepository에서.
 
테스트 클래스를 먼저 작성한 다음에 멤버 리포지토리를 작성할 수도 있다.
TDD(테스트 주도 개발): 틀을 먼저 만드는 것으로, 테스트를 먼저 만들고 구형 클래스를 만들어서 돌려보는 것을 의미한다.
 

💡회원 서비스 개발

회원 서비스는 이전에 만들었던 회원 domain과 repository를 활용하여 실제 비즈니스 로직을 작성하는 것이다.

위와 같은 경로에 service라는 패키지와 MemberService라는 class를 만들어주었다.

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
//        Optional<Member> result = memberRepository.findByName(member.getName());
//        result.ifPresent(m -> {
//            throw new IllegalStateException("이미 존재하는 회원입니다.");
//        });

        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 메서드를 작성하면서, 중복 회원 검증을 하는 메서드를 새로 만들어 주었고,
이어서 전체 회원을 조회하는 findMembers메서드와
id로 회원을 조회하는 findOne메서드를 만들어주었다.
 

💡회원 서비스 테스트

MemberService 파일에서 Generate -> Test를 누르면

위 경로에 자동으로 MemberServiceTest가 생긴다.

package hello.hellospring.service;

import org.junit.jupiter.api.Test;

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

class MemberServiceTest {

    @Test
    void join() {
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

-> 위와 같은 코드들이 자동으로 생성
 

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.Assertions;
import org.junit.jupiter.api.Test;

import java.util.Optional;

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

class MemberServiceTest {

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

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

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

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

        //then
        Member findMember = memberService.findOne(saveId).get();
        //memberRepository에서 가져와서 비교해야되니까 간단한 findOne으로 객체 가져옴
        // 회원가입한 member의 id가 저장소에 있으면, 해당 member 객체를 findMember로
        assertThat(member.getName()).isEqualTo(findMember.getName());
    }

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

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

        //when
        memberService.join(member1);
//        try{
//            memberService.join(member2); //validate에서 걸려서 예외가 터짐
//            fail();
//        } catch (IllegalStateException e){
//            assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
//        }
        //try catch문은 번거로움

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

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

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

회원가입 test 코드와 중복 회원 예외 test코드도 작성해주었다.
저장소에 중복된 회원이 있을 경우 위 코드에 따라 정상적으로 예외 처리가 된다.
 

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

@AfterEach // 메서드 실행이 끝날 때마다 실행됨
public void afterEach() {
	memberRepository.clearStore(); // 저장소 내용 다 지움
}

이번에도 저번처럼 각 메서드의 실행이 끝날 때마다 저장소에 있는 내용을 지워준다.
 
🚨 🚨 🚨 그러나 회원 리포지토리 테스트 케이스 처럼 memberRepository의 내용을 지우면 문제가 발생할 수 있다.
왜냐하면 memberService 객체가 아닌 새로운 memberRepository 저장소 객체를 만들었기 때문이다. 그래서 다른 내용을 지울 수 있는 위험이 있기 때문에 위에 방법이 아닌 다른 방법으로 clearStore() 를 해야한다.
지금은 MemoryMemberRepository 저장소가 static이라서 문제는 없지만, 혹시라도 static이 아닌 경우 서비스의 저장소가 아닌 다른 저장소를 처리하게 되는 문제가 발생하게 된다. (출처: easylog)

private static Map<Long, Member> store = new HashMap<>();

 
 

💡회원 서비스 테스트 - clearStore, DI

위와 같은 문제를 해결하기 위해선 MemberService에 memberRepository를 외부에서 넣어주도록 변경하면 된다.
 
src/main/java/hello.hellospring/service/MemberService 파일에서의 수정

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

 
src/test/java/hello.hellospring/service/MemberServiceTest 파일에서의 수정

MemberService memberService;
MemoryMemberRepository memberRepository;

@BeforeEach // 메서드 시작되기 전
public void beforeEach() {
	memberRepository = new MemoryMemberRepository();
	memberService = new MemberService(memberRepository);
}

@AfterEach // 메서드 시작된 후
public void afterEach() {
	memberRepository.clearStore();
}

 
이러면 이제 같은 memberRepository가 생성이 되고, 메서드가 끝나면 memberRepository를 clear 하게 된다.
이를 DI(Dependency Injection)이라고 한다.