1. 프로젝트 개요

이번 파트에서는 한줄평을 등록하는 기능을 만들어 보겠습니다.

나의 예매 내역에서 확정된 예매의 경우, 예매자 리뷰 남기기 버튼이 보입니다.

예매자 리뷰 남기기 버튼을 클릭하면, 한줄평 등록 폼으로 이동합니다.

한줄평 등록 폼에는 별점, 리뷰, 사진을 등록할 수 있습니다.

예매자는 별점, 리뷰 정보를 입력하고 사진을 선택한 후 리뷰 등록 버튼을 클릭합니다.

리뷰 등록 버튼을 클릭하면, 리뷰가 등록되고 해당 리뷰가 달린 상세페이지로 리다이렉트 됩니다.

이번 파트에서는 백엔드의 경우, 기존에 배웠던 내용을 토대로 구현을 이어 나가시면 됩니다.

프론트엔드에서는 이번 파트에서 새롭게 배운 기술을 포함하여 추가로 구현해야 합니다.

기획서

기획서는 아래 파일을 통해서 확인하실 수 있습니다.

이번 파트는 아래 기획서 중 20-21 페이지 부분만 개발합니다.

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

[한줄평 등록] API 스펙 & test

• POST (한줄평 등록): /api/reservations/{reservationInfoId}/comments

[전시상품조회] API 스펙 & test

• GET (상품 전시 정보 구하기): /api/products/{displayInfoId}

4. 평가기준표

[기능]

1. 사진 등록 (업로드)
   
   • 사진 한장 업로드가 가능해야 한다.
   • 별점, 한줄평 내용, 사진파일을 서버로 올릴 수 있다.
   • 사진 파일의 확장자는 jpg, png 만 허용한다.
     

[소스코드]

1. JAVA - 이름 규칙
   
   • JAVA Naming Conventions 을 지킨다.(참고 1) (참고 2)
   • 클래스의 이름과 메소드의 이름은 직관적으로 작성하도록 한다.
     (클래스의 이름과 메소드의 이름만 보아도, 어떤 기능을 가지고 있을지 어떤 내용이 구현되어 있을지
     짐작할 수 있어야 한다.)
   • 코드를 읽는 사람이 개념을 쉽게 파악할 수 있도록 읽기 쉬운 코드를 작성하도록 한다.
     예를 들어 변수 이름을 구체적으로 작성하도록 한다.
     
     
2. JAVA - 중복된 코드 제거 및 코드 구조화
   
   • 중복된 코드가 있다면, 별도의 메소드나 클래스로 분리하도록 한다.
   • 하나의 메소드가 너무 많은 코드를 담지 않는다.
     코드의 양이 많을 경우 private한 메소드를 이용해서 메소드를 분리하거나 별도의 객체를 만들어 사용하도록 한다.
   • 클래스의 코드 길이가 너무 길어진다면, 해당 클래스가 몇개의 클래스로 분리될 수 있는지 고민한다.
   • 변수는 최대한 덜 사용하고, 최대한 가볍게 만들어 가독성을 높이도록 한다.
     
     
3. JAVA - 가독성
   
   • 조건문의 경우 긍정적이고 흥미로운 (주 흐름에 해당하는) 경우가 앞쪽에 위치하도록 한다.
   • 삼항연산자, do-while 문장은 코드 가독성을 떨어트리니 되도록 사용하지 않는다.
   • 블럭이 너무 많이 중첩되면 코드를 읽기 어려워진다. 블록을 private메소드로 추출할 수 있는지 고민한다.
   • 코드는 빈줄을 이용해 커다란 블록을 논리적인 문단으로 구분한다.
   • 코드는 들여쓰기를 잘 지키도록 한다.
   • 필요하지 않은 코드는 제거한다.
     
     
4. JAVA - 프로젝트 구조
   • Controller, Service, Repository를 사용하여 구현되어 있어야 한다.
   • Controller에서 Service를 Service에서 Repository의 기능을 호출할 수 있지만, 그 반대는 허용되지 않는다.
     
     
5. JAVA - Web API
   • 별점, 리뷰, 이미지 파일을 전달받아 저장하는 web api를 작성한다.
   • 업로드의 경우는 MultipartFile을 이용해 파일 정보를 읽어들여야 한다.
   • 이미지가 업로드 되는 경로는 /webapp 이하의 폴더가 아니어야 한다.
   • 동일한 이름의 파일을 업로드 하더라도 덮어쓰기가 되지 않도록 한다.
   • api가 호출될 때, 컨트롤러 메소드의 이름과 요청 시간 등을 Log로 기록하도록 한다.
     
     
6. JAVA - 다운로드
   • 이미지 id를 전달받아 해당 이미지를 다운로드 하는 컨트롤러를 작성한다.
     
     
7. JAVA - jsp
   • 기존 jsp의 이미지 경로를 이미지 다운로드 컨트롤러를 이용되도록 수정한다.

5. 프로젝트 제출방법

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

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

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

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