[gradle] implementation, api 차이

개요

Gradle에서 의존성을 설정할 때는 compileOnly, runtimeOnly, implementation, api 등 여러 가지 옵션을 사용할 수 있다. 특히 api와 implementation은 외부 라이브러리를 프로젝트에 추가할 때 가장 자주 사용하는 두 가지 방법으로, 이 둘은 모두 라이브러리를 추가하는 기능을 제공하지만 각기 다른 방식으로 동작하기 때문에 차이점을 알아두면 좋다.

dependencies {
    api 'org.apache.httpcomponents:httpclient:4.5.7'
    implementation 'org.apache.commons:commons-lang3:3.5'
}

참고로 이전 Gradle 버전에서는 implementation 키워드가 없었고, 대신 compile을 사용하여 라이브러리를 적용했다. 하지만 Gradle 6.x 이후 버전에서는 compile이 deprecated 되었고, 그 자리를 api 키워드가 그 자리를 대체하게 되었다.

 

 

api vs implementation

implementation으로 설정된 의존성은 전이되지 않으며, 해당 모듈 내부에서만 사용된다. 반면 api로 설정된 의존성은 전이되어 다른 모듈의 컴파일 클래스 경로(compileClasspath)에도 추가된다.

• api 의존성은 해당 모듈을 사용하는 다른 모듈에도 노출된다. 예를 들어, 현재 모듈이 httpclient 라이브러리를 사용하고 있다면, 이 모듈을 의존하는 다른 모듈도 자동으로 httpclient 라이브러리를 사용할 수 있게 된다.
• 반면 implementation 의존성은 해당 모듈 내부에서만 사용되며, 다른 모듈에는 노출되지 않는다. 이를 통해 의존성을 캡슐화하여 내부 구현을 외부에 숨기고, 다른 모듈에 영향을 미치지 않도록 할 수 있다.

즉 implementation로 설정된 의존성은 다른 모듈의 컴파일 클래스 경로에 포함되지 않으며, 이로 인해 라이브러리를 제공하는 측(Producer)에서 의존성을 변경하더라도, 사용하는 측(Consumer)은 재컴파일하지 않아도 된다. 이를 통해 컴파일 시간을 단축하고 재빌드 빈도를 줄일 수 있는 이점을 얻을 수 있다.

아래의 네 가지 경우를 통해 조금 더 차이점을 자세히 살펴보자.

 

 

예시

1) ModuleB가 ModuleA를 api로, Module C가 Module B를 api로 의존

• Module B는 Module A를 api로 의존하고 있으므로, Module B에서 Module A의 Hello 클래스를 사용할 수 있다.
• 또한 Module C는 Module B를 api로 의존하고 있기 때문에, Module A에 대한 의존성이 전이되어 Module C에서도 Module A의 Hello 클래스를 사용할 수 있다.

 

2) Module B가 Module A를 api로, Module C가 Module B를 implementation으로 의존

• Module B는 Module A를 api로 의존하고 있으므로, Module B에서 Module A의 Hello 클래스를 사용할 수 있다.
• Module C는 Module B를 implementation으로 의존하고 있지만, Module B가 Module A를 api로 의존하고 있기 때문에 Module C도 Module A의 Hello 클래스를 사용할 수 있다.
• 즉 implementation으로 의존하더라도 api로 연결된 의존성은 전이된다.

 

3) Module B가 Module A를 implementation으로, Module C가 Module B를 api로 의존

• Module B는 Module A를 implementation으로 의존하고 있기 때문에, Module A의 의존성은 Module B 내부에서만 사용된다. 즉, Module B는 Module A의 Hello 클래스를 사용할 수 있지만, 그 의존성은 다른 모듈로 전이되지 않는다.
• Module C는 Module B를 api로 의존하고 있지만, implementation 의존성은 전이되지 않기 때문에 Module A의 Hello 클래스를 사용할 수 없다.

 

4) Module B가 Module A를 implementation으로, Module C가 Module B를 implementation으로 의존

• Module B는 Module A를 implementation으로 의존하므로, Module B에서만 Module A의 Hello 클래스를 사용할 수 있다. 이 의존성은 전이되지 않는다.
• Module C는 Module B를 implementation으로 의존하고 있기 때문에, Module B의 의존성도 전이되지 않아 Module C는 Module A의 Hello 클래스를 사용할 수 없다.

 

참고로 여기서는 모두 Module A에 작성된 Hello 클래스를 다른 모듈에서 사용할 수 있는지 여부를 예시로 들었지만, Module A가 특정 외부 라이브러리를 api나 implementation으로 의존하고 있을 때, Module B와 Module C에서 그 라이브러리를 사용할 수 있는지도 고민해 보면 좋다. 만약 Module A가 httpclient 같은 외부 라이브러리를 implementation으로 의존하고 있을 경우 Module B와 Module C에서는 Module A를 어떤 방식으로 의존하더라도 해당 라이브러리를 사용할 수 없다.

 

 

정리

Gradle은 가능한 한 implementation을 사용하는 것을 권장하는데, api는 의존성이 다른 모듈에 전이되지만 implementation은 해당 모듈 내부에서만 사용되고 다른 모듈에는 노출되지 않기 때문이다. 무분별하게 api를 사용하기보다는 상황에 맞게 implementation을 사용하여 의존성을 캡슐화하고, 이를 통해 컴파일 시간을 단축하여 재빌드 빈도를 줄일 수 있는 이점을 얻는 것이 좋다.

특히 모듈형 모놀리식 구조를 사용하고 있을 때는 이점이 더욱 큰데, 모듈형 모놀리식 구조에서는 여러 모듈이 하나의 큰 애플리케이션을 구성하지만, 각 모듈 간의 독립성이 중요하기 때문이다. implementation을 사용하면 모듈 간의 불필요한 의존성 전이를 막아 각 모듈이 변경될 때 전체 애플리케이션을 재컴파일하는 시간을 줄일 수 있다.