[Spring] 스프링 입문 - 3. 회원 관리 예제 - 백엔드 개발
스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술
인프런 김영한님 강좌인 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 내용을 학습하며 다룬 글입니다.
문제(저작권, 오류 및 잘못된 부분 등)가 있다면 알려주세요!!
PREV)
[1. 비지니스 요구사항 정리]
[2. 회원 도메인과 리포지토리 만들기]
[3. 회원 리포지토리 테스트 케이스 작성]
[4. 회원 서비스 개발]
[5. 회원 서비스 테스트]
[1. 비지니스 요구사항 정리]
- 데이터 : 회원 ID, 이름
- 기능 : 회원 등록, 회원 조회
- 컨트롤러 : 웹 MVC의 컨트롤러 역할 (이벤트 처리 등)
- 서비스 : 핵심 비지니스 로직 구현 (EX. 회원 중복 확인 등)
- 리포지토리 : 데이터베이스 접근, 도메인 객체를 DB에 저장 및 관리
- 도메인 : 비지니스 도메인 객체 (EX. 회원, 주문, 상품 등) , 데이터베이스에 저장하고 관리됨
[2. 회원 도메인과 리포지토리 만들기]
- 회원 객체
java/hello.hellospring/domain/Member.java
package hello.hellospring.domain;
public class Member {
private Long id; //임의의 값. 고객이 정하는 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;
}
}
- 회원 리포지토리 인터페이스
java/hello.hellospring/repository/MemberRepository.java
회원 객체를 저장해주는 곳
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); //id로 회원을 찾는다.
Optional<Member> findByName(String name); //name으로 회원을 찾는다.
List<Member> findAll(); //저장된 회원 리스트를 모두 반환해준다.
}
NPE (NullPointerException) : null 참조로 인해 발생되는 예외
다양하게 NPE를 방지하는 방법이 있지만, 그 중 Optional 이용
Optional : null이 될 수도 있는 객체를 감싸는 Wrapper 클래스
Optional<Member> optMember; // Member 타입의 객체를 감쌀 수 있는 Optional 타입의 변수 선언
- Optional.empty() : null을 담고 있는, 비어있는 Optional 객체 생성
- Optional.of(value) : null이 아닌 객체를 담고 있는 Optional 객체 생성 ( null이 담겨서는 안됨)
- Optional.ofNullable(value) : null인지 확신할 수 없는 객체를 담고 있는 Optional 객체 생성 ( null이 담길 경우, Optional.empty()와 동일한 객체 생성)
Optional<Member> maybeMember = Optional.empty();
Optional<Member> maybeMember2 = Optional.of(aMemeber);
Optional<Member> maybeMember3 = Optional.ofNullable(aMember);
Optional<Member> maybeMember3 = Optional.ofNullable(null);
참고]
https://www.daleseo.com/java8-optional-after/
- 회원 리포지토리 메모리 구현체
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import java.util.*;
public class MemoryMemerRepository implements MemberRepository{
//save를 할 때 저장할 수 있는 곳
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); //시스템 id 지정해주기
store.put(member.getId(), member); //저장소에 넣어주기
return member; //저장된 결과 반환
}
@Override
public Optional<Member> findById(Long id) { //회원 찾기
return Optional.ofNullable(store.get(id)); //null이 반환될 가능성이 있으므로 Optional.ofNullable로 감싸주어야 한다.
}
@Override
public Optional<Member> findByName(String name) { //회원 찾기
return store.values().stream()
.filter(member -> member.getName().equals(name)) //회원의 name과 파라미터로 들어온 name과 일치하는 지 확인.
.findAny(); //하나라도 찾는 것. 결과가 null이면 Optional로 감싸져서 반환된다.
}
@Override
public List<Member> findAll() {
return new ArrayList<>(store.values()); //회원 목록 반환.
}
public void clearStore() {
store.clear();
}
}
- Optional.ofNullable : null이 넘어올 경우, NPE 발생시키지 않고 빈 Optional 객체 반환.
[3. 회원 리포지토리 테스트 케이스 작성]
회원 도메인과 리포지토리가 제대로 동작하는 지를 검증하기 위해서 테스트 케이스를 작성한다.
- 개발한 기능을 실행시켜 테스트할 때 자바의 main 메서드를 통해서 실행하거나 웹 애플리케이션의 컨트롤러를 통해서 실행한다. 그렇지만, 이 방법은 준비와 실행에 시간이 오래 걸리고, 반복 실행과 여러 테스트를 한 번에 실행시키기에 어려움이 있다.
따라서, 자바는 JUnit이라는 프레임워크를 이용하여 테스트를 실행하여 이러한 문제를 해결한다.
given : 무엇인가 주어졌을 때
when : 이거를 실행을 시키고
then : 결과가 이게 나와야 한다
- 회원 리포지토리 메모리 구현체 테스트
test/java/hello.hellospring/repository/MemoryMemberRepositoryTest.java
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;
import static org.assertj.core.api.Assertions.*;
class MemoryMemberRepositoryTest { //굳이 public이 아니여도 됨.
MemoryMemerRepository repository = new MemoryMemerRepository();
@AfterEach //테스트가 끝날 때마다 데이터를 지워줘야 한다
public void afterEach(){ //메서드가 끝날 때마다 동작한다.
repository.clearStore();
}
/*save 테스트*/
@Test //테스트할 수 있도록 @Test import해준다.
public void save() {
// given
Member member = new Member();
member.setName("spring"); //회원 이름을 지정해준다.
// when
repository.save(member); //리포지토리에 회원을 저장해준다.
// then 검증 : 저장한 것과 꺼낸 것이 동일해야 한다.
Member result = repository.findById(member.getId()).get(); //저장된 id를 찾아온다, findById의 반환 타입은 Optional. Opntional에서 값을 꺼낼 때 get이용
//System.out.println("result = " + (result == member)); 동일하다면 true로 출력됨
//Assertions.assertEquals(member, result); 동일하지 않으면 오류 발생 (Assertions : jupiter 사용시)
assertThat(member).isEqualTo(result);
}
/*findByName 테스트*/
@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);
}
/*findAll 테스트*/
@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에 직전 테스트의 결과가 남아있을 수 있다. 따라서 해당 어노테이션을 사용하여 저장된 데이터를 삭제해주도록 한다.
[4. 회원 서비스 개발]
java/hello.hellospring/service/MemberService.java
//같은 이름인 중복 회원 X
Optional<Member> result = memberRepository.findByName(member.getName()); //일단 이름을 찾아본다
result.ifPresent(m -> { //이미 그 이름이 존재한다면, ifPresent() : null이 아니라 값이 있으면 다음 동작이 실행된다.
throw new IllegalStateException("이미 존재하는 회원입니다."); //예외 처리
})
Optional로 반환하는 것은 별로 좋지 않으므로, 아래와 같이 변경해줄 수 있다.
memberRepository.findByName(member.getName())
.ifPresent(m -> { throw new IllegalStateException("이미 존재하는 회원입니다.");
});
[전체 코드]
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemerRepository;
import java.util.List;
import java.util.Optional;
public class MemberService {
private final MemberRepository memberRepository = new MemoryMemerRepository(); //final : 변경할 수 없는 상수값
/*
회원 가입
*/
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 -> { //이미 그 이름이 존재한다면, ifPresent() : null이 아니라 값이 있으면 다음 동작이 실행된다.
throw new IllegalStateException("이미 존재하는 회원입니다.");
});
// Optional<Member> result = memberRepository.findByName(member.getName());
// result.ifPresent(m -> {
// throw new IllegalStateException("이미 존재하는 회원입니다.");
// });
}
/*
전체 회원 조회
*/
public List<Member> findMembers() {
return memberRepository.findAll(); //findAll의 반환 타임 : List
}
public Optional<Member> findOne(Long memberId) {
return memberRepository.findById(memberId);
}
}
- ctrl + alt + shift + t 단축키를 이용하여 Extract Method → validateDuplicateMember
[5. 회원 서비스 테스트]
ctrl + shift + t 단축키를 이용하면 자동으로 테스트 클래스를 생성한다.
MemoryService.java 수정
// private final MemberRepository memberRepository = new MemoryMemerRepository(); //final : 변경할 수 없는 상수값
//기존 코드에서는 직접 메모리 회원 리포지토리를 생성함
//수정된 코드에서는 외부에서 넣어주는 것으로 수정되었다.(Dependency Injection : 외부에서 넣어주는 것)
private final MemberRepository memberRepository;
public MemberService(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
- Dependency Injection ( DI ) : 외부에서 넣어주는 것, 의존 관계 주입
가 가능하도록 수정.
- IoC와 DI에 대한 정리는 기본편 강의를 들으면서 재정리하기 메모메모..
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemerRepository;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
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 내에 있는 memberRepository와 두번째 줄에서의 memberRepository는 서로 다른 객체이다.
// MemberService memberService = new MemberService();
// MemoryMemerRepository memberRepository = new MemoryMemerRepository();
MemberService memberService;
MemoryMemerRepository memberRepository;
@BeforeEach
public void beforeEach() {
memberRepository = new MemoryMemerRepository();
memberService = new MemberService(memberRepository);
//MemoryMemberRepository를 만들어 넣어주므로써 같은 메모리 리포지토리를 사용하게 됨
}
@AfterEach //테스트가 끝날 때마다 데이터를 지워줘야 한다
public void afterEach(){ //메서드가 끝날 때마다 동작한다.
memberRepository.clearStore();
}
@Test
public void 회원가입() {
//given 무엇인가 주어졌을 때
Member member = new Member();
member.setName("spring");
//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);
// try{ //실행할 코드
// memberService.join(member2);
// fail();
// }catch(IllegalStateException e){ //예외
// assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
// }
memberService.join(member1);
IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2)); //assertThrows : 예외 처리 메서드, ()->가 실행되고 예외가 발생해야 한다.
assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
}
@Test
void findMembers() {
}
@Test
void findOne() {
}
}
- @BeforeEach : 각 테스트 실행 전에 호출된다. 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존 관계도 새로 맺어준다.