-
[스프링 입문] (3) 회원 관리 예제 - 백엔드 개발카테고리 없음 2024. 1. 9. 21:49
이번 강의는 무슨 소리인지... 잘 모르겠어서 코드 분석을 좀 했다.
스프링 부트 기반 게시판 깃허브 코드를 봐야 좀 전체적인
이해가 잘 될 것 같다.
3. 회원 관리 예제 - 백엔드 개발.pdf0.18MB
[회원 리포지토리 인터페이스]
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); Optional<Member> findByName(String name); List<Member> findAll(); }--> 회원 정보를 저장하고 조회하는데 사용되는 MemberRepository 인터페이스를 정의한 것
- save: Member 객체 받아 저장하고, 저장된 회원 객체 반환
- findById: 회원의 식별자(ID)를 받아 해당 ID에 해당하는 회원 찾아 반환,
반환 타입은 Optional<Member>로, 회원이 존재하지 않을 수 있기 때문에 Optional을 사용해 null 방지
- findByName: 회원의 이름 받아서 해당 이름에 해당하는 회원 찾아 반환
- findAll: 저장된 모든 회원을 리스트 형태로 반환
[회원 리포지토리 메모리 구현체]
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<>(); 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) { return Optional.ofNullable(store.get(id)); } @Override public List<Member> findAll() { return new ArrayList<>(store.values()); } @Override public Optional<Member> findByName(String name) { return store.values().stream() .filter(member -> member.getName().equals(name)) .findAny(); } public void clearStore() { store.clear(); } }--> 메모리에 데이터를 저장하기 때문에 애플리케이션이 종료되면 저장된 데이터가 모두 사라짐
- 데이터 저장을 위한 Map, sequence 변수
store: 회원 정보를 저장하기 위한 Map<Long, Member> 타입의 맵. 회원의 ID를 키로 사용하여 회원 정보 저장
sequence: 회원의 ID를 생성하기 위한 변수. 각 회원이 추가될 때마다 1씩 증가
- save 메서드: 회원 정보 저장, 저장된 회원 객체 반환
- findById, findByName, findAll 메서드
- clearStore 메서드: 테스트 시에 사용된 데이터를 초기화하기 위한 메서드로, 저장된 회원 정보 모두 제거
[회원 리포지토리 메모리 구현체 테스트]
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 java.util.Optional; import static org.assertj.core.api.Assertions.*; class MemoryMemberRepositoryTest { MemoryMemberRepository repository = new MemoryMemberRepository(); @AfterEach public void afterEach() { repository.clearStore(); } @Test public void save() { //given Member member = new Member(); member.setName("spring"); //when repository.save(member); //then Member result = repository.findById(member.getId()).get(); assertThat(member).isEqualTo(result); } @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); } }--> MemoryMemberRepository 클래스를 테스트하는 JUnit 테스트 클래스인 MemoryMemberRepositoryTest.
MemoryMemberRepositoryTest 클래스의 메서드들이 예상하는대로 동작하는지 확인하기 위해 작성됨.
- save() 메서드 테스트
: save() 메서드가 주어진 멤버들을 저장하고, 저장된 멤버를 findById로 찾아오는지 확인.
assertThat, isEqualTo를 사용하여 예상한 값과 실제 값이 같은지를 검증.
+ asserThat?: 테스트 코드에서 특정 조건이 참인지 여부를 확인하는 데 사용.
asserThat 메서드는 첫 번째 매개변수로 검증 대상이 되는 값을 받으며, 이어지는 메서드 체인을 통해 다양한 검증 조건을 지정할 수 있음.
assertThat(result).isEqualTo(expectedResult);result: 실제로 어떤 동작의 결과물, 어떤 값
expectedResult: 기대하는 값, 예상한 결과
- findByName() 메서드 테스트
: findByName() 메서드가 주어진 이름과 일치하는 멤버를 찾아오는지 확인.
assertThat, isEqualTo를 사용하여 예상한 값과 실제 값이 같은지를 검증
- finAll() 메서드 테스트
: finAll() 메서드가 현재 저장된 모든 멤버를 리스트로 가져오는지를 확인.
assertThat, isEqualTo를 사용하여 예상한 값과 실제 값이 같은지를 검증
- @AfterEach 어노테이션이 적용된 afterEach() 메서드
: 각 테스트 메서드 실행 이후에 실행되는 메서드로, 테스트 데이터를 정리하는 역할을 함.
repository.clearStore()를 호출하여 저장된 데이터 초기화.
한번에 여러 테스트를 실행하면 메모리 DB에 직전 테스트의 결과가 남을 수 있음.
이렇게 되면 다음 이전 테스트 때문에 다음 테스트가 실패할 가능성이 있음.
@AfterEach를 사용하면 각 테스트가 종료될 때마다 이 기능 실행.
여기서는 메모리 DB에 저장된 데이터 삭제.
- 테스트는 각각 독립적으로 실행되어야 함. 테스트 순서에 의존관계가 있는 것은 좋은 테스트가 아님.
[회원 서비스]
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.findByName(member.getName()) * .ifPresent(m --> { * throw new IllegalStateException("이미 존재하는 회원입니다."); * }); * --> ctrl + t : 해당 줄 드레그 해서 메서드 생성할 수 있음 */ memberRepository.save(member); // 중복되지 않은 경우 회원 저장, 회원의 고유 ID 반환 return member.getId(); } private void validateDuplicateMember(Member member) { memberRepository.findByName(member.getName()) // 회원 저장소에서 주어진 회원의 이름으로 이미 저장된 회원 찾음 .ifPresent(m -> { throw new IllegalStateException("이미 존재하는 회원입니다."); }); // 만약 찾은 회원이 있다면, 그 회원 정보(m)을 가지고 람다 표현식 실행 // 이미 존재한느 회원이라는 익셉션 발생시킴 } /** * 전체 회원 조회 */ public List<Member> findMembers() { return memberRepository.findAll(); } // 모든 회원 가져옴 public Optional<Member> findOne(Long memberId) { return memberRepository.findById(memberId); } // 특정 ID에 해당하는 회원을 Optional로 반환 }--> 회원 가입과 관련된 비즈니스 로직을 처리하는 MemberService 클래스를 나타냄
1. 회원가입(join 메서드)
2. 중복 회원 검증(validateDuplicateMember 메서드):
memberRepository.findByName(member.getName())
를 통해 이미 존재하는 회원을 조회하고, 만약 존재한다면 IllegalStateException 예외를 던져 중복 회원임을 알림.
+ 람다 표현식: 익명 함수를 간편하게 작성할 수 있도록 하는 방법.
(parameters) -> expression- parameters: 메서드에 전달되는 매개변수를 나타냄
- ->: 람다 화살표, 매개변수와 표현식 분리
- expression: 메서드가 수행하는 동작을 나타내는 표현식
// 기존의 익명 클래스를 사용한 방법 Runnable runnable1 = new Runnable() { @Override public void run() { System.out.println("Hello, World!"); } }; // 람다 표현식을 사용한 방법 Runnable runnable2 = () -> System.out.println("Hello, World!");람다 표현식은 주로 함수형 인터페이스를 구현할 때 사용.
함수형 인터페이스는 하나의 추상 메서드만을 가진 인터페이스를 말하며,
람다 표현식은 이 추상 메서드를 간결하게 구현할 수 있게 해줌.
3. 전체 회원 조회(findMembers 메서드)
4. 특정 회원 조회(findOne 메서드)
+ Optional: 값이 존재할 수도 있고 존재하지 않을 수도 있는 컨테이너 객체를 나타냄.
주로 null을 사용하는 대신 Optional을 사용하여 코드의 안전성 높이고 예외 방지.
String name = "John"; Optional<String> optionalName = Optional.of(name); // 값이 있는 Optional 생성 // 값이 존재하는 경우 if (optionalName.isPresent()) { System.out.println("Name: " + optionalName.get()); } // 또는 람다 표현식을 사용하여 값이 있는 경우에 특정 작업 수행 optionalName.ifPresent(n -> System.out.println("Name: " + n));
[ctrl + shift + t -> 해당 클래스 test 자동 생성]
이 변경은 의존성 주입(DI)을 통해 MemberRepository 구현체를 주입하는 형태로 코드를 변경한 것
- 처음의 코드
private final MemberRepository memberRepository = new MemoryMemberRepository();--> 여기서 MemberRepository 를 직접 생성하여 사용하는 것은 구체적인 구현체에 강하게 의존하는 것.
이를 변경하기 어려워짐.
만약 나중에 다른 종류의 MemberRepository 구현제로 전환하려면 코드의 변경이 필요.
- 두 번째의 코드
private final MemberRepository memberRepository; public MemberService(MemberRepository memberRepository) { this.memberRepository = memberRepository; }--> 여기서는 MemberRepository 생성자를 통해 주입받는다.
즉, MemberService는 어떤 종류의 MemberRepository 구현체가 주입되던 상관하지 않음.
이런 방식으로 코드를 작성하면 나중에 다른 구현체로 손쉽게 전환할 수 있음.
[MemberServiceTest]
package hello.hellospring.service; import hello.hellospring.domain.Member; import hello.hellospring.repository.MemoryMemberRepository; 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와 MemoryMemberRepository는 beforeEach 메서드에서 초기화됨 MemberService memberService; MemoryMemberRepository memberRepository; // 각 테스트 메서드가 실행되기 전에 호출되는 메서드 @BeforeEach public void beforeEach() { // MemoryMemberRepository와 MemberService 초기화 memberRepository = new MemoryMemberRepository(); memberService = new MemberService(memberRepository); } // 각 테스트 메서드가 실행된 후에 호출되는 메서드 @AfterEach public void afterEach() { // MemoryMemberRepository의 clearStore 메서드를 호출하여 저장된 데이터를 초기화 memberRepository.clearStore(); } @Test public void 회원가입() throws Exception { //Given Member member = new Member(); member.setName("hello"); //When Long saveId = memberService.join(member); //Then Member findMember = memberRepository.findById(saveId).get(); assertEquals(member.getName(), findMember.getName()); } @Test public void 중복_회원_예외() throws Exception { //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("이미 존재하는 회원입니다."); } }--> MemberService 클래스의 테스트를 위한 JUnit 테스트 클래스인 MemberServiceTest.
MemberService는 회원 가입과 중복 회원 검증과 같은 비즈니스 로직을 담당하는 서비스 클래스이며 해당 클래스의 메서드들을 테스트하는 데 사용됨.
1. @BeforeEach 어노테이션이 적용된 beforeEach 메서드:
각 테스트 메서드가 실행되기 전에 실행되는 메서드로, 테스트에 필요한 객체를 초기화.
테스트가 서로 영향이 없도록 항상 새로운 객체를 생성하고, 의존관계도 새로 맺어줌
2. @AfterEach 메서드
3. 회원가입 테스트 메서드:
MemberService의 join 메서드를 호출하여 회원을 가입시키는 테스트.
새로운 회원을 생성하고, memberService.join(member)을 호출한 후에
가입한 회원을 memberRepository를 통해 찾아와서 이름이 일치하는지를 검증
4. 중복_회원_예외 테스트 메서드:
중복된 이름으로 회원을 가입하려고 할 때 예외가 발생하는지 테스트.
먼저 하나의 회원을 가입시키고, 같은 이름을 가진 다른 회원을 가입하려고 할 때
IllegalStateException이 발생하는지를 검증.
+ IllegalStateException: 객체의 상태가 메서드 호출을 수행할 수 있는 유효한 상태가 아닐 때 발생
'상태가 잘못되었다'는 의미.