Skip to content

Commit

Permalink
Chore: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@chaewon-io
chaewon-io authored Jun 10, 2024
1 parent f399222 commit 4b79164
Showing 1 changed file with 189 additions and 77 deletions.
266 changes: 189 additions & 77 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,31 @@
## 🌊 챌린지의 파도를 넘어 취업으로, WAVED-BE
# 🌊 챌린지의 파도를 넘어 취업으로, WAVED-BE
<img src="https://github.com/chaewon-io/Waved_BE/assets/82140052/963b74c3-90b4-4fff-82c5-2d2d83a1b379" width="1000"/>
<br>

## 프로젝트 소개
- 개발자 맞춤형 챌린지 : 취업 준비가 외롭지 않도록 맞춤형 챌린지를 준비했어요.

### 📆 개발기간
- 동기부여 챌린지 : 참여할 챌린지에 예치금을 걸고, 챌린지를 완주할 동기부여를 얻으세요.

- 맞춤형 인증방식 : 각 챌린지별 최적의 인증 방식으로 효율적으로 달성률을 채워보세요.

- 인증내역 커뮤니티 : 매일 인증하고 같은 기수 개발자들과 답변을 공유하며, 함께 성장하세요.

## 서비스 링크
https://waved-likelion.site/

## 개발기간
- 개발 : 2024년 2월 26일 ~ 2024년 3월 22일
- 테스트 및 리팩토링 : 2024년 4일 1일 ~ 2024년 4월 26월
- 테스트 및 리팩토링 : 2024년 4일 1일 ~ 2024년 4월 26월

### 🔧 Tools
## Team
![2046](https://github.com/chaewon-io/Waved_BE/assets/82140052/a7d4394b-17c6-40ba-9b6e-fc01acdb8195)


## 아키텍쳐
![waved-BE_ 구글 로그인 아키텍처 - Page 1 (2)](https://github.com/chaewon-io/Waved_BE/assets/82140052/cdda17c4-807b-4ac7-a678-2cbe7e8ba0c5)

## Tools

<div align=left>
<img src="https://img.shields.io/badge/JAVA 17-407999?style=for-the-badge&logo=JAVA 17&logoColor=white">
Expand All @@ -26,79 +46,13 @@

</div>

### 🏄‍♀️ 아키텍쳐
![waved-BE-Page-1](https://i.ibb.co/CM6FNjz/waved-BE-Page-1.jpg)

### 🏄‍♀️ API명세
- 포스트맨 : https://documenter.getpostman.com/view/34016201/2sA3JRXds2

| | Method | URI | Description |
| --- | --- | --- | --- |
| 관리자 | GET | /api/v2/admin/groups | 진행중인 챌린지 그룹 조회 |
| | GET | /api/v2/admin/{challengeGroupId}/verifications | 그룹별 인증 내역 조회 |
| | DELETE | /api/v2/admin/{challengeGroupId}/verifications/{verificationId} | 인증 내역 취소 논리삭제 |
| 일반회원 | PATCH | /api/v1/members/edit | 멤버 정보 수정(초기 회원 가입시) |
| | POST | /api/v1/members/reissue | 토큰 재발급 refreshTocken 활용 |
| | POST | /api/v1/members/logout | 로그아웃 accessToken 만료 기간 전인 10분동안은 블랙리스트 처리 |
| | DELETE | /api/v1/members/delete | 회원 탈퇴 |
| | GET | /api/v1/members/profile | 프로필 조회 |
| | GET | /api/v1/members/profile/edit | 프로필 수정 |
| | POST | /api/v1/members/github | 깃허브 연동 |
| | GET | /api/v1/members/github | 깃허브 정보 조회 |
| | DELETE | /api/v1/members/github | 깃허브 연동 해제 |
| | GET | /api/v1/members/reviews?page=0&limit=5 | 자신의 리뷰 조회 5개씩 페이징 |
| | GET | /api/v1/members/paymentRecords?page=0&limit=5 | 예치금 내역 조회5개씩 페이징 |
| 챌린지 | GET | /api/v1/challenges/waiting | 대기중인 전체 챌린지 조회 비회원조회가능 |
| | GET | /api/v1/challenges/{challengeId}/reviews?page=0&limit=5 | 챌린지 전체 리뷰 조회 5개씩 페이징 비회원조회가능 |
| 챌린지 그룹(기수) | GET | /api/v1/challengeGroups/info/{challengeGroupId} | 챌린지 그룹 상세 정보 조회 비회원조회가능 |
| | POST | /api/v1/challengeGroups/{challengeGroupId}?deposit= | 챌린지 그룹 신청 |
| | GET | /api/v1/challengeGroups/{challengeGroupId}?verificationDate= | 챌린지 그룹의, 날짜별, 인증 내역 조회 |
| | GET | /api/v1/challengeGroups/{challengeGroupId}/myVerifies?verificationDate= | 챌린지 그룹의 내 인증 내역 조회 |
| 마이챌린지 | GET | /api/v1/myChallenges?status=PROGRESS | WAITING | COMPLETED
| 상태별 마이 챌린지 조회 |
| | GET | /api/v1/myChallenges/{myChallengeId} | 나의(마이챌린지) 인증 내역 조회 |
| 인증 | POST | /api/v1/verify/{challengeGroupId}
→ form-data : imageUrl, content, link, 깃헙은 제출 x | 챌린지 인증 제출 (글, 링크, 사진, 깃허브) 중복 제출 불가능 |
| | GET | /api/v1/verify/{challengeGroupId}/dates?quizDate=2024-03-20 03:25:02.337779 | 그룹의, 날짜별 퀴즈 조회 |
| | GET | /api/v1/verify/{challengeGroupId} | 그룹의, 오늘의 퀴즈 조회 |
| 리뷰 | POST | /api/v1/reviews/myChallenge/{myChallengeId} | 리뷰 등록 중복 등록 불가능 |
| | GET | /api/v1/reviews/{reviewId} | 리뷰 수정용 content 조회 |
| | PATCH | /api/v1/reviews/{reviewId} | 리뷰 수정 |
| | DELETE | /api/v1/reviews/{reviewId} | 리뷰 삭제 |
| 결제 | POST | /api/v1/payments/{myChallengeId} | 결제 후 검증 |
| | POST | /api/v1/payments/{myChallengeId}/cancel | 챌린지 신청 취소 시 환급 |
| | POST | /api/v1/payments/{myChallengeId}/completed | 챌린지 완주 시 환불 버튼 |
| 좋아요 | POST | /api/v1/likes/{verificationId} | 좋아요 추가 중복 추가 불가능 |
| | GET | /api/v1/likes/{verificationId} | 특정 인증 내역 좋아요 수 조회 |
| | DELETE | /api/v1/likes/{verificationId} | 좋아요 취소 |
| 알림 | GET | /api/v1/event/subscribe | 알림 구독 |
| | GET | /api/v1/event/new | 새로운 알림 유무 확인 |

### 🏄‍♀️ 테이블 (다이어그램)
<img width="700" alt="스크린샷 2023-12-21 오후 2 08 32" src="https://i.ibb.co/djSMQCh/image.png">


### 🏄‍♀️ 사이트
https://waved-likelion.site/

### 🏄‍♀️ 구현 기능
#### 1. 회원가입/로그인
- 스프링 시큐리티와 OAuth 2.0 로그인 연동을 JWT 토큰 기반으로 구현하였고, Redis를 사용하여 refresh Token을 저장하였습니다.
- 로그아웃한 유저 토큰의 블랙리스트 처리로 보안을 강화했습니다.
<br>
<img width="700" alt="image" src="https://i.ibb.co/T0CQGSn/image.jpg">

#### 2. 실시간 알림
- 스프링 서버 사이드 이벤트 SseEmitter로 구현하였고, 관리자 단에서 취소되는 인증에 대해 유저에게 확실하게 전달할 수 있도록 실시간 알림을 사용했습니다.
<br>
<img width="300" alt="image" src="https://i.ibb.co/qRjhnjG/ezgif-com-video-to-gif-converter.gif">

#### 3. 결제 사후 검증, 취소, 환급
- 포트원과 연동하여 결제 요청을 확인하고, 금액이 정확한지 체크하는 사후 검증 과정과 결제 취소 및 환급 과정의 전체 결제 프로세스를 구현했습니다.
<br>
<img width="400" alt="image" src="https://i.ibb.co/9ZZZ76t/waved-ezgif-com-video-to-gif-converter.gif">

### 🏄‍♀️ 패키지 구조
## API명세
- 포스트맨 : https://documenter.getpostman.com/view/34016201/2sA3JRXds2

### 테이블 (다이어그램)
<img src="https://github.com/chaewon-io/Waved_BE/assets/82140052/cf6ceb01-1bdd-42ee-aeff-a196ab3a9dc4" width="1000"/>

## 패키지 구조
```
└── src
Expand Down Expand Up @@ -210,4 +164,162 @@ https://waved-likelion.site/
├── application.yml
└── application-secret.yml
```

## Feature
### A. 회원가입/로그인 '구글 OAuth2.0 JWT 토큰 방식'
`JWT 토큰 방식` : 스프링 시큐리티와 OAuth 2.0 로그인 연동을 JWT 토큰 기반으로 구현하였습니다.

`Redis` : 레디스를 사용해서 refresh Token을 저장하여 관리하였습니다.

`블랙리스트` : 로그아웃한 유저 토큰의 유효 시간동안 블랙 리스트 처리를 하여 보안을 강화하였습니다.

<br>

![waved-BE_ 구글 로그인 아키텍처 - Page 1 (1)](https://github.com/chaewon-io/Waved_BE/assets/82140052/b6b9bf4a-4f0c-48ed-9933-b48f4c20a139)


### B. 다양한 챌린지 인증 방식 기능 구현
사진, 글, 링크, 깃헙 인증 방식 도입 및 인증 내역 조회
- `사진 인증` : 이미지 파일을 multipart 전송을 통해 업로드하면 Azure Blob Storage에 저장하도록 구현하였습니다.

- `깃헙 인증` : GithubApi를 사용해서 레포지토리의 당일 커밋 기록을 불러오도록 구현했습니다.

<br>

![2050](https://github.com/chaewon-io/Waved_BE/assets/82140052/62fdfbb1-e9c4-47c8-95df-83098637cd7d)
![2051](https://github.com/chaewon-io/Waved_BE/assets/82140052/9391aa1b-8498-472d-bce4-16fcc8c875b1)

### C. 좋아요 및 리뷰 기능
격리 수준으로 트랜잭션을 활용해서 DB 원자성을 보장하는 방식으로 좋아요 기능을 구현했습니다.
→ 동시에 여러 개의 좋아요가 발생해도 엔티티 개수 조회하는 트랜잭션은 변경되지 않는 데이터 읽어서 높은 격리 수준을 가지게 됩니다.

### D. 데이터 생성 자동화
`불편함 발생` : 챌린지 기수제로 운영 시, 매번 수동으로 기수를 생성해야하는 불편함이 발생했습니다.

`자동화 처리` : 챌린지에 기수 관련 필드 추가 및 스케줄링을 통해 챌린지 기수 객체 생성 자동화 했습니다.

→ 이를 통해 운영 효율성과 데이터 정확성을 향상시켰습니다.

<br>

![2049](https://github.com/chaewon-io/Waved_BE/assets/82140052/f3593ebb-8f95-4894-9aa1-3f999575a11d)

### E. 포트원 연동을 통한 결제 프로세스
`결제` : 포트원과 연동하여 결제 요청을 확인하고, 금액이 정확한지 체크하는 사후 검증 과정과 결제 취소 및 환급 과정의 전체 결제 프로세스를 구현했습니다.
<br>
![2047](https://github.com/chaewon-io/Waved_BE/assets/82140052/bd71b226-d186-4665-bd09-92f9d303cfac)


### F. SSE(Server-Sent-Events)를 이용한 실시간 알림 기능
`실시간 알림` : 스프링 서버 사이드 이벤트 SseEmitter로 구현하였고, 관리자 단에서 취소되는 인증에 대해 유저에게 확실하게 전달할 수 있도록 실시간 알림을 사용했습니다.
<br>
![2048](https://github.com/chaewon-io/Waved_BE/assets/82140052/fcd7c9a5-9075-469d-8962-fcc2201f12fc)

### G. 예외 처리
`전역 예외 처리기 정의` : 전역 예외 처리기를 정의하고 예외 유형별로 처리 로직을 구현하였습니다.
- 각 유형에 대해 HTTP 상태 코드와 오류 메시지를 반환하도록 하여 협업을 위한 일관성 있는 예외 처리와 중복 코드를 줄일 수 있었습니다.
```java
@RestControllerAdvice
public class GlobalExceptionHandler {

@ExceptionHandler(MemberNotFoundException.class)
@ResponseStatus(HttpStatus.NOT_FOUND)
public ResponseEntity<ResponseDto> handleMemberNotFoundException(MemberNotFoundException e) {
return ResponseDto.of(HttpStatus.NOT_FOUND, e.getMessage());
}

@ExceptionHandler(WrongGithubInfoException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
public ResponseEntity<ResponseDto> handleWrongGithubInfoException(WrongGithubInfoException e) {
return ResponseDto.of(HttpStatus.BAD_REQUEST, e.getMessage());
}

...

}
```

## 🚀 ISSUE
### 1. 쿼리 최적화 시도 ‘부분 조회’
→ 불필요한 데이터 전송을 하고 있다고 판단해 성능 향상을 위한 부분 조회의 필요성을 느껴 다양한 테스트를 진행해보았습니다.

a. 성능 테스트 수행
→ 여러 방법으로 부분 조회 실행 시 실행 시간 테스트 결과 dto 사용 부분 조회가 가장 적은 2~4배 정도의 시간이 소요됩니다. 데이터 조회 시 시간을 제외한 성능 개선을 위해 dto 사용 부분 조회로 결정하였습니다.

```
Test1 - Elapsed time: 112 milliseconds // 기존 멤버 조회
Test2 - Elapsed time: 673 milliseconds // QueryDSL 부분 조회
Test3 - Elapsed time: 601 milliseconds // Projection 부분 조회
Test4 - Elapsed time: 471 milliseconds // Dto 부분 조회
```

b. 데이터베이스 쿼리 분석

```
Hibernate:
select
m1_0.id,
m1_0.auth_level,
m1_0.birth_year,
m1_0.create_date,
m1_0.email,
m1_0.gender,
m1_0.github_id,
m1_0.github_token,
m1_0.has_info,
m1_0.has_new_event,
m1_0.job_title,
m1_0.modified_date,
m1_0.nickname
from
member m1_0
where
m1_0.id=?
```
```
Hibernate:
/* SELECT
new com.senity.waved.domain.challenge.service.NicknameDto(m.nickname)
FROM
Member m
WHERE
m.id =:id */ select
m1_0.nickname
from
member m1_0
where
m1_0.id=?
```

c. 메모리 사용량 비교

```
Test1 - Elapsed time: 103 milliseconds // 기존 멤버 조회
Test1 - 메모리 사용량: 4527440
Test2 - Elapsed time: 564 milliseconds // Dto 부분 조회
Test2 - 메모리 사용량: 23068640
```

→ 효율 측정 결과 기존 방법인 전체 조회에서 메모리 사용량과 시간 소요에서 약 5배정도 추가로 들어 기존 방법으로 결정했습니다.

### 2. 객체 관계 최적화
→ 기수별로 운영되는 챌린지 서비스였기에 복잡한 객체 관계로 인해 불필요한 데이터가 조회되어 성능 저하가 발생했습니다.

a. `JPA 매핑 관계 재정의`
: 서비스에서 실제로 필요한 관계만 설정하고, 불필요한 매핑을 제거하였습니다. 또한 JPA의 자동 관계 설정 기능을 통해 얻을 수 없는 부분은 외래키 설정을 유지하며 서비스에 최적화 된 방법으로 객체 관계를 재정의 하였습니다.

b. `Entity와 DTO 변환으로 관심사 분리`
: 서비스의 자유도가 떨어지고, 유연성 저하되어 유지 보수 측면에서 엔티티에서 DTO 변환하는 구조가 필요하다고 판단했습니다. 이를 적용하여 관심사 책임 분리를 하여 코드 유연성을 높였습니다.

→ 이렇게 최적화를 진행하며 쿼리 호출 감소로 무한 루프를 방지하고, 실제 데이터 조회 속도가 2배 향상되었습니다.
→ 마이 챌린지 페이지로 이동 시 3초 이상 걸렸는데 1초로 줄어들었습니다.

0 comments on commit 4b79164

Please sign in to comment.