<스프링입문>03. 회원 관리 예제 - 백엔드 개발

📌 요약

🔗 1. 비즈니스 요구사항 정리

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

리포지토리
회원 도메인과 도메인 객체를 저장하고 불러올 수 있는 저장소

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

테스트 케이스
회원 리포지토리가 정상동작하는지 테스트

🔗 4. 회원 서비스 개발

실제 비지니스 로직이 있는 회원 서비스 개발

🔗 5. 회원 서비스 테스트

정상동작하는지 테스트
🔸 테스트는 JUnit이라는 테스트 프레임워크로 만들 것

💡 단축키

• ctrl+shift+enter : 자동완성

• ctrl+alt+v : 변수 추출
• ctrl+shift+alt+t : extract method
• alt_enter: statc import (Assertions에서 사용)

ㄴ단축키 안 될 경우 윈도우 한글입력방법 전환

윈도우 오른쪽 하단의 "한" 아이콘 클릭 후 Microsoft 입력기 선택

📌 비즈니스 요구사항 정리

🔅 아직 데이터 저장소가 선정되지 않았다고 가정 > spring의 특성을 잘 설명하기 위해

1. 비즈니스 요구사항

🔸 데이터: 회원ID, 이름
🔸 기능: 회원 등록, 조회

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

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

3. 클래스 의존관계

🔸 회원 비지니스 로직: MemberService
🔸 회원 리포지토리: MemberRepository. interface로 설계 < 저장소가 없기 때문
🔸 MemoryMemberRepositoty: MemberRepository는 메모리 구현체로 만듬

💡 아직 데이터 저장소가 선정되지 않아, 인터페이스로 구현 클래스를 변경할 수 있도록 설계
💡 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용

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

1. 회원 객체 class 생성

main/.../hello.hellospring/domain/Member
hello.hellospring 아래에 domain 이름의 package 생성 + domain 아래에 Member 이름의 class 생성
🔸 요구사항에 존재한 ID와 name 데이터를 private으로 생성
ID는 고객이 정하는 ID가 아닌, system이 data를 구분하기 위해 저장하는 임의의 값
name은 고객이 정한 값
🔸 Getter, setter 생성

🏅 최종 코드_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;
    }
}

2. 회원 리포지토리 인터페이스 생성

main/.../hello.hellospring/repository/MemberRepository
hello.hellospring 아래에 repository 이름의 package 생성 + repository 아래에 MemberRepository 이름의 interface 생성

🔸 repository: 회원 객체를 저장하는 저장소

repository의 기능 save findById findByName findAll

• Save : 회원이 저장소에 저장
• FindById : Id로 회원 찾기
• FindByName : 이름으로 회원 찾기
• FindAll : 모든 회원 리스트 반환

🔸 Optional: Java8에 들어간 기능 모든 값을 optional로 감싸서 반환. null일 경우 null 그대로 반환하지 않고 optional로 감싸서 반환

🏅 최종 코드_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();
}

3. 회원 리포지토리 메모리 구현체 생성

main/.../repository/MemoryMemberRepository
repository 아래에 MemoryMemberRepository 이름의 class 생성

class 기본

🔸 방금 만든 MemberRepository implements -> ctrl+I 단축키 사용해 가능한 메서드 모두 구현
🔸 Map을 통해 key는 Id이므로 Long, value값으로 member 코드 작성 후 ctrl+space 단축키로 Map import
🔸 sequence는 0,1,2 등 key값 생성

class 내 함수

🔸 save 함수
1) member의 Id 값(=sequence 값) 세팅
2) store에 저장=>Map에 저장
3) 결과인 member 반환

    public Member save(Member member) {
        member.setId(++sequence);
        store.put(member.getId(), member);
        return member;
    }

🔸 findById 함수
1) store에서 id값을 넣고 get으로 반환
2) Optional.ofNullable로 감쌈 => null이어도 감싸며 client에서 특정 기능 가능(추후에 배움)

    public Optional<Member> findById(Long id) {
        return Optional.ofNullable(store.get(id));
    }

🔸 findByname 함수
1) lambda 사용
2) stream으로 Map에서 loop 돌려서 member.getName()이 들어온 name과 같을 경우 반환
3) findAny()로 있을 경우 Optional로 반환

    public Optional<Member> findByName(String name) {
        return store.values().stream()
                .filter(member -> member.getName().equals(name))
                .findAny();
    }

🔸 findAll 함수
1) Map을 List로 변환하기 위해 new ArrayList<> 사용
2) store.values() 반환
💡 실무에서 자바로 list 많이 사용

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

🏅 최종 코드_MemoryMemberRepository

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

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

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

1. 테스트 케이스 개발

test/.../hello.hellospring/repository/MemoryMemberRepositoryTest
test/java/hello.hellospring 아래에 repository 이름의 package 생성 + repository 아래에 MemoryMemberRepositoryTest 이름의 class 생성

🔸 굳이 public으로 안 해도 됨
🔸 @Test 후에 테스트하고자하는 함수 작성

2. 테스트 함수

save + findById

🔸 findById는 반환 타입이 Optional이므로 .get()으로 바로 가져와도됨. 좋지 않은 코드지만 테스트에서는 사용 가능
🔸 검증
Assertions.assertThat(member).isEqualTo(result)로 같은 지 확인 가능(이 때 Assertions는 org.assertj.core.api.Assertions 사용)

    public void save()  {
        Member member = new Member();
        member.setName("spring");

        repository.save(member);

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

findByName

💡 shift+F6 단축키 : rename, 변수명 바꿈

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

        Assertions.assertThat(result).isEqualTo(member1);
    }

findAll

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

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

🌟 전체 코드 실행 시 오류 발생

테스트 케이스는 순서 상관 없이, 의존 관계 없이 설계되어야 함
💡 테스트가 끝날 때마다 repository와 공용 데이터를 비우는 작업 필수

🔸 main/.../repository//MemoryMemberRepository 에 코드 추가

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

🔸 test/.../repository/MemoryMemberRepositoryTest 에 코드 추가

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

🏅 최종 코드_MemoryMemberRepository

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

🏅 최종 코드_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;

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

        Member result = repository.findById(member.getId()).get();
        Assertions.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();

        Assertions.assertThat(result).isEqualTo(member1);
    }

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

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

}

💡 테스트 주도 개발 (TDD)
: 테스트 케이스를 먼저 만들고 구현 클래스를 만들어 돌리는 방식
위에서 진행한 방식은 테스트 주도 개발이 아님. 구현 클래스 생성 후 테스트 케이스 생성

📌 회원 서비스 개발

💡 회원 서비스
회원도메인과 리포지토리를 활용하여 실제 비지니스 로직을 작성하는 단계
함수명도 비지니스 로직에 맞게 작성

1. 회원 서비스 개발

main/.../hello.hellospring/service/MemberService
hello.hellospring 아래에 service라는 package 생성 + service 아래에 MemberService 이름의 class 생성

2. 회원 서비스 함수

회원가입

🔸 ifPresent : 이미 값이 존재하면 로직에 의해 동작, optional이라 가능

    #1
    Optional<Member> result = memberRepository.findByName(member.getName());
    result.ifPresent(m -> {
        throw new IllegalStateException("이미 존재하는 회원입니다");
    });
    
    #2
    memberRepository.findByName(member.getName())
            .ifPresent(m -> {
                throw new IllegalStateException("이미 존재하는 회원입니다");
            });

🔸 두 코드는 같은 같은 의미
💡 2번 코드와 같이 로직이 있을 경우 ctrl+shift+alt+t 단축키 사용해 method를 빼는 것이 좋음

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

Id로 찾기

    public Optional<Member>  findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }

🏅 최종 코드_MemberService

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

📌 회원 서비스 테스트

위에서 작성한 MemberService 클래스 테스트

1. 회원 서비스 테스트 개발

💡 위에서 작성한 MemberService 클래스에서 단축키 ctrl+shift+t 사용
Testing library는 JUnit5, Generate test methods for은 모두 선택

자동으로 test/.../hello.hellospring/service/MemberServiceTest 생성

2. 회원 서비스 테스트 코드 작성

💡 Test 함수는 한글로 바꿔도 됨
💡 given-when-then을 생각하며 작성
given - 기반으로 하는 data
when - 검증하는 것
then - 검증 결과

회원가입

🔸 Assertions는 assertj 꺼 사용. alt_enter 단축키 사용해 statc import 실행

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

🌟 1. 예외처리가 중요> when 파트

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

🔸 try-catch(#1)보다 assertThrows(#2)가 더 좋은 문법
두번째 파라미터에 존재하는 lambda가 실행될 때, IllegalStateException 발생해야함
Ex) IllegalStateException 대신 NullPointerException으로 변경할 경우 오류문이 맞지 않아 오류 발생

#2
        //when
        memberService.join(member1);
        assertThrows(IllegalStateException.class, () -> memberService.join(member2));

🌟 1_1. 검증

🔸 ctrl+alt+v 단축키 사용해 error message 받고 검증

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

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

🌟 2. repository clean해줘야함

🔸 MemoryMemberRepository 객체 생성
🔸 clearStore() 사용

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

2_1. 🌟 위 코드의 경우 리포지토리가 Test와 Service에서 각각 생성되어 다른 리포지토리가 됨

🔸 @BeforeEach사용해 테스트 코드 실행 전에 repository 초기화

💡 Dependent Injection(DI) 사용하여 코드 변경
🔸 MemberService

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

🔸 MemberServiceTest

    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach
    public void beforeEach()    {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }

🏅 최종 코드_MemberService

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;

    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())
                .ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다");
                });
    }

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

    public Optional<Member>  findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

🏅 최종 코드_MemberServiceTest

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 java.util.Optional;

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
    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 중복_회원_예외()  {
        //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("이미 존재하는 회원입니다");
        /**

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

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}