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

📕 비즈니스 요구사항 정리

데이터 : 회원ID, 이름
기능 : 회원 등록, 조회
✔ 아직 데이터 저장소가 선정되지 않음(가상의 시나리오) -> 어떤 DB를 사용할지 정하지 않았음

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

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

📖 클래스 의존관계

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

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

📖 회원 객체

public class Member {
    private Long id; //임의의 값, 데이터를 구분하기 위해 시스템이 저장하는 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;
    }
}

1. hello.hellospring 아래 domain 패키지를 생성하고 해당 패키지 안에 Member 클래스를 만들었다.
2. 식별자 id와 이름을 만들고 Getter, Setter를 만들었다.
   ✔ Window 단축키 : Alt + Insert

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

public interface MemberRepository {
    Member save(Member member); //회원이 저장소에 저장
    Optional<Member> findById(Long id); //id로 회원 찾기
    Optional<Member> findByName(String name); //name으로 회원 찾기
    List<Member> findAll(); //지금까지 저장된 모든 회원 list 반환
}

1. hello.hellospring 아래 repository 패키지를 생성하고 해당 패키지 안에 MemberRepository Interface를 만들어 작성했다.

🎈 Optional이란?

▪ Optional은 Java8부터 도입된 Null이 올 수 있는 값을 감싸는 Wrapper 클래스로, 참조하더라도 NPE가 발생하지 않도록 도와준다.
▪ NPE는 NullPointerException으로 null 객체 참조에서 메서드를 호출하려고 할 때 발생하는 예외이다.
▪ 비어있는 객체를 반환할 수 있는 상황에서 Optional 객체로 반환값을 래핑해준다면 반환되는 값이 Null일지라도 Optional 객체로 래핑되어 반환되기 때문에 Null로부터 안전해진다. Optional은 클라이언트 코드에게 명시적으로 빈 값일 수도 있다는 것을 알려주고 빈 값에 대한 처리를 강제한다.
▪ 자바에서 제공하는 객체를 Optional 객체로 감싸기 위해서는 Optional에서 제공하는 of와 ofNullable 메서드를 사용한다. of는 인자로서 Null 값을 받지 않는다는 것이고 ofNullable은 Null 값을 허용한다는 것이다.

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

public class MemoryMemberRepository implements MemberRepository {
    private static Map<Long, Member> store = new HashMap<>(); //회원을 저장
    private static long sequence = 0L; //0, 1, 2 등 키 값 생성

    @Override
    public Member save(Member member) {
        member.setId(++sequence); //member id는 시스템이 생성, name은 회원가입 시 입력 받으므로 여기서 지정하지 않음
        store.put(member.getId(), member); //member id와 member를 한 쌍으로 Map으로 선언한 store에 저장
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        return Optional.ofNullable(store.get(id)); //Optional.ofNullable을 통해 반환 값이 null이더라도 클라이언트에서 처리가 가능하도록 함
    }

    @Override
    public Optional<Member> findByName(String name) {
        return store.values().stream()
                .filter(member -> member.getName().equals(name)) //파라미터로 넘어온 name과 member의 name이 같은지 확인
                .findAny(); //findAny는 가장 먼저 탐색되는 요소를 리턴하여 하나라도 반환함. 없을 경우 null이 Optional로 감싸져 반환
    }

    @Override
    public List<Member> findAll() {
        return new ArrayList<>(store.values()); //store member들을 전부 반환
    }
    
    public void clearStore() {
        store.clear();
    }
}

1. repository 패키지 안에 MemoryMemberRepository 클래스를 만들었다.
2. member id는 시스템이 생성하는 거고, name은 회원가입 시 입력을 받으므로 여기서 id만 지정해준다. member id와 member를 한 쌍으로 Map으로 선언한 store에 저장한다.
3. Optional.ofNullable을 통해 반환 값이 null이더라도 클라이언트에서 처리가 가능하도록 한다.
4. 파라미터로 넘어온 name과 member의 name이 같은지 확인하고, findAny를 통해 값을 반환한다. 만약 없을 경우 null이 Optional로 감싸져 반환된다.
5. store member들을 전부 반환한다.

✔ 현재 예제에서는 동시성 문제가 고려되어 있지 않지만 실무에서는 ConcurrentHashMap, AtomicLong 사용을 고려한다.

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

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

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

class MemoryMemberRepositoryTest {
    MemoryMemberRepository repository = new MemoryMemberRepository();

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

    @Test //import org.junit.jupiter.api.Test
    public void save() {
        Member member = new Member(); //새로운 member 생성
        member.setName("spring"); //만든 member의 name을 spring으로 설정

        repository.save(member); //리포지토리에 member 저장

        //만든 member가 제대로 저장되었는지 검증
        Member result = repository.findById(member.getId()).get(); //메모리에 저장된 값을 result로 저장
        assertThat(member).isEqualTo(result); //생성한 member와 result가 같은지 확인 import static org.assertj.core.api.Assertions.*
    }

    @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(); //spring1 이름을 가진 member를 result에 저장
        //Member result = repository.findByName("spring2").get(); //이렇게 작성하면 테스트 실패
        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();
        assertThat(result.size()).isEqualTo(2); //저장된 member의 인원수로 전체 멤버를 제대로 반환했는지 검증
    }
}

1. src/test/java/hello.hellospring 아래 repository 패키지를 생성하고 MemoryMemberRepository 클래스를 만든다.
2. 테스트할 메서드들에 @Test를 붙여서 생성해준다.

🎈 Save

@Test
public void save() {
	Member member = new Member(); //새로운 member 생성
	member.setName("spring"); //만든 member의 name을 spring으로 설정

	repository.save(member); //리포지토리에 member 저장

	//만든 member가 제대로 저장되었는지 검증
	Member result = repository.findById(member.getId()).get(); //메모리에 저장된 값을 result로 저장
    assertThat(member).isEqualTo(result); //생성한 member와 result가 같은지 확인
}

1. 새로운 member를 생성하고 생성한 member의 name을 spring으로 설정한 후 리포지토리에 member를 저장한다.
2. 만든 member가 제대로 저장되었는지 검증하기 위해 메모리에 저장된 값을 result로 저장하고, Assertions의 assertThat을 사용해서 생성한 member와 result가 같은지 확인한다.
   ✔ Alt + Enter 단축키로 static import로 변경할 수 있다

🎈 findByName

@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(); //spring1 이름을 가진 member를 result에 저장
	//Member result = repository.findByName("spring2").get(); //이렇게 작성하면 테스트 실패
	assertThat(result).isEqualTo(member1); //검증
}

1. 새로운 member1을 생성하고 생성한 member의 name을 spring1으로 설정한 후 리포지토리에 member1을 저장한다. 정교한 테스트를 위해 member2도 만들어준다.
   ✔ Alt + F6 단축키로 rename을 할 수 있다
2. spring1 이름을 가진 member를 result에 저장하고, assertThat을 사용해서 검증한다.

🎈 findAll

@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); //저장된 member의 인원수로 전체 멤버를 제대로 반환했는지 검증
}

1. 새로운 member1을 생성하고 생성한 member의 name을 spring1으로 설정한 후 리포지토리에 member1을 저장하고, List 개수를 확인하기 위해 member2도 만들어준다.
2. assertThat에서 저장된 member의 인원수로 전체 멤버를 제대로 반환했는지 검증한다.

이렇게 3개의 테스트 코드를 작성하고서 class에서 테스트를 실행하게 되면 findByName()에서 에러가 발생한다. 그 이유는 findAll()이 먼저 실행되었기 때문에 이미 member1과 member2에 값이 저장되었기 때문이다.
✔ 모든 테스트는 순서와 상관없이 메서드 별로 독립적으로 실행되어야 한다.

🎈 @AfterEach

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

한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 이렇게 되면 다음 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다. @AfterEach를 사용하면 각 테스트가 종료될 때마다 이 기능을 실행한다. 여기서는 메모리 DB에 저장된 데이터를 삭제한다.

🎈 테스트 주도 개발(TDD)

현재는 MemoryMemberRepository 개발 완료 후 테스트 클래스를 작성했지만 반대로 테스트 클래스를 먼저 작성하고 개발 클래스를 작성하는 방법이 있는데 이를 테스트 주도 개발(TDD)라고 한다.

📗 회원 서비스 개발

서비스 클래스는 비즈니스에 가까운 이름을 사용해야 한다. 서비스는 비즈니스에 의존적으로 설계하고, 리포지토리는 기계적으로 개발자스럽게 이름을 붙인다.

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()) //findByName 메서드는 Optional로 반환되기 때문에 바로 ifPresent를 사용할 수 있음
                .ifPresent(m -> { //ifPresent는 값을 가지고 있으면 실행하고, 값이 없으면 넘어감
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });
    }

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

    //회원 한 명 조회
    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

1. src/main/java/hello.hellospring 아래 service 패키지를 생성하고 MemberService 클래스를 만든다.
2. 비즈니스 로직에서 같은 이름을 가진 중복 회원은 없어야 하기 때문에 validateDuplicateMember를 만들어서 중복 회원을 검증한다.
   ✔ Window 변수 추출 단축키 : Ctrl + Alt + V
3. findByName 메서드는 Optional로 반환되기 때문에 바로 ifPresent를 사용할 수 있다. ifPresent 메서드는 값을 가지고 있으면 실행하고, 값이 없으면 넘어간다.

📘 회원 서비스 테스트

테스트 케이스 메서드명은 한글로 작성하는 경우도 종종 있다. 직관적이고, 빌드될 때 Test 코드는 실제 코드에 포함되지 않기 때문이다.

테스트는 대부분 무언가가 주어졌는데(given), 이것을 실행했을 때(when), 결과가 이게 나와야해(then) 라는 구조로 나뉘어지기 때문에 주석으로 given, when, then을 적어두고 해당하는 코드를 작성하는 것이 좋다.

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();
        assertEquals(member.getName(), 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("이미 존재하는 회원입니다."); //에러 메시지로 상태 검증
    }
}

✔ Window 테스트 클래스 자동 생성 단축키 : Ctrl + Shift + T
✔ Window 이전 실행한 코드 다시 실행 단축키 : Shift + F10

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

public class MemberServiceTest {
  MemberService memberService = new MemberService;
  MemberRepository memberRepository = new MemoryMemberRepository();
}

▪ 위의 코드에서 문제는 MemberService에서 생성한 memberRepository와 테스트 케이스에서 만든 memberRepository가 서로 다른 인스턴스라는 것이다.
▪ 지금 상황에선 문제가 되지 않는다고 해도 memberRepository의 store 객체가 static 필드가 아니게 되면 DB가 다른 DB가 되면서 문제가 생길 것이다. 그뿐만 아니라 같은 리포지토리로 테스트하는 것이 맞는데 다른 리포지토리로 테스트되고 있다. 그래서 같은 인스턴스를 사용하도록 바꿔야 한다.
▪ MemberRepository를 MemberService에서 직접 생성하는 것이 아니라 생성자 파라미터를 통해 외부로부터 주입받도록 바꿔준다. 이런 것을 의존성 주입(DI)이라고 한다.

public class MemberService {
  private final MemberRepository memberRepository;

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

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

@BeforeEach : 각 테스트 실행 전에 호출된다. 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어준다.
의존성 주입(DI) : 클래스 간 의존관계를 관리하고 있는 Bean 중에서 필요한 것을 컨테이너가 자동으로 주입해 주는 것을 말한다. 즉, 어떤 객체가 사용하는 의존 객체를 직접 만들어서 사용하는 게 아니라, 주입받아서 사용하는 방법을 말한다.

📚 참고자료

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술