1. 프로젝트 개요

이번 프로젝트에서는 예약하기, 예약 목록 보기, 예약 취소 기능을 구현하도록 하겠습니다.

지난 프로젝트에 이어서 진행하시면 됩니다.

기획서

2. 프로젝트 개발스펙

개발환경

• JDK 설치 (ver 1.8)
• 이클립스 설치
• tomcat 설치 (ver 8.5)
• MySQL 설치

기술 요구사항

본 프로젝트에서는 프론트엔드 부분을 직접 구현하지 않습니다.

• 기존의 프로젝트에 Controller, Service, Dao 등을 추가하여 개발합니다.
• Spring Security를 이용하여 로그인 페이지를 작성합니다.
• Swagger를 이용해 Web API 테스트 페이지를 제공합니다.
• Web API를 JUnit을 이용해 Test합니다.
  

3. 프로젝트 개발과정 참고

개발순서 (BE)

1. Spring Security 설정을 추가한다.
2. 로그인 페이지를 작성한다.
3. 기존의 프로젝트에 샘플 데이터를 읽어 들여 상세화면을 위한 Web API를 작성한다.
4. 크롬에서 새로운 탭을 열고 로그인을 한다.
5. 크롬에서 새로운 탭을 열고 Swagger페이지에서 테스트를 진행한다.

Web API 명세서

이번 프로젝트에서는 다음과 같은 3가지의 Web API를 작성하도록 하겠습니다.

• 예약 등록하기 / 주문정보 구하기 / 예약 취소하기

1. 예약 등록하기
   POST (예약 등록하기): /api/reservationInfos
   
   POST 방식으로 예약정보를 등록합니다. 예약을 하기 위해서는 로그인 완료한 상태여야 합니다.
   
   각 속성의 설명은 다음과 같습니다.
   1. prices : 예매를 할 때 선택한 가격과 수량 정보
   2. productId : 상품 id
   3. displayInfoId : 전시 정보 id
   4. reservationYearMonthDay : 예약일 (반드시 yyyy.mm.dd 형식이어야 합니다.)
   5. userId : 로그인한 사용자 id
      
      
   6. id : 예약 id (자동 생성)
   7. productId : 상품 id
   8. displayInfoId : 전시 정보 id
   9. cancelFlag : 취소 유무 (0 : 취소 안함, 1 : 취소됨)
   10. reservationDate : 예약일
   11. createDate : 등록일
   12. modifyDate : 수정일
   13. prices : 예매를 할 때 선택한 가격과 수량 정보
   
   <요청 Body 예제>
   

   {
     "prices": [
       {
         "count": 2,
         "productPriceId": 3
       }
     ],
     "productId": 1,
     "displayInfoId": 1,
     "reservationYearMonthDay": "2020.01.02",
     "userId": 1
   }

   
   <응답결과>
   

   {
     "id": 17,
     "productId": 1,
     "cancelFlag": 0,
     "displayInfoId": 1,
     "userId": 1,
     "reservationDate": 1577890800000,
     "createDate": 1584369835893,
     "modifyDate": 1584369835893,
     "prices": [
       {
         "id": 21,
         "reservationInfoId": 17,
         "productPriceId": 3,
         "count": 2
       }
     ]
   }

   
   
2. 주문 정보 구하기
   GET (주문 정보 구하기): /api/reservationInfos
   
   주문한 상품 정보를 조회합니다. 주문한 상품 정보를 조회하기 위해서는 로그인 완료한 상태여야 합니다.
   
   각 속성의 설명은 다음과 같습니다.
   • size : 예약한 상품 수
   • items : 예약 상품 정보
   
   <응답결과>
   

   {
       "size": 2,
       "items": [
           {
               "id": 16,
               "productId": 1,
               "displayInfoId": 1,
               "cancelFlag": 1,
               "productDescription": "Paper, Present:너를 위한 선물",
               "productContent": "대림미술관은 오는 12월 7일부터 2018년 5월 27일까지 세계적인 아티스트들의 섬세한 감각과 아날로그적 소재인 종이가 만나 감성적인 매체로 확장되는 과정을 소개하는 전시 〈PAPER, PRESENT: 너를 위한 선물〉을 개최합니다. 이번 전시에서는 다양한 분야에서 활동하고 있는 아티스트들이 종이의 본래적 속성에 집중하여 재료 자체의 순수한 아름다움을 담은 작품들을 일곱 개의 감각적인 공간에서 선보입니다. 바람, 별빛, 햇살과 같은 자연 요소와 기억, 설렘과 같은 감정의 요소를 종이와 결합하여 구성한 공간들은, 자연 현상을 감각적으로 경험하고 아날로그적 정서를 자극하는 매체로서 종이를 경험하게 하며 종이에 감성을 입혀 예술로 만나는 특별한 시간을 선물할 것입니다.",
               "userId": 1,
               "sumPrice": 4000,
               "reservationDate": 1577890800000,
               "createDate": 1584369012000,
               "modifyDate": 1584369012000
           },
           {
               "id": 1,
               "productId": 1,
               "displayInfoId": 1,
               "cancelFlag": 0,
               "productDescription": "Paper, Present:너를 위한 선물",
               "productContent": "대림미술관은 오는 12월 7일부터 2018년 5월 27일까지 세계적인 아티스트들의 섬세한 감각과 아날로그적 소재인 종이가 만나 감성적인 매체로 확장되는 과정을 소개하는 전시 〈PAPER, PRESENT: 너를 위한 선물〉을 개최합니다. 이번 전시에서는 다양한 분야에서 활동하고 있는 아티스트들이 종이의 본래적 속성에 집중하여 재료 자체의 순수한 아름다움을 담은 작품들을 일곱 개의 감각적인 공간에서 선보입니다. 바람, 별빛, 햇살과 같은 자연 요소와 기억, 설렘과 같은 감정의 요소를 종이와 결합하여 구성한 공간들은, 자연 현상을 감각적으로 경험하고 아날로그적 정서를 자극하는 매체로서 종이를 경험하게 하며 종이에 감성을 입혀 예술로 만나는 특별한 시간을 선물할 것입니다.",
               "userId": 1,
               "sumPrice": 11000,
               "reservationDate": 1584363798000,
               "createDate": 1584363798000,
               "modifyDate": 1584363798000
           }
       ]
   }​

   
   
   
3. 예약 취소하기
   PUT (예약 취소하기): /api/reservationInfos
   
   PUT 방식으로 취소합니다. 예약을 취소하기 위해서는 로그인 완료한 상태여야 합니다.
   
   각 속성의 설명은 다음과 같습니다.
   • id : 예약 id
   • result : 성공시 success, 실패시 fail
   
   <요청 Body 예제>
   

   {
     "id": 16
   }

   
   <응답결과>
   

   {
     "result": "success"
   }​

4. 평가기준표

[소스코드]

1. 네이밍
   1. 변수명은 명사로 작성해야 한다.
   2. 메소드 명은 동사로 행위를 표현할 수 있어야 한다.
      
      
2. 단위분리
   • 하나의 메소드에서 하나의 행위만 하도록 한다.
     
     
3. 예외처리
   
   • 예외사항은 Exception을 활용하여 비즈니스적인 의미를 담을 수 있도록 한다.
   • 적절한 try ~ catch 절 사용으로 발생한 예외를 처리한다.
     
     
4. 컨벤션
   • 컨벤션 규칙을 잘 지키도록 한다. (자바 코드 컨벤션)

[테스트]

1. 단위 테스트
   • 단위별 테스트를 작성한다.
     
     
2. 웹 테스트
   • Swagger2를 이용하여 테스트할 수 있는 환경을 구성하고 테스트 한다.
     
     
3. 보안 테스트
   • 인증이 필요한 Web API의 경우, 로그인 후에만 사용 가능한지 확인한다.

5. 프로젝트 제출방법

본 프로젝트는 2023년 5월 31일자로 리뷰 제출이 중단되었습니다. 개인 학습용으로만 활용 부탁드립니다.

※ 동료 학습자의 원활한 학습을 위해 프로젝트 관련 소스코드 유출(SNS, Gitlab, Github)을 엄격히 금지합니다.

※ 개발환경의 버전을 맞추는 일은 서버 오류 등의 이슈를 방지할 수 있어 매우 중요합니다. 반드시 권장 버전으로 설치해 주세요.

※ 부스트코스의 프로젝트는 순차적으로 학습하도록 구성되어 있습니다. 프로젝트 진행에 참고 부탁드립니다.