💻 Technology

Server

Co-working Tools

💻 System Architecture

🏠 기술 스택 및 프레임워크 사용 이유

☁️ BackEnd

MSA 선정 이유

기존의 모놀리식 아키텍쳐는 애플리케이션이 모두 단일 프로젝트에 존재하여 단순하기 때문에 개발 속도가 빠르다. 또한 오류 시 문제가 발생한 위치를 식별하기 쉽고, 테스트 수행이 쉽다. 하지만 애플리케이션 규모가 크다면 관리가 어려울 수 있고 이 방식은 확장에 유연하지 않다.
다른 다양한 기능 추가로 확장할 계획이 있고, 현재 기획단계의 애플리케이션 규모가 큰 ‘광장’ 에서는 복잡한 시스템 설계 및 관리가 필요하고 다른 서비스와 독립적으로 확장할 수 있는 MSA 구조를 채택하였다.

Spring Eureka	QueryDSL
서비스 디스커버리 Spring Eureka는 마이크로서비스 간의 통신을 위해 서비스 디스커버리 기능을 제공한다. 이를 통해 서비스가 동적으로 등록되고 해지될 수 있으며, 클라이언트 애플리케이션은 Eureka 서버를 통해 서비스의 위치를 검색할 수 있습니다. 로드 밸런싱 Spring Eureka는 로드 밸런싱을 지원하여 여러 인스턴스 중 하나를 선택하여 요청을 분산시킬 수 있습니다. 이는 애플리케이션의 확장성과 가용성을 향상시키므로 Spring Eureka로 선정하였습니다.	타입 안정성 QueryDSL은 컴파일 시점에 타입 검사를 수행하므로 런타임 시점에 발생할 수 있는 SQL 쿼리 관련 오류를 사전에 방지합니다. 이는 코드의 안정성을 향상시키고 버그를 줄여줍니다. 동적 쿼리 작성 QueryDSL은 동적으로 쿼리를 생성할 수 있는 능력을 제공합니다. 이를 통해 사용자 입력 또는 조건에 따라 쿼리를 동적으로 조작할 수 있기에 QueryDSL로 선정하였습니다.

Docker	ElastiCache
일관성 컨테이너는 환경을 패키지화하므로 개발, 테스트 및 프로덕션 환경 사이의 일관성을 유지하기가 더 쉽습니다. 동일한 컨테이너를 로컬 개발 환경에서 실행하고 프로덕션 서버에서 실행할 때 예상대로 동작합니다. 선언적 구성 Docker Compose와 같은 도구를 사용하면 애플리케이션 구성을 선언적으로 정의할 수 있습니다. 이를 통해 환경 변수, 네트워킹, 볼륨 마운트 등을 쉽게 관리할 수 있어 Docker를 선정하였습니다.	빠른 성능 처리량이 많고 지연 시간이 짧은 인 메모리 데이터 스토어에서 데이터를 검색하여 데이터베이스 성능을 강화로 빠른 응답 속도를 제공합니다. 유연한 데이터 만료 관리 각 키에 대해 만료 시간을 설정할 수 있어, Refresh Token의 유효 기간 관리가 용이합니다. 따라서 ElastiCache로 Refresh Token을 관리하기 위해 해당 기술을 선정하였습니다.

🔖 Naming Rules

• 컴포넌트, 타입, 인터페이스, 생성자, 클래스 : PascalCase
• 메소드 & 파라미터 & 변수 : camelCase
• 상수 : SNAKE_CASE

🗂️ Commit Convetion

📌 Type

commit명	commit 규칙
feat	새로운 기능 추가
fix	버그 수정 혹은 기능 수정
design	css 등 사용자 UI 디자인 추가 및 수정
docs	문서 추가 및 수정
test	테스트코드, 리팩토링 테스트 코드를 추가했을 때
style	코드 포맷팅, 세미콜론 누락, 코드 변경이 없이 추가 및 수정
refactor	코드 리펙토링
build	빌드 관련 파일 추가 및 수정
rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만 수행
remove	파일을 삭제하는 작업만 수행
chore	그 외 자잘한 수정

• commit message example
  • feat : 작업 내용
  • fix : 작업 내용
  • chore : …
• 커밋은 파일 단위로 작업한 내용 쪼개서 하기
• 커밋메시지는 영어로 작성

👨🏻‍🎓 Branch Rules

• 형식 [Header]/[이슈 번호]/[이슈 작업 내용 요약]
  • ex) feat/#2/login

Header	기능
main	최종 배포할 서비스 내용의 브랜치
develop	주요 개발 브랜치, 이 브랜치를 기준으로 각자 작업한 기능을 merge
feat	기능 개발 브랜치, 기능 개발이 완료 시 develop 브랜치에 merge
fix	기능 수정 브랜치, 이미 develop 브랜치에 merge된 기능을 수정하고 완료 시 develop 브랜치에 merge
hotfix	master 브랜치로 배포 후에 버그가 생겼을 때 긴급 수정하는 브랜치

⚽️ Issues

• 이슈 제목 - feat : mainPage 수정

• 마일스톤 적용

• 템플릿 이용

  ## 📌이슈 설명
  
  ## 🗒️투두리스트
  - [ ]
  - [ ]
  
  ## 👣참고사항

👻 Pull requests

• pr 제목 - feat : mainPage 수정 (이슈제목과 동일하게)

• 템플릿 이용

  ### 📝 Description
  이슈 번호 : #번호
  
  ### 💽 작업 내용
  - 1
  - 2
  
  ### 🖼 결과 (사진 및 작업 결과)

🎃 Directory Structure

☁️ BackEnd

DDD 패턴

┌── api-gateway
├── service1
│   ├── src
│   │   ├── main
│   │   │   ├── java.com.gwangjang.backend
│   │   │   │   ├── domain
│   │   │   │   │   └── service1
│   │   │   │   │       ├── application
│   │   │   │   │       │    └── dto
│   │   │   │   │       │    └── mapper
│   │   │   │   │       │    └── service
│   │   │   │   │       ├── domain
│   │   │   │   │       │    └── entity
│   │   │   │   │       │    └── repository
│   │   │   │   │       │    └── service
│   │   │   │   │       ├── exception
│   │   │   │   │       │    └── exception
│   │   │   │   │       └── presentation
│   │   │   │   │            └── controller
│   │   │   │   │            └── mapper
│   │   │   │   │            └── service
│   │   │   │   ├── global
│   │   │   │   └── BackendApplication
│   │   │   ├── resources
│   │   └── test
│   ├── build.gradle
│   ├── Dockerfile
│   ├── settings.gradle
│   ├── gradlew
│   └── gradlew.bat
└─── service2
└─── service3
└─── service4

🐬 Git Flow