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

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

데이터 : ID, name

기능 : 등록 및 조회

전제 : DB는 설정되지 않음.

 

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

 

1. 컨트롤러 : 웹 MVC의 컨트롤러 역할

2. 서비스 : 핵심 비즈니스 로직 구현

3. 리포지토리 : DB에 접근, 도메인 객체를 DB에 저장 및 관리

4. 도메인 : 비즈니스 도메인 객체

ex) 회원, 주문, 쿠폰 등등 주로 DB에 저장하고 관리됨.

 

 

 

- 클래스 의존관계

 

- DB가 선정되지 않은 상황이라 우선 인터페이스로 구현 클래스를 변경할수 있도록 설계

- 데이터 저장소(DB)는 RDB, NoSQL 등등 다양한 저장소가 있지만 고민중인 상황

- 개발진행을 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용

 

2. 회원 도메인과 Repository 생성

- 회원 객체(도메인) 생성

package kdo6301.spring0.domain;

public class Member {

    private Long id;
    private String name;

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

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

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

}

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

 

저장하기 위한 save 메소드, 검색을 위한 findBy 메소드 선언

package kdo6301.spring0.repository;

import kdo6301.spring0.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();
}

❗️ Optional이란?

개발을 할 때 가장 많이 발생하는 예외 중 하나인 Null Pointer Exception ( NPE ) 를 피하기 위해 사용하는 문법

Optional <T> 는 null값이 올 수 있는 값을 감싸는 Wrapper 클래스로 , null이 발생 하더라도 NPE가 발생하지 않도록 도와준다.

 

 

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

 

package kdo6301.spring0.repository;

import kdo6301.spring0.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) {
    	// store에 해당하는 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();
    }
}

- Map Collection

/ key, value를 쌍으로 구성되는 요소를 다루는 컬렉션

/ key를 통해 value를 얻어낸다.

/ 삽입 : get() 메소드

/ 검색 : put() 메소드

 

- ArrayList Collection

/ C++의 vector와 같이 배열의 크기가 가변적으로 변함

 

 

- HashMap Collection

/ Map Collection class에 속하는 클래스 

/ HashMap은 Map을 구현한다. key와 value를 묶어 하나의 entry로 저장한다는 특징을 가짐

/ 마찬가지로 key와 value의 쌍으로 구성되는 요소를 다루는 컬렉션

/ 마찬가지로 value를 검색하기 위해서 key를 이용

/ 삽입 : get() 메소드

/ 검색 : put() 메소드

/ 해시 알고리즘(hash algorithm)을 사용하여 많은 양의 데이터를 검색하는데 검색 속도가 매우 빠르다.

 

 

- ofNullable() method

of()나 ofNullable() 메소드를 사용하여 Optional 객체를 생성할 수 있다.

 

of() 메소드는 null이 아닌 명시된 값을 지니는 Optional 객체를 리턴

-> of() 메소드를 통해 생성된 객체에 null이 저장되면 NPE 발생

ofNullable() 메소드는 명시된 값이 null이 아니면 명시된 값을 가지는 Optional 객체를 리턴,

명시된 값이 null이면 비어있는 Optional 객체를 리턴

 

- stream / filter 

stream은 컬렉션에 저장되어 있는 요소들을 하나씩 참조하여 람다식으로 처리할 수 있도록 해주는 iterator

데이터 처리를 간결하게 작성 가능하고, inner iterator를 사용하기 때문에 병렬 처리가 쉽다고 한다.

 

3. 회원 Repository Test Case 작성

개발한 기능을 실행해서 테스트 할 때 자바의 main 메소드를 통해서 실행하거나, 컨트롤러를 통해서 해당 기능을 실행하기에는 실행하는 데

오래 걸리기 때문에 여러 테스트를 한번에 실행하기 어렵다는 단점이 있다.

 

자바는 JUnit이라는 프레임워크 테스트를 실행해서 이러한 단점을 해결한다.

 

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

import kdo6301.spring0.domain.Member;
import kdo6301.spring0.repository.MemoryMemberRepository;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.assertj.core.api.Assertions;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

import static org.assertj.core.api.AssertionsForClassTypes.assertThat;

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

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

    @Test
    public void save()
    {
        //given
        Member member = new Member();
        member.setName("spring1");
        //when

        repository.save(member);

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

    @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 

: 한번에 여러 메소드의 테스트를 실해앟면 메모리 DB에 직전 테스트의 결과가 남을 수 있다.

이렇게 결과가 남게 되면 이전 테스트가 다음 테스트에 영향을 주어서 실패할 가능성이 있다.

AfterEach 어노테이션을 사용하면 각 테스트가 종료될 때 마다 이 기능을 실행하는데, 각 테스트가 끝나면 store를 비우도록 설정해 주었다.

 

❗️❗️ 테스트는 독립적으로 실행되어야 한다. 의존관계가 있는 테스트는 좋은 테스트가 아님.

 

4.  회원 서비스 개발

 

package kdo6301.spring0.service;

import kdo6301.spring0.domain.Member;
import kdo6301.spring0.repository.MemberRepository;
import kdo6301.spring0.repository.MemoryMemberRepository;

import java.util.List;
import java.util.Optional;

public class MemberService {
	
    
    /*
    private final MemoryMemberRepository memberRepository = new MemoryMemberRepository();
    로 작성하면 
    
    해당 인터페이스 구현 객체만 사용할 수 있지만,
    
    private final MemberRepository memberRepository = new MemoryMemberRepository();
	
    이렇게 작성하면 오른쪽에 MemberRepository 인터페이스를 구현한 다른 클래스를 사용할 수도 있다.
   
 
    */
    
    
    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);
    }
}

 

 

5.  회원 서비스 테스트

기존에는 회원 서비스 ( MemberService ) 가 MemoryMemberRepository를 직접 생성하게 해주었다.

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

*회원 리포지토리의 코드가

회원 서비스 코드를 DI 가능하게 변경한다.

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

}

 

package kdo6301.spring0.service;

import kdo6301.spring0.domain.Member;
import kdo6301.spring0.repository.MemberRepository;
import kdo6301.spring0.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.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 join() {
        //given
        Member member = new Member();
        member.setName("Kim");
        //when
        Long saveId = memberService.join(member);

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

    @Test
    void 중복회원예외()
    {
        // given
        Member mem1 = new Member();
        mem1.setName("Spring1");

        Member mem2 = new Member();
        mem2.setName("Spring1");

        // when

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

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


        // then
    }
 
}

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

-> @AfterEach 안써주어도 됨.

 

 

<참고 자료>

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EC%9E%85%EB%AC%B8-%EC%8A%A4%ED%94%84%EB%A7%81%EB%B6%80%ED%8A%B8/dashboard

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

 

https://mangkyu.tistory.com/70

[Java] Optional이란? Optional 개념 및 사용법 - (1/2)

https://mkil.tistory.com/122

[자바 기본 개념] 컬렉션(Collection) - HashMap / 예제

https://devlogofchris.tistory.com/41

[JAVA]Map이란? (HashMap, Hashtable, TreeMap)

https://psychoria.tistory.com/765

[Java] 자바 ArrayList 사용 방법

 

[Java] 스트림(Stream) 개념 및 사용법 / filter, map / iterator 비교