Skip to content

Latest commit

 

History

History
407 lines (289 loc) · 13.5 KB

README.md

File metadata and controls

407 lines (289 loc) · 13.5 KB

카카오테크캠퍼스 1기 12조 픽업셔틀 팀입니다😇

저희 프로젝트를 소개합니다

편리하게 음료를 픽업하고, 픽업 받을 수 있는 픽업셔틀입니다.

❗ 프로젝트에서 고민한 점

사용자 로그인 과정에 대한 고민

사용자로부터 ID와 PW를 입력 받아서 로그인 하는 과정과 카카오 OAuth 로그인 중 어떤 것을 구현할지 고민을 하였습니다. 저희는 최대한 사용자가 회원가입할 때 편의성을 제공해주기 위해서 OAuth 로그인 과정을 선택하였습니다.
OAuth 처리할 때 redirect uri를 백엔드 서버 주소로 할 것인가 프론트엔드 서버 주소로 할 것인가에 대한 고민
KAKAO OAuth 로그인을 구현하기 위해서 카카오로부터 인가코드받고 카카오로부터 엑세스 토큰과 리프레시 토큰을 요청하는 부분을 프론트엔드와 백엔드가 각각 역할을 나누는 방식으로 구현할지 아니면 모든 과정을 백엔드에서 처리할지 고민하였습니다.
결국은 카카오로부터 인가코드를 받고 엑세스 토큰과 리프레시 토큰을 요청하는 모든 과정을 백엔드에서 처리하는 것으로 구현하였습니다. 즉, redirect uri를 백엔드 서버 주소로 설정하였었는데, 이 방법을 선택했던 이유는 최대한 프론트엔드 개발하는데 있어서 최대한 신경을 덜 쓸 수 있도록 편의성을 제공해주기 위해서였습니다.

인증 과정

저희 서비스는 인증 과정을 JWT로 구성하였습니다. JWT를 사용하게 된 이유는 쿠키는 보안에 너무 취약하고 세션으로 사용하게 된다면 사용자수가 많아지게 되면 서버에 과부하가 생길 수 있다고 판단하였기 때문에 인증 절차를 JWT로 사용하기로 결정하였습니다.
엑세스 토큰은 응답 Body를 통해 프론트엔드로 넘겨주고 리프레시 토큰은 DB 테이블을 만들어서 저장하는 식으로 구성하였습니다. 엑세스 토큰 기간과 리프레시 토큰 기간을 얼마로 둘 건지에 대해서도 고민을 했는데 엑세스 토큰은 30분 리프레시 토큰은 2주로 정했습니다.

배포

크램폴린에 배포할 때 저희는 먼저 프론트엔드 서버와 백엔드 서버를 서로 다른 도메인을 사용하여 배포하려고 했습니다. 하지만 여기에서 많은 문제점들이 발생하였었는데, CORS, SameSite 정책으로 프론트엔드 서버와 백엔드 서버 간에 통신이 제대로 안되는 문제점이 있었고, 프론트엔드에서 “카카오 로그인”버튼을 클릭해도 로그인 처리를 백엔드에서 모두 처리하기 때문에 백엔드 Spring Security의 SecurityContext에서 인증 객체가 제대로 관리가 되지 않아서 아무리 로그인이 성공해도 인증 객체가 저장이 되지 않는다는 문제점이 발생하였습니다. 도메인이 다름으로써 프론트엔드 서버와 백엔드 서버 간의 통신할 때 여러 문제점들이 계속 발생이 되어 따라서 프론트엔드와 백엔드 서버를 각각 다른 도메인으로 두지 않고 하나의 쿠버네티스 네임스페이스에서 프론트엔드와 백엔드, MySQL, Nginx를 모두 동작시키는 식으로 해결하였습니다. 하나의 네임스페이스에서 동작을 시킴으로써 위에 적었던 모든 문제점들을 해결할 수 있었습니다.

이미지 업로드

저희는 이미지 업로드를 S3로 할 것인지 DB에 바이너리 데이터 형식으로 저장할 것인지에 대해서 고민을 하였었습니다. 학교에서 DB 과목을 배웠을 당시에는 DB에 이미지 저장은 바이너리 데이터 형식으로 저장하는 걸로 배웠었기 때문에 이미지 업로드 관련해서는 바이너리 데이터 형식으로 저장하려고 했었습니다. 하지만 조원들과의 상의를 하면서 인터넷에 자료를 찾아보니깐 DB에 비해서 Amazon S3에 저장해서 사용하는 것이 더 많은 장점이 있다는 것을 알게 되었습니다. 주로 성능, 확장성, DB 비용, 빠른 로딩 시간에서 S3가 DB에 비해서 이점을 얻을 수 있다는 것을 알았기에 DB에 바이너리를 저장하는 것이 아닌 S3에 이미지를 업로드 하는 식으로 새롭게 사용해보기로 결정하였습니다. DB에 바이너리 데이터 형식으로 저장하는 것보단 S3 형식으로 이미지를 업로드하기 위해서 스프링 부트에서 사전 세팅하는데 시간이 좀 걸렸지만 확실히 DB에 바이너리 형식으로 업로드 하는 것에 비해 S3에 업로드를 해보니 DB 과부하에 대한 걱정이 사라지게 되었고 속도 측면에서도 빨라지게 되어서 서비스를 운영하는 측면에 있어서 성능 최적화를 얻을 수 있게 되었습니다.

프로젝트 구조

ERD

디렉터리 구조

📦src
 ┣ 📂docs
 ┃ ┗ 📂asciidoc
 ┣ 📂main
 ┃ ┣ 📂generated
 ┃ ┃ ┗ 📂pickup_shuttle
 ┃ ┃ ┃ ┗ 📂pickup
 ┃ ┃ ┃ ┃ ┗ 📂domain
 ┃ ┣ 📂java
 ┃ ┃ ┗ 📂pickup_shuttle
 ┃ ┃ ┃ ┗ 📂pickup
 ┃ ┃ ┃ ┃ ┣ 📂config
 ┃ ┃ ┃ ┃ ┣ 📂domain
 ┃ ┃ ┃ ┃ ┃ ┣ 📂beverage
 ┃ ┃ ┃ ┃ ┃ ┣ 📂board
 ┃ ┃ ┃ ┃ ┃ ┣ 📂match
 ┃ ┃ ┃ ┃ ┃ ┣ 📂oauth2
 ┃ ┃ ┃ ┃ ┃ ┣ 📂refreshToken
 ┃ ┃ ┃ ┃ ┃ ┣ 📂store
 ┃ ┃ ┃ ┃ ┃ ┗ 📂user
 ┃ ┃ ┃ ┃ ┣ 📂security
 ┃ ┃ ┃ ┃ ┣ 📂utils
 ┃ ┃ ┃ ┃ ┣ 📂_core
 ┃ ┃ ┃ ┃ ┃ ┣ 📂errors
 ┃ ┃ ┃ ┃ ┃ ┗ 📂utils
 ┃ ┗ 📂resources
 ┃ ┃ ┣ 📂db
 ┃ ┃ ┣ 📂static
 ┃ ┃ ┣ 📂templates
 ┗ 📂test
 ┃ ┗ 📂java
 ┃ ┃ ┗ 📂pickup_shuttle
 ┃ ┃ ┃ ┗ 📂pickup
 ┃ ┃ ┃ ┃ ┗ 📂domain
 ┃ ┃ ┃ ┃ ┃ ┣ 📂board
 ┃ ┃ ┃ ┃ ┃ ┣ 📂user

🪪 Tech Stacks

Backend

분류 Stack
BACK-END
DATABASE
Version Control
INFRA

📒 참고 자료

🙋 참여 인원


이진혁
(LJH098)

이기준
(dnjfqhd12345)

박주현
(B-JuHyeon)
Backend Backend Backend

Team12_BE

12조

카카오 테크 캠퍼스 3단계 진행 보드


배포와 관련하여


최종 배포는 크램폴린으로 배포해야 합니다.

하지만 배포 환경의 불편함이 있는 경우를 고려하여 

임의의 배포를 위해 타 배포 환경을 자유롭게 이용해도 됩니다. (단, 금액적인 지원은 어렵습니다.)

아래는 추가적인 설정을 통해 (체험판, 혹은 프리 티어 등)무료로 클라우드 배포가 가능한 서비스입니다.

ex ) AWS(아마존), GCP(구글), Azure(마이크로소프트), Cloudtype 

Notice

필요 산출물들은 수료 기준에 영향을 주는 것은 아니지만, 
주차 별 산출물을 기반으로 평가가 이루어 집니다.

주차 별 평가 점수는 추 후 최종 평가에 최종 합산 점수로 포함됩니다.

레포지토리 운영-001 (1) image

git flowchart_FE.pdf


필요 산출물

Step3. Week-1

1주차

    - 5 Whys
    - 마켓 리서치
    - 페르소나 & 저니맵
    - 와이어 프레임
    - 칸반보드

Step3. Week-2

2주차

    - ERD 설계서
    
    - API 명세서

Step3. Week-3

3주차

    - 최종 기획안

Step3. Week-4

4주차

    - 4주차 github
    
    - 4주차 노션

Step3. Week-5

5주차

    - 5주차 github
    
    - 5주차 노션

Step3. Week-6

6주차

    - 6주차 github
    
    - 중간발표자료
    
    - 피어리뷰시트

Step3. Week-7

7주차

    - 7주차 github
    
    - 7주차 노션

Step3. Week-8

8주차

    - 중간고사
    

Step3. Week-9

9주차

    - 9주차 github
    
    - 9주차 노션

Step3. Week-10

10주차

    - 10주차 github
    
    - 테스트 시나리오 명세서
    
    - 테스트 결과 보고서

Step3. Week-11

11주차

    - 최종 기획안
    
    - 배포 인스턴스 링크

과제 상세 : 수강생들이 과제를 진행할 때, 유념해야할 것

1. README.md 파일은 동료 개발자에게 프로젝트에 쉽게 랜딩하도록 돕는 중요한 소통 수단입니다.
해당 프로젝트에 대해 아무런 지식이 없는 동료들에게 설명하는 것처럼 쉽고, 간결하게 작성해주세요.

2. 좋은 개발자는 디자이너, 기획자, 마케터 등 여러 포지션에 있는 분들과 소통을 잘합니다.
UI 컴포넌트의 명칭과 이를 구현하는 능력은 필수적인 커뮤니케이션 스킬이자 필요사항이니 어떤 상황에서 해당 컴포넌트를 사용하면 좋을지 고민하며 코드를 작성해보세요.


코드리뷰 관련: review branch로 PR시, 아래 내용을 포함하여 코멘트 남겨주세요.

1. PR 제목과 내용을 아래와 같이 작성 해주세요.

PR 제목 : 부산대_0조_아이템명_0주차