Summary

안녕하세요! 손민철 멘토님 부산대 3조 번개볼링 BE입니다. 5주차 코드리뷰 잘 부탁드립니다~ 😄

5주차 작업 내역입니다.

댓글 api 구현
서버 타임존 KST 설정
쪽지 API 구현
점수 CRUD 구현
모집글 피드백 반영

Description

5주차 작업 내역 상세입니다.

댓글 api 구현

댓글 생성 | 대댓글 생성 | 댓글 조회 | 댓글 수정 | 댓글 삭제 (5가지) 구현하였습니다.

| 댓글 조회

모집글의 경우, 최근에 쓴 글이 최상위로 가지만, 댓글은 최근에 쓴 댓글이 최하위로 가게 됩니다.
삭제된 댓글에 대댓글이 있는 경우만, "삭제된 댓글입니다"/ 유저id null로 돌려줍니다.
그외, 대댓글이 없는 삭제된 댓글과 대댓글이 삭제된 경우의 댓글은 responseBody에 포함되어 내려가지 않습니다.
size=20으로 요청이 왔다고 가정했을때, 대댓글이없는 삭제된 댓글이 5개 함께 db에서 조회된 경우 15개의 최상위 댓글만이 response로 돌아가게됩니다.

삭제된 댓글 고려
삭제된 댓글들로 인한 통일되지 않은 응답 개수 문제는, 프론트의 구현이 무한 스크롤로 이루어질 것입니다.
따라서 적은 개수가 응답되어도 자동으로 다음 key로 요청이 일어나 사용자 경험에 큰 영향을 주지 않습니다. 그렇기 때문에 무시해도 될 것 같아 이렇게 구현하였습니다.

| 댓글 삭제

대댓글을 가지고 있는 댓글을 삭제 할 수 있으므로 삭제 시, user를 null로 변경하며 content를 '삭제된 댓글입니다'로 변경합니다.
user가 null이 될 수 있으므로 responseDto 만드는 과정에 null 체크를 추가하였습니다.(유저 이름, 유저 프로필 이미지)

서버 타임존 KST 설정

서버 timezone을 맞췄습니다. 통신은 전부 KST 한국 시간으로 이루어집니다.
서버 및 MySQL, Spring boot의 시간대를 전부 KST(Asia/Seoul)로 변경하였습니다.
자바스크립트 테스트에서 Date 객체 직렬화 시 자동으로 UST로 변경되는 점을 확인하였고, 프론트에 요청하여 직접 "2023-10-06T22:10:00" YYYY-MM-DDTHH:MM:SS 형식으로 요청해달라고 전달하였습니다.

쪽지 API 구현

| 대화방(쪽지) 목록 조회

쪽지 상대방별 가장 최신 쪽지를 찾아서 가져옵니다.

| 일대일 대화방 쪽지 조회

조회시 쪽지를 읽음 처리하였습니다. isRead(false->true)
자신과의 쪽지는 조회할 수 없습니다.

| 쪽지 보내기

본인에게는 쪽지를 보낼 수 없습니다.

| 쪽지함 삭제

특정 상대와의 쪽지를 전부 삭제 합니다.

| 쪽지 개별 삭제

쪽지Id를 받아 쪽지를 개별 삭제합니다.

점수 CRUD 구현

점수 등록 | 점수 조회 | 점수 수정 | 점수 삭제

| AWS S3

aws 계정 생성 및 s3 버킷 생성했습니다.
application-aws.yml 파일을 작성해서 s3와 연동할 수 있도록 aws 계정을 연결하였습니다.
현재 api 키 값으로는 s3만 접근이 가능합니다.

| File Upload

한번에 올릴 수 있는 파일은 1개당 10MB, 총 10개까지만 올릴 수 있도록 하여 총 용량은 100MB로 제한하였습니다.
점수는 여러개를 동시에 올릴 수 있기 때문에 다중 파일 업로드 방식으로 구현하였습니다.
post man에서 form-data로 테스트를 해볼 수 있습니다. (따라서 api 명세도 같이 수정해주었습니다.)
- multipart/form-data 형식이므로 request body가 json 형식이 아니라, 이 부분에 대해서 수정해주었습니다.
점수 수정은 1개씩만 가능하게 하여 단일 파일 업로드 방식으로 구현하였습니다.

| Related S3 & File Upload

aws에 파일을 올리는 로직은 _core/utils/AwsS3Service에 구현하였습니다.
단일 파일 업로드용 함수를 구현하고 custom하여 사용할 수 있도록 작성해두었습니다. (필요하신 분은 복사해서 사용하시면 될 것 같습니다.)
_core/utils/CommonUtils에는 파일명을 반환하는 로직이 있습니다.
- 파일명은 작성자/게시글ID/score/파일명_업로드시간.확장자 로 작성이 되게 하였습니다.
- 따라서 s3에도 위와 같은 경로로 파일이 저장되게 됩니다.
- 브라우저 상에서 이미지에 접근하는 경로는 accessImageUrl로 Score field에 추가했습니다.

| Web Security

웹 보안 상으로 파일 업로드 공격이 예상되어, white listing 방식으로 확장자를 검사하는 로직을 추가하였습니다.
업로드 가능한 확장자는 png, jpg, jpeg, gif 4가지입니다.

모집글 피드백 반영

getCurrnetNumber 수정
PostRepository 수정
- 마감시간이 현재시간보다 과거일때는 조회되지 않게 수정했습니다.
- 모집중 목록 조회일때, isClose가 false여도 마감시간이 현재시간보다 과거이면 조회가 되지 않게 하였습니다.
PostController Create, Update 함수 수정
- 다른 Controller도 보면서 같이 수정하기
- api 명세도 수정하기
post update 요청 시각으로 변경
post 등록 시 response body에 pk 주기 - 프론트 요청 사항
모집글 마감 api 구현하기 (모집글 마감 버튼 눌렀을 때, 바로 마감되게 할 수 있게 수정 ) - 프론트 요청 사항

[추가 정보]

테스트 편하게 하기 위해 data.sql에 더미 데이터를 추가하였습니다.
- 더미 유저, 볼링볼링(test1@test.com / test12!@) 계정(user 권한)을 추가하였습니다.
- 더미 모집글을 추가하였습니다.
- 해당 더미 모집글에 더미 댓글들을 추가하였습니다.
global exception handler를 통해 디버깅하기 쉽도록, unkown error의 경우 stackTrace를 출력하도록 하였습니다.

Related Issue

관련된 이슈는 다음과 같습니다.

28 : 쪽지 관련 API 구현

29 : 서버 시간대 맞추기

30 : 댓글 관련 api 구현

32 : 점수 CRUD 구현

33 : 모집글 관련 피드백 반영하기

질문 사항

5주차 질문 사항입니다! 🤔

쪽지 조회 방식

~~쪽지 목록 조회와 일대일 대화방 쪽지 조회 api 동작 방식에 대해서 고민이 있습니다!~~

~~#44 : 관련된 이슈입니다!~~

~~간단하게 요약을 하자면, 현재의 구현 방식은 다음과 같습니다.~~

~~상대방과의 대화방에 들어갔을 때, 모두 읽음 처리는 하지만 가장 최근의 20개만 사용자에게 먼저 보여줌~~
~~20개 이상의 안읽은 쪽지가 있을 때, 일부의 쪽지가 읽히지 않고 무시 당할 가능성이 있음~~

~~이 방식에 대해서 같이 논의를 해보고 싶습니다.~~

쪽지 조회 방식의 경우, 프론트분들과 논의하여 문제 해결했습니다!

Step3-kakao-tech-campus / Team3_BE

부산대_3조_번개볼링_5주차 #45