Maven范围和Gradle配置知多少?

简介:
Java构建工具的关键功能之一是依赖关系管理,我们要在自己的项目中使用某个第三方库,并且构建工具将负责在构建生命周期中的正确时间下载它并将其添加到类路径中。
Maven作为构建工具已经存在了很长时间,它稳定并且在Java社区中仍然很受欢迎。
Gradle在很早以前就已经成为Maven的替代品,它严重依赖于Maven依赖项基础结构,但是提供了一种更加灵活的声明依赖项的方法。

什么是范围/配置?

Maven pom.xml文件或Gradle build.gradle文件指定从我们的源代码创建软件工件的必要步骤。例如,此工件可以是JAR文件或WAR文件。

在大多数不平凡的项目中,我们都依赖第三方库和框架。因此,构建工具的另一任务是管理对这些第三方库和框架的依赖关系。

假设我们要在代码中使用SLF4J日志记录库。在Maven pom.xml文件中,我们将声明以下依赖关系:

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.26</version>
    <scope>compile</scope>
</dependency>

在Gradle build.gradle文件中,相同的依赖性如下所示:

implementation 'org.slf4j:slf4j-api:1.7.26'

Maven和Gradle都允许定义不同的依赖组。这些依赖项组在Maven中称为“范围”,在Gradle中称为“配置”。

这些依赖项组中的每一个都有不同的特征,并以不同的方式回答以下问题:

  • 在构建生命周期的哪些步骤中将提供依赖关系?可以在编译时使用吗?在运行时?在测试的编译和运行时?

  • 依赖关系是可传递的吗?它会暴露给我们自己项目的消费者,以便他们也可以使用它吗?如果是这样,它**
    将泄漏到使用者的编译时间和/或使用者的运行时中吗?

  • 最终构建工件中是否包括依赖项?我们自己项目的WAR或JAR文件是否包括依赖项的JAR文件?

在上面的示例中,我们将SLF4J依赖项添加到了Maven compile范围和Gradle implementation配置中,这可以分别视为Maven和Gradle的默认值。

让我们看一下所有这些作用域和配置的语义。

Maven范围

Maven 为Java项目提供了6个作用域。

但是,我们将不讨论system和import范围,因为它们比较奇特。

compile

该compile范围是默认范围,当我们对声明某个依赖项没有特殊要求时,可以使用它。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 编译时间
  • 运行
    是 是 是
  • 测试编译时间
  • 测试运行时
    注意,compile作用域会泄漏到编译时,从而加剧依赖污染。

provided

我们可以使用provided作用域声明一个最终构建工件中将不包括的依赖项。

例如,如果我们依赖项目中的Servlet API,并且将其部署到已经提供Servlet API的应用程序服务器上,则可以将依赖项添加到provided作用域中。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 编译时间
  • 运行 (没有 没有 没有)
  • 测试编译时间
  • 测试运行时

runtime

我们将runtime范围用于在编译时不需要的依赖项,例如,当我们针对某个API 进行编译时,只需要在运行时实现该API。

一个示例是SLF4J,我们slf4j-api将其包含在compile范围内,并将该API的实现(如slf4j-log4j12或logback-classic)包含到runtime范围内。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 运行 (没有 是 是)
  • 测试运行时

test

我们可以将test作用域用于仅在测试中需要且在生产代码中不可用的依赖项。

此范围的依赖项示例是测试框架,例如JUnit,Mockito或AssertJ。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 测试编译时间 (没有 没有 没有)
  • 测试运行时

Gradle配置

Gradle具有更多样化的配置集,这是Gradle变得更年轻,更积极开发的结果,因此能够适应更多的用例。

让我们看一下Gradle的Java库插件的标准配置。请注意,我们必须在构建脚本中声明插件才能访问配置:

plugins {
    id 'java-library'
}
implementation

该implementation配置应视为默认配置。我们使用它来声明我们不想暴露给使用者的编译时的依赖项。

引入此配置是为了取代不推荐使用的compile配置,以避免使用我们实际上不想公开的依赖项来污染使用者的编译时间。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

编译时间
运行 没有 是 是
测试编译时间
测试运行时
api
我们使用api配置来声明依赖关系,这些依赖关系是我们API的一部分,即对于我们明确希望暴露给使用者的依赖关系。

这是唯一将依赖项暴露给使用者的编译时的标准配置。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 编译时间
  • 运行 (是 是 是)
  • 测试编译时间
  • 测试运行时

compileOnly

通过compileOnly配置,我们可以声明仅在编译时可用的依赖项,而在运行时则不需要。

这种配置的一个示例用例是像Lombok这样的注释处理器,它在编译时修改字节码。编译后不再需要它,因此依赖项在运行时不可用。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 编译时间 (没有 没有 没有)

runtimeOnly

该runtimeOnly配置使我们可以声明在编译时不需要的依赖关系,但将在运行时可用,类似于Maven的runtime范围。

另一个例子是SLF4J,我们slf4j-api在implementation配置中包括该API以及该配置的实现(例如slf4j-log4j12或logback-classic)runtimeOnly。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 运行 (没有 是 是)

testImplementation

与相似implementation,但是声明的依赖项testImplementation 仅在测试的编译和运行期间可用。

我们可以使用它来声明对测试框架(如JUnit或Mockito)的依赖关系,这些依赖关系仅在测试中需要,而在生产代码中不可用。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 测试编译时间 (没有 没有 没有)
  • 测试运行时

testCompileOnly

类似compileOnly,但声明的依赖testCompileOnly是测试编译时可用,而不是在运行时。

我想不出一个具体的例子,但是可能有一些类似于Lombok的注释处理器仅与测试有关。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 测试编译时间 (没有 没有 没有)

testRuntimeOnly

类似runtimeOnly,但声明的依赖testRuntimeOnly是测试运行期间只提供,而不是在编译时。

一个示例是声明对JUnit Jupiter Engine的依赖关系,该引擎运行我们的单元测试,但我们不对其进行编译。

有空的时候? 泄漏到消费者的编译时间? 泄漏到消费者的运行时? 包含在工件中吗?

  • 测试运行时 (没有 没有 没有)

结合Gradle配置

由于Gradle的配置非常具体,因此有时我们可能希望结合其功能。在这种情况下,我们可以使用多个配置声明一个依赖项。例如,如果我们希望compileOnly在测试编译时也可以使用依赖项,则可以在testCompileOnly配置中另外声明它:

dependencies {
  compileOnly 'org.projectlombok:lombok:1.18.8'
  testCompileOnly 'org.projectlombok:lombok:1.18.8'
}

要删除重复的声明,我们还可以告诉Gradle我们希望testCompileOnly配置包括配置中的所有内容compileOnly:

configurations {
  testCompileOnly.extendsFrom compileOnly
}

dependencies {
  compileOnly 'org.projectlombok:lombok:1.18.8'
}

但是,请注意执行此操作,因为每次以这种方式组合两个配置时,在声明依赖项时都会失去灵活性。

Maven Scope与Gradle配置

Maven范围不能完全转换为Gradle配置,因为Gradle配置更精细。但是,这是一张在Maven范围和Gradle配置之间进行转换的表格,其中有一些有关差异的说明:

Maven范围等效摇篮配置compileapi如果依赖关系应该暴露给消费者,implementation如果不是providedcompileOnly(请注意,providedMaven范围在运行时也可用,而compileOnlyGradle配置不可用)runtimeruntimeOnlytesttestImplementation

结论

作为较年轻的构建工具,Gradle在声明依赖项时提供了更大的灵活性。我们可以更好地控制依赖项是否在测试中,运行时或编译时可用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,612评论 5 471
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,345评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,625评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,022评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,974评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,227评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,688评论 3 392
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,358评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,490评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,402评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,446评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,126评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,721评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,802评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,013评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,504评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,080评论 2 341

推荐阅读更多精彩内容