[Gradle] Dependency Configuration이란?

 

 

 

🧐 서론

이전 글에서 의존성 관리에 대해서 간략하게 알아보았습니다.

이번에는 의존성에 대해서 조금 자세히 알아보도록 하겠습니다.

 

의존성을 사용하기 전에 dependency configuration이라는 개념에 대해서 알아보겠습니다.

 

 

 

 

 

 

🧐 Dependency Configuration

Gradle 기반의 프로젝트에서 선언되는 모든 의존성들은 해당 의존성이 사용되어지는 특정한 scope가 있습니다.

예를 들어 어떤 의존성은 소스 코드를 컴파일하는데 사용되어지고, 어떤 의존성은 런타임에만 사용되어집니다.

테스트 환경에서만 사용되어야 하는 의존성들도 존재합니다.

 

Gradle에서는 의존성이 사용되는 scope를 configuration을 통해 명시합니다.

모든 configuration은 고유한 이름으로 식별할 수 있습니다.

 

 

 

 

 

🌱 Plugin과 configuration

많은 Gradle의 플러그인(plugin)들은 해당 플러그인에서 미리 정의한 configuration들을 프로젝트에 추가합니다.

예를 들어, 자바 플러그인은 코드 컴파일, 테스트 실행 등에 필요한 다양한 클래스패스(classpath)를 나타내기 위한 configuration들을 추가합니다.

 

다음은 configuration들이 특정한 목적을 위해 선언된 의존성을 사용하는 그림입니다.

 

소스 코드를 컴파일하는 경우에는 implementation이라는 configuration을 사용하며,

테스트를 실행하는 경우에는 testRuntime이라는 configuration을 사용하는 것을 알 수 있습니다.

이에 대한 더 자세한 설명은 java 플러그인을 살펴보는 글에서 다루도록 하겠습니다.

 

더 많은 configuration의 사용 예시는 resolution result APIs를 참고해주세요.

 

 

 

 

 

🌱 configuration의 상속(inheritance)과 합성(composition)

Configuration은 다른 configuration을 확장(extends)함으로써 상속 계층을 형성할 수 있습니다.

자식 configuration은 부모 configuration들이 선언한 모든 의존성들을 물려받습니다.

 

자바 플러그인을 예시로 살펴보면, testImplementation은 implementation을 상속합니다.

 

테스트 코드를 컴파일하기 위해서는, 테스트하려는 소스 코드의 의존성 뿐만 아니라, 테스트 클래스를 작성하는 데 필요한 의존성까지 모두 필요한데요, 이를 위해 testImplementation이 implementation을 상속하도록 하였습니다.

 

testImplementation은 선언된 의존성들을 테스트를 위한 classpath인 testCompileClasspath과 testRuntimeClasspath에 추가하는데요, testImplementation은 implementation을 상속하기 때문에 implementaion에 선언된 의존성들 역시 testCompileClasspath과 testRuntimeClasspath에 추가됩니다.

 

아래 그림은 하나의 예시를 나타냅니다.

 

implementation으로 설정된 Guava는 프로덕션 환경에서 실행될 때에도 필요하지만, 테스트시에도 필요하기 때문에 compileClasspath, runtimeClasspath, testCompileClasspath, testRuntimeClassPath에 모두 추가됩니다.

 

그러나 testImplementation으로 선언된 JUnit은 오직 testCompileClasspath, testRuntimeClassPath에만 추가되므로, 프로덕션 환경에서는 이를 의존하지 않게 됩니다.

 

 

 

 

😎 Configuration 상속해보기

Configuration의 상속은 내부적으로 Configuration의 extendsFrom이라는 메서드를 호출함으로써 이루어집니다.

이를 직접 사용하는 예시를 살펴보도록 하겠습니다.

 

 

smoke test를 작성하려는 상황을 가정해 보겠습니다.

somke test는 HTTP 호출을 통해 endpoint를 검증합니다.

기본 테스트 프레임워크로는 이미 JUnit을 사용하고 있다고 하겠습니다.

 

이제 testImplementation을 상속하는 smokeTest라는 이름의 새로운 configuration을 정의하도록 하겠습니다.

이를 통해 smokeTest에서도 testImplementation에서 선언된 의존성들(JUnit)을 사용할 수 있습니다.

configurations {
    smokeTest.extendsFrom testImplementation
}

dependencies {
    testImplementation 'junit:junit:4.13'  // smokeTest 에서도 사용할 수 있다.
    smokeTest 'org.apache.httpcomponents:httpclient:4.5.5'
}

 

 

 

 

 

 

 

 

 

🧐 Project dependencies

소프트웨어는 종종 소프트웨어 구성요소들을 모듈로 분할하여 유지보수성을 개선하고 강결합을 방지합니다.

모듈들은 동일한 프로젝트 내에서 코드를 재사용하기 위해 서로간의 의존성을 정의할 수 있습니다.

 

 

Gradle은 모듈간의 의존성을 모델링할 수 있습니다.

이러한 의존성들은 project dependencies라고 불리는데, 이는 각각의 모듈이 Gradle project로 표현되기 때문입니다.

 

예시는 다음과 같습니다.

dependencies {
    implementation project(':shared')
}

이를 통해 해당 build.gradle을 사용하는 project는 shared라는 프로젝트에 대하여 의존성을 가지게됩니다.

 

런타임시에, 빌드는 의존성이 올바른 순서로 구성되고 classpath에 추가되도록 자동적으로 보장합니다.

멀티모듈에 대한 자세한 내용은 Authoring Multi-Project Builds를 참고해주세요.

 

 

 

 

이외에도 다양한 종류의 dependency들이 있는데, 이들에 대한 내용은 Different kinds of dependencies를 확인해주세요.

 

 

 

 

 

 

 

 

 

🔎 Reference

https://docs.gradle.org/current/userguide/declaring_dependencies.html#sec:dependency-types

Declaring dependencies