Maven与Gradle依赖项scope
Maven和Gradle对依赖项的scope有所不同。在Maven世界中,一个依赖项有6种scope而gradle的scope 一直在优化调整优化。
maven scope属性
依赖范围控制哪些依赖在哪些classpath 中可用,哪些依赖包含在一个应用中。
-
compile (编译)
compile是默认的范围;如果没有提供一个范围,那该依赖的范围就是编译范围。编译范围依赖在所有的classpath中可用,同时它们也会被打包。 -
provided (已提供)
provided 依赖只有在当JDK 或者一个容器已提供该依赖之后才使用。例如, 如果你开发了一个web 应用,你可能在编译 classpath 中需要可用的Servlet API 来编译一个servlet,但是你不会想要在打包好的WAR 中包含这个Servlet API;这个Servlet API JAR 由你的应用服务器或者servlet 容器提供。已提供范围的依赖在编译classpath (不是运行时)可用。它们不是传递性的,也不会被打包。 -
runtime (运行时)
runtime 依赖在运行和测试系统的时候需要,但在编译的时候不需要。比如,你可能在编译的时候只需要JDBC API JAR,而只有在运行的时候才需要JDBC
驱动实现。 -
test (测试)
test范围依赖 在一般的编译和运行时都不需要,它们只有在测试编译和测试运行阶段可用。 -
system (系统)
system范围依赖与provided类似,但是你必须显式的提供一个对于本地系统中JAR文件的路径。这么做是为了允许基于本地对象编译,而这些对象是系统类库的一部分。这样的构建应该是一直可用的,Maven 也不会在仓库中去寻找它。如果你将一个依赖范围设置成系统范围,你必须同时提供一个systemPath元素。注意该范围是不推荐使用的(建议尽量去从公共或定制的 Maven 仓库中引用依赖) -
import(导入)
import仅支持在中的类型依赖项上。它表示要在指定的POM 部分中用有效的依赖关系列表替换的依赖关系。该scope类型的依赖项实际上不会参与限制依赖项的可传递性。
gradle 依赖管理 scope(gradle 6.6.1)
-
compile(已弃用)
编译时间依赖性。被取代implementation。 -
implementation 延伸 compile
implementation 默认的scope。implementation的作用域会让依赖在编译和运行时均包含在内,但是不会暴露在类库使用者的编译时。举例,如果我们的类库包含了gson,那么其他人使用我们的类库时,编译时不会出现gson的依赖。 -
compileOnly
仅编译时依赖项,在运行时不使用。编译时可见 -
compileClasspath 延伸 compile, compileOnly, implementation
编译类路径,在编译源代码时使用。由任务使用compileJava。 -
annotationProcessor
编译期间使用的注释处理器。 -
runtime(不建议使用)扩展 compile
运行时依赖项。被取代runtimeOnly。 -
runtimeOnly
仅运行时依赖项,运行时可见 -
runtimeClasspath 延伸 runtimeOnly, runtime, implementation
运行时类路径包含实现的元素以及仅运行时元素。 -
testCompile(不建议使用)扩展 compile
编译测试的其他依赖项。被取代testImplementation。 -
testImplementation 延伸 testCompile, implementation
仅实现测试的依赖项。 -
testCompileOnly
其他依赖项仅用于编译测试,在运行时不使用。 -
testCompileClasspath 延伸 testCompile, testCompileOnly, testImplementation
测试编译类路径,在编译测试源时使用。由任务使用compileTestJava。 -
testRuntime(不建议使用)扩展 runtime, testCompile
仅用于运行测试的其他依赖项。被取代testRuntimeOnly。 -
testRuntimeOnly 延伸 runtimeOnly
运行时仅依赖于运行测试。 -
testRuntimeClasspath 延伸 testRuntimeOnly, testRuntime, testImplementation
用于运行测试的运行时类路径。由任务使用test。 -
archives
Artifacts (e.g. jars) produced by this project. Used by task uploadArchives. -
default 延伸 runtimeClasspath
项目依赖于此项目的默认配置。包含此项目在运行时所需的工件和依赖项
下图分别显示了main和test 的依赖项配置。您可以使用此图例解释颜色:
-
灰色文本-已弃用配置。
-
绿色背景-您可以声明对配置的依赖关系。
-
蓝灰色背景-该配置供任务使用,而不供您声明依赖项。
-
浅蓝色背景与等宽线文本— —一个任务。
图一 java插件- main 依赖项配置
图二 Java插件- test依赖项配置