Codebase

📌 Codebase (코드베이스) 관리 모범 사례

(Twelve-Factor App 원칙: 단일 코드베이스 유지)

마이크로서비스를 설계할 때, 각 마이크로서비스는 단일 코드베이스(Single Codebase)를 유지해야 합니다.
이를 통해 유지보수성과 확장성을 높이고, 배포 과정에서의 혼란을 방지할 수 있습니다.

🔹 1. 코드베이스(Codebase)란?

• 코드베이스(Codebase)는 소스 코드가 저장된 단일 버전 관리 저장소(예: Git, SVN)를 의미합니다.
• 모든 변경 사항은 버전 관리 시스템(Version Control System, VCS)을 통해 관리됩니다.
• 각 마이크로서비스는 독립적인 코드베이스를 가져야 하며, 다른 마이크로서비스와 코드베이스를 공유하면 안 됩니다.

🔹 2. 올바른 코드베이스 관리 방법

✅ 단일 코드베이스, 여러 배포 환경

• 하나의 코드 저장소(Git)에서 여러 배포 환경(개발, 테스트, 스테이징, 프로덕션)을 관리해야 합니다.
• 각 환경은 별도의 브랜치 또는 설정 파일을 통해 관리할 수 있습니다.

📌 올바른 코드베이스 구조 예시

📦 my-microservice/
 ├── 📂 src/                # 소스 코드
 ├── 📂 config/             # 환경별 설정 파일
 │   ├── application-dev.yml
 │   ├── application-test.yml
 │   ├── application-prod.yml
 ├── 📂 scripts/            # 배포 및 마이그레이션 스크립트
 ├── pom.xml                # Maven 프로젝트 설정 파일
 ├── Dockerfile             # 컨테이너 이미지 빌드 파일
 ├── README.md              # 프로젝트 설명 파일

🔹 3. 왜 코드베이스를 공유하면 안 되는가?

마이크로서비스가 단일 코드베이스를 공유하면 여러 환경에서 같은 코드가 여러 번 배포되면서 유지보수가 어려워집니다.

❌ 잘못된 예시: 모든 마이크로서비스가 하나의 코드 저장소를 공유

📦 monolithic-repo/
 ├── 📂 user-service/
 ├── 📂 order-service/
 ├── 📂 payment-service/

➡ 📌 문제점:
✅ 독립적인 배포 불가능: 한 서비스의 변경 사항이 다른 서비스에도 영향을 미칠 수 있음.
✅ 테스트 및 확장성 저하: 특정 서비스만 변경해도 전체 코드베이스를 다시 빌드해야 함.
✅ 무결성 문제 발생: 여러 환경에서 같은 코드가 동시에 수정될 경우, 충돌 가능성이 높음.

🔹 4. 단일 코드베이스의 장점

✅ 각 마이크로서비스는 독립적으로 배포 가능
✅ 각 환경(개발, 테스트, 운영)에 맞게 쉽게 배포 가능
✅ 버전 관리를 통해 변경 사항을 추적할 수 있음
✅ 코드 충돌을 줄이고 유지보수를 단순화할 수 있음

🔹 5. 코드베이스와 배포 환경의 관계

아래 다이어그램은 단일 코드베이스에서 여러 환경으로 배포되는 방식을 보여줍니다.

📌 단일 코드베이스 유지 → 여러 환경(Development, Test, Staging, Production)에서 배포
📌 각 환경은 설정(Configuration)만 다르게 적용
📌 코드베이스를 공유하지 않고, 환경별로 설정을 변경하여 배포

 

출처 : Spring Microservices in Action 2nd Edition

 

📌 Summary:
✅ 하나의 코드베이스를 유지하지만, 환경별 설정은 분리해야 함.
✅ 배포할 때마다 소스 코드를 변경하지 않고 환경만 변경할 수 있도록 설계해야 함.

📌 결론: 마이크로서비스 코드베이스 관리 원칙

1️⃣ 각 마이크로서비스는 단일 코드베이스(Single Codebase)를 가져야 함
2️⃣ Git과 같은 버전 관리 시스템을 활용하여 변경 사항을 관리
3️⃣ 각 환경(개발, 테스트, 운영)은 설정 파일이나 프로파일(Spring Profile)로 분리
4️⃣ 코드베이스를 여러 서비스가 공유하면 유지보수가 어렵기 때문에 분리해야 함

🔹 올바른 코드베이스 관리를 통해 마이크로서비스의 확장성과 유지보수성을 극대화할 수 있습니다! 🚀