【Gradle：新一代构建工具】学习笔记 3 Gradle进阶说明 3.12 Gradle中的依赖方式、依赖下载、依赖类型

末蓝、 2024-03-23 15:38 77阅读 0赞

### 【Gradle：新一代构建工具】学习笔记 ###

#### 文章目录 ####

*   *  【Gradle：新一代构建工具】学习笔记
     *   *  3 Gradle进阶说明
         *   *  3.12 Gradle中的依赖方式、依赖下载、依赖类型
             *   *  3.12.1 依赖的方式
                 *  3.12.2 依赖的下载
                 *  3.12.3 依赖的类型

[【【尚硅谷】Gradle教程入门到进阶（从gradle安装到项目实战）】 ][Gradle_gradle_]

![在这里插入图片描述][da4ab6519f3946a1a42690589f216a10.png_pic_center]

#### 3 Gradle进阶说明 ####

##### 3.12 Gradle中的依赖方式、依赖下载、依赖类型 #####

###### 3.12.1 依赖的方式 ######

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

*  本地依赖：依赖本地的某个jar包，具体可通过文件集合、文件数的方式指定
 *  项目依赖：依赖某个project
 *  直接依赖：依赖的类型 依赖的组名:依赖的名称:依赖的版本号

案例如下：

dependencies {
        
        //①.依赖当前项目下的某个模块[子工程]【这里有个注意点，被依赖的模块名一定要出现在settings 文件中】
        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 group: 'org.apache.logging.log4j', name: 'log4j', version: '2.17.2'
    }

![在这里插入图片描述][996642b8a1f043d690ba674b91a2d09d.png_pic_center]

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

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

上面是简写法，完整版写法如下：

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

group/name/version 共同定位一个远程仓库,version 最好写一个固定的版本号，以防构建出问题，implementation 类似 maven 中的依赖的 scope,对比 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'])

###### 3.12.2 依赖的下载 ######

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

###### 3.12.3 依赖的类型 ######

类似于 Maven 的 scope 标签，gradle 也提供了依赖的类型,具体如下所示：

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

官方文档参考：

*  https://docs.gradle.org/current/userguide/java\_library\_plugin.html\#java\_library\_plugin: 各个依赖范围的关系和说明
    
    ![在这里插入图片描述][b5e38b6508d549798f11a02daa354d67.png_pic_center]
 *  https://docs.gradle.org/current/userguide/upgrading\_version\_6.html\#sec:configuration\_removal : 依赖范围升级和移除
    
    ![在这里插入图片描述][d51a5e76f5b741acab85020cfba86466.png_pic_center]
 *  https://docs.gradle.org/current/userguide/java\_library\_plugin.html\#java\_library\_plugin：API 和 implemention 区别
    
    ![在这里插入图片描述][99ef090a80574d8599c4c2591ab83921.png_pic_center]
 *  https://docs.gradle.org/current/userguide/java\_plugin.html\#java\_plugin: 执行 java 命令时都使用了哪些依赖范围的依赖。
    
    ![在这里插入图片描述][28469357a93e435aadcd4acc4f44932b.png_pic_center]

**提示 1：java 插件提供的功能，java-library 插件都提供**

[Gradle_gradle_]: https://www.bilibili.com/video/BV1yT41137Y7
[da4ab6519f3946a1a42690589f216a10.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/5d9900b55cf14f83b07010d7bb18a2cb.png
[996642b8a1f043d690ba674b91a2d09d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/537bb8b2d5da4089900d19fab4f23549.png
[b5e38b6508d549798f11a02daa354d67.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/f1eb1548002e49f3bc589a46b8b614a9.png
[d51a5e76f5b741acab85020cfba86466.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/248f16c980b8416fa27af2acae5b2f55.png
[99ef090a80574d8599c4c2591ab83921.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/b956c9afbf3c4cd4b4adbdf380a0a1c3.png
[28469357a93e435aadcd4acc4f44932b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ebe0b66445fc4908b8c853e79cc63c73.png