[Gradle] implementation, runtimeOnly, compileOnly 차이점

spring boot 프로젝트에서 DB 세팅을 하다가 아래 gradle 설정에 대해 의문이 생겼다.

implementation 'org.postgresql:postgresql'
runtimeOnly 'org.postgresql:postgresql'

implementation은 자주 쓰는데 runtimeOnly와 compileOnly에 대한 명확한 사용 시점이 궁금해졌다.

 

Classpath

Classpath는 클래스나 jar 파일이 존재하는 위치이다.

크게 complileClasspath, runtimeClasspath로 나누어져 있다.

compileClasspath는 에러없이 컴파일을 하기 위해 필요한 클래스와 jar 파일이 위치한다.

runtimeClasspath는 애플리케이션이 정상적으로 실행되기 위해 필요한 클래스와 jar의 경로이다.

 

implementation

- 직접적으로 의존하는 모듈까지만 리빌드

 

compileOnly

- 컴파일 시점에만 꼭 필요한 라이브러리를 명시

- 컴파일 이후 실행할 때 해당 라이브러리가 필요없을 때 사용

- 빌드 결과물의 사이즈가 줄어드는 장점이 있음

- ex) lombok dependency

 

runtimeOnly

- 실행 시점에만 사용

- 컴파일 시점에는 필요없지만 실행 시점에 꼭 필요한 라이브러리를 명시

- 해당 클래스에서 코드 변경이 필요해도 컴파일을 다시 하지 않아도 됨

- ex) DB나 로그 관련 dependency

 

이론적으로 무슨 의미인지는 대충 알 것 같다.

앞으로 설정 파일에서 의존성 건드릴 때 classpath에 추가되는 것을 유심히 보면서 더 이해해야 할 것 같다.

추가적으로 알게 되는 사실이 있다면 내용을 추후에 추가하겠다.