스프링 사전과제 가이드: 종합 과제

시리즈 네비게이션

📚 전체 로드맵: 스프링 사전과제 가이드 로드맵 참고

이 과제는 1~7편에서 다룬 모든 내용을 종합적으로 활용하는 실전 과제입니다.

과제 개요

온라인 마켓플레이스의 백엔드 API를 구현합니다. 판매자는 상품을 등록하고, 구매자는 상품을 검색하여 주문할 수 있습니다.

제출 기한

• 기한: 과제 수령일로부터 7일

기술 스택

• 필수: Java 17+ 또는 Kotlin, Spring Boot 3.x, JPA/Hibernate, Gradle
• 데이터베이스: H2 (로컬), MySQL 8.0 (Docker)
• 선택: QueryDSL, Redis

비즈니스 요구사항

1. 회원 관리

• 회원 유형: BUYER(구매자), SELLER(판매자), ADMIN(관리자)
• 회원가입 시 이메일 중복 검사
• 로그인 시 JWT 토큰 발급 (Access Token + Refresh Token)
• 판매자는 사업자등록번호 필수 입력

2. 상품 관리 (판매자 전용)

• 상품 등록/수정/삭제 (본인 상품만)
• 상품 이미지 업로드 (최대 5장, 각 10MB 이하)
• 상품 상태: DRAFT(임시저장), ON_SALE(판매중), SOLD_OUT(품절), DELETED(삭제)
• 재고 관리

3. 상품 조회 (전체 공개)

• 상품 목록 조회 (페이지네이션, 검색, 필터링)
• 상품 상세 조회
• 카테고리별 조회
• 인기 상품 목록 (캐싱 적용)

4. 주문 관리

• 구매자: 주문 생성, 주문 취소, 주문 내역 조회
• 판매자: 본인 상품 주문 확인, 배송 상태 변경
• 주문 상태: PENDING(대기) → CONFIRMED(확정) → SHIPPED(배송중) → DELIVERED(배송완료)
• 주문 취소는 PENDING, CONFIRMED 상태에서만 가능

5. 알림

• 주문 생성 시 판매자에게 알림 (비동기)
• 배송 상태 변경 시 구매자에게 알림 (비동기)
• 알림은 로그로 대체 (실제 발송 구현 불필요)

API 명세

인증 API

회원 API

상품 API

주문 API

카테고리 API

상세 요구사항

1. 인증/인가

[요구사항]
- JWT 기반 인증 (Access Token: 1시간, Refresh Token: 7일)
- 비밀번호는 BCrypt로 암호화
- Role 기반 접근 제어 (BUYER, SELLER, ADMIN)
- 리소스 소유자 검증 (본인 상품/주문만 수정 가능)

2. 상품 검색/필터링

GET /api/v1/products?keyword=노트북&categoryId=1&minPrice=100000&maxPrice=2000000&status=ON_SALE&page=0&size=20&sort=createdAt,desc

3. 주문 생성

// POST /api/v1/orders
{
  "orderItems": [
    {
      "productId": 1,
      "quantity": 2
    },
    {
      "productId": 3,
      "quantity": 1
    }
  ],
  "shippingAddress": {
    "zipCode": "12345",
    "address": "서울시 강남구 테헤란로 123",
    "addressDetail": "456호",
    "receiverName": "홍길동",
    "receiverPhone": "010-1234-5678"
  }
}

[주문 처리 규칙]
- 재고 확인 후 차감 (동시성 고려)
- 여러 판매자 상품 동시 주문 가능 (판매자별 주문 분리)
- 주문 생성 시 판매자에게 알림 이벤트 발행
- 재고 부족 시 주문 실패 처리

4. 파일 업로드

[요구사항]
- 지원 확장자: jpg, jpeg, png, gif
- 최대 파일 크기: 10MB
- 상품당 최대 5장
- 저장 경로: /uploads/products/{productId}/{filename}
- 파일명은 UUID로 변환하여 저장

5. 캐싱

[캐싱 대상]
- 인기 상품 목록: 10분 TTL
- 카테고리 목록: 1시간 TTL
- 상품 상세 (선택): 5분 TTL, 수정 시 무효화

6. 로깅

[요구사항]
- 모든 요청에 고유 Request ID 부여 (MDC)
- API 요청/응답 로깅 (AOP)
- 로그 포맷: [timestamp] [level] [requestId] [class] message

기술 요구사항

프로젝트 구조 선택

다음 두 가지 구조 중 하나를 선택하여 구현합니다.

Option A: 싱글 모듈 (권장)

marketplace/
└── src/main/java/com/example/
    ├── controller/
    ├── service/
    ├── repository/
    ├── domain/
    ├── dto/
    └── config/

Option B: 멀티 모듈 (도전)

두 가지 구조 중 선택 가능:

B-1. 정석 (DIP 적용)

marketplace/
├── marketplace-api/           # Controller, Security, 실행
├── marketplace-domain/        # Entity, Service, Repository 인터페이스
├── marketplace-infra/         # Repository 구현, 외부 연동
└── marketplace-common/        # 공통 예외, 유틸리티

B-2. 간소화 (실용적)

marketplace/
├── marketplace-api/           # Controller, Service, Security, 실행
├── marketplace-domain/        # Entity만
├── marketplace-infra/         # JpaRepository, QueryDSL
└── marketplace-common/        # 공통 예외, 유틸리티

멀티 모듈 선택 시 요구사항:

• 선택한 구조(B-1 또는 B-2)를 일관되게 적용
• B-1 선택 시: domain → infra 의존 금지, Repository 인터페이스/구현 분리
• B-2 선택 시: Service는 api 모듈에 위치, JpaRepository 직접 사용
• README에 선택한 구조와 이유 명시

필수 구현

선택 구현 (가산점)

데이터 모델 (참고)

Member
├── id (PK)
├── email (UNIQUE)
├── password (encrypted)
├── name
├── phone
├── role (BUYER, SELLER, ADMIN)
├── businessNumber (SELLER only)
├── createdAt
└── updatedAt

Product
├── id (PK)
├── sellerId (FK → Member)
├── categoryId (FK → Category)
├── name
├── description
├── price
├── stockQuantity
├── status (DRAFT, ON_SALE, SOLD_OUT, DELETED)
├── salesCount
├── createdAt
└── updatedAt

ProductImage
├── id (PK)
├── productId (FK → Product)
├── imageUrl
├── displayOrder
└── createdAt

Category
├── id (PK)
├── name
├── parentId (FK → Category, nullable)
└── displayOrder

Order
├── id (PK)
├── buyerId (FK → Member)
├── orderNumber (UNIQUE)
├── status (PENDING, CONFIRMED, SHIPPED, DELIVERED, CANCELLED)
├── totalAmount
├── shippingAddress (embedded)
├── orderedAt
└── updatedAt

OrderItem
├── id (PK)
├── orderId (FK → Order)
├── productId (FK → Product)
├── sellerId (FK → Member)
├── productName (snapshot)
├── productPrice (snapshot)
├── quantity
└── subtotal

평가 기준

기본 점수 (70점)

가산점 (35점)

감점 요소

제출 방법

1. GitHub Repository에 코드 업로드
2. README.md에 다음 내용 포함:
   • 실행 방법 (로컬, Docker)
   • 기술 스택 및 선택 이유
   • API 문서 접근 방법
   • 프로젝트 구조 설명
   • 추가 구현 사항
3. Repository URL 제출

참고 사항

실행 환경

싱글 모듈

# 로컬 실행 (H2)
./gradlew bootRun --args='--spring.profiles.active=local'

# Docker Compose 실행
docker-compose up -d

멀티 모듈

# 로컬 실행 (H2)
./gradlew :marketplace-api:bootRun --args='--spring.profiles.active=local'

# JAR 빌드
./gradlew :marketplace-api:bootJar

# Docker Compose 실행
docker-compose up -d

테스트 계정 (시드 데이터)

질문

• 과제 진행 중 질문은 이메일로 문의
• 요구사항 해석이 모호한 경우 합리적으로 판단하여 구현하고 README에 명시

체크리스트

제출 전 확인해주세요:

• ./gradlew build 성공
• docker-compose up 실행 가능
• Swagger UI 또는 REST Docs 접근 가능
• 테스트 전체 통과
• README.md 작성 완료
• .env, 시크릿 키 등 민감 정보 제외
• 불필요한 파일 (.idea, .DS_Store 등) 제외

힌트

// 1. 비관적 락
@Lock(LockModeType.PESSIMISTIC_WRITE)
@Query("SELECT p FROM Product p WHERE p.id = :id")
Optional<Product> findByIdWithLock(@Param("id") Long id);

// 2. 낙관적 락 + 재시도
@Version
private Long version;

// 주문 생성 후 이벤트 발행
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
public void handleOrderCreated(OrderCreatedEvent event) {
    // 비동기로 알림 처리
    notificationService.notifySeller(event.getSellerId(), event.getOrderId());
}

rootProject.name = 'marketplace'

include 'marketplace-api'
include 'marketplace-domain'
include 'marketplace-infra'
include 'marketplace-common'

// marketplace-common: 의존성 없음 (공통 유틸, 예외)

// marketplace-domain
dependencies {
    implementation project(':marketplace-common')
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
}

// marketplace-infra
dependencies {
    implementation project(':marketplace-common')
    implementation project(':marketplace-domain')
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    // QueryDSL (선택)
    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
    runtimeOnly 'com.h2database:h2'
    runtimeOnly 'com.mysql:mysql-connector-j'
}

// marketplace-api (실행 모듈)
dependencies {
    implementation project(':marketplace-common')
    implementation project(':marketplace-domain')
    implementation project(':marketplace-infra')
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-security'
}

// marketplace-domain/.../ProductRepository.java (인터페이스)
public interface ProductRepository {
    Product save(Product product);
    Optional<Product> findById(Long id);
}

// marketplace-infra/.../ProductRepositoryImpl.java (구현)
@Repository
@RequiredArgsConstructor
public class ProductRepositoryImpl implements ProductRepository {
    private final ProductJpaRepository jpaRepository;

    @Override
    public Product save(Product product) {
        return jpaRepository.save(product);
    }
}

// marketplace-infra/.../ProductJpaRepository.kt
interface ProductJpaRepository : JpaRepository<Product, Long>, ProductJpaRepositoryCustom {
    fun findBySellerId(sellerId: Long, pageable: Pageable): Page<Product>
}

// marketplace-infra/.../ProductJpaRepositoryCustom.kt
interface ProductJpaRepositoryCustom {
    fun search(keyword: String?, categoryId: Long?, pageable: Pageable): Page<Product>
}

// marketplace-infra/.../ProductJpaRepositoryImpl.kt (QueryDSL)
class ProductJpaRepositoryImpl(
    private val queryFactory: JPAQueryFactory
) : ProductJpaRepositoryCustom {
    override fun search(...) = queryFactory.selectFrom(product).where(...).fetch()
}

// marketplace-api/.../ProductService.kt (Service는 api 모듈에 위치)
@Service
class ProductService(
    private val productJpaRepository: ProductJpaRepository  // 직접 주입
) { ... }

// marketplace-api의 Application.java
@SpringBootApplication(scanBasePackages = "com.example")
public class MarketplaceApplication { }

FROM gradle:8.5-jdk17 AS builder
WORKDIR /app

# Gradle 파일 먼저 복사 (캐싱)
COPY build.gradle settings.gradle ./
COPY gradle ./gradle
COPY marketplace-common/build.gradle ./marketplace-common/
COPY marketplace-domain/build.gradle ./marketplace-domain/
COPY marketplace-infra/build.gradle ./marketplace-infra/
COPY marketplace-api/build.gradle ./marketplace-api/

RUN gradle dependencies --no-daemon || true

# 소스 복사 및 빌드
COPY . .
RUN gradle :marketplace-api:bootJar --no-daemon -x test

# Runtime
FROM eclipse-temurin:17-jre-alpine
WORKDIR /app
COPY --from=builder /app/marketplace-api/build/libs/*.jar app.jar
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "app.jar"]

👉 구현코드 보러가기

Good Luck!

👉 이전: 7편 - Advanced Patterns 👉 처음으로: 1편 - Core Application Layer