프로젝트 공통 관리가 필요한 부분 브랜치명 정리

자료 모음

프로젝트 공통 관리가 필요한 부분 브랜치명 정리 - chat gpt

dev.jelee 2024. 11. 25. 11:49

설명: comm/env 브랜치는 애플리케이션이 실행되는 환경 설정과 관련된 작업을 다룹니다. 이는 개발, 테스트, 운영 환경에 따라 다르게 설정되는 값을 관리하는 작업입니다.
작업 내용:
- 프로퍼티 파일 설정: application.properties 또는 application.yml 파일에서 환경별로 다른 설정을 적용하는 작업.
- 프로파일별 설정: Spring의 @Profile을 사용하여, 개발/운영 환경에 따라 다른 빈(bean)을 주입하거나 설정을 변경.
- 환경 변수 처리: 서버 환경에 따라 System.getenv()와 같은 환경 변수를 처리하는 코드.
- CI/CD 및 배포 관련 설정: Docker, Kubernetes 등 다양한 환경에서 애플리케이션을 실행하기 위한 설정.
예시: 개발 환경에서는 테스트 데이터베이스를 사용하고, 운영 환경에서는 실제 데이터베이스를 연결하는 설정을 관리하는 작업.

설명: comm/exception 브랜치는 애플리케이션에서 발생하는 예외 처리와 관련된 작업을 담당합니다. 예외가 발생했을 때 일관되게 처리하고, 오류 메시지나 로그를 관리하는 기능을 제공합니다.
작업 내용:
- 글로벌 예외 처리: @ControllerAdvice 또는 @ExceptionHandler를 사용하여 애플리케이션 전역에서 발생하는 예외를 처리.
- 커스텀 예외 클래스 생성: 특정 비즈니스 로직에 맞는 예외를 정의하고 처리하는 작업.
- 예외 메시지 및 응답 포맷 관리: 예외 발생 시 사용자에게 반환할 메시지나 응답 형식 일관성 관리.
- 로깅 및 모니터링: 예외 발생 시 로그를 찍고, 외부 시스템(예: Sentry)으로 전송하여 예외 모니터링.
예시: 404 Not Found, 500 Internal Server Error와 같은 HTTP 상태 코드에 맞는 예외 처리 및 사용자에게 오류 메시지 반환.

설명: comm/static 브랜치는 정적 리소스(HTML, CSS, JavaScript, 이미지 파일 등)의 관리와 최적화를 담당합니다. 웹 애플리케이션에서 사용하는 정적 파일들을 효율적으로 제공하고, 성능을 개선하는 작업을 합니다.
작업 내용:
- 정적 파일 경로 설정: Spring Boot에서 기본적으로 제공하는 src/main/resources/static 경로 외에 추가 경로나 맞춤 설정을 적용.
- 정적 파일 압축 및 최적화: 이미지, CSS, JS 파일을 압축하여 로딩 성능을 향상.
- 정적 파일 캐싱: 클라이언트에서 정적 파일을 캐시하도록 설정하여, 서버 부하를 줄이고 빠르게 로드되도록 함.
- 정적 리소스 제공: @Controller나 @RestController를 통해 동적으로 정적 파일을 제공하는 작업.
예시: CSS 파일을 압축하여 웹 페이지 로딩 시간을 단축하거나, 이미지 파일에 캐시 설정을 추가하여 클라이언트 측에서 효율적으로 로드되도록 설정하는 작업.

설명: comm/aop 브랜치는 **AOP (Aspect-Oriented Programming)**를 적용하여 공통적인 관심사(예: 로깅, 트랜잭션 관리 등)를 한 곳에서 처리하는 기능을 다룹니다. AOP는 코드의 중복을 줄이고, 유지보수를 용이하게 만듭니다.
작업 내용:
- 로깅: 메소드 실행 전후에 자동으로 로깅을 추가하는 작업.
- 트랜잭션 관리: 특정 메소드에서 자동으로 트랜잭션을 시작하고 종료하는 기능을 추가.
- 보안/인증: 메소드 실행 전에 권한을 체크하는 보안 관련 기능을 추가.
- 예외 처리: 예외 발생 시 일관되게 예외를 처리하는 기능을 추가.
예시: 모든 서비스 메소드에 대해 트랜잭션을 자동으로 관리하거나, 메소드 실행 전후에 로깅을 자동으로 수행하는 작업.

이 각각의 브랜치는 공통적인 기능을 다루는 브랜치로, 애플리케이션 전체에서 재사용되거나 일관성 있는 처리를 통해 효율적인 관리가 가능하도록 돕습니다. 각 브랜치의 정확한 내용은 해당 브랜치의 커밋 메시지나 코드를 확인하는 것이 좋습니다.