Dolpin Backend Wiki

서비스 바로가기

개발 일정

참고: roadmap.md 참조

기간	주요 작업 (Backend 관련)
~ 2025.05.12	- 사용자 인증/인가 API 개발 - 초기 사용자 정보 처리 API 개발 - AI 추천 결과 제공 API 개발 - 장소 정보 조회 API 개발 - DB 모델링 (사용자, 장소, 초기 추천 데이터) - 기록 CRUD API 개발
~ 2025.06.20	- 사진 업로드 처리 (S3 연동) - 개인화 추천 로직 연동 API 수정 - DB 모델링 (리뷰, 좋아요 등)
~ 2025.07.18	- 지역별 인기 게시글 집계 로직 개발 - Geofencing 연동 API 개발 - 기록 키워드 분석 및 추천 반영 로직 개발 - '발견한 장소 리스트' API 개발
~ 2025.08.01	- 전체 코드 리팩토링 및 성능 개선 - API 응답 구조 및 에러 처리 표준화 - DB 쿼리 최적화

ERD

ERD 다이어그램 https://www.erdcloud.com/d/4EXE3TQWj8xoCmqjP
ERD 명세서 https://www.notion.so/Dolpin-ERD-1d6e68db3e15808c918cd307c252de6b

API

API 명세서: https://www.notion.so/Dolpin-API-1dce68db3e1580c98317ca7fd9a91b9d
응답 규격: 표준 RESTful API 응답 형식 준수 (성공/실패 상태 코드, 데이터, 메시지 등 포함)

배포 환경 및 CI/CD 파이프라인

참고: README.md 아키텍처 구조 참조

배포 환경: AWS (EC2, RDS 등 활용 예상)
데이터베이스: MySQL (AWS RDS 활용 예상)
웹 서버: Nginx (로드밸런싱 및 리버스 프록시)
CI/CD 도구: GitHub Actions
빌드 도구: Gradle
컨테이너화: Docker
파이프라인 요약:
1. dev 브랜치에 푸시/병합 시 자동 빌드 (Gradle) 및 테스트 실행
2. 테스트 통과 시 Docker 이미지 빌드 및 AWS 환경에 배포 (개발 서버)
3. main 브랜치에 병합 시 자동 빌드, 테스트 및 프로덕션 환경 배포

코드 품질 관리 도구

도구	역할	목적
.editorconfig	코드 스타일 통일	IDE 간의 기본적인 코드 스타일 일관성 유지
Checkstyle	정적 코드 분석	정의된 코딩 규칙 준수 여부 검사
JaCoCo	코드 커버리지 측정	테스트 코드의 코드 커버리지 분석
(선택) Java Test Fixtures	테스트 픽스처 관리	테스트 데이터 및 설정의 재사용성 및 관리 용이성 증대
(선택) SonarQube	코드 품질 플랫폼	정적 분석, 버그, 보안 취약점 등 종합적인 코드 품질 관리

트러블 슈팅

(추가 예정) 1. 트러블 슈팅 제목

컨벤션 룰

1. 코드 스타일 가이드 (EditorConfig & CheckStyle)

EditorConfig (.editorconfig 파일)

설정 항목	값	설명
charset	utf-8	문자 인코딩 UTF-8
end_of_line	lf	줄 끝 문자는 LF
indent_style	space	들여쓰기 스타일은 공백
indent_size	4	들여쓰기 크기는 4칸
insert_final_newline	true	파일 끝에 빈 줄 추가
trim_trailing_whitespace	true	줄 끝의 불필요한 공백 제거
max_line_length	120	한 줄의 최대 길이 120자

CheckStyle (프로젝트 내 checkstyle.xml 설정 파일 참조) Google Java Style Guide 기반 설정 사용 권장

항목	규칙 (요약)
클래스명	PascalCase
변수명 및 메서드명	camelCase
상수명	UPPER_SNAKE_CASE
패키지명	소문자, `.` 구분
탭 사용	사용 금지 (공백 사용)
줄 바꿈	일관된 규칙 적용 (연산자 이전/이후 등)
최대 라인 길이	120자 (EditorConfig와 동일)
제어문 블록 {}	항상 사용 (if, for, while 등)
연산자 배치	일관된 규칙 적용
import 순서	표준 순서 적용 (java, javax, org, com...)
주석 스타일	Javadoc, `//` 등 명확한 스타일 사용

2. 커밋 메시지 컨벤션

(Angular Commit Convention 기반)

커밋 메시지 형식:

<type>: <subject> (#이슈번호)

<body>

<footer>

제목 규칙:

type: 다음 한 칸 공백 필수
제목 끝에 마침표(.) 사용 금지
제목은 간결하게 핵심 내용 요약
이슈 번호는 제목 끝 #이슈번호 형식으로 추가

타입	설명
build	빌드 시스템 또는 외부 의존성 변경 (gradle, npm 등)
chore	코드 수정 없이 설정 변경, 리소스 관리 등 기타 잡무
content	(별도 정의 필요 시)
docs	문서 수정 (README, Wiki 등)
feat	새로운 기능 추가
fix	버그 수정
refactor	코드 리팩토링 (기능 변경 없이 코드 구조 개선)
style	코드 스타일 변경 (포맷팅, 세미콜론 등; 로직 변경 없음)
test	테스트 코드 추가/수정
deploy	배포 관련 스크립트 또는 설정 변경

예시:

feat: 사용자 로그인 API 구현 (#42)

이메일과 비밀번호를 이용한 사용자 로그인 기능을 구현했습니다.
JWT 토큰 발급 로직 포함.

3. 추가 규칙 (PR, 브랜치 등)

브랜치 전략: frontend-wiki.md의 Git 브랜치 전략과 동일하게 적용 (main, dev, feature/#, bug/#, refactor/#)
PR 제목: 커밋 메시지 제목 형식과 유사하게 작성 (예: Feat: 사용자 로그인 API 구현 (#42))
PR 내용: 변경 목적, 주요 변경 사항, 테스트 방법, 관련 이슈 번호 명시
코드 리뷰: 최소 1명 이상의 리뷰어 승인 후 병합 원칙
단위 테스트: 주요 로직에 대한 단위 테스트 작성 권장 (JUnit, Mockito 등 사용)

1. Backend Wiki - 100-hours-a-week/7-team-ddb-wiki GitHub Wiki

Dolpin Backend Wiki

서비스 바로가기

목차

개발 일정

ERD

API

배포 환경 및 CI/CD 파이프라인

코드 품질 관리 도구

트러블 슈팅

컨벤션 룰

1. 코드 스타일 가이드 (EditorConfig & CheckStyle)

2. 커밋 메시지 컨벤션

3. 추가 규칙 (PR, 브랜치 등)

⚠️ GitHub.com Fallback ⚠️

1. Backend Wiki - 100-hours-a-week/7-team-ddb-wiki GitHub Wiki

Dolpin Backend Wiki

서비스 바로가기

목차

개발 일정

ERD

API

배포 환경 및 CI/CD 파이프라인

코드 품질 관리 도구

트러블 슈팅

컨벤션 룰

1. 코드 스타일 가이드 (EditorConfig & CheckStyle)

2. 커밋 메시지 컨벤션

3. 추가 규칙 (PR, 브랜치 등)

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️