[Spring Boot][1] 3. 회원 관리 예제 - 백엔드 개발

🏷 비즈니스 요구사항 정리

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

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

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

✔️ 클래스 의존 관계

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

---

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

회원 객체
✔️ src/main/java/hello.hellospring/domain/Member.java

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

회원 리포지토리 인터페이스
✔️ src/main/java/hello.hellospring/repository/MemberRepository.java

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.List;
import java.util.Optional;
//4가지 기능 만들기
public interface MemberRepository {
    //회원 저장
    Member save(Member member);
    //아이디로 회원 찾기
    Optional<Member> findById(Long id);
    //이름으로 이름 찾기
    Optional<Member> findByName(String name);
    //지금까지 저장된 모든 회원 리스트를 반환해줌
    List<Member> findAll();
}

💡 option + Ènter 누르고 Implement interface 누르면 인터페이스 한번에 추가가 가능하다.

✔️ src/main/java/hello.hellospring/repository/MemoryMemberRepository.java

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import java.util.*;

public class MemoryMemberRepository implements  MemberRepository{
    // 옵션+엔터 -> Implement method
    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) {
        // 스토어에서 꺼낸다
        // 이 결과가 없으면 NULL이 되기 때문에 이 경우를 고려해 Optional.ofNullable 사용
        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();
    }
}

Optional.ofNullable : 결과값으로 Null이 반환될 때를 처리해주기 위함

---

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

과연 내가 작성한 회원 리포지토리 클래스가 정상적으로 작동할까? 할 때 사용하는 것이 바로 테스트 케이스 !!!!!

• 개발한 기능을 실행해서 테스트 할 때 자바의 main 메서드를 통해서 실행하거나, 웹 애플리케이션의 컨트롤러를 통해서 해당 기능을 실행한다.
• 이러한 방법은 준비하고 실행하는데 오래 걸리고, 반복 실행하기 어렵고 여러 테스트를 한번에 실행하기 어렵다는 단점이 있다.
• 자바는 JUnit이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다.
  
  

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

✔️ src/test/java/hello.hellospring/repository/MemoryMemberRepositoryTest.java

package hello.hellospring.repository;

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

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

public class MemoryMemberRepositoryTest {
    MemberRepository repository = new MemoryMemberRepository();

    @Test
    public void save() {
        Member member = new Member();
        member.setName("Spring");
        // 리포지토리에 저장
        repository.save(member);

        // Optional 에서 값을 꺼낼 때 get()을 사용할 수 있음
        Member result = repository.findById(member.getId()).get();

        // 검증1 (글자로 뜸)
        //System.out.println("result = "+(result == member));
        // 검증2
        //Assertions.assertEquals(member, result);
        // 검증3 (요즘에 많이 사용)
        assertThat(member).isEqualTo(result);
    }
}

테스트가 잘 된 경우, 👇🏻아래와 같이👇🏻 녹색 불이 뜬다

(null값을 넣어서) 테스트에 실패한 경우, 👇🏻아래와 같이👇🏻 빨간색 불이 뜬다

+)💡 테스트 할 때 @Test 작성 후 위 사진처럼 Test org.junit.jupiter.api 를 import 해준다

✔️ src/test/java/hello.hellospring/repository/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.*;

public 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);

        // Optional 에서 값을 꺼낼 때 get()을 사용할 수 있음
        Member result = repository.findById(member.getId()).get();

        // 검증1 (글자로 뜸)
        //System.out.println("result = "+(result == member));
        // 검증2
        //Assertions.assertEquals(member, result);
        // 검증3 (요즘에 많이 사용)
        assertThat(member).isEqualTo(result);
    }

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

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

        //then
        //사이즈는 두개가 나와야한다.
        assertThat(result.size()).isEqualTo(2);
    }
}

전체를 한번에 테스트 할 때, 실행순서 때문에 오류가 발생할 수 있는데 이를 방지하기 위해 쓰는 방법이 있다! 🌟중요🌟

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

하나의 테스트가 끝날 때마다 리포지토리를 깔끔하게 비워주는 역할

• @AfterEach : 한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 이렇게 되면 다음 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다.
• @AfterEach 를 사용하면 각 테스트가 종료될 때 마다 이 기능을 실행한다. 여기서는 메모리 DB에 저장된 데이터를 삭제한다.
• 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다.

---

🏷 회원 서비스 개발

회원 서비스는 회원 리포지토리와 도메인을 활용하여 실제 비즈니스 로직을 작성하는 부분!

✔️ src/test/java/hello.hellospring/service/MemberService.java

package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;

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

    // 회원가입
    public Long join(Member member) {
        // 중복 회원 검사
        **memberRepository.findByName(member.getName())
                .ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });**
        
        memberRepository.save(member);
        return member.getId();
    }
}

위의 findByName 과 같이 로직이 쭉 나오는 경우라면, 메소드로 따로 빼는 것이 좋다!
control+t 를 누르면 리팩토링 관련한 다양한 팁들이 보인다!

✔️ src/test/java/hello.hellospring/service/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) {
        //중복 회원 검증 필요
        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);
    }
}

---

🏷 회원 서비스 테스트

💡 테스트 하려는 파일의 클래스명에서 command + shift + T 단축키를 누르면 자동으로 쉽게! 테스트 파일을 만들 수 있다.

✔️ src/main/test/hello.hellospring/service/MemberServiceTest.java

class MemberServiceTest {
    MemberService memberService = new MemberService();

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

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

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

• 실행시 정상적으로 잘 동작한다. 하지만, 이 코드는 너무 단순하고, 실제 테스트에서는 정상플로우 보다 예외플로우가 훨씬 더 중요함!
  
  

✔️ src/main/test/hello.hellospring/service/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.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();
    }

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

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

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

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

        Member member2 = new Member();
        //이름을 member1과 똑같이 설정해줌
        member1.setName("spring");

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

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

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

✔️ src/main/java/hello.hellospring/service/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();

    private final MemberRepository memberRepository;

    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    .
    .
    .
    .
    .
    이후 동일)

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

---

🤦🏻‍♀️ ...............
이제 정말 조금씩 어려워 지는 것 같다.............망했다ㅎㅋㅎㅋ
자바 문법도 틈틈히 익히면서 수강해야겠다...!