Spring 기반 멀티모듈 프로젝트 환경변수 설정 방법

멀티모듈 프로젝트는 코드 재사용성을 높이고 의존성을 명확히 하여 유지보수성을 향상하지만, 각 모듈별 환경변수 설정 위치와 방식에 대한 고민을 동반한다.

API 스펙 변경 시 환경변수 파일(yml, properties)을 API 모듈에 둘 것인지, 아니면 구현체가 있는 client 모듈에 둘 것인지 결정해야 한다. 또한 프로필(Profile)별로 다른 설정값을 관리하는 문제도 발생한다.

환경변수 설정을 위한 4가지 주요 방식을 비교한다:

• spring.config.import: 애플리케이션의 application.yml에서 다른 모듈의 설정을 직접 임포트하는 직관적인 방식
• spring.profiles.include: 특정 프로필 활성화 시 다른 설정 파일을 포함하는 방식
• @PropertySource: 특정 클래스 수준에서 설정 파일을 지정하는 방식
• @Profile과 @PropertySource 조합: 프로필에 따라 특정 설정 파일을 로드하도록 구성하여 유연성을 높인 방식

카카오페이에서는 환경변수 설정을 체계적으로 관리하고 유지보수성을 높이기 위해 @Profile과 @PropertySource를 조합한 방식을 최종 선택했다.