🍔스팡잇츠 프로젝트

---

프로젝트 소개

• 진행 기간: 2024-11-01 ~ 2024-11-07
• 스팡잇츠는 배달의민족과 쿠팡이츠를 벤치마킹하여 개발된
  배달 서비스 앱의 백엔드 프로젝트입니다.
• 사용자는 다양한 가게의 메뉴를 검색하고 주문할 수 있으며,
  사장님은 가게와 메뉴를 관리할 수 있습니다.
• 주요 기능으로는 회원 관리, 가게 및 메뉴 관리, 주문 관리, 리뷰 기능 등이 포함됩니다.

---

팀원 구성

팀원	역할	GitHub
이한식	회원 기능 (로그인, 회원가입, 회원탈퇴 등)	@coldrice99
김신희	주문 관리 (주문 생성, 상태 변경, 로그 기록)	@shinheekim
박지예	메뉴 관리 (메뉴 추가, 수정, 삭제)	@bbobsang
지창현	리뷰 기능 (리뷰 작성, 수정, 삭제, 필터링)	@tesbro1194
최서영	가게 관리 (가게 등록, 조회, 수정, 폐업)	@seoyeong-4811

---

채택한 개발 기술과 브랜치 전략

Spring Boot & JPA

• Spring Boot를 사용하여 RESTful API 설계와 서버 구축을 진행하였습니다.
• JPA로 데이터베이스와의 매핑을 통해 효율적인 데이터 관리 및 트랜잭션을 유지했습니다.

JWT 인증

• 사용자 인증에 JWT(Json Web Token)를 적용하여 회원 로그인과 인증을 처리했습니다.

브랜치 전략

• Git-flow 전략을 활용하여 main, develop, issue 브랜치를 관리했습니다.
  • main: 배포 버전을 관리하는 브랜치
  • develop: 개발 단계에서 통합되는 브랜치
  • issue: 기능별로 작업 후 develop 브랜치에 병합

---

초기 깃 컨벤션

• PR - 작은 단위의 작업을 올리고, TEST까지 완료했을 때마다 보내기⭐
  PR 제목 - 내가 완료한 기능/ 부분 - 앞으로 내가 개발할 거
  

• Issues 관리 - Issue 번호에 맞게 브랜치 생성

  

• commit message

  [#1] feat: 게시글 조회
  

• merge ⇒ approve 2명
  

프로젝트 구조

├── README.md
├── .gitignore
├── build.gradle
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com.sparta.spangeats
│   │   │       ├── common
│   │   │       ├── domain
│   │   │       │   ├── address
│   │   │       │   ├── auth
│   │   │       │   ├── basket
│   │   │       │   ├── cart
│   │   │       │   ├── member
│   │   │       │   ├── menu
│   │   │       │   ├── order
│   │   │       │   ├── orders
│   │   │       │   ├── review
│   │   │       │   └── store
│   │   │       └── security
│   │   └── resources
│   └── test
└── SpangEatsApplicationTests.java

역할 분담

• 🧑‍💻 이한식: 회원 기능 (로그인, 회원가입, 회원탈퇴, 카카오 소셜 로그인, 관리자 기능)
• 👩‍💻 김신희: 주문 기능 (주문 생성, 상태 변경, 로그 기록), 회원 주소 관리, 장바구니 기능(+스케줄러)
• 👩‍💻 박지예: 메뉴 관리 (메뉴 추가, 수정, 삭제, 카테고리)
• 👨‍💻 최서영: 가게 관리 (가게 등록, 조회, 수정, 폐업, 공지)
• 👩‍💻 지창현: 리뷰 기능 (리뷰 작성, 수정, 삭제, 가게 별 조회, 회원 별 조회)

필수 기능 구현에만 집중하여 최대한 화요일까지 개발 완료를 목표, 이후 추가 기능들 구현

---

프로젝트 설계

https://www.figma.com/design/b4yYQvAKbWrzVL82929thO/%EC%8A%A4%ED%8C%A1%EC%9D%B4%EC%B8%A0?node-id=0-1&t=LnlR7lOuCwpRsVzp-1

와이어프레임

1.회원 관리

2.가게관리

3.메뉴관리

4.주문관리

5.리뷰관리

• API 명세서

회원 API

기능	URL	Method	Request Body	Response
회원가입	/api/auth/signup	POST	email (이메일 형식), password (비밀번호), nickname (닉네임), memberRole (USER/OWNER/ADMIN), phoneNumber (전화번호), adminSecretKey (관리자 회원가입 시 필요)	성공 시: "회원 가입이 완료되었습니다!" 실패 시: 에러 메시지
로그인	/api/auth/login	POST	email (이메일 형식), password (비밀번호)	성공 시: JWT 토큰 반환 실패 시: 에러 메시지
회원 정보 조회	/api/auth/me	GET	Headers: Authorization: Bearer {JWT}	사용자 정보 반환
전체 회원 조회 (관리자)	/api/admin/members	GET	Headers: Authorization: Bearer {JWT}	전체 회원 목록 반환
회원 탈퇴	/api/auth/delete	DELETE	Headers: Authorization: Bearer {JWT}, password (회원 탈퇴 시 비밀번호 확인)	성공 시: "회원 탈퇴 완료" 메시지 반환

---

가게 관리 API

기능	URL	Method	Request Body	Response
가게 등록	/api/stores	POST	storeName (가게 이름), category (카테고리), notice (가게 공지)	성공 시: 등록된 가게 정보 반환
가게 정보 조회	/api/stores/{storeId}	GET	-	가게 정보와 메뉴 목록 반환
가게 목록 조회	/api/stores	GET	name (이름으로 검색), category (카테고리별 조회)	검색 조건에 맞는 가게 목록 반환
가게 공지 수정	/api/stores/{storeId}/notice	PATCH	notice (변경할 공지 내용)	성공 시: 수정된 가게 공지 반환
가게 삭제	/api/stores/{storeId}	DELETE	-	성공 시: 삭제 완료 메시지 반환

---

메뉴 관리 API

기능	URL	Method	Request Body	Response
메뉴 추가	/api/stores/{storeId}/menus	POST	menuName (메뉴 이름), price (가격), description (설명)	성공 시: 추가된 메뉴 정보 반환
메뉴 조회	/api/menus/{menuId}	GET	-	메뉴 상세 정보 반환
메뉴 수정	/api/menus/{menuId}	PATCH	menuName (메뉴 이름), price (가격), description (설명)	성공 시: 수정된 메뉴 정보 반환
메뉴 삭제	/api/menus/{menuId}	DELETE	-	성공 시: 삭제 완료 메시지 반환

---

장바구니 API

기능	URL	Method	Request Body	Response
장바구니 추가	/api/cart	POST	menuId (메뉴 ID), quantity (수량)	성공 시: 장바구니 항목 추가 결과 반환
장바구니 조회	/api/cart	GET	-	사용자의 장바구니 목록 반환
장바구니 수량 수정	/api/cart/{cartItemId}	PATCH	quantity (수정할 수량)	성공 시: 수정된 장바구니 항목 반환
장바구니 항목 삭제	/api/cart/{cartItemId}	DELETE	-	성공 시: 삭제 완료 메시지 반환

---

주문 API

기능	URL	Method	Request Body	Response
주문 생성	/api/orders	POST	storeId (가게 ID), menuList (menuId, quantity)	성공 시: 주문 생성 결과 반환
주문 상태 변경	/api/orders/{orderId}/status	PATCH	status (REQUEST, ACCEPTED, CANCEL 등)	성공 시: 주문 상태 변경 결과 반환
특정 주문 조회	/api/orders/{orderId}	GET	-	주문 상세 정보 반환
전체 주문 내역 조회	/api/orders/history	GET	-	사용자의 모든 주문 내역 반환

---

리뷰 API

기능	URL	Method	Request Body	Response
리뷰 작성	/api/reviews	POST	orderId (주문 ID), rating (1-5), comment (리뷰 내용)	성공 시: 작성된 리뷰 정보 반환
리뷰 조회	/api/reviews/{reviewId}	GET	-	리뷰 상세 정보 반환
리뷰 수정	/api/reviews/{reviewId}	PATCH	rating (수정할 평점), comment (수정할 리뷰 내용)	성공 시: 수정된 리뷰 정보 반환
리뷰 삭제	/api/reviews/{reviewId}	DELETE	-	성공 시: 삭제 완료 메시지 반환

---

ERD

---

페이지별 기능

회원 기능

회원가입 및 로그인

• 회원가입: 이메일과 비밀번호를 입력받아 검증한 후, 비밀번호는 CustomPasswordEncoder를 사용해 암호화하여 저장합니다.
• 일반 로그인: 로그인 시, 검증을 통과하면 JWT 토큰을 발급하여 사용자 인증을 처리합니다.
• 관리자 로그인: 요청 바디에 추가로 admin 키를 입력받아 검증을 거친 뒤 로그인 가능하도록 구현했습니다.

회원 정보 조회 및 수정

• 정보 조회: 사용자가 자신의 정보를 조회할 수 있는 기능을 제공합니다.
• 정보 수정: 사용자가 자신의 정보를 업데이트할 수 있습니다.

회원 탈퇴

• 탈퇴 처리: 사용자 본인의 요청으로 계정을 탈퇴 처리할 수 있으며, 탈퇴된 계정은 재사용이 불가하도록 관리합니다.

관리자 기능

• 전체 회원 조회: 관리자 권한으로 전체 회원의 정보를 조회할 수 있는 기능을 제공하여 사용자 관리가 가능하도록 했습니다.

카카오 소셜 로그인

• 제한 사항: 카카오 API를 통한 소셜 로그인으로 사용자 아이디, 이메일, 닉네임 정보를 받아 로그인할 수 있지만, 비밀번호 검증이 필요한 일부 기능에는 접근이 제한됩니다.

가게 등록 및 조회

• 사장님 권한을 가졌을 경우에만 최대 3개 까지 가게 생성이 가능
• 가게 공지 입력시, 금지어는 입력 불가
• 특정 가게 조회시 메뉴도 함께 조회 가능
• 이름으로 가게 조회시, open 상태인 가게만 최근등록일 기준으로 조회됨

메뉴 관리

• 메뉴 추가, 수정, 삭제 (삭제된 메뉴는 조회에서 제외)

장바구니 및 주문 관리

• 장바구니 메뉴들을 담을 수 있습니다.
  • 다른 매장의 메뉴들을 담는 경우 이미 있던 장바구니들을 초기화 하고 담습니다.
  • 또한 같은 매장의 같은 메뉴를 또 담는 경우에는 수량을 업데이트하고, 없으면 새로운 장바구니 항목을 생성하여 저장합니다.
• 장바구니 조회, 수량 업데이트, 삭제가 가능합니다.
• 하루 이상 지난 장바구니 항목들을 삭제합니다.
  이 작업은 스케줄러를 통해 매일 자정에 자동으로 진행됩니다.

  ---

• 주문을 생성할 수 있습니다. 장바구니에 담았던 기록들을 프론트에서 리스트로 넘겨준 후 각 주문 항목에 대한 Menu 존재 여부를 확인한 후 주문과 메뉴 사이의 중간 테이블 또한 생성해줍니다.
  • 최소 주문 금액 이상 주문해야 주문이 가능합니다.
  • 오픈 시간 전, 마감 시간 이후는 주문이 불가합니다.
• 사용자는 특정 주문, 모든 주문 내역을 조회할 수 있습니다.
• 주문 상태는 총 4가지로, REQUEST, CANCEL, ACCEPTED, REJECTED의 상태가 있습니다.
  추후에는 배달 시작, 배달 완료까지 주문 상태를 늘려보려고 합니다.
• 주문을 생성한 경우, 또 상태가 변경된 후에 모두 로그 관리를 합니다.

리뷰 작성 및 조회

• 객체를 참조하지 않고, 필드를 가지는 것으로 구현
• 리뷰 작성 시 주문 하나 당 한 건 가능
• 모든 조회 - 페이지네이션
• 가게 별 조회, 회원 별 조회
• 가게 별 조회 시 JPQL 사용
• 각 메서드에 대한 테스트 코드 작성 완료

---

개선 목표

회원 기능

• 검증 로직의 일관성 유지: 서비스 레이어 또는 필터 중 한 곳에 검증 로직을 일관되게 통합해 코드 가독성과 유지보수성을 높일 예정입니다.
• 관리자 기능 확장: ADMIN 역할의 관리자 기능 추가를 통해 다양한 관리 기능을 추가할 예정입니다.
• 카카오 소셜 로그인 제한사항 개선: 카카오 API의 권한 한계로 인해 일부 기능이 제한되어, 대체 인증 방안 모색 예정입니다

가게 및 메뉴 기능

• 연관관계 개선: 가게와 메뉴 간의 1:N(양방향) 관계에서 참조 순환 문제 해결을 위해 필요한 정보만 반환하도록 개선 예정입니다.
• 카테고리별 조회 기능 추가: 가게를 카테고리별로 조회할 수 있도록 기능 확장 예정입니다.

메뉴 관리 기능

• 카테고리 및 옵션 기능 추가: 카테고리와 옵션 기능을 구현한 프로젝트의 포스트맨 테스트를 완료할 예정입니다.

주문 관리 기능

• 예외 처리: 실제 서비스를 다시 떠올려 보면서 추가될만한 예외처리들을 적용해보고,
• 테스트 코드 작성

리뷰 관리 기능

• 예외 처리 추가
• 주문 완료 후 리뷰는 14일 이내 작성
• 리뷰 작성 후 수정은 리뷰 작성 7일 이내 가능
• 연관 관계를 맺지 않아 회원이 탈퇴 이후에도 데이터가 DB에 남는 문제 해결

---

프로젝트 후기(+ 약간의 트러블 슈팅)

• 🧑‍💻이한식
  • 이번 프로젝트에서 회원가입, 로그인, 회원탈퇴 기능을 구현하며, Spring Security와 JWT 방식의 이점에 대해 깊이 이해하게 되었습니다. 초기에는 패스워드 인코더를 직접 구현해야 한다는 발제 조건 때문에 JWT만으로 인증을 구현하려 했지만, Spring Security의 내장 기능이 보안성과 유지보수성 측면에서 우수하다는 것을 알게 되어 최종적으로 Spring Security와 JWT 방식을 도입했습니다.
  • 또한, 인증 및 인가 필터를 직접 구현하고, USER와 OWNER 외에 ADMIN 역할을 추가해 관리자만 접근할 수 있는 기능을 /api/admin 엔드포인트로 설정했습니다. 비록 전체 회원 정보 조회 기능만 구현이 됐지만, 다양한 관리 기능을 확장할 계획도 세웠습니다.
  • 마지막으로, 카카오 소셜 로그인 기능을 구현했으나 API 권한 한계로 인해 아이디, 이메일, 닉네임 정보만 활용할 수 있어 패스워드 검증이 필요한 일부 기능에 접근하지 못한 점은 아쉬웠습니다. 이러한 제한 사항을 어떻게 개선할지에 대해 고민하게 되는 계기가 되었습니다.
  • 트러블 슈팅 문제 1: 회원 상태 확인 시 403 에러 및 NullPointerException 발생

    • 원인: permitAll() 설정 경로에서는 UserDetails 객체가 생성되지 않아 null이 반환되었습니다.

    • 해결: UserDetails 없이 이메일 중복 여부로 탈퇴 여부를 확인하도록 수정했습니다.

      문제 2: 필터 체인에서 요청이 차단되어 회원가입 API가 도달하지 않음

    • 원인: JwtAuthorizationFilter의 doFilter() 호출이 조건문 내부에 있어 요청이 필터에서 차단됨.

    • 해결: doFilter() 호출을 조건문 밖으로 이동해 요청이 컨트롤러까지 전달되도록 수정했습니다.

• 🧑‍💻 김신희
  • 처음에는 왜 장바구니가 주문과 메뉴의 중간테이블이 되는 것보다 장바구니는 view로 보여지고 따로 중간 테이블을 만드는 것이 좋은 지 이해하지 못했었습니다. 하지만 튜터님들의 설명과 고민을 오래해본 결과 후자를 선택하는 것이 더 낫다고 판단하였습니다. 장바구니의 경우는 사용자가 주문할 메뉴들을 고민하는 중간 상태를 나타냅니다. 따라서 실제 주문하지 않고도 항목을 자유롭게 추가하고 제거할 수 있는 상태로써 “작업 영역”에 가깝습니다. 따라서 주문과 장바구니 테이블을 따로 만들어서 확정된 항목들이 넘어오는 것이 더 데이터의 일관성을 지킬 수 있다고 판단했습니다.
    또한 장바구니와 주문을 분리함으로써 실제 주문 기록에 영향을 주지 않고 사용자가 관심 있는 현재 항목을 보여줄 수 있다는 것이 좋다고 판단했습니다. ERD를 짜다보면 항상 이유가 있는 다른 방법들이 있어서 새롭고 재밌다고 느꼈습니다.
  • 처음 Rebase 전략 및 issue에 맞는 브랜치 전략을 사용해봤는데, 생각보다 어렵지 않게 경험할 수 있어서 좋았습니다. 앞으로도 issue 생성 후에 해당 이슈에 맞는 브랜치를 만들어 개발하려고 합니다.
• 🧑‍💻 박지예
  • 기능을 구현하는 과정에서 많은 실수를 겪었는데, 그 실수를 해결하지 못하고 끝내는 것이 매우 속상하고 아쉽습니다. 향후에는 시간관리를 체계적으로 분배하고 관리해야할 필요성이 있다고 느꼈습니다. 실력이 모자라 팀원 분들께 피해만 끼친것같아 죄송스럽기도 한 마음입니다. 그래도 좋은 팀원분들 덕분에 무사히 프로젝트를 완수할 수 있었던것 같습니다. 고생들 많으셨고 감사했습니다
• 🧑‍💻 지창현
  • 다양한 방식으로 구현을 할 수 있고, 방식마다 장단점이 있다는 걸 확실히 느꼈습니다. 예를 들자면 가게 별 리뷰를 조회할 때, 가게와 리뷰의 연관 관계가 없는 문제를 어떻게 해결할 것인가? 라는 문제가 있습니다.

  1. 가게와 리뷰의 ID를 갖는 테이블을 만든다.

  2. 가게와 리뷰가 연관관계를 갖게 한다.

  3. 가게 - 주문 - 리뷰 라는 연결고리를 이용하여 로직으로 풀어낸다.

  4. 연관 관계를 맺지 않고 필요로 하는 엔티티의 id를 필드로 갖게 한다.

     → 저는 4번을 선택했습니다.

  • 코드 리뷰를 많이 하지 못해 아쉽습니다.
  • 제가 부족해서 팀원들에게 미안합니다….
• 🧑‍💻 최서영
  • 팀원들과 큰 문제와 갈등 없이 프로젝트를 마무리 할 수 있어서 다행인것 같습니다. 이번 프로젝트에서 가장 기본적인 crud를 담당하였는데, 팀원들의 자세한 코드리뷰와 조언들을 통해 부족했던 부분들을 보완할 수 있었습니다. 또한 제가 담당하지 않았던 회원가입/로그인 부분과 연관관계 부분들을 참고하면서 공부가 많이 되었습니다. 브랜치 전략과 rebase 사용 전략은 아직도 헷갈리는 부분들이 많아서 이 부분도 공부가 필요하겠다는 생각을 했습니다. 배운것도 많고 부족함도 많이 느끼게 되는 프로젝트 였습니다.

---

https://github.com/KimLeeParkJiChoi/spang-eats.git