Yanabada_BackEnd
👋안녕하세요~ 야나바다 백엔드 팀입니다😀
| 박주현 | 안수지 | 장성수 | 황규철 |
|---|---|---|---|
 |
 |
 |
 |
🏨 프로젝트 소개
프로젝트 내용
- 무료 예약 취소가 불가한 숙소의 양도/거래 플랫폼
프로젝트 주제 및 필수 구현 기능 제안
- 야놀자
프로젝트 제작 배경
- 예약 취소에 대한 불만이 많음, 유저의 착각/실수도 있으나 천재지변, 개인적 사유로 인해 어쩔 수 없이 취소수수료가 발생하는 경우 유저의 불만 및 탈퇴로 이어짐
- 예약 취소의 부정적 경험으로 인해 유저가 탈퇴하는 것을 막을 수 있는 방안으로 예약 취소 불가 상품을 해결할 수 있는 플랫폼 또는 기능 제공
- 공급자와 기존 구매자, 양도자를 모두 고려한 안전하고 신뢰도 높은 예약 취소 거래 기능 구축
- 예약 취소 수수료가 아닌 취소 예약건을 온전히 체크인 완료하면 매출 증대에 기여할 것으로 기대함
프로젝트 목적
- 기획, 디자인, 프론트엔드, 백엔드 간의 협업
- RESTful API 개발
프로젝트 기간
- 서비스 기획 기간 : 2023년 12월 02일 ~ 01월 05일
- 서비스 개발 기간 : 2023년 01월 04일 ~ 01월 29일
프로젝트 실행방법
메뉴얼
야나바다 홈페이지
메인서버 배포 URL
테스트 서버 배포 URL
테스트 계정
- ID : test@naver.com
- PW : password123!
docker run -d -p 6379:6379 --name yanabada_redis redis- 6379 포트로 Redis가 실행중이어야 프로젝트가 정상 실행됩니다!
- http://localhost:8080/h2-console 에 들어갑니다.
- 아래 정보대로 입력 칸을 채우고 Connect를 누른다.
- Driver Class: org.h2.Driver
- JDBC URL: jdbc:h2:mem:testdb
- User Name: sa
- Password: (빈칸)
📚 프로젝트 기술스택
🗺️ 프로젝트 파이프라인
🗄️서버 인프라
📝 프로젝트 기획
ERD
API 명세서
API 명세서에 없는 API는 더미데이터를 넣기위한 자체적인 API입니다.
컨벤션
1. 코딩 컨벤션
- 커스텀 구글 코딩 컨벤션을 사용합니다.
- 메소드 네이밍, 패키지, DTO 네이밍 등 기타 코딩 컨벤션은 노션 백엔드 아카이브 폴더를 확인합니다.
2. 브랜치 전략 - Git Flow
- 브랜치 전략으로 Git Flow를 사용합니다.
- API 구현 및 설계는 모든 팀원의 Approve를 받아야 Merge 할 수 있습니다.
브랜치별 역할
- 실제 작업을 하는 브랜치
- 이슈 번호가 1이라면 feature/1로 만들면 됩니.
- 'develop'을 베이스 브랜치로 하여 만들어야 합니다.
- ( 브랜치 생성은 베이스 브랜치[ 체크아웃되어있는 브랜치 ]를 기준으로 만들어진다.)
- 작업이 완료되면 develop으로 Pull Request를 날립니다.
- 본인을 제외한 조원의 Approve를 모두 받았다면 Merge 합니다.
- 테스트 서버에 자동 배포되는 브랜치
- 다음 버전 개발을 위해 release으로 가기 전 기능 코드들을 모아두는 브랜치
- 작성한 기능이 잘 작동되는지 확인하고, release으로 PR 및 Merge를 하면 됩니다.
- develop으로 Merge 하고 나서 자동 배포된 테스트 서버에서 자신의 API가 정상 작동하는지 꼭 테스트해야 합니다.
- 실제 서비스를 운영할 수 있는 메인 서버 자동 배포되는 브랜치
- release으로 Merge 하고 나서 자동 배포된 메인 서버에서 자신의 API가 정상 작동하는지 꼭 테스트해야 합니다.
- 최종본을 갖는 브랜치
3. 협의사항
-
협업 관련
- 매 회의시 회의록 작성
- 백엔드 아카이브에 기술스택 사용법 정리
- 데일리 스크럼: 매일 오전 10:00, 오후 14:00, 19:00 노션에 진행상황 공유
- Notion 에서 PM, UIUX, FrontEnd 및 BackEnd 회의사항 공유, 서로간의 질문사항 & 건의사항 소통
- 매주 금요일 팀 전체회의
- 매 회의시 회의록 작성
-
커밋 메시지 관련
- 커밋 제목은
prefix: 커밋 메시지형태로 합니다. - prefix의 목록과 각각의 용도는 IntelliJ 플러그인 commit message template 에 맞춰 작성
- 커밋 내용을 자세하게 적습니다.
- 커밋 제목은
🤔 프로젝트 이슈
-
웹소켓을 지원해주지 않는 저사양 브라우저에서 웹소켓을 쓴것 같은 효과를 내주는 SockJS를 웹소켓컨피그에 덧붙였는데, SpringBoot3 버전이 되고 나서 부턴 정상 작동을 안하는지 몇몇 레퍼런스에서도 사용하지 말라고 하였습니다. 이걸 모르고 첨엔 썼다가 프론트에서 커넥션을 맺지 못하는 원인을 찾기 못했는데 여러 레퍼런스를 통해 SockJS를 제거하니 커넥션이 잘 맺어졌습니다.
-
서비스 계층에서 타 도메인의 의존성 주입을 무엇을 받을지 팀원들과 심도깊은 회의를 하였습니다. 타 도메인의 서비스계층 또는 레포지토리계층 둘중 어떤 것을 의존성 받았을 때 장단점이 있는지 회의하였고, 결국 레포지토리 계층을 주입받기로 결정하였습니다.
-
리버스 프록시 서버를 사용했을시 각기 다른 URL 프록시 패스에 각각 다른 헤더를 set 해주어야한다는 걸 배웠고, 서버블록이 같은 포트가 두개 이상여서 프록시 서버가 작동하지 않는 이슈도 있었습니다. 포트당 한개의 블록을 갖게끔 하고 원하는 그리고 올바른 헤더를 세팅해주어 문제를 해결했습니다.
-
HTTPS 를 사용하는 본서버에서 쿠키 설정에서 문제를 겪었는데 바로, domain 을 따로 지정해줘야 하는 문제였습니다. 쿠키 설정 시
domain에 따로 값을 지정해주지 않으면, default로domain=<서버의 도메인 주소>로 지정됩니다. 그리고 크롬 브라우저는 쿠키를 받았더라도,domain이 현재 크롬을 동작하는domain과 일치해야만 쿠키를 사용할 수 있습니다.이 문제를 해결하기 위해, 서버의 domain(api.yanabada.com)과 클라이언트 배포 도메인(www.yanabada.com)의 공통 부분을 맞추어서domain= yanabada.com으로 설정하였습니다. 그 결과 클라이언트에서도 서버로부터 받은 쿠키를 사용할 수 있게 되었습니다.
🪄 프로젝트 회고
황규철
황규철
서로 다른 4가지 분야의 사람들과 만나서 팀 프로젝트를 해볼 수 있었던 좋은 경험이었습니다.
개발을 모르는 분들과의 협업도 처음 진행해볼 수 있었는데, 이 때 이전에는 몰랐던 소통의 중요성을 깨닫게 되었습니다. 이전에는 개발자들과만 협업을 진행하다보니 당연하게 여겼던 부분들은 대수롭지 않게 넘겼었는데, 다른 분야의 사람들과 협업하면서 나에게는 당연하던 것이 남에게는 아닐 수 있구나 라는 것을 알게되었습니다. 협업에서 소통이란 '남의 입장에서 한번 더 생각해보기' 라는 것을 알게 된 좋은 경험이었습니다.