점주 가게 등록

[june-777]

💡 다음 이슈를 해결했어요.

Issue Link - #5

구현하며 구체화된 비즈니스 요구사항이 있어서 아래에 첨부합니다.
PR Merge 승인되면, Wiki - 요구사항 명세서를 갱신하겠습니다.

기능 요구사항

• 가게 이름, 전화번호, 위치 정보, 카테고리, 이용 시간(시작 시간 / 종료 시간), 최소 주문 금액을 입력해 가게를 등록할 수 있다.
  • Store 도메인 객체에 필드 반영
  • 카테고리 → StoreCategory 엔티티
• 한명의 점주는 여러개의 가게를 등록할 수 있다.
  • Store → Vendor (ManyToOne) (동훤님이 엔티티 설계로 사전에 세팅함)

가게 이름

- 가게 이름은 2자 ~ 10자까지 가능

가게 주소

- 송파구만 가능 (위치정보 논의 필요)

최소 주문 금액

- 최소 주문 금액은 5,000원 이상 가능
- 최소 주문 금액은 1,000원 단위로 가능

가게 이용 시간 (시작 시간 / 종료 시간)

- 가게 이용 시간은 시작 시간과 종료 시간으로 구성
- 시작 시간은 종료 시간보다 이전만 가능
- 시작 시간 / 종료 시간은 분(m) 단위까지 가능

💡 이슈를 처리하면서 추가된 코드가 있어요.

Store CustomException

• 가게 관련 예외를 표현하는 커스텀 예외
• 가게 관련 예외를 제한하고, 예외 검증 테스트에서 예외를 메세지로 세부적으로 검증하기 위해 ErrorCode Enum 을 활용함
• [feat] 가게와 관련된 예외를 명시하는 ErrorCode Enum 정의]
• [refactor] StoreException 을 생성할 때, 가게 관련 ErrorCode Enum 을 생성자 매개변수로 사용

Store Exception Handler

• 가게 관련 예외를 핸들링하는 글로벌 예외 핸들러
• 글로벌 예외 핸들러에 대한 논의가 진행되지 않아, 가게 관련 예외만 핸들링하도록 구현함
• [feat] Store 예외 핸들러 구현

Configuration Yaml

• 설정 파일의 depth 가독성을 위해 .properties 를 .yaml로 변경함
• JPA, H2 인메모리 DB, H2 콘솔 등의 기본적인 설정만 진행
• [feat] 인메모리 H2 DB 및 jpa yaml 설정

DateTimeProvider 인터페이스

• Java에서 기본으로 제공하는 날짜 API를 직접 의존하여 사용하는 경우 테스트하기 어려워지는 코드가 됨
• 날짜 값을 테스트 코드상에서 제어할 수 없기 때문
• 따라서 인터페이스로 분리하였고, 프로덕션은 CurrentDateTimeProvider, 테스트는 FixedDateTimeProvider를 사용
• [feat] 시간 정보를 제공하는 DateTimeProvider 인터페이스 정의
• [feat] 고정 시간을 반환하는 DateTimeProvider 테스트용 구현체
• [feat] 현재 시간을 반환하는 DateTimeProvider 프로덕션용 구현체
• [feat] DateTimeProvider 구현체인 CurrentDateTime 를 Bean 객체로 설정

주석 처리

• 인터페이스의 경우 설계 의도에 대한 팀원 공동의 합의가 필요한 부분이기 때문에 javadocs로 주석처리함
• 서비스 계층에서 반환되는 RuntimeException을 javadocs로 주석처리함

💡 이런 고민을 했어요.

한명의 점주가 여러개의 가게를 등록할 수 있다.

• 동일한 가게를 등록할 수 없도록 검증해야하지 않나?
• 그러면 가게를 식별할 수 있는 정보가 필요한데, 현재로썬 가게 식별 정보가 없다.
• 지난 회의에서 사업자 번호가 필요없을 것으로 판단되어 폐기하였는데, 사업자 번호로 가게를 식별하도록 해야할 것 같다.
• 아니면 사업자 번호 외의 다른 식별 정보가 있을까?

가게 위치 정보에 대한 요구사항 정의

• 지난 회의에서 위치 정보에 대한 요구사항이 러프하게 진행되었음.
  • 송파구로만 한정
  • 구 정보로만 한정
• 요구사항이 명확하게 정의되어야, 엔티티 설계를 마무리할 수 있음
  • 현재는 프로토타입으로서 송파구로만 한정하도록 간략히 개발함.
• 또한 가게 등록 검증 과정에서 위치 정보에 대한 검증도 필요할 것으로 생각함.
  • i.g) 해당 위치의 가게는 이미 등록된 가게입니다.
  • 해당 검증을 수행하려면, 마찬가지로 가게 위치 정보에 대한 요구사항 정의를 fix 해야함.

💡 다음 자료를 참고하면 좋아요.

• TODO

✅ 셀프 체크리스트

• TODO
• 내 코드를 스스로 검토했습니다.
• 필요한 테스트를 추가했습니다.
• 모든 테스트를 통과합니다.
• 브랜치 전략에 맞는 브랜치에 PR을 올리고 있습니다.
• 커밋 메세지를 컨벤션에 맞추었습니다.
• wiki를 수정했습니다.
  • 기능 요구사항이 구체화되었는데, PR 승인 완료되면 wiki에 반영하겠습니다.

[kimhyun5u]

제가 이따가는 못 볼 것 같아서 미리 승인 해놓겠습니다!

테스트 코드 깨지는 것만 수정해주시고 올리시면 될 것 같아요.

DTO 관련 논의는 추후 #42 에서 진행하는 걸로 하겠습니다.

merge conflict 과정에서 force push 를 진행하여, 사라진 커밋에 대한 리뷰입니다. 리뷰남겨주신 부분은 반영완료했습니다!

[Hyeon-Uk]

ResolveArgument가 중복될 수 있으니 conflict 처리까지해주시면 감사하겠습니다 :)