[Spring Intro] Section 03. 회원 관리 예제 - 백엔드 개발
강의: 김영한의 스프링 입문
# 비지니스 요구사항 정리
1. 비지니스 요구사항
- 데이터: 회원 ID, 이름
- 기능: 회원 등록, 조회
- 아직 데이터 저장소가 선정되지 않음(가상의 시나리오) 즉, 어떤 데이터베이스를 사용할지는 정하지 않았다고 가정한다
2. 일반적인 웹 애플리케이션 계층 구조
- 컨트롤러: 웹 MVC의 컨트롤러 역할
- 서비스: 핵심 비지니스 로직 구현 ex. 회원은 중복가입을 할 수 없다
- 리포지토리: 데이터베이스에 접근 도메인 객체를 DB에 저장하고 관리
- 즉, 핵심 비지니스 로직이 동작하도록 구현한 객체가 리포지토리라고 생각하면 된다
- 도메인: 비지니스 도메인 객체로 회원, 주문, 쿠폰 등등 주로 데이터베이스에 저장하고 관리되는 비지니스 도메인 객체이다
3. 클래스 의존관계
- 아직 데이터베이스 저장소가 선정되지 않아서, 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계한다
- 데이터 저장소는 RDB, NoSQL 등등 다양한 저장소를 고민 중인 상황으로 가정한다
- 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소를 사용한다
4. 프로젝트 계층 구조 Preview
# 회원 도메인과 리포지토리 만들기
1. 회원 객체
- hello.hellospring 아래 domain package를 생성하고 해당 package 안에 Meber class를 다음과 같이 작성한다
Mac 기준으로 IntelliJ에서는 Command + n 을 누르면 자동으로 getter/setter를 생성할 수 있다
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;
}
}
2. 회원 리포지토리 인터페이스
- hello.hellospring 아래 repository package를 생성하고 Interface로 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); // 회원 저장
Optional<Member> findById(Long id); // ID로 회원 찾기
Optional<Member> findByName(String name); // Name으로 회원 찾기
List<Member> findAll(); // 저장된 회원 list를 반환
}
Optional이란 Java8 부터 도입된 기능이다
예를 들어 해당 멤버가 없을 시 null이 반환되는데 이를 Optional로 감싸서 반환할 경우에 구현에 어려움이 있던 부분들이 개선되었다. 대표적으로는 반환 값이 null이더라도 클라이언트 측에서 무언가를 할 수 있게 되었다
3. 회원 리포지토리 구현체
- repository package 아래 MemoryMemberRepository 클래스를 다음과 같이 작성한다
현재 예제에서는 동시성 문제가 고려되어 있지 않지만 실무에서는 ConcurrentHaspMap, AtomicLong 사용을 고려한다
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); // 멤버 id는 시스템이 생성, name은 회원가입시에 입력받으므로 여기서 지정하지 않음
store.put(member.getId(), member); // member id와 member를 한 쌍으로 Map으로 선언한 store에 저장
return member;
}
@Override
public Optional<Member> findById(Long id) {
// ofNullable을 통해 반환 값이 null이어도 클라이언트에서의 처리가 가능
return Optional.ofNullable(store.get(id));
}
@Override
public Optional<Member> findByName(String name) {
// 검색 결과가 Optional로 반환되며 없는 이름이라면 null이 Optional로 감싸져 반환됨
return store.values().stream()
.filter(member -> member.getName().equals(name)) // name(parameter)과 Member의 이름이 같은지 확인
.findAny(); // String에서 가장 먼저 탐색되는 요소를 리턴하며 하나라도 반환하게 되어 있음. 없을 경우 Optional로 null이 감싸져 반환
}
@Override
public List<Member> findAll() {
return new ArrayList<>(store.values()); // store member들을 전부 반환
}
public void clearStore(){
store.clear();
}
}
# 회원 리포지토리 테스트 케이스 작성
1. 테스트 케이스 작성
- 테스트 케이스는 쉽게 말해서 우리가 위에서 만든 회원 리포지토리 클래스가 정상적으로 작동하나?를 검증할 수 있는 방법이다
- 개발한 기능을 실행해서 테스트 할 때 자바의 main 메소드를 통해서 실행하거나, 웹 애플리케이션의 컨트롤러를 통해서 해당 기능을 실행한다
- 이러한 방법은 준비하고 실행하는데 오래걸리고, 반복 실행하기 어렵고 여러 테스트를 한번에 실행하기 어렵다는 단점이 있다
- 자바는 JUnit이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다
2. 회원 리포지토리 메모리 구현체 테스트
- src/test/java 하위 폴더에 repository package를 생성하고 다음과 같이 MemoryMemberRepository 클래스를 작성한다
- @AfterEach
- 한번에 여러 테스트를 실행하면 메모리 DB 직전 테스트의 결과가 남을 수 있다
- 이렇게 되면 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다
- 따라서 @AfterEach를 사용함으로써 각 테스트가 종료될 때 마다 정의된 기능을 실행한다
- 여기에서는 메모리 DB에 저장된 데이터를 삭제한다
- 테스트는 각각 독립적으로 실행되어야 한다
- 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아니다
1. Mac 기준으로 command + shift + enter를 누르면 커서의 위치가 해당 줄의 맨 마지막에 있지 않더라도 바로 다음줄로 넘어간다
2. assertThat: 'Add on-demand static import for 'org.assertj.core.api.Assertions'를 선택하여 static import를 하면 다음부터 assertThat만 입력하여 사용할 수 있다
3. 코드 복사 시 변수 이름만 변경해서 재사용하고 싶다면 Shift+F6 을 눌러 변경할 수 있다
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 //org.junit.jupiter.api
public void save() {
Member member = new Member();// 새로운 member 생성
member.setName("spring"); // 만든 member의 이름을 spring으로 설정
repository.save(member);
// 만든 member가 저장되었는지 검증
Member result = repository.findById(member.getId()).get(); // 메모리에 저장된 값을 result로 저장
assertThat(result).isEqualTo(member); // 생성한 member와 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(); // spring1 이름을 가진 member를 result에 저장
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의 인원수로 전체 멤버를 제대로 반환했는지 검증
}
}
3. 테스트 확인 방법
- 메소드 단위의 검증과 전체 검증이 가능하다 (클래스 단위로도 가능하며 그 방법은 전체 검증과 유사하다)
- 메소드 단위의 검증
- 전체 검증
- 테스트의 성공은 아래 왼쪽과 같고 실패는 오른쪽과 같이 실패 이유를 알려준다
4. 개발과 테스트 순서
현재는 MemoryMemberRepository 개발 완료 후 테스트 클래스를 작성했지만 반대로 테스트 클래스를 먼저 작성하고 개발 클래스를 작성하는 방법이 있는데 이를 테스트 주도 개발(TDD)라고 한다
# 회원 서비스 개발
- 실제 비지니스 로직을 작성하는 것이다
- hello.hellospring 아래 service package를 생성하고 다음과 같이 MemberService 클래스를 작성한다
Mac 기준으로 Ctrl + T 를 사용하면 코드 리팩토리와 관련한 기능을 사용할 수 있다 ex. 선택 코드 method로 변환하여 사용
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){
validateDuplicateMember(member); // 중복 회원 검증 -> 비지니스 로직에서 같은 이름으로는 회원은 있을 수 없다고 명시
memberRepository.save(member);
return member.getId();
}
private void validateDuplicateMember(Member member) {
memberRepository.findByName(member.getName()) // findByName 메소드는 Optional로 반환되기 때문에 아래와 같이 작성 가능
.ifPresent(m ->{
throw new IllegalStateException("이미 존재하는 회원입니다.");
});
}
// 전체 회원 조회
public List<Member> findMembers(){
return memberRepository.findAll();
}
// 회원 한 명 조회
public Optional<Member> findOne(Long memberId){
return memberRepository.findById(memberId);
}
}
# 회원 서비스 테스트
1. DI(Dependency Injection)
- 기존에는 회원 서비스가 메모리 회원 리포지토리를 직접 생성하게 코드를 작성했었다
public class MemberService {
private final MemberRepository memberRepository = new MemoryMemberRepository();
}- 위와 같이 MemberService와 MemberServiceTest에서 new MemoryMemberRepository()를 각각 선언해주면 서로 다른 Repository(다른 객체)를 사용하게 된다
- 이 문제를 해결하기 위해서는 아래와 같이 의존관계를 주입해주어야 한다 -> 회원 리포지토리의 코드가 회원 서비스 코드를 DI 하도록 변경하여 같은 인스턴스를 사용하도록 변경하면 된다. (Constructor 추가)
public class MemberService {
private final MemberRepository memberRepository;
public MemberService(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
...
}
2. given, when, then 문법
- given - 무언가가 주어졌는데
- when - 이걸 실행했을 때
- then - 이런 결과가 나와야 함
3. 테스트 생성 단축키
Mac 기준으로 Command + Shift + T를 누르면 간편하게 테스트 케이스 생성이 가능하다
- MemberService 클래스에서 단축키를 이용해 테스트 케이스를 생성한다
4. 회원 서비스 테스트 코드 작성
- @BeforeEach: 각 테스트 실행 전에 호출되며 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어준다
- 테스트는 예외 상황 검증이 더 중요하다
Mac 기준 변수 생성 단축키: Command + option + v
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.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 static org.assertj.core.api.Assertions.*;
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 회원가입() {
//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());
}
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("이미 존재하는 회원입니다."); // 에러메시지로 상태 검증
}
@Test
void findMembers() {
}
@Test
void findOne() {
}
}
'Study > Backend Note' 카테고리의 다른 글
| [Spring Intro] Section 06. 스프링 DB 접근 기술 (0) | 2023.03.06 |
|---|---|
| [Spring Intro] Section 05. 회원 관리 예제 - 웹 MVC 개발 (0) | 2023.03.04 |
| [Spring Intro] Section 04. 스프링 빈과 의존관계 (0) | 2023.02.28 |
| [Spring Intro] Section 02. 스프링 웹 개발 기초 (0) | 2023.02.26 |
| [Spring Intro] Section 01. 프로젝트 환경설정 (0) | 2023.02.24 |
