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

섹션4. 회원 관리 예제 - 백엔드 개발

dlng23 2024. 11. 16. 17:02

비즈니스 요구사항 정리

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

 

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

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

 

클래스 의존관계

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

단순한 구현체, 구체적인 기술이 선정된 후, 바꿔 끼우기 위해 인터페이스 정의

 

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

회원 객체

hello.hellospring.domain 패키지 생성 후 Member 클래스 생성

package hello.hellospring.domain;

public class Member {

    private Long id; //데이터 구분 위해 사용, 실제 회원 id X
    private String name; //회원 이름

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }
}

 

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

hello.hellospring.repository 패키지 생성 후 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); //회원(id, name) 저장
    Optional<Member> findById(Long id); //id로 회원 찾기
    Optional<Member> findByName(String name); //name으로 회원 찾기
    List<Member> findAll(); //저장된 모든 회원 리스트 반환
}

반환 값이 null일 경우의 처리 방법으로 Optional 사용

 

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

repository 패키지 안에 MemoryMemberRepository 클래스 생성

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import java.util.*;

/**
 * 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
 */

public class MemoryMemberRepository implements MemberRepository{

    private static Map<Long, Member> store = new HashMap<>(); //key는 회원 id, 값은 Member
    private static long sequence = 0L; //시스템에서의 key값 생성 위함

    @Override
    public Member save(Member member) { 
        member.setId(++sequence); //id 값 1 증가
        store.put(member.getId(), member); // (id, member) map에 넣음
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) { //key가 id인 member 반환
        return Optional.ofNullable(store.get(id)); //null일 경우를 위해 optional로 감쌈
    }

    @Override
    public Optional<Member> findByName(String name) {//루프를 돌면서 파라미터로 넘어온 name과 같은 name을 가진 member 반환
        return store.values().stream()
                .filter(member -> member.getName().equals(name))
                .findAny();
    }

    @Override
    public List<Member> findAll() { //저장된 모든 member 반환
        return new ArrayList<>(store.values());
    }
}

 

 

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

작성한 코드가 정상적으로 돌아가는지 검증하기 위해 테스트 케이스(코드) 작성

 

main 메서드를 통해 실행하거나 웹 애플리케이션의 컨트롤러를 통해 해당 기능을 실행하는 경우

오래 걸리고, 반복 실행하기 어렵고, 여러 테스트를 한번에 실행하기 어려움

→ 자바는 JUnit이라는 프레임워크로 테스트 실행

 

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

src/test/java/hello.hellospring 패키지 안에 repository 패키지 생성 후, MemoryMemberRepositoryTest 클래스 생성

org.juint.jupiter.api 선택

 

MemberRepository의 save 메서드 테스트

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

    repository.save(member);

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

반환 타입이 optional, get으로 꺼낸 후 result로 받음

result가 member와 같은가 해서 test 하면 같을 경우 true 로 나옴

 

Assertions → org.juint.jupiter.api  선택 / assertEquals(expected, actual)

같을 경우 출력되는 값은 없지만 녹색 check 표시 됨

 

다른 값일 경우 오류 

 

Assertions → org.assertj.core.api 선택 

Assertions static import 하면 assertThat 바로 칠 수 있음

 

 

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

        assertThat(result).isEqualTo(member1);
        
    }

"spring1" 과 member1을 비교할 시에는 초록check 표시가 뜨지만

"spring2"로 바꾼 후 비교하면 result가 member2가 되기 때문에 빨간 글(오류)이 나

 

 

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

isEqualto(2) 하면 저장된 Member 수가 2이기때문에 초록 check 표시 뜸

 

2 → 3으로 바꾸면 expected:3 , but was: 2로 빨간 글이 나옴

 

다시 2로 바꾼 후, 

전체 테스트 수행 시

findByName() 오류 발생

테스트 순서 : findAll() →findByName() →save() 순으로 실행되는 것을 볼 수 있음

순서는 보장되지 않음

모든 테스트는 순서랑 상관없이 메소드별로 따로 동작하게 설계해야 함

findAll 이 먼저 실행되면서 spring1, spring2가 이미 저장되었기때문에 오류 발생

 

 

테스트가 끝나면 데이터 clear 해야 함

MemoryMemberRepository에 clearStore()작성

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

@AfterEach : 메서드 실행이 끝날때마다 동작

작성 후, 테스트 돌려보면 문제 없이 동작

 

 

회원 서비스 개발

hello.hellospring 아래에 service 패키지 생성, service 패키지에 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){
        //같은 이름이 있는 중복 회원X
        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);
    }
}

ctrl + shift + alt + T 를 눌러 메서드 추출 가능

서비스 클래스는 네이밍에 있어서 비즈니스에 가까운 용어를 사용

 

회원 서비스 테스트

클래스 내에서 ctrl + shift + T 눌러 테스트 생성 가능

메서드 클릭하면 

src/test/java 아래에 같은 패키지(hello.hellospring.service) 생성 후, 해당 패키지에 테스트 코드 생성 해줌

 

테스트의 경우, 과감하게 한글로 적어도 됨 ( 빌드될 때 실제 코드에 테스트 코드는 포함되지 않음 )

Given When Then : given이 주어졌는데 when을 실행했을 때 then 결과가 나옴

given when then 주석을 가지고 하면 테스트가 길 때 쉽게 파악 가능 

 

@Test
void 회원가입() {
    //given 
    Member member = new Member(); //새로운 Memeber 객체 생성
    member.setName("hello"); //이름을 "hello"로 설정

    //when
    Long saveId = memberService.join(member); //회원가입 수행, 저장된 회원 id 받음

    //then 
    Member findMember = memberService.findOne(saveId).get(); //저장된 회원 ID로 회원 조회, optional에서 객체 꺼냄
    assertThat(member.getName()).isEqualTo(findMember.getName()); //회원가입한 member의 이름과 조회한 findMember의 이름이 같은지 검증
}

 

중복 회원 검증 로직을 타서 예외 발생하는 경우도 확인해야 함

spring이라는 이름을 가진 member1이 먼저 가입되어 있기때문에 중복 회원 예외 발생

 

try-catch 문 외에 다른 방법으로 예외 처리 가능

드래그 후, ctrl + shift + /  → 해당 부분 주석처리

 

() -> memberService.join(member2) 부분에서 IllegalStateException 발생하여, 테스트 성공

 

예외를 IllegalStateException → NullPointException 으로 바꾼 경우 해당 예외가 발생하지 않아 테스트 실패 

예외를 받아서 검증

 

member.setName에 "spring"으로 받으면 중복_회원_예외 test에서 spring으로 가입하기때문에 문제 발생

클리어 해주어야 함 

AfterEach 추가

shift + F10 → 이전에 실행했던 것 그대로 실행해줌

제대로 동작

 

ctrl + B → navigate

MemberService에서 MemoryMemberRepository 새로 생성, Test class에서도 MemoryMemberRepository 생성

다른 객체 → 두 개를 쓸 필요X  (MemoryMemberRepository에서 static으로 되어있기때문에 문제없지만)

static이 아니라면 다른 인스턴스일 경우 저장소, 내용물 달라지기때문에 같은 인스턴스를 사용하도록 바꾸는게 좋음

 

 

MemberService에서  '= new ~ ' 부분 지우고

alt + inset → generate 명령어, constructor 이용하여 외부에서 넣어주도록 바꿈

 

@BeforeEach 사용하여 동작하기 전에 memberRepository, memberService 생성

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

Member Service 입장에서 보면, 직접 new 하지 않고 외부에서 넣어줌 

이것을 Dependece Injection, DI 라고