Gradle中的依赖Dependencies说明与使用总结

简介: Gradle中的依赖Dependencies说明与使用总结

【1】依赖的方式

Gradle 中的依赖分别为直接依赖,项目依赖,本地jar 依赖。

dependencies {
  //①.依赖当前项目下的某个模块[子工程]
  implementation project(':subject01')
  //②.直接依赖本地的某个jar文件
  implementation files('libs/foo.jar', 'libs/bar.jar')
  //②.配置某文件夹作为依赖项
  implementation fileTree(dir: 'libs', include: ['*.jar'])
  //③.直接依赖
  implementation 'org.apache.logging.log4j:log4j:2.17.2'
}

① 直接依赖

在项目中直接导入的依赖,就是直接依赖

implementation 'org.apache.logging.log4j:log4j:2.17.2'

上面是简写法,完整版写法如下:

implementation group: 'org.apache.logging.log4j', name: 'log4j', version: '2.17.2'

group/name/version 共同定位一个远程仓库,version 最好写一个固定的版本号,以防构建出问题。

implementation 类似maven 中的依赖的。对比maven 中的依赖:

<dependencies>
  <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.12</version>
    <scope>compile</scope>
  </dependency>
</dependencies>

② 项目依赖

从项目的某个模块依赖另一个模块。

implementation project(':subject01')

这种依赖方式是直接依赖本工程中的libary module,这个libary module 需要在setting.gradle 中配置。

③ 本地jar 依赖

本地jar 文件依赖,一般包含以下两种方式:

//直接依赖某文件
implementation files('libs/foo.jar', 'libs/bar.jar')
//配置某文件夹作为依赖项
implementation fileTree(dir: 'libs', include: ['*.jar'])

当执行build 命令时,gradle 就会去配置的依赖仓库中下载对应的Jar,并应用到项目。

【2】依赖的类型

类似于Maven 的scope 标签,gradle 也提供了依赖的类型。

类型 说明
compileOnly 由java插件提供,曾短暂的叫provided,后续版本已经改成了compileOnly,适用于编译期需要而不需要打包的情况
runtimeOnly 由java 插件提供,只在运行期有效,编译时不需要,比如mysql 驱动包。,取代老版本中被移除的runtime
implementation 由java 插件提供,针对源码[src/main 目录] ,在编译、运行时都有效,取代老版本中被移除的compile
testCompileOnly 由java 插件提供,用于编译测试的依赖项,运行时不需要
testRuntimeOnly 由java 插件提供,只在测试运行时需要,而不是在测试编译时需要,取代老版本中被移除的testRuntime
testImplementation 由java 插件提供,针对测试代码[src/test 目录] 取代老版本中被移除的testCompile
providedCompile war 插件提供支持,编译、测试阶段代码需要依赖此类jar 包,而运行阶段容器已经提供了相应的支持,所以无需将这些文件打入到war 包中了;例如servlet-api.jar、jsp-api.jar
compile 编译范围依赖在所有的classpath 中可用,同时它们也会被打包。在gradle 7.0 已经移除
runtime runtime 依赖在运行和测试系统的时候需要,在编译的时候不需要,比如mysql 驱动包。在gradle 7.0 已经移除
api java-library 插件提供支持,这些依赖项可以传递性地导出给使用者,用于编译时和运行时。取代老版本中被移除的compile
compileOnlyApi java-library 插件提供支持,在声明模块和使用者在编译时需要的依赖项,但在运行时不需要。

需要说明的是,java 插件提供的功能,java-library 插件都提供。

【3】api 与implementation 区别

api implementation
编译时 能进行依赖传递,底层变,全部都要变、编译速度慢 不能进行依赖传递,底层变不用全部都要变,编译速度快
运行时 运行时加载,所有模块的class都要被加载 运行时加载,所有模块的class都要被加载
应用场景 适用于多模块依赖,避免重复依赖模块 多数场景下使用

对api来讲

编译时:如果libC 的内容发生变化,由于使用的是api 依赖,依赖会传递,所以libC、libA、projectX 都要发生变化,都需要重新编译,速度慢。

运行时:libC、libA、projectX 中的class 都要被加载。


对implementation 来讲


编译时:如果libD 的内容发生变化,由于使用的是implemetation 依赖,依赖不会传递,只有libD、libB 要变化并重新编译,速度快。

运行时:libC、libA、projectX 中的class 都要被加载。


api 的适用场景是多module 依赖。moduleA 工程依赖了module B,同时module B 又需要依赖了module C,modelA 工程也需要去依赖module C,这个时候避免重复依赖module,可以使用module B api 依赖的方式去依赖module C,modelA 工程只需要依赖moduleB 即可。


总之,除非涉及到多模块依赖,为了避免重复依赖,咱们会使用api,其它情况我们优先选择implementation,拥有大量的api 依赖项会显著增加构建时间。


【4】依赖冲突解决

依赖冲突是指"在编译过程中, 如果存在某个依赖的多个版本, 构建系统应该选择哪个进行构建的问题"。


默认下,Gradle 会使用最新版本的jar 包【考虑到新版本的jar 包一般都是向下兼容的】,实际开发中,还是建议使用官方自带的这种解决方案。当然除此之外,Gradle 也为我们提供了一系列的解决依赖冲突的方法: exclude移除一个依赖,不允许依赖传递,强制使用某个版本。


① exclude移除一个依赖

dependencies {
  testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
  testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
  implementation('org.hibernate:hibernate-core:3.6.3.Final'){
  //排除某一个库(slf4j)依赖:如下三种写法都行
  exclude group: 'org.slf4j'
  exclude module: 'slf4j-api'
  exclude group: 'org.slf4j',module: 'slf4j-api'
  }
  //排除之后,使用手动的引入即可。
  implementation 'org.slf4j:slf4j-api:1.4.0'
}


② 不允许依赖传递

dependencies {
  testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
  testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
  implementation('org.hibernate:hibernate-core:3.6.3.Final'){
    //不允许依赖传递,一般不用
    transitive(false)
  }
  //排除之后,使用手动的引入即可
  implementation 'org.slf4j:slf4j-api:1.4.0'
}

在添加依赖项时,如果设置transitive 为false,表示关闭依赖传递。即内部的所有依赖将不会添加到编译和运行时的类路径。

③ 强制使用某个版本

dependencies {
  testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
  testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
  implementation('org.hibernate:hibernate-core:3.6.3.Final')
  //强制使用某个版本!!【官方建议使用这种方式】
  implementation('org.slf4j:slf4j-api:1.4.0!!')
  //这种效果和上面那种一样,强制指定某个版本
  implementation('org.slf4j:slf4j-api:1.4.0'){
    version{
      strictly("1.4.0")
    }
  }
}

我们可以先查看当前项目中到底有哪些依赖冲突:

/下面我们配置,当Gradle 构建遇到依赖冲突时,就立即构建失败
configurations.all() {
  Configuration configuration ->
  //当遇到版本冲突时直接构建失败
  configuration.resolutionStrategy.failOnVersionConflict()
}
目录
相关文章
|
安全 Cloud Native Go
解决Gradle依赖问题:不安全协议的处理策略Could not resolve all dependencies for configuration ‘:detachedConfiguration9
解决Gradle依赖问题:不安全协议的处理策略Could not resolve all dependencies for configuration ‘:detachedConfiguration9
1020 0
|
23天前
|
Java Spring
Gradle 如何确保依赖的版本兼容性
Gradle 通过依赖管理机制确保版本兼容性,使用声明式配置定义项目依赖,自动解析和下载所需库。它支持版本范围和动态版本,通过冲突解决策略选择最佳版本,保证构建的一致性和可靠性。
|
5月前
|
Java 数据库连接 数据库
在Maven或者Gradle构建配置中添加了必要的依赖
在Maven或者Gradle构建配置中添加了必要的依赖
60 1
|
6月前
|
Java 关系型数据库 MySQL
Gradle笔记 六 Gradle 中的Dependencies
Gradle笔记 六 Gradle 中的Dependencies
140 0
|
Java API Maven
Gradle使用总结
Gradle使用总结
251 0
|
Java Maven Android开发
android之gradle配置仓库与引入依赖
android之gradle配置仓库与引入依赖
600 0
gradle依赖冲突的解决方式
gradle依赖冲突的解决方式
125 0
|
Java 数据库连接 API
Gradle依赖管理:编译时和运行时依赖的区别
Gradle依赖管理:编译时和运行时依赖的区别
112 0
|
缓存 Java API
Gradle 构建工具 #5 又冲突了!如何理解依赖冲突与版本决议?
Gradle 作为官方主推的构建系统,目前已经深度应用于 Android 的多个技术体系中,例如组件化开发、产物构建、单元测试等。可见,要成为 Android 高级工程师 Gradle 是必须掌握的知识点。
220 0
Gradle 构建工具 #5 又冲突了!如何理解依赖冲突与版本决议?
|
人工智能 移动开发 Java
Android Studio插件版本与Gradle 版本对应关系
Android Studio插件版本与Gradle 版本对应关系
2342 0
Android Studio插件版本与Gradle 版本对应关系