[volume-2] 요구사항 문서, 시퀀스 다이어그램, 클래스 다이어그램, ERD 작성

[dame2]

📌 Summary

• 배경: Brand/Product/Like/Order 도메인 구현 전 설계 문서가 필요했다.
• 목표: 요구사항 명세, 시퀀스 다이어그램, 클래스 다이어그램, ERD를 Mermaid로 작성하여 구현 가이드 제공.
• 결과: 4개의 설계 문서 작성 완료, 이후 도메인 구현 시 참조 가능.

🧭 Context & Decision

문제 정의

• 현재 동작/제약: User 도메인만 구현된 상태, 나머지 커머스 도메인 설계 없음.
• 문제(또는 리스크): 설계 없이 개발 시 일관성 부족, 재작업 위험.
• 성공 기준: 설계 문서를 기반으로 Brand/Product/Like/Order 도메인 구현 가능.

선택지와 결정

• 좋아요 설계 방식:

  • 정렬 성능이 우수한 비정규화 방식과, 정합성을 충족하도록 좋아요 테이블을 별개로 두되 정렬 성능이 떨어지는 선택지가 있었다.
  • 체크리스트에 명시한 대로, 정합성을 충족하도록 설계했다.

• 좋아요 등록 정책:

  • 좋아요가 이미 존재할 때는 무시하는 멱등 처리 방식과 등록된 좋아요를 취소하는 토글 방식 중 토글 방식을 선택했다.
  • 사용자 편의성을 위해 토글 방식을 선택했다.

• 어드민 인증:

  • Interceptor 방식은 컨트롤러에서 어드민 정보 접근 시 Request에서 다시 추출이 필요하고, 특정 메서드만 예외 처리하려면 추가 로직 필요한 문제가 있었다.
  • ArgumentResolver는 모든 메서드에 AdminAuth 파라미터 추가가 필요하고, 실수로 어노테이션을 누락하면 보안 위험한 문제가 있었다.
  • 인증과 인가의 책임을 나누기 위해서 Interceptor + ArgumentResolver 조합으로 안전장치를 이중으로 설계했다. 인증은 요청 단위(Interceptor)에서, 인가 정보 전달은 메서드 단위(ArgumentResolver)에서 처리된다.

• 주문 로직:

  • OrderItem에 가격 스냅샷을 저장하여 상품 가격 변경 시에도 주문 가격을 유지하도록 했다.
  • OrderItem은 과거 사실을 기록하는 엔티티다. 주문이라는 사건에서 확정된 상품 정보를 기록하는 엔티티다. 따라서 가격은 Product가 아니라 OrderItem의 속성으로 모델링하도록 했다.
  • Product의 price와 OrderItem의 price로 현재와 과거의 가격을 분리했다.

🏗️ Design Overview

변경 범위

• 영향 받는 모듈/도메인: 설계 문서만 추가 (코드 변경 없음)
• 신규 추가:
  • .docs/design/01-requirements.md - 요구사항 명세
  • .docs/design/02-sequence-diagrams.md - 시퀀스 다이어그램
  • .docs/design/03-class-diagram.md - 클래스 다이어그램
  • .docs/design/04-erd.md - ERD
  • .claude/skills/SKILL.md - 요구사항 분석 스킬
• 제거/대체: 없음

주요 컴포넌트 책임

• 01-requirements.md: 도메인별 필드, 비즈니스 규칙, 유저 시나리오 16개, API 명세
• 02-sequence-diagrams.md: 주문/좋아요/브랜드 삭제/상품 조회/어드민 인증 시퀀스
• 03-class-diagram.md: 계층별 클래스 구조 (Controller → Facade → Service → Repository)
• 04-erd.md: 6개 테이블 스키마, 인덱스, FK 정책, 쿼리 최적화 가이드

🔁 Flow Diagram

주문 생성 Flow (설계 문서 기반)

sequenceDiagram
    autonumber
    participant Client
    participant OrderV1Controller
    participant OrderFacade
    participant OrderService
    participant ProductService
    participant DB

    Client->>OrderV1Controller: POST /api/v1/orders
    OrderV1Controller->>OrderFacade: createOrder(userId, items)
    OrderFacade->>OrderService: createOrder(userId, items)
    Note over OrderService: @Transactional 시작
    loop 각 주문 항목
        OrderService->>ProductService: getProductForOrder(productId)
        ProductService->>DB: SELECT ... FOR UPDATE
        DB-->>ProductService: Product
        OrderService->>OrderService: 재고 검증
        alt 재고 부족
            OrderService-->>Client: 400 INSUFFICIENT_STOCK (전체 롤백)
        end
        OrderService->>ProductService: decreaseStock(productId, quantity)
    end
    OrderService->>DB: INSERT orders, order_items
    Note over OrderService: @Transactional 커밋
    OrderService-->>Client: 201 Created

Loading

좋아요 토글 Flow (설계 문서 기반)

sequenceDiagram
    autonumber
    participant Client
    participant ProductLikeV1Controller
    participant ProductLikeFacade
    participant ProductLikeService
    participant DB

    Client->>ProductLikeV1Controller: POST /api/v1/products/{id}/likes
    ProductLikeV1Controller->>ProductLikeFacade: like(userId, productId)
    ProductLikeFacade->>ProductLikeService: like(userId, productId)
    ProductLikeService->>DB: SELECT FROM product_likes
    alt 좋아요 없음
        ProductLikeService->>DB: INSERT (신규 등록)
        ProductLikeService-->>Client: 200 OK "좋아요 등록"
    else 좋아요 존재
        ProductLikeService->>DB: DELETE (토글 취소)
        ProductLikeService-->>Client: 200 OK "좋아요 취소"
    end

Loading

---

📋 Checklist

• 상품/브랜드/좋아요/주문 도메인이 모두 포함되어 있는가?
• 기능 요구사항이 유저 중심으로 정리되어 있는가?
• 시퀀스 다이어그램에서 책임 객체가 드러나는가?
• 클래스 구조가 도메인 설계를 잘 표현하고 있는가?
• ERD 설계 시 데이터 정합성을 고려하여 구성하였는가?

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}