Dependencies

📌 의존성 관리 (Dependencies Management)

(Twelve-Factor App 원칙: 명확한 의존성 선언)

마이크로서비스를 개발할 때, 사용하는 라이브러리와 프레임워크의 의존성을 명확하게 관리하는 것이 필수적입니다.
올바른 의존성 관리는 빌드 안정성과 환경 간 일관성 유지에 중요한 역할을 합니다.

🔹 1. 의존성 관리의 중요성

마이크로서비스는 여러 외부 라이브러리(Third-Party Libraries)를 사용합니다.
따라서 의존성을 적절히 관리하지 않으면 환경에 따라 빌드 결과가 달라질 수 있으며,
버전 충돌로 인해 애플리케이션이 정상적으로 실행되지 않을 가능성이 있습니다.

✅ 올바른 의존성 관리 방법
1️⃣ 모든 의존성을 명시적으로 선언해야 함.
2️⃣ 빌드 도구(Maven, Gradle)를 사용하여 의존성을 관리.
3️⃣ 의존성 버전을 고정하여, 항상 같은 버전이 사용되도록 보장.
4️⃣ 의존성 충돌을 방지하기 위해 버전 호환성 확인 필요.

🔹 2. Maven을 활용한 의존성 관리

Java 기반 마이크로서비스에서는 Maven과 같은 빌드 도구를 활용하여 의존성을 관리합니다.

✅ Maven의 동작 원리

출처 : Spring Microservices in Action 2nd Edition

 

 

1️⃣ Maven이 pom.xml 파일을 읽음
2️⃣ 로컬 저장소(.m2/repository)에서 의존성을 검색
3️⃣ 해당 의존성이 없으면 Maven 중앙 저장소에서 다운로드
4️⃣ 다운로드한 의존성을 로컬 저장소에 저장하여 이후 빌드에서 재사용
5️⃣ 모든 의존성이 해결되면 최종적으로 JAR 파일을 생성

🔹 3. Maven 의존성 선언 예제

아래 예제는 pom.xml에서 MySQL 및 Spring Boot 관련 의존성을 명확하게 선언한 코드입니다.

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.6.3</version>
    </dependency>

    <!-- MySQL 데이터베이스 드라이버 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.27</version>
        <scope>runtime</scope>
    </dependency>

    <!-- Lombok (컴파일 타임 어노테이션 프로세싱) -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.22</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

📌 주요 포인트:
✅ 각 의존성의 groupId, artifactId, version을 명확히 선언하여 빌드의 일관성을 유지.
✅ scope를 runtime, provided 등으로 설정하여 빌드 시점과 실행 시점을 구분.
✅ 의존성 버전을 명시적으로 선언하여 자동 버전 변경으로 인한 문제 방지.

🔹 4. Maven vs. Gradle 의존성 관리

Java 개발에서는 Maven 외에도 Gradle이 널리 사용됩니다.
둘 다 빌드 자동화 및 의존성 관리 기능을 제공하지만, 차이점이 있습니다.

특징	Maven	Gradle
빌드 스크립트 형식	XML (pom.xml)	Groovy/Kotlin (build.gradle)
의존성 선언 방식	XML 기반 (Verbose)	DSL 기반 (간결한 코드)
속도	느림 (XML 파싱)	빠름 (병렬 실행, 캐싱)
사용성	전통적인 Java 빌드 도구로 널리 사용됨	최근 대세, Kotlin 기반 프로젝트에서 많이 사용됨

📌 Gradle 의존성 선언 예제 (build.gradle.kts - Kotlin DSL)

dependencies {
    implementation("org.springframework.boot:spring-boot-starter-web:2.6.3")
    runtimeOnly("mysql:mysql-connector-java:8.0.27")
    compileOnly("org.projectlombok:lombok:1.18.22")
}

📌 Maven과 Gradle 중 선택:

• Maven은 전통적인 Java 프로젝트에 적합
• Gradle은 속도가 중요하거나, Kotlin 기반 프로젝트에 적합

🔹 5. 올바른 의존성 관리 전략

✅ 모든 의존성을 빌드 스크립트(Maven/Gradle)에 명시적으로 선언
✅ 라이브러리 버전을 명확히 지정하여, 예측 가능한 빌드 환경 유지
✅ Maven 로컬 저장소를 활용하여, 네트워크 문제 시에도 빌드 가능하도록 설정
✅ 의존성 충돌을 방지하기 위해 Spring Boot BOM(Bill of Materials) 사용 가능

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.6.3</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

✅ 필요 없는 의존성은 제거하여 빌드 속도를 최적화

📌 결론: 마이크로서비스에서 올바른 의존성 관리 방법

1️⃣ 의존성을 반드시 빌드 도구(Maven, Gradle)에서 선언할 것
2️⃣ 각 의존성의 버전을 명확히 지정하여 환경 간 일관성을 유지
3️⃣ Maven/Gradle을 사용하여 중앙 저장소에서 자동으로 의존성을 해결
4️⃣ BOM(Bill of Materials) 사용하여 의존성 버전 충돌 방지
5️⃣ 불필요한 의존성을 제거하여 빌드 속도를 최적화

🔹 이를 통해 마이크로서비스의 안정성과 유지보수성을 극대화할 수 있습니다! 🚀