dnd-side-project/dnd-7th-1-backend

🏃 땅따먹기 기반 운동 장려 애플리케이션 NEMODU

DND 7기 프로젝트 (2022.08~)

프로젝트 설명

시연 영상 📺

📃 기능 리스트

• 회원
  • 프로필 조회 및 수정
  • 마이 페이지 조회 (운동 기록 정보, 회원 정보 등)
  • 운동 기록 필터 관리 (내 기록 보기, 친구 기록 보기 등)
  • 운동 기록 메시지 수정
  • 메인 화면 조회 (내 영역, 이번 주 영역, 친구 영역, 챌린지 정보, 챌린지 멤버 영역 등)
• 챌린지 (지인과 함께 일정 기간동안 운동 기록을 공유하며 경쟁하는 기능)
  • 챌린지 생성 및 초대
  • 챌린지 수락, 거절
  • 챌린지 상태 관리
    • 챌린지 시작날짜에 맞춰 진행
    • 월요일 00시 챌린지 종료
    • 챌린지 참여하는 사람(챌린지 멤버)에 대한 상태 관리 및 주최자 관리
  • 챌린지 색깔 계산
  • 상태 별 챌린지 목록 조회
  • 상태 별 챌린지 상세 목록 조회
  • 챌린지 진행 기간동안 기록된 영역 조회
  • 챌린지 삭제
• 운동 기록
  • 운동 기록 생성
  • 운동 기록 조회
• 랭킹
  • 역대 누적 칸 수 랭킹 계산
  • 이번 주 영역 수 랭킹 계산
  • 걸음 수 랭킹 계산
• 친구
  • 친구 신청 및 응답
  • 카카오 친구 목록 조회
  • 카카오 친구 초대 메시지 전송
  • 친구 삭제
  • 위치 기반 친구 추천
• 회원가입/로그인
  • 카카오, 애플 소셜 로그인 지원
  • JWT 기반 토큰 인증
  • 카카오 회원 정보 조회
  • 로그아웃
  • 회원 탈퇴
• 푸시 알람
  • FCM 토큰 관리
  • 특정 상황에서 푸시 알람 요청 및 알람 관리
• HTTPS 지원

🔷 Architecture

🔶 ER-MODEL

⚔️ 기술 스택

🔥 SERVER

• Java 11 (OpenJDK 11)
• Spring boot 2.7.1
  • 의존성 관리
  • Auto Configuration
• Spring Security
  • JWT 기반 토큰을 활용한 인증
  • ExceptionEntryPoint를 활용한 예외 처리
• Spring Data JPA
  • 객체 중심의 ORM 쿼리 활용
• QueryDSL
  • 컴파일 단게에서 쿼리 에러 검출
  • 중복 쿼리 재활용을 통해 유지보수에 용이하도록 함
  • 동적 쿼리를 효율적으로 작성
  • No Offset을 활용한 페이징 쿼리 개선
• Spring Batch
  • 체계적인 배치 작업: Chunk 단위로 트랜잭션을 관리해 메모리에 한 번에 적재하지 않도록 해 서버의 부담 최소화
  • Challenge의 상태 변경 시 배타 락 설정 -> Chunk 단위 작업 필요
  • AbstractPagingItemReader, JpaItemWriter를 상속받아 네모두의 엔티티 구성에 맞게 구성

🎁 DB

• MySQL 8.0.30
  • 테이블의 성격을 고려한 객체 중심의 엔티티 설계
  • N:M 관계를 조인 테이블을 활용해 1:N, M:1로 풀어내 개발 복잡도 저하
  • N-gram Parser를 활용한 부분 문자열 검색 (FullText-index)

🌉 Infra

• Nginx
  • SSL 인증서를 활용한 암호화/복호화
  • 발급받은 도메인(nemodu.site)에 대한 프록시 역할

☁️ Cloud

• AWS EC2
  • 필요한 만큼 컴퓨팅 자원 사용(온디맨드)
  • 인스턴스 모니터링
• AWS RDS
  • 데이터베이스 모니터링 및 관리
• AWS S3
  • 회원 프로필 사진을 비롯한 파일 저장
  • 정적 페이지 저장 및 전달 (약관 페이지)
• AWS ElastiCache
  • Redis를 활용해 데이터 캐싱
  • 빠른 조회 및 서버 부하 감소
  • Expire Event 구독: 이벤트가 발행되는 경우 데이터 처리 (FCM 토큰 재발급 요청)

🏋 개선 과정

1️⃣ 예외 처리 개선

추후 발생할 다양한 예외를 처리하기 위해 유연한 구조 필요

• 발생할 수 있는 예외에 대한 코드 정의 (ExceptionCodeSet.java)
• 인터페이스를 통해 예외 클래스의 역할 정의 (BaseException.java)
• 추상 클래스를 활용해 예외 클래스의 중복 코드 최소화 (BaseExceptionAbs.java)
• @RestControllerAdvice를 활용해 컨트롤러 레벨에서 발생하는 예외 공통 처리
• 필터 레벨에서 발생하는 예외를 처리하기 위해, AuthenticationException을 상속 받은 예외 클래스 생성
• 기존에 정의한 예외 코드를 활용해 AuthenticationEntryPoint를 상속받은 핸들러에서 예외 처리
• 케이스별 예외 클래스 생성 및 각 예외에 대한 개별 처리
  (Ex:FilterException.java, 필터 레벨에서 발생한 예외를 처리하기 위해 AuthenticationException 상속)

2️⃣ 회원가입/로그인 개선

카카오, 애플 2가지 소셜 로그인을 지원. 나중에 추가될 수 있는 다양한 회원가입 형태에 대한 대비

• Resource Server(현 시점에서 카카오, 애플)에 맞춰 개발해 구조 변경이 힘들다고 판단 -> Resource Server 의존성 최소화
• 로그인 후 Redirect 받는 형태가 아닌, 클라이언트가 로그인 후 토큰까지 발급하는 것으로 역할 분리.
• 소셜 로그인에 대한 공통 API를 제공해 서버에서 필요한 정보를 받아 회원 정보 관리

3️⃣ 메인 화면 API 개선

데이터가 많아질수록 메인 화면 API 성능이 급격히 저하됨

• 1:N 형태로 설계된 '운동 기록<->영역'을 조회할 때, 2번에 걸쳐 조회하던 것을 Join을 활용해 한 번으로 줄임 (DB I/O 최소화)
• 회원 중심으로 데이터를 조회하는 로직 -> 영역을 중심으로 데이터 조회. 즉, 한 번에 데이터를 조회하도록 로직 개선
• 올바른 인덱스 설계를 통해 쿼리 성능 개선
  • 테스트 결과: 실행 속도 81.95% 향상
• 클라이언트의 지도 축척 정보를 활용해 MBR(Minimum Bounding Rectangle) 계산 -> 불필요한 데이터 최소화
• MySQL의 MBR_CONTAINS() 함수를 활용해 MBR 내 영역만 조회하도록 개선
  • 테스트 결과: 실행 속도 42.86% 향상

4️⃣ 랭킹 개선

랭킹 계산에 활용되던 QueryDSL의 Tuple클래스의 의존성이 전역에 퍼져있음.

• 랭킹 계산에 필요한 공통 DTO 생성
• DTO를 활용해 조회함으로써, Tuple에 대한 의존성 제거
• 잘못된 Join 사용으로 인해 불필요하게 복잡해진 랭킹 계산 로직을 Outer Join을 활용해 간소화
• 랭킹 계산을 공통 모듈로서 활용해 추후 다양한 곳에서 사용하기 쉽도록 함

5️⃣ 배치 작업 개선

사용자가 많아졌을 때, 많은 데이터를 한 번에 메모리에 적재하는 것은 부담

• 일정 단위만큼 데이터를 조회해 처리하도록 함 -> 코드가 복잡해 유지보수가 힘들 것으로 예상
• 특히, 챌린지 상태 변경 배치의 경우, 변경 전 데이터를 조회할 수 없도록 배타 락을 적용함 -> 빠르게 처리해야 함.
• Spring Batch를 도입해 Job, Step 각 단계 별 작업을 Chunk로 단위로 수행
• Postman으로 직접 테스트하기 힘들기 때문에, 테스트 코드 작성

6️⃣ 푸시 알람을 위한 FCM 토큰 신선도 유지

각 사용자의 FCM 토큰이 2달이 경과한 경우, 클라이언트에게 재발급을 요청해야 함.

• 사용자마다 만료 시간이 다르기 때문에, 스케줄러를 통해 직접 확인하는 것은 비효율적
• FCM 토큰을 Redis에 저장하고, TTL을 2달(60일)로 설정
• 토큰이 만료되는 경우 Expire Event를 발행해 서버로 전달 -> 이벤트를 감지하면 key 정보에 맞춰 토큰 재발급 요청
• Apns(iOS의 푸시 알람 서비스)의 Silent Message를 활용해 재발급 요청

7️⃣ 로그 전략 개선

서버 모니터링 및 빠른 트러블 슈팅을 위한 로그 전략 개선 필요

• 푸시 알람, 배치 등 특정 서비스에 따른 Logger 분리
• 로그 레벨에 따른 로그 수집
• 시간, 용량 별 Rolling 전략 수립
• Logger 클래스를 Request Scope Bean으로 생성해 쉽게 로그를 확인할 수 있도록 개선
  -> @Qualifer를 통해 특정 Logger를 주입해야 하는 부분은 개선 필요

8️⃣ Prometheus, Grapana를 활용한 모니터링 (진행 중)

운영을 위해 JVM 메모리 사용량 및 GC 모니터링이 필요하다고 판단

dnd-7th-1-backend's Issues

[FEAT] 카카오 로그인 개발

- 제목

카카오 로그인 개발

- 개발 의도

소셜 로그인(카카오) 기능 구현

- 기능 리스트

• Redirect URL에 전달받은 인가코드를 통한 카카오 엑세스 토큰 발급
• 엑세스 토큰을 활용한 사용자 정보 조회
• 신규/기존 유저를 구분 및 적절한 Response

- 비고

-

[FEAT] 시간에 따라 알맞는 운동 기록 추출 로직 구현

- 제목

시간에 따라 알맞는 운동 기록 추출 로직 구현

- 개발 의도

홈화면, 개인기록, 친구기록, 랭킹, 챌린지 기록 등 여러 기능에서 필요한 로직

- 기능 리스트

• 이번주 개인 기록 추출 (findRecordOfThisWeek)
• 과거 개인 기록 추출(일) (findRecordOfPastByDay)
• 과거 개인 기록 추출(주) (findRecordOfPastByWeek)
• 이번주 챌린지 기록 추출 (findChallengeRecordOfThisWeek)
• 과거 챌린지 기록 추출 (findChallengeRecordOfPast)

- 비고

queryDsl을 사용하여 시간에 따라(start와 end사이) 운동 기록을 추출하는 쿼리를 작성하고 
서비스 단에서 필요한 로직 작성 

[FEAT] 운동기록 관련 메소드 구현

- 제목

운동기록 관련 메소드 구현

- 개발 의도

랭킹 시스템, 기록시작, 활동 기록 에서 필요한 함수

- 기능 리스트

• 특정 날짜사이 누적 칸의 수 조회
• 특정 날짜사이 누적 영역의 수 조회
• 영역 혹은 칸의 수에 따라 정렬하여 유저를 조회

- 비고

로직 설명
- 페이징을 해서 보낼건지 논의 필요
- 누적 랭킹은 계산이 어떻게 되는지 논의 필요

추후 고려 사항 리스트

- 제목

개발 중 발견된 고려 사항 기술

- 목적

추후 기술 부채 해소

- 내용

• (22년10월01일) 회원 삭제 시, 챌린지를 어떻게 처리 할 지(삭제되는 회원이 주최자라면?)

[FEAT] 마이 페이지 관련 기능 개발

- 제목

마이 페이지 관련 기능 개발

- 개발 의도

마이페이지 및 프로필에서 활용될 소개 메시지 관련 기능 구현

- 기능 리스트

• 회원 엔티티 수정
• 회원 정보 조회 기능 구현
• 회원 정보 수정 기능 구현
• 기록이 있는 날짜 조회 api 구현

- 비고

기존 칼로리 관련 부분은 삭제 후, 걸음 수로 대체
소개 메시지 관련 기능 구현 

[FEAT] 홈화면 및 기록 api 개발

- 제목

홈 화면 및 기록 api 개발

- 개발 의도

홈 화면, 기록 시작-끝 기능 구현

- 기능 리스트

• 홈 화면 api
• 기록 api

- 비고

- 홈화면 HomeReponseDto 반환
- 기록 시작: 운동 기록 객체 생성, StartResponseDto 반환
- 기록 끝: EndRequestDto, 기록 저장

[FEAT] JWT토큰으로 보안 강화

- 제목

JWT토큰으로 보안 강화

- 개발 의도

토큰을 이용해 stateless한 상태 유지

- 기능 리스트

• 회원 가입, 재 로그인시 토큰 발급
• 매 request마다 토큰 검증
• 기존 유저가 접속시 자동 로그인 구현

- 비고

스프링 시큐리티 사용

[FEAT] 챌린지 상태 관리 기능 구현

- 제목

챌린지 상태 관리 및 조회 관련 기능 개발

- 개발 의도

챌린지를 진행하기 위해, 수락/거절 요청을 반영하고 챌린지 진행 여부를 결정.

- 기능 리스트

• 각 회원은 요청에 따라 수락/거절하는 기능 구현(Accept, Reject)
• 챌린지는 각 시작일의 자정에 "Progress" 상태로 변경
• 챌린지가 시작된 이후, 수락한 회원으로만 챌린지 진행 (나머지 삭제)
• 수락한 회원이 없으면 챌린지 삭제

- 비고

회원이 챌린지를 수락하는 지의 여부는 UserChallenge 테이블에서 관리한다.
챌린지 자체가 진행되는지의 여부는 Challenge 테이블에서 관리한다.
두 테이블 모두 상태 관리는 ChallengeStatus로 한 번에 처리한다.(ENUM)

[BUG] 테스트 간 발견된 에러 리스트

- 발견 날짜

2022-08-25~2022-08-26

- 제목

테스트 간 발견된 에러 리스트

- 개발 의도

- 영역 관련된 랭킹 계산
- 걸음수 랭킹 관련 오류
- 프로필 조회 시 누적 영역 계산

- 실제 결과

걸음수 랭킹 조회시 OutOfBoundsException
Accumulate 타입 챌린지 진행 시 랭킹 계산이 잘 안되는 상황 
누적 영역 계산 시 예외 발생
→ 테스트 데이터가 올바른지? 로직이 에러가 있는지?

- 관련된 파일

• ExerciseRecordRepository
• UserServiceImpl.java
• ExerciseRecordServiceImpl.java

[FEAT] 메인화면 필터 구현, 챌린지 조회 기능 수정 등

- 제목

메인화면 필터 구현, 챌린지 조회 기능 수정 등

- 개발 의도

메인화면 필터 구현
챌린지 조회할 때, 챌린지 종류에 따른 랭킹 정보를 조회하도록 수정

- 기능 리스트

• 메인 화면 필터(나의 기록 보기, 친구 보기) 구현
• 챌린지 종류에 따른 랭킹 정보 조회]
• 필터 ON/OFF 기능 구현

- 비고

-

[CHORE] 설정 파일 수정, CORS 설정 추가

- 제목

 설정 파일 수정, CORS 설정 추가

- 목적

1. 각자 환경이 다르므로, application.yml에 DB와 관련된 정보를 직접적으로 넣지 않기 위함.
2. JavaScript로부터 통신이 가능하도록 하기 위함.

- 내용

• 원활한 협업을 위해 데이터베이스의 username과 password를 직접 입력하지 않고, 변수를 통해 주입
• 프론트엔드와 통신하기 위한 CORS 설정 추가

[FEAT] 랭킹 순위 추가 및 마이, 친구 페이지 개발

- 제목

랭킹 순위 추가 및 마이페이지 개발

- 개발 의도

랭킹 및 운동 기록 관리 구체화

- 기능 리스트

• 랭킹에 순위 추가
• 기록 중지 api 개발
• 친구 프로필 api 개발
• 마이페이지 api 개발

- 비고

1. 랭킹이 동점일 경우 처리 로직
2. 기록 결과에서 칸을 어떻게 저장하는지를 고려하여 개발 진행 예정 (사진, 좌표)

[FEAT] 일주일 챌린지 생성 기능 구현

- 제목

일주일 챌린지 생성 구현

- 개발 의도

일주일 챌린지 기능 구현(1) - 일주일 챌린지 생성

- 기능 리스트

• 친구 목록 조회
• 챌린지 생성 및 상태 관리

- 비고

1. 챌린지 생성을 위해 친구 목록을 조회한다. (현재, 회원 관련 기능이 없으므로 임의의 데이터를 추가해 구현한다.)
   친구 목록이 Response로 주어지는 것을 목표로 한다.
2. 챌린지와 관련된 정보와 상태가 DB에 생성·적용되는 것을 목표로 한다.

[DOCS] ER 다이어그램 작성

- 제목

ER 다이어그램 작성

- 목적

원활한 개발을 위한 설계

- 기한

초안: ~2022-07-25

- 비고

• 결과물: ER 다이어그램
• 작성자: 박찬호, 박세헌

[FEAT] 회원 엔티티 작성

- 제목

회원 엔티티 작성

- 개발 의도

각자 역할에 따른 분업에 앞서 공통으로 필요한 회원 엔티티 작성

- 기능 리스트

• 회원 엔티티 작성

- 비고

회원 엔티티 작성 후, 각 역할에 따른 연관관계 매핑 및 기능 구현 예정
박찬호: 챌린지
박세헌: 개인 운동 기록 관리

[REFACTOR] 칸, 영역, 랭킹 코드 리팩토링

- 제목

칸, 영역, 랭킹 코드 리팩토링

- 개발 의도

가독성 향상 및 더 효율 적인 방안 모색

- 변경 전

1. 자바 문법 스트림을 통해 칸의 정보 조회
2. equals, hashCode를 칸의 중복 제거

- 변경 후

1. Matrix Repository단에서 MatrixDto로 직접 조회
2. distinct를 통해서 중복 제거

- 관련된 파일

비고

• 칸 랭킹은 쿼리로 조회 하였지만 영역 랭킹은 불가능하였음
• 쿼리로 조회하는 방식이 시간이 2배정도 빠름

[FEAT] DTO 및 유저 운동 기록 관리

- 제목

홈화면과 기록 시작-끝 구현

- 개발 의도

홈화면 및 기록 시 통신 데이터 파악

- 기능 리스트

• 홈화면 DTO 구성
• 운동 기록 DTO 구성
• 유저 운동 기록 및 관리

- 비고

Dto를 구성해 service단에서 로직을 새롭게 작성

[ADD] 예외 처리 반영

- 제목

예외 처리 반영

- 개발 의도

프로그램 완성도를 위해 미뤄놨던 예외 처리 반영

- 변경 전

Optional<> ~ .orElseThrow(); 에 대한 예외 처리가 없음.
챌린지 3개 이상 생성하는 경우와 같은 유효하지 않은 요청에 대한 대처가 미흡함.

- 변경 후

ControllerAdvice를 통한 전역 예외 처리 및 각 상황에 대한 대처.
Response 메시지 형식 통일

- 관련된 파일

• config/exception/*
• 예외 처리가 필요한 Service단 파일

[FEAT] MySQL Point 적용

- 제목

MySQL Point 적용 및 페이징 적용

- 개발 의도

모든 데이터를 한 번에 전달하면서 증가하는 리소스 사용량과 프론트의 부담을 줄이기 위한 페이징 적용

- 기능 리스트

• 위도, 경도를 Point를 적용해 관리(로직 수정)
• Haversine을 적용한 거리 계산 및 데이터 정제

- 비고

추후 MVP2 진행 전 리팩토링 고려 필요

프로젝트 세팅

• querydsl 환경 조성
• WebSocket 서버 구축 + test
• swagger 설정 + test

[FEAT] 메인화면 마무리

- 제목

메인 화면 마무리

- 개발 의도

API를 배포하기 위한 메인화면 마무리

- 기능 리스트

• 챌린지 개수 반환
• 유저 마지막 위치 반환

- 비고

기록 종료할 때 유저의 마지막 위치 최신화 → 메인화면 접속 시 위치 반환

[FEAT] 챌린지 리스트 관련 조회 기능 개발

- 제목

챌린지 리스트 관련 조회 기능 개발

- 개발 의도

챌린지 목록 조회용 API 개발

- 기능 리스트

• 진행 대기중인 챌린지 리스트 조회
• 진행 중인 챌린지 리스트 조회
• 진행 완료 상태의 챌린지 리스트 조회
• 초대 받은 챌린지 리스트 조회

- 비고

진행 대기중: 챌린지 기간 및 현재 진행 상황 포함 
진행 중: 현재 순위 포함
진행 완료: 기간 및 순위를 포함

[FEAT] 챌린지 관련 메소드 추가

- 제목

챌린지 관련 메소드 추가

- 개발 의도

메인화면에서 사용할 챌린지 관련 메소드 추가

- 기능 리스트

• 챌린지를 하고 있지 않은 유저 조회
• 챌린지 진행 중인 유저 조회 및 챌린지 색상 조회

- 비고

내부에서 사용 하기 위해 Service 단에 작성함.
추후, 클라이언트에서도 필요 시 Controller와 매핑 예정

[FEAT] 필요한 엔티티 생성 및 연관관계 매핑

- 제목

필요한 엔티티 생성 및 연관관계 매핑

- 개발 의도

설계된 ER-Model에 따른 엔티티 생성 및 연관 관계 매핑

- 엔티티 리스트

• 운동 기록
• 영역
• 챌린지 정보
• 회원-챌린지
• 회원-친구관계

- 비고

회원과 챌린지는 N:M 관계이므로, 이를 1:N, M:1로 풀어서 연관관계를 매핑한다.
회원(N) : 챌린지(M) → 회원(1) : 회원-챌린지(N) | 회원 -챌린지(N) : 챌린지(1)

회원(1) : 운동기록(N)
운동기록(1) : 영역(N)

챌린지 진행 중에 생성된 영역은 영역 테이블에서 관리하고, 챌린지 정보에서 시간을 기준으로 조인해서 조회한다.

[CHORE] Logger, Swagger 설정 추가

- 제목

 Logger, Swagger 설정 추가

- 목적

Logger: 로그를 파일로 관리하기 위한 Logger와 관련된 설정 추가
Swagger: API 문서 자동화를 위한 Swagger와 관련된 설정 추가

- 내용

• Swagger 사용을 위해, Springfox 3.0 버전 종속성 추가
• Log4j2 종속성 추가 및 기존 Logback 종속성 제거

[FEAT] 프로필 사진 관련 기능 구현

- 제목

프로필 사진 관련 기능 구현

- 개발 의도

최종 발표 전까지 회원의 프로필 사진을 띄우기 위한 기능 구현

- 기능 리스트

• 회원 엔티티에 프로필 사진과 관련된 기능 구현
• 프로필 사진이 필요한 기존 기능 수정

- 비고

S3를 활용해서 파일 업로드
기존 기능 중, 프로필 사진이 필요한 곳에는 다 추가해야 함.