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

김영한 스프링 입문 강의 정리

[무료] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 - 인프런 | 강의

목차

• 비즈니스 요구사항 정리
• 회원 도메인과 리포지토리 만들기
• 회원 리포지토리 테스트 케이스 작성
• 회원 서비스 개발
• 회원 서비스 테스트

 

비즈니스 요구사항 정리

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

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

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

클래스 의존 관계

• 아직 데이터 저장소가 선정되지 않아 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계
• 데이터 저장소는 RDB, NoSQL 등등 다양한 저장소를 고민중인 상황으로 가정
• 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용
• 회원 비즈니스 로직에는 MemberService가 있다.
• MemberRepository, 회원 저장은 Interface로 설계
• 우선 구현체를 단순한 메모리 구현체로 만들것이다.
• 향후 DB의 구체적인 기술이 선정되면 바꿔끼우기 위해 interface가 필요한 것이다.

 

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

회원 객체

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

• Alt + Insert 키로 getter와 setter 쉽게 구현 가능
• long이 아닌 Long -> null값 가능

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

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

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

인터페이스 구현체

인터페이스엔 메서드 이름만 작성
이후 상속받을 클래스에서 내용 채운다.

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

• Optional

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

개발한 기능 테스트 시, 자바의 main 메서드를 통해 실행하거나, 웹 애플리케이션의 컨트롤러 통해서 해당 기능 실행한다.

단점

• 준비하고 실행하는데 오래걸림
• 반복 실행 어려움
• 여러 테슽트 한 번에 실행하기 어려움

자바는 JUnit이라는 프레임워크로 테스트를 실행해 이러한 문제를 해결한다.

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

'src/test/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.*;

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();
        // System.out.println("result = " + (result == member));
        // Assertions.assertEquals(member, result);
        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(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);
    }
}

• 메서드 테스트를 한 번에 실행시킬 때, 테스트 순서는 보장되지 않는다. -> 테스트는 서로 의존 관계 없이 설계되어야 한다.
  따라서 테스트 순서에 의해 생기는 오류를 방지하기 위해서, 한 메서드의 테스트가 끝나면 레포지토리를 깔끔하게 지워줘야 한다. -> afterEach
• AssertThat 오류 해결
  https://www.inflearn.com/questions/327686
• TDD (테스트 주도 개발)
  만들려고 하는 것의 검증할 수 있는 틀을 미리 만들어둔다.
  작품 완성 후 이 틀에 들어가는지 확인을 해본다.

테스트 성공 화면

테스트 실패 화면

 

회원 서비스 개발

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) {
        // 같은 이름이 있는 중복 회원 불가
        // ifPresent : null이 아니라 값이 있다면
        // get() || orElseGet() 방법도 가능
        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);
    }

}

• Extract Method (Ctrl + Alt + M)
  • 메서드를 추출할 때 사용
  • 그룹으로 함께 묶을 수 있는 코드조각이 있으면,
    코드의 목적이 잘 들어나도록 이름을지어 별도의 메소드로 뽑아내는 방법

 

회원 서비스 테스트

단축키 : Alt + Enter -> Create Test

• 테스트코드에서 메서드 이름을 '회원가입'과 같이 한글로 작성해도 된다.
• static import (Alt + Enter)

DI (Dependency Injection)

객체를 직접 생성하는 것이 아니고, 외부에서 생성 후 주입시켜주는 방식

// Test Code
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.assertThrows;

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

// MemberService.java
package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;

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) {
        // 같은 이름이 있는 중복 회원 불가
        // ifPresent : null이 아니라 값이 있다면
        // get() || orElseGet() 방법도 가능
        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);
    }

}