diff --git a/README.md b/README.md index fb386a65..17014fc8 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,29 @@ -# Shimpyo_BE : 숙박 예약 서비스 - -2023-11-20 ~ 2023-12-01 +# Shimpyo_BE : 숙박 정보 조회/검색 및 숙박 예약 시스템 --- -## 📌 목차 +## 0. 목차 -- [멤버](#멤버) -- [설정](#설정) -- [설계](#설계) - - [아키텍처](#아키텍처) - - [DB 설계](#DB-설계) - - [API 설계](#API-설계) -- [CI/CD](#CICD) -- [API 문서](#API-문서) +- [1. 프로젝트 설명](#1-프로젝트-설명) + - [🧑🏻‍💻 팀원](#-팀원) + - [💁🏻 소개](#-소개) + - [🎯 목적](#-목적) + - [🔗 배포 링크](#-배포-링크) +- [2. 설정](#2-설정) +- [3. 설계](#3-설계) + - [📰 아키텍처](#-아키텍처) + - [💾 DB 설계](#-DB-설계) + - [📡 API 설계](#-API-설계) +- [4. CI/CD](#4-cicd) +- [5. 에러 해결](#5-에러-해결) +- [6. 회고](#6-회고) +- [7. API 문서](#7-API-문서) --- -## 멤버 +## 1. 프로젝트 설명 + +### 🧑🏻‍💻 팀원 @@ -42,22 +48,41 @@ + + + + +
정의정
- Backend + BE 팀장 		심재철
- Backend + BE 팀원 		이주연
- Backend + BE 팀원
+ - CI
+ - REST Docs
+ - 회원
+ - 즐겨찾기
+ 		+ - CD
+ - EC2
+ - 숙소
+ - 장바구니
+ 		+ - Redis 분산락
+ - 예약
+ - 별점
+
@@ -68,12 +93,12 @@
- 정지오 프로필 + 백상원 프로필 - 백상원 프로필 + 정지오 프로필 @@ -92,40 +117,123 @@ 최우혁
- Frontend + FE 팀장(전) 		- - 정지오
- Frontend + + 백상원
+ FE 팀장 		- - 백상원
- Frontend + + 정지오
+ FE 팀원 		장수빈
- Frontend + FE 팀원 		소유나
- Frontend + FE 팀원

+### 💁🏻 소개 + +![](src/main/resources/image/main-page.png) +> 숙박 정보 조회/검색 및 숙박 예약 시스템 + +### 🎯 목적 + +- 숙박 시설 제공 및 검색: 사용자가 특정 지역이나 날짜에 필요한 숙박 시설을 쉽게 찾을 수 있도록 정보를 제공합니다. +- 가용한 숙소 정보 제공: 사용자에게 해당 지역의 여러 숙소 옵션, 가격, 시설, 평가 등 다양한 정보를 제공하여 선택을 돕습니다. +- 온라인 예약 및 결제: 사용자가 선택한 숙소를 신속하게 예약하고, 온라인으로 결제할 수 있는 편리한 기능을 제공합니다. +- 평가 제공: 다른 이용자들의 평가를 통해 사용자가 숙소를 선택할 때 도움을 받을 수 있도록 합니다. + +### ⏰ 개발 기간 + +2023-11-20 ~ 2023-12-01 + +### 🔗 배포 링크 + +https://43.202.234.108.nip.io + +### 🪄 실행 가이드 + +1. Clone 받는다. + +```shell +git clone https://github.com/Shimpyo-House/Shimpyo_BE.git +cd Shimpyo_BE +``` + +2. 설정 파일을 작성한다. + +> `application.yaml` +> +> ```java +> spring: +> profiles: +> active: local + +> `application-local.yaml` +> ```java +> spring: +> config: +> activate: +> on-profile: local +> datasource: +> driver-class-name: org.mariadb.jdbc.Driver +> url: jdbc:mariadb://localhost:3308/shimpyo?createDatabaseIfNotExist=true&serverTimezone=Asia/Seoul +> username: ${DB_USERNAME} +> password: ${DB_PASSWORD} +> jpa: +> hibernate: +> ddl-auto: update +> show-sql: true +> properties: +> hibernate: +> default_batch_fetch_size: 100 +> data: +> redis: +> host: localhost +> port: 6379 +> jwt: +> secret: ${JWT_SECRET} +> access-token-expire-time: ${ACCEESS_TOKEN_EXPIRE_TIME} +> refresh-token-expire-time: ${REFRESH_TOKEN_EXPIRE_TIME} +> open-api: +> service-key: F+zEWUXK0YK5FtuiHBJpOdqfmCV5qNXt+0F5g7X67//VQnlWbQCMUF5UlKPMetolbj9LAbfC0o7+XBe2AyzaWQ== +> logging: +> level: +> root: debug + +3. Docker 컨테이너 실행 + +```shell +docker-compose up --build -d +``` + +4. Run + +```shell +gradle test +gradle build +gradle bootJar +``` --- -## 설정 +## 2. 설정 - 자바 버전: 17 - 스프링 버전: 6.0.13 @@ -140,60 +248,213 @@ - Spring Web - Test Containers - Json -- `applicaion-local.yaml`, `application-prod.yaml`, `.env` 파일은 LMS에서 확인하실 수 있습니다! +- `application.yaml`, `applicaion-local.yaml`, `application-prod.yaml`, `.env` 파일은 LMS에서 확인하실 수 + 있습니다! --- -## 설계 +## 3. 설계 -### 아키텍처 +### 📰 아키텍처 > ![](src/main/resources/image/architecture.png) -### DB 설계 +### 💾 DB 설계 + `ERD` > ![](src/main/resources/image/erd.png) -### API 설계 +### 📡 API 설계 [Spring REST Docs](#API-문서)를 통해 확인하실 수 있습니다. --- -## CI/CD +## 4. CI/CD -### CI +### 🛠️ CI > ![](src/main/resources/image/ci.png) -### CD +### 🛠️ CD > ![](src/main/resources/image/cd.png) --- -## API 문서 +## 5. 에러 해결 + +### 📌 주요 에러 + +> #### < Spring REST Docs snippet 에러 > +> Spring REST Docs 으로 API를 문서화 하기 위해 asciidoc을 사용합니다. +> +> 그런데 테스트 코드를 작성하고 빌드를 수행하면 만들어지는 html을 확인해보니, **snippets 파일을 찾지 못 하는 버그**가 발견되었습니다. +> +> ![](src/main/resources/image/docs-error.png) +> ```shell +> 11월 27, 2023 7:22:00 오후 uri:classloader:/gems/asciidoctor-2.0.10/lib/asciidoctor/reader.rb preprocess_include_directive +> SEVERE: member-api.adoc: line 15: include file not found: C:/Users/jeong/Desktop/FC/Shimpyo_BE/{snippets}/auth-rest-controller-docs-test/sign-up/http-request.adoc +> include file not found: C:/Users/jeong/Desktop/FC/Shimpyo_BE/{snippets}/auth-rest-controller-docs-test/sign-up/http-request.adoc :: member-api.adoc :: C:/Users/jeong/Desktop/FC/Shimpyo_BE/C:/Users/jeong/Desktop/FC/Shimpyo_BE/src/docs/asciidoc/member/member-api.adoc:15 (uri:classloader:/gems/asciidoctor-2.0.10/lib/asciidoctor/reader.rb:preprocess_include_directive) +> ``` +> #### < 에러 해결 > +> snippets 경로를 index.adoc 파일이 아니라 member-api.adoc 파일에서 지정해보니, 정상적으로 작동하는 것을 확인할 수 있었습니다. +> +> ```shell +> ifndef::snippets[] +> :snippets: build/generated-snippets +> endif::[] +> +> = Member REST API Docs +> :doctype: book +> :icons: font +> :source-highlighter: highlightjs +> :toc: left +> :toclevels: 2 +> +> ~~ 생략 ~~ +> ``` + +> #### < Open API Service Key 에러 > +> Open API 에서 숙박 상품 조회를 하기 위해 요청을 보냈는데, 다음과 같은 응답을 받았습니다. +> +> ```shell +> +> +> SEVICE ERROR +> SERVICE_KEY_IS_NOT_REGISTERED_ERROR +> 30 +> +> +> ``` +> Service Key가 등록되지 않았다는 에러 응답이었습니다. +> +> 디코딩 서비스 키를 사용해보기도 하고 인코딩 서비스키를 사용해보기도 했으나 여전히 같은 응답이 돌아왔습니다. +> +> #### < 에러 해결 > +> Service 키를 먼저 인코딩 한 후 Uri 빌드 시 true 옵션을 부여하여 해결했습니다. +> ```java +> // ~~ 생략 ~~ +> private String makeBaseSearchUrl() { +> String STAY_SEARCH_URI = "/searchStay1"; +> return BASE_URL + STAY_SEARCH_URI + +> "?serviceKey=" + URLEncoder.encode(SERVICE_KEY, StandardCharsets.UTF_8) + +> DEFAULT_QUERY_PARAMS; +> } +> // ~~생략~~ +> private JSONObject getAccommodation(int pageSize, int pageNum) throws JSONException { +> URI uri = UriComponentsBuilder.fromHttpUrl(makeBaseSearchUrl()) +> .queryParam("pageNo", pageNum) +> .queryParam("numOfRows", pageSize) +> .build(true).toUri(); +> ResponseEntity response = restTemplate.exchange(uri, HttpMethod.GET, +> httpEntity, String.class); +> log.info("숙박 정보 조회"); +> return new JSONObject(response.getBody()) +> .getJSONObject("response") +> .getJSONObject("body"); +> } +> // ~~ 생략 ~~ + +> #### < 상수화 Wrapper Type 에러 > +> 상수 조건 값을 Wrapper Type으로 선언해 빌드시 롬복 자체 식별이 안되는 에러가 발생했습니다. +> +> ![](src/main/resources/image/wrapper-error-1.png) +> +> #### < 에러 해결 > +> 유효성 검증 값의 경우 원시 타입으로 선언되어 있어 원시 타입으로 변경하여 해결했습니다. +> +> ![](src/main/resources/image/wrapper-error-2.png) +> + +## 6. 회고 +
+정의정 +
+ +- **느낀 점** + - 본 프로젝트에서 BE 팀장으로서 참여하였는데, 전체적인 프로젝트 총괄을 맡으면서 각 팀간 소통과 회의 진행에 있어서 어려움을 느꼈습니다. + - 이번 협업 경험을 통해 다른 분야와의 소통 방식에 대해 고민하고, 원활한 소통을 위해 서로의 이해와 배려가 중요하다는 것을 다시 한 번 느낄 수 있었습니다. + +- **프로젝트를 하면서 잘했던 점** + - 매일 Daliy Scrum을 진행하여 현재 프로젝트 진행 상황을 파악하고 효과적으로 일 단위 task를 수행할 수 있었습니다. + - 2주 단위 스프린트로 기능을 개발하여 짧은 시간 안에 효율적인 개발이 가능했습니다. + - 적극적인 코드 리뷰를 통해 더 나은 코드 작성법에 대해 생각할 수 있었고, 팀원 간 코드를 분석하고 배울 수 있었습니다. + - GitHub와 Discord를 웹훅을 통해 연결하여 PR, ISSUE 등 알림 기능을 구현하여 빠른 피드백이 가능했습니다. + - REST Docs를 도입하여 테스트 코드를 통한 안정적인 API 문서화를 수행할 수 있었습니다. + +- **프로젝트를 진행하면서 힘들었던 점** + - FE와 개발 속도를 맞추는데 어려움을 느꼈습니다. + - 본 프로젝트는 FE 5명, BE 3명으로, BE가 비교적 적은 인원이었습니다. + - 요구사항과 일정에 맞게 개발을 하면서 FE 팀이 API 연결 기간을 충분히 가질 수 있도록 하기 위해 많은 노력이 필요했습니다. + - 또한, 서로의 기술에 대해 모르다보니 FE와의 소통에 어려움을 느꼈습니다. + - FE와의 협업을 위한 기본적인 지식을 겸비해야겠다는 생각을 했습니다. + +
+
+ +
+이주연 +
+ +- **느낀 점** + - 프론트엔드와의 협업 프로젝트는 처음이었는데, 프론트엔드와 소통하며 API를 연결하는 방법을 배울 수 있었던 시간이었습니다. + - 매일 10시, 17시 데일리 스크럼 시간을 잘 활용해 서로의 상황을 꾸준히 공유하여 계획에 큰 차질없이 프로젝트가 진행될 수 있었던 것 같습니다. + - 백엔드 팀원들간의 코드 리뷰를 통해 서로의 코드를 공유하고 의견을 나누며 많이 배울 수 있는 시간이었습니다. + +- **프로젝트를 하면서 잘했던 점** + - 매일 10시, 17시 데일리 스크럼 시간을 잘 활용해 서로의 상황을 꾸준히 공유하여 계획에 큰 차질없이 프로젝트가 진행될 수 있었던 것 같습니다. + +- **프로젝트를 진행하면서 힘들었던 점** + - 프론트엔드에 대해 지식이 부족하기 때문에 프론트엔드가 설명해주는 것을 빠르게 이해하고 소통하는데 어려움을 겪었습니다. 이번 프로젝트를 통해 프론트엔드에 대해 조금 알아갈 수 있었던 것 같습니다. + +
+
+ +
+심재철 +
+ +- **배운 점** + - 프로젝트를 통해 나의 경험 중 하나로, 효과적인 협업을 위해서는 자신의 진행 상황을 솔직하게, 빠르게 전달하는 것이 상당히 중요하다는 것을 깨달았습니다. 투명하게 소통함으로써 팀 전체가 현재 상황을 정확히 파악하고, 문제 발생 시 신속한 대응이 가능하다는 것을 인지했습니다. + +- **프로젝트를 하면서 잘했던 점** + - 프로젝트 진행 중에는 효과적인 협업을 실현하기 위해 서로의 진행 상황을 체계적으로 공유하면서 개발을 진행했습니다. + - 팀 원 개개인이 빈 시간이 발생할 때 주도적으로 추가 기능이나 프로젝트에 필요한 작업들을 수행하고자 해서 프로젝트 일정에 맞출 수 있었습니다. + +- **프로젝트를 진행하면서 힘들었던 점** + - 프로젝트에서 가장 어려웠던 부분은 팀 구성원이 3명이어서 요구사항에 따른 API 개발을 프로젝트 일정에 맞추는데 빠듯함이 있었습니다. + +
+
+ +## 7. API 문서 ※ Spring REST Docs로 문서화했습니다. > `index` -> ![](src/main/resources/image/index-docs.png) +> ![](src/main/resources/image/docs/index-docs.png) > > `Member API Docs` -> ![](src/main/resources/image/member-docs.png) +> ![](src/main/resources/image/docs/member-docs.png) > > `Product API Docs` -> ![](src/main/resources/image/product-docs.png) +> ![](src/main/resources/image/docs/product-docs.png) +> +> `Room API Docs` +> ![](src/main/resources/image/docs/room-docs.png) > > `Cart API Docs` -> ![](src/main/resources/image/cart-docs.png) +> ![](src/main/resources/image/docs/cart-docs.png) > > `Reservation API Docs` -> ![](src/main/resources/image/reservation-docs.png) +> ![](src/main/resources/image/docs/reservation-docs.png) > > `Reservation Product API Docs` -> ![](src/main/resources/image/reservation-product-docs.png) +> ![](src/main/resources/image/docs/reservation-product-docs.png) > > `Star API Docs` -> ![](src/main/resources/image/star-docs.png) -> +> ![](src/main/resources/image/docs/star-docs.png) +> +> `Favorite API Docs` +> ![](src/main/resources/image/docs/favorite-docs.png) diff --git a/src/main/resources/image/cart-docs.png b/src/main/resources/image/cart-docs.png deleted file mode 100644 index 92d3c3b1..00000000 Binary files a/src/main/resources/image/cart-docs.png and /dev/null differ diff --git a/src/main/resources/image/docs-error.png b/src/main/resources/image/docs-error.png new file mode 100644 index 00000000..7b4465d7 Binary files /dev/null and b/src/main/resources/image/docs-error.png differ diff --git a/src/main/resources/image/docs/cart-docs.png b/src/main/resources/image/docs/cart-docs.png new file mode 100644 index 00000000..8bce70a1 Binary files /dev/null and b/src/main/resources/image/docs/cart-docs.png differ diff --git a/src/main/resources/image/docs/favorite-docs.png b/src/main/resources/image/docs/favorite-docs.png new file mode 100644 index 00000000..dd3f9974 Binary files /dev/null and b/src/main/resources/image/docs/favorite-docs.png differ diff --git a/src/main/resources/image/index-docs.png b/src/main/resources/image/docs/index-docs.png similarity index 100% rename from src/main/resources/image/index-docs.png rename to src/main/resources/image/docs/index-docs.png diff --git a/src/main/resources/image/docs/member-docs.png b/src/main/resources/image/docs/member-docs.png new file mode 100644 index 00000000..7f8508f7 Binary files /dev/null and b/src/main/resources/image/docs/member-docs.png differ diff --git a/src/main/resources/image/docs/product-docs.png b/src/main/resources/image/docs/product-docs.png new file mode 100644 index 00000000..c76c4ba0 Binary files /dev/null and b/src/main/resources/image/docs/product-docs.png differ diff --git a/src/main/resources/image/docs/reservation-docs.png b/src/main/resources/image/docs/reservation-docs.png new file mode 100644 index 00000000..4fbe06cc Binary files /dev/null and b/src/main/resources/image/docs/reservation-docs.png differ diff --git a/src/main/resources/image/docs/reservation-product-docs.png b/src/main/resources/image/docs/reservation-product-docs.png new file mode 100644 index 00000000..1b26250f Binary files /dev/null and b/src/main/resources/image/docs/reservation-product-docs.png differ diff --git a/src/main/resources/image/docs/room-docs.png b/src/main/resources/image/docs/room-docs.png new file mode 100644 index 00000000..db0832d7 Binary files /dev/null and b/src/main/resources/image/docs/room-docs.png differ diff --git a/src/main/resources/image/docs/star-docs.png b/src/main/resources/image/docs/star-docs.png new file mode 100644 index 00000000..08db15b6 Binary files /dev/null and b/src/main/resources/image/docs/star-docs.png differ diff --git a/src/main/resources/image/erd.png b/src/main/resources/image/erd.png index 8c04e67c..67056c54 100644 Binary files a/src/main/resources/image/erd.png and b/src/main/resources/image/erd.png differ diff --git a/src/main/resources/image/main-page.png b/src/main/resources/image/main-page.png new file mode 100644 index 00000000..13340c86 Binary files /dev/null and b/src/main/resources/image/main-page.png differ diff --git a/src/main/resources/image/member-docs.png b/src/main/resources/image/member-docs.png deleted file mode 100644 index 16fd7f5b..00000000 Binary files a/src/main/resources/image/member-docs.png and /dev/null differ diff --git a/src/main/resources/image/product-docs.png b/src/main/resources/image/product-docs.png deleted file mode 100644 index 17af6ec0..00000000 Binary files a/src/main/resources/image/product-docs.png and /dev/null differ diff --git a/src/main/resources/image/reservation-docs.png b/src/main/resources/image/reservation-docs.png deleted file mode 100644 index 1183fb08..00000000 Binary files a/src/main/resources/image/reservation-docs.png and /dev/null differ diff --git a/src/main/resources/image/reservation-product-docs.png b/src/main/resources/image/reservation-product-docs.png deleted file mode 100644 index 10351bf0..00000000 Binary files a/src/main/resources/image/reservation-product-docs.png and /dev/null differ diff --git a/src/main/resources/image/star-docs.png b/src/main/resources/image/star-docs.png deleted file mode 100644 index 92a3f61e..00000000 Binary files a/src/main/resources/image/star-docs.png and /dev/null differ diff --git a/src/main/resources/image/wrapper-error-1.png b/src/main/resources/image/wrapper-error-1.png new file mode 100644 index 00000000..ce58b621 Binary files /dev/null and b/src/main/resources/image/wrapper-error-1.png differ diff --git a/src/main/resources/image/wrapper-error-2.png b/src/main/resources/image/wrapper-error-2.png new file mode 100644 index 00000000..1fc49f8a Binary files /dev/null and b/src/main/resources/image/wrapper-error-2.png differ