9oormthon-univ/2024_beotkkotthon_team_24_be

🔄 아웃풋을 위한 인풋 [REINPUT] 백엔드 레포지토리

🌸 REINPUT 🌸

아웃풋을 위한 인풋, 리-인풋

🏆 한국스마트정보교육원 24년 상반기 SW개발공모전 최우수상

🌸 프로젝트 소개

• 프로젝트 명 : REINPUT
• 프로젝트 설명 : 흩어져 있는 인사이트들을 리인풋이 제공하는 AI 인사이트 자동 분류로 인사이트를 체계적으로 관리하고, 리마인드 기능을 통해 인사이트를 주기적으로 상기시켜 인사이트를 활용해 보세요!

TechStack

Development Environment

Infra

CI/CD

🌸 기술 설명

기술 스택

• Spring Boot : Spring Boot를 사용하여 백엔드 서버 구축
• Spring Security : Spring Security를 사용하여 인증 및 권한 부여
• JWT : JWT를 사용하여 토큰 기반 인증 구현
• QueryDSL : QueryDSL을 사용하여 동적 쿼리 작성
• Swagger : Swagger를 사용하여 API 문서화
• AWS : AWS를 사용하여 서버 배포
• Docker : Docker 및 Docker Compose를 사용하여 컨테이너 관리 및 배포, 이미지 관리
• Github Actions : Github Actions를 사용하여 CI/CD 파이프라인 구축
• Nginx : Nginx를 사용하여 로드 밸런싱 및 리버스 프록시 구축
• RDS : RDS를 사용하여 MySQL 데이터베이스 구축
• S3 : S3를 사용하여 정적 파일 관리
• Route53 : Route53을 사용하여 도메인 관리
• IAM : IAM을 사용하여 AWS 리소스 접근 제어 및 보안 관리
• EC2 : EC2를 사용하여 서버 인스턴스 생성
• ALB : ALB를 사용하여 로드 밸런싱 및 http 프로토콜 https 리다이렉트 구현
• Gradle : Gradle을 사용하여 빌드 관리
• JPA : JPA를 사용하여 ORM 구현
• MySQL : 읽기 작업이 빈번하다는 점을 고려해 선택한 MySQL을 사용한 데이터베이스 구축
• 무중단배포 : Docker, Docker-Compose, Nginx, EC2, Target-groups, Application Load Balancer, AWS Certificate Manager, Route53, Github Action, Github Action Self-Hosted Runner, Gabia 를 사용한 Blue-Green 프리티어 무중단 배포 서버 파이프라인 구축 및 https 서비스 배포

Reinput Service Architecture

🌸 협업

• Git Branch 전략 : GitHub Flow 전략을 사용하여 개발
• DDD : 도메인 주도 개발 방식을 사용하여 개발
• Notion : 프로젝트 일정 및 문서화를 위해 Notion 사용
• Scrum : 매일 저녁 10시에 스크럼 진행

Git Branch 전략

• main : 배포 가능한 상태만을 관리하는 브랜치
• feat : 새로운 기능 개발 브랜치
• fix: 기능 수정 및 업데이트 브랜치
• test : 테스트 코드 작성 브랜치

Scrum

• 매일 저녁 10시에 스크럼 진행
• 스크럼 내용 : 완료 된 일, 진행 한 일, 남은 일, 이슈사항 공유
• 코드 컨벤션 : 코드 컨벤션 리뷰

Notion

• 일정 관리 : 일정 관리 및 문서화
• 문서화 : 프로젝트 관련 문서화 요구사항 관리, API 명세서, 클래스 다이어그램, ERD 등

이슈 관리

• 이슈 템플릿 : 이슈 템플릿을 사용하여 이슈 작성
• 이슈 담당자 : 이슈 담당자를 지정하여 이슈 관리
• 버그 공유 : 버그 발생 시 이슈를 통해 공유
• 진행 상황 : 현재 진행상황을 이슈를 통해 공유 및 관리

PR 관리

• PR Template : PR 템플릿을 사용하여 PR 작성

커밋 메시지 규칙

커밋 메시지 : 커밋 메시지 규칙을 준수하여 커밋

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• refactor: 코드 리팩토링
• test: 테스트 코드, 리팩토링 테스트 코드 추가
• chore: 빌드 업무 수정, 패키지 매니저 수정
• comment: 필요한 주석 추가 및 변경
• rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
• remove: 파일을 삭제하는 작업만 수행한 경우

이슈 & PR 템플릿

## 1. 기능 설명

<br>

## 2. 상세 설명

<br>

## 3. 추가 사항

🌸 기타 사항

Swagger API 문서

• URL : Swagger API 문서

ERD

클래스 다이어그램

2024_beotkkotthon_team_24_be's Issues

[feat]: folder 구현

1. 기능 설명

folder api

• 폴더 리스트 반환
• 폴더 생성
• 폴더 수정
• 폴더 삭제

2. 상세 설명

3. 추가 사항

[feat]: healthcheck api

1. 기능 설명

2. 상세 설명

3. 추가 사항

[fix]: yml이 submodule을 가져오도록 설정

1. 문제 정의

2. 원인 파악

3. 해결

[bug]: @AuthenticationPrincipa parameter error

1. 문제 정의

final @AuthenticationPrincipal Long userId

로 userId가 정상적으로 가져오지 못하는 문제를 발견했습니다

2. 원인 파악

3. 해결

모든 컨트롤러에 대해, user정보가 필요한 API에 대하여 아래와 같이 코드를 수정해야 합니다.

final @AuthenticationPrincipal PrincipalDetails principalDetails

[feat]: github actions CI/CD

1. 기능 설명

github action, docker, nginx, ec2를 사용해 무중단 배포 파이프라인을 설정합니다.

2. 상세 설명

3. 추가 사항

[feat]: swagger 기본 설정

1. 기능 설명

swagger 기본 세팅을 완료합니다.

2. 상세 설명

3. 추가 사항

[feat]: reminder 구현

1. 기능 설명

• 오늘의 질문 구현
• 리마인드 캘린더 구현

2. 상세 설명

오늘의 질문

1-1: 저장한 인사이트가 0개 일 때

• 안내 문구: “인사이트를 저장하면 매일 리마인드 질문을 드려요!”
• 저장하러 가기 버튼 노출
  1-2: 저장한 인사이트가 1개 이상일 때
• 안내 문구: “다음 질문에 답하여 인사이트를 리마인드 해보세요!”
• 마지막으로 읽은 지 가장 오래된 인사이트를 차례대로 노출
• 하루 최대 5개의 리마인드 질문 노출
  1-3: 모든 질문에 답 했을 때
• 안내 문구: OO님, 오늘 모든 질문에 답하셨어요!
• 작성한 답변 미리 보기

리마인드 캘린더

1. 리마인드 인사이트
   1.1. 망각곡선주기

1. 1일 후 노출
2. 1주일 후 노출
3. 1개월 후 노출
   ⇒ 1-1, 1-2, 1-3에 사용자가 확인 안한 경우 리마인드 다시 설정할 수 있게 알림 필요할 것 같음
   ⇒ 추후 망각곡선주기를 사용자가 설정할 수 있게 하거나, 이 주기로 기억을 못하는 경우 늘려주는 식으로 하면 좋을 것 같음.

1.2. 사용자 지정 일

1. 매 주 n요일에 노출
2. 매 월 n일에 노출

2. 추천 인사이트

• 매일 3개씩 추천
• 추천 인사이트는 당일에만 확인할 수 있음

1. 인사이트 저장 전:

• 서비스 초기: 관리자가 정리한 인사이트를 직무 별로 임의로 노출(링크 모아서 전달 예정)
• 사용자가 많아지면: 나와 같은 직무의 사용자들이 올린 인사이트(링크만)와 콘텐츠 광고 노출

2. 인사이트 저장 후:

• 서비스 초기: 1번과 같이 관리자가 정리한 인사이트를 직무 별로 임의로 노출시키고
• 사용자가 많아지면: 내가 저장한 태그 관련해서 다른 사용자들이 올린 인사이트(링크만)와 콘텐츠 광고 노출

3. 추가 사항

[feat]: swagger 설명 추가

1. 기능 설명

2. 상세 설명

3. 추가 사항

[refactor]: 로그인 시 유저 이름도 리턴하도록 api 변경

1. refactoring 사항

"00님..." 을 프론트에서 보여주기 위해서는 유저의 이름이 들어가 있어야 한다.

2. refactoring 내용

메인페이지 호출 시 반환값에 유저 이름을 추가한다.

3. 추가사항

[feat]: insight 수정

1. 기능 설명

인사이트 수정 기능을 추가합니다.

2. 상세 설명

3. 추가 사항

[fix]: 인사이트 정보 반환 시 폴더 색상 같이 반환하기

1. 문제 정의

2. 원인 파악

3. 해결

[feat]: 폴더 내 인사이트 리스트 가져오기

1. 기능 설명

2. 상세 설명

3. 추가 사항

image only

1. 기능 설명

2. 상세 설명

3. 추가 사항

[feat]: 내 폴더 공유 url 생성하기

1. 기능 설명

내 폴더에 있는 인사이트 리스트에 대해 읽기 가능한 url을 생성합니다.

2. 상세 설명

3. 추가 사항

[feat]: 인사이트 저장 service 로직 기능추가

1. 기능 설명

인사이트 저장 로직 완료 시, 적절한 반환값을 제공해야 합니다.
이 반환값을 제공하도록 코드를 추가합니다.

24.03.23 추가 ->
해당 유저의 직무를 파악
해당 직무와 관련된 더미데이터 랜덤 반환

2. 상세 설명

3. 추가 사항

[refactor]: folder exception 및 최적화 진행

1. refactoring 사항

- 쿼리dsl 쿼리 최적화 - valid강화 - 에러 핸들링

2. refactoring 내용

-N+1 해결 -validation controller advice적용 -custom error handling 및 에러 반환

3. 추가사항

[feat]: 담당 domain entity 작성

1. 기능 설명

folder, user, reminder등의 도메인 설정

2. 상세 설명

3. 추가 사항

[fix]: 인사이트 lastview 칼럼 구성 변경

1. 문제 정의

CustomReminderRepository 주입받아서
boolean isInsightInRemindersToNotify(Long userId, Long insightId)
참이면 -> void updateLastView(Long insightId)

2. 원인 파악

3. 해결

[bug]: InsightService DI Error

1. 문제 정의

2. 원인 파악

3. 해결

[fix]: 인사이트 저장 로직 변경

1. 문제 정의

기존 폴더 이름만을 가지고 폴더에 저장하는 것이 아닌, 유저 ID와 같이 키값으로 설정해 가져오도록 합니다.

2. 원인 파악

3. 해결

[feat]: insight delete

1. 기능 설명

2. 상세 설명

3. 추가 사항

[refactor]: 추후 리팩토링 사항

1. refactoring 사항

• 폴더 공유, uuid 인증 포함
• 인사이트 전체 찾기 인사이트 도메인 이동
• querydsl 최적화

2. refactoring 내용

• uuid포함후 , 캐시(redis등)에 적용하여 공유된 폴더인지 확인
• 인사이트 전체 찾기 폴더에 있는 기능 인사이트 도메인으로 이전
• 복잡한 쿼리, 서브쿼리, 코드 컨벤션등 리팩토링 수행

3. 추가사항

• error 핸들링 추가

[feat]: 이미지 파일 s3 저장

1. 기능 설명

클라이언트에서 이미지를 추가할 때 마다 해당 api를 호출합니다.
이 api가 호출되면, aws s3에 이미지 원본이 저장되고 반환값으로 해당 s3 이미지 링크를 전달합니다.

MySQL RDS에는 이미지 링크만 저장되고, 이미지 원본은 aws S3 Standard 버킷에 저장됩니다.

2. 상세 설명

3. 추가 사항

https://chb2005.tistory.com/200

[fix]: 공유 링크 public 접근 허용

1. 문제 정의

공유 링크는 public하게 접근이 가능해야 합니다.
SpringSecurity를 수정하여 누구나 접근 가능하도록 합니다.

2. 원인 파악

3. 해결

[feat]: Insight 저장, 상세보기

1. 기능 설명

Insight 관련 핵심 기능을 구현합니다.

• 인사이트 저장
• 인사이트 상세보기

2. 상세 설명

3. 추가 사항

[feat]: 폴더 내부에서 인사이트 태그로 검색

1. 기능 설명

2. 상세 설명

3. 추가 사항

[feat]: 링크 og:image 제공

1. 기능 설명

링크를 받고 og:image를 리턴합니다.
없을 경우 반환하지 않습니다.

2. 상세 설명

3. 추가 사항

[bug]: insight - reminder 무한 재귀 호출 방지

1. 문제 정의

현재 인사이트 상세보기 API 호출 시, insight 객체 안에 reminder이 있고, reminder 객체 안에 insight가 있어 서로 무한하게 재귀호출을 해 API 반환 시 중첩된 데이터를 전송하고 있습니다.

2. 원인 파악

각 객체에서 서로 불러오지 않도록 DO를 다시 구성합니다.

3. 해결

[fix]: secret key management

1. 문제 정의

AESUtil Class의 KEY 및 INIT_VECTOR 값을 하드코딩 하지 말고, github secret으로 관리합니다.
기타 보안이 필요한 키들도 마찬가지로 관리합니다.

2. 원인 파악

3. 해결

최후순위로 해결하는 이슈입니다.