Requirements - takeoff-26/logistics-service GitHub Wiki

MSA 기반 국내 물류 관리 및 배송 시스템 개발

도메인 요구사항

공통

• 각 도메인의 CRUD, search 작업 필요 몇몇 도메인 제외
• 도메인 주도 설계(DDD)

허브 관리

• 허브 정보 캐싱
• 17 곳의 허브 고정이므로 데이터 생성

허브간 이동정보 관리

• 허브 경로 위,경도 계산
• 이동경로 알고리즘 설정 및 구현 (난이도: 중 선택) (P2P + Hub to Hub Relay)
• 허브 간 이동 경로 캐싱

배송 담당자 관리

• 배송 담당자 배송 순번 순차적 배정
• 배송 담당자 타입에 따라 업체 배송, 허브 배송 분리

업체 관리

• 업체 추가시 관리 허브 ID가 존재하는지 확인

상품 관리

• 상품 생성시 업체가 존재하는지 확인, 상품관리 허브 ID가 존재하는지 확인

주문 관리

• 주문 생성시 배송도 같이 생성

배송 관리

• 배송과 배송 경로 기록 엔티티 분리 생성
• 배송과정에서 발생한 경로를 추적
• 주문 생성시 배송과 배송 경로 기록 데이터 같이 생성

슬랙 메시지 관리

• AI를 통해 메시지 발송 기능 구현

사용자 관리

• 권한 분리
• 로그인 기능

AI 연동 기능

• 발송 허브 담당자에게 배송 예상 시간 알림 처리

글로벌 요구사항

프로젝트 구조

• Layered Architecture
• Entity 및 DTO: 각 기능별로 Entity와 DTO(Data Transfer Object)를 분리하여 관리
• API 설계: RESTful API 원칙에 따라 설계
• Exception Handling: 글로벌 예외 처리 (ExceptionHandler 사용)

데이터 보존 및 삭제 처리

• 데이터 보존: 모든 데이터는 완전 삭제되지 않고 숨김 처리로 관리
• 데이터 감사 로그: 모든 정보에 생성일, 생성 아이디, 수정일, 수정 아이디, 삭제일, 삭제 아이디를 포함

MSA 애플리케이션 구성

• 유레카 서버 생성 및 애플리케이션 관리
• 게이트웨이 생성 및 라우팅
• 게이트웨이에서 인가
• 서킷 브레이커 적용
• 모든 애플리케이션을 Docker 컨테이너로 실행

데이터베이스 설계

• 테이블 명명 규칙: 모든 테이블에 p_ 접두사 사용
• UUID 사용: 모든 주요 엔티티의 식별자는 UUID를 사용 (유저는 예외)
• Audit 필드: 모든 테이블에 created_at, created_by, updated_at, updated_by, deleted_at, deleted_by 필드를 추가하여 데이터 감사 로그 기록

접근 권한 관리

• 각 바운더리 컨텍스트별 권한 검사

보안

• JWT 인증: Spring Security와 JWT(Json Web Token)를 이용한 인증 및 권한 관리
• 권한 확인 : CUSTOMER 이상의 권한은 요청마다 저장되어 있는 권한 값과 동일한지 체크필요
• 비밀번호 암호화: BCrypt 해시 알고리즘을 사용한 비밀번호 암호화
• 데이터 유효성 검사: 서버 측 데이터 유효성 검사를 위해 Spring Validator 사용

테스트

• 테스트: 테스트 스크립트 혹은 툴을 이용하여 endpoint에서 전체 API를 커버하는 테스트를 자동화