📌 김영한 선생님의 스프링 입문 강의 강의를 들으면서 공부한 내용을 정리한 게시물입니다.
[ 비즈니스 요구사항 정리 ]
회원 관리 예제를 통해서 백엔드 개발을 시작해보자! 기본적인 요구사항은 다음과 같다.
- 데이터: 회원ID, 이름
- 기능: 회원 등록, 조회
- 아직 데이터 저장소가 선정되지 않았다. (가상의 시나리오)
1. 일반적인 웹 애플리케이션 계층 구조
- 컨트롤러: 웹 MVC의 컨트롤러 역할
- 서비스: 핵심 비즈니스 로직 구현
- 리포지토리: 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리
- 도메인: 비즈니스 도메인 객체
- Ex) 회원, 주문, 쿠폰 등등 주로 데이터베이스에 저장하고 관리됨.
2. 클래스 의존 관계
- 아직 데이터 저장소가 선정되지 않아서, 우선 인터페이스로 구현 클래스를 변경할 수 있도록 설계한다.
- 데이터 저장소는 RDB, NoSQL 등등 다양한 저장소를 고민 중인 상황으로 가정한다.
- 개발을 진행하기 위해서 초기 개발 단계에서는 구현체로 가벼운 메모리 기반의 데이터 저장소 사용한다.
[ 회원 도메인과 리포지토리 만들기 ]
1. 회원 객체
main/java/hello.hellospring/domain/Member.java
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. 회원 리포지토리 인터페이스
main/java/hello.hellospring/repository/MemberRepository.java
public interface MemberRepository {
Member save(Member member);
Optional<Member> findById(Long id);
Optional<Member> findByName(String name);
List<Member> findAll();
}findById,findByName의 결과값이null일 수도 있는데, 요즘은 이렇게null이 반환될 때의 처리를Optional로 감싸서 사용하는 방법을 선호한다.
3. 회원 리포지토리 메모리 구현체
main/java/hello.hellospring/repository/MemoryMemberRepository.java
/**
* 동시성 문제가 고려되어 있지 않음. 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
*/
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 세팅
store.put(member.getId(), member); //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());
}
public void clearStore() {
store.clear();
}
}private static Map<Long, Member> store = new HashMap<>();에서
id값이Long이고 값이Member이므로Map<Long, Member>로 설정하는 것이다.sequence는 키 값을 생성해주는 것이다.
[ 회원 리포지토리 테스트 케이스 작성 ]
개발한 기능을 실행해서 테스트할 때 자바의 main 메소드를 통해서 실행하거나, 웹 애플리케이션의 컨트롤러를 통해서 해당 기능을 실행한다. 하지만 이러한 방법은 준비하고 실행하는데 오래 걸리고, 반복 실행하기 어렵고 여러 테스트를 한 번에 실행하기 어렵다는 단점이 있다.
자바는 JUnit 이라는 프레임워크로 테스트를 실행해서 이러한 문제를 해결한다.
📌 테스트 문법
이렇게 세 부분으로 나눠서 테스트하는 것이 좋다.
@Test void 회원가입() { //given -> 검증 데이터 //when -> 검증하려는 것 //then -> 검증하는 부분 }
1. 테스트 코드
src/test/java/hello.hellospring/repository/MemoryMemberRepositoryTest.java
class MemoryMemberRepositoryTest {
MemoryMemberRepository repository = new MemoryMemberRepository();
@Test
public void save() {
Member member = new Member();
member.setName("spring");
repository.save(member);
Member result = repository.findById(member.getId()).get();
Assertions.assertEquals(member, result);
}
}- 테스트용으로만 쓸 것이기 때문에 굳이
public으로 하지 않아도 된다. Optional에서 값을 꺼내올 때는get()을 사용한다.Assertions.assertEquals는 첫 번째 값과 두 번째 값이 같은 경우 Test 성공, 다른 경우 Test 실패가 된다.
만약 테스트가 성공하면 (같다면) 이렇게 초록색이 뜬다.
📌 참고 | 테스트 실패 코드
- 틀린 코드 (
Assertions.assertEquals함수 안에null값을 넣었다.)
class MemoryMemberRepositoryTest {
MemoryMemberRepository repository = new MemoryMemberRepository();
@Test
public void save() {
Member member = new Member();
member.setName("spring");
repository.save(member);
Member result = repository.findById(member.getId()).get();
Assertions.assertEquals(member, null);
}
}
2. 테스트 전체 코드
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();
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);
}
}- 한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있다. 이러면 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있다.
@AfterEach를 사용하면 각 테스트가 종료될 때마다 메모리 DB에 저장된 데이터를 삭제한다.- 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존 관계가 있는 것은 좋은 테스트가 아니다.
[ 회원 서비스 개발 ]
main/java/hello.hellospring/service/MemberService.java
public class MemberService {
private final MemberRepository memberRepository = new MemoryMemberRepository();
/**
* 회원가입
*/
public Long join(Member member) {
//같은 이름이 있는 중복 회원 X
memberRepository.findByName(member.getName())
.ifPresent(m -> {
throw new IllegalStateException("이미 존재하는 회원입니다.");
});
memberRepository.save(member);
return member.getId();
}
}회원가입 시 중복되는 이름을 허용하지 않기 위해서 위와 같이 코드를 작성했다. 그런데 findByName이라는 동작을 수행할 때마다 중복되는지 확인 과정이 필요한데, 이렇게 공통 로직이 나올 때 extract method를 하면 편리하게 사용할 수 있다.
📌 메서드 추출하기 (Windows 기준)
코드 드래그 + 오른쪽 마우스 →
Refactor→Extract method해서 이름 설정 (여기서는validateDuplicateMember로 설정)
extract method한 결과
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 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);
}
}Optional을 감싸서IfPresent와 같은 것들을 사용할 수 있다.Optional자체를 반환하는 것은 권장하지 않는다.
[ 회원 서비스 테스트 ]
🚫 테스트 하기 전에 코드 수정합시다!
기존에 회원 서비스가 메모리 회원 리포지토리를 직접 생성하게 했는데,
private final MemberRepository memberRepository = new MemoryMemberRepository();다음과 같이 회원 리포지토리의 코드가 회원 서비스 코드를 DI 가능하도록 변경해주자.
public class MemberService {
private final MemberRepository memberRepository;
public MemberService(MemberRepository memberRepository) {
this.memberRepository = memberRepository;
}
...
}⭐ 테스트 쉽게 하기
- 테스트하고자 하는 파일의 클래스명에서
ctrl+ shift + T를 하면 자동으로 Test 파일을 만들어준다.- 테스트코드 메소드는 한글로 적어도 무방하다.
test/java/hello.hellospring/service/MemberServiceTest.java
class MemberServiceTest {
MemberService memberService;
MemoryMemberRepository memberRepository;
@BeforeEach
public void beforeEach() {
memberRepository = new MemoryMemberRepository();
memberService = new MemberService(memberRepository);
}
@AfterEach
public void afterEach() {
memberRepository.clearStore();
}
@Test
public 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("이미 존재하는 회원입니다.");
}
}@BeforeEach: 각 테스트 실행 전에 호출된다. 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존 관계도 새로 맺어준다.
[ 📘 오늘의 TIL 정리 ]
- 일반적인 웹 애플리케이션 계층 구조는 컨트롤러, 서비스, 리포지토리, 도메인으로 구성되어 있다.
- 컨트롤러: 웹 MVC의 컨트롤러 역할
- 서비스: 핵심 비즈니스 로직 구현
- 리포지토리: 데이터베이스에 접근, 도메인 객체를 DB에 저장하고 관리
- 도메인: 비즈니스 도메인 객체
- 요즘에는
null이 반환될 때의 처리를Optional로 감싸는 방법을 선호한다. (findById,findByName등을 사용할 때null이 반환될 수 있다.) - 자바는
JUnit프레임워크를 제공하여 테스트를 쉽게 할 수 있도록 한다. - 테스트를 할 때는 다음과 같이 세 부분으로 나눠서 테스트하는 것이 좋다.
given: 검증 데이터when: 검증하려는 것then: 검증하려는 부분
Assertions.assertEquals에서 첫 번째 값과 두 번째 값이 같은 경우 테스트 성공, 다를 경우 테스트 실패가 된다.@AfterEach를 사용하면 각 테스트가 종료될 때마다 메모리 DB에 저장된 데이터를 삭제한다.- 테스트는 각각 독립적으로 실행되어야 한다. 테스트 순서에 의존 관계가 있는 것은 좋은 테스트가 아니다.
Optional자체를 반환하는 것은 권장하지 않는다.- 테스트를 할 때, 테스트를 하고자 하는 파일의 클래스명에
Ctrl + Shift + T를 하면 자동으로 테스트 파일을 만들어준다. @BeforeEach는 각 테스트 실행 전에 호출되며, 테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존 관계를 새로 맺어주는 역할을 한다.
🚧 https://coji.tistory.com/ 🏠