Gradle 总结

太过爱你忘了你带给我的痛 2021-09-30 05:50 337阅读 0赞

# Gradle #

`Gradle`是基于*groovy*，可切换的，像*Maven*一样基于约定优于配置的构建框架，构建脚本默认为`build.gradle`。  
  
  
Gradle出现之前Java的三个构建工具：`Ant`、`Gant`和`Maven`;

*  1.`Ant`是由Java编写的构建工具，它的核心代码是由Java编写的，与平台无关，构建脚本默认为`bulid.xml`;
 *  2.`Gant`是一个基于Ant的构建工具，它在Ant的基础上用Groovy写的DSL，构建脚本默认为`build.gant;`
 *  3.`Maven`继承了Ant的项目构建功能，具有依赖管理和项目管理的功能，提供了中央仓库，构建脚本默认为`pom.xml`;

> *本文基于Gradle **5.5** 版本*

## 1 基本概念 ##

### 1.1设计理念 ###

*  1.在项目中添加新任务
 *  2.为新加入的任务提供默认配置，这个默认配置会在项目中注入新的约定（如源文件位置）。
 *  3.加入新的属性，可以覆盖插件的默认配置属性。
 *  4.为项目加入新的依赖。

### 1.2 基本概念 ###

Gradle中的两个重要概念：`项目`和`任务`。

*  1.`项目`是指我们的构建产物（比如Jar包）或实施产物（将应用程序部署到生产环境）一个项目包含一个或多个任务。
 *  2.`任务`是指不可分的最小工作单元，执行构建工作（比如编译项目或执行测试）。

在项目目录中的`build.gradle`指定了`一个项目`和它的许多子`任务`。

### 2 仓库 ###

Gradle完全支持用于发布或检索依赖的`Maven`和`Ivy`仓库。  
Gradle也会将依赖缓冲在本地中，方便在无网的环境使用，`Linux/MacOS`下缓存路径为: `~/.gradle`。  
![在这里插入图片描述][2019072615375968.png]

> *参考：[https://docs.gradle.org/current/userguide/declaring\_dependencies.html][https_docs.gradle.org_current_userguide_declaring_dependencies.html]*

#### 2.1 加入Maven仓库 ####

Gradle提供了三种`“别名”`供我们使用，它们分别是：

*  1.mavenCentral()别名，表示依赖是从Central Maven 2 仓库中获取的。
 *  2.jcenter()别名，表示依赖是从Bintary’s JCenter Maven 仓库中获取的。
 *  3.mavenLocal()别名，表示依赖是从本地的Maven仓库中获取的。

也可自定义仓库路径：

*  4.自定义仓库地址的maven仓库，表示依赖是指定`URL`的Maven仓库中获取的。

repositories { 
        mavenCentral()
        jcenter()
        maven { 
            url 'http://maven.aliyun.com/nexus/content/groups/public/'
        }
    }

> *注：*  
> *`mavenCentral()`访问的地址为：`https://repo1.maven.org/maven2`*  
> *由于国内网络的问题这个地址经常`无法使用`，解决办法是把`https`换成`http`：*  
> *`maven { url 'http://repo1.maven.org/maven2' }`*

### 3 Task ###

每个项目都由不同的任务组成；  
任务是`真正`做事情的角色，构建过程中的真正`执行者`；

Task做的事情：

*  编译类
 *  将类文件存储到指定的文件夹中
 *  创建JAR
 *  生成Javadoc或将一些归档发布到存储库
 *  等

Task执行顺序：

*  1.任务可能会存在依赖关系
 *  2.用dependsOn让Task有顺序的运行起来

### 4 插件 ###

`插件`是一堆Task的集合，用于实现自动化;  
所有有用的功能，都是通过插件进行添加的；  
以`编译`Java代码为例，Gradle内置了`Java插件`(它是许多其他Gradle插件的基础)。

`Java插件`将`Java编译`以及`测试`和`捆绑`任务添加到项目中，使用Java插件需在build.gradle中加入插件ID：

plugins { 
       id 'java'
    }

导入了Java插件后，会生成一系列的默认的配置值，并且会导入已编排好的的Task：

compileJava(type: JavaCompile)		//Java 编译
    processResources(type: Copy)		//拷贝 Resources 资源
    classes(type: Task)			//组装 Java 类
    compileTestJava(type: JavaCompile)	//Java Test 编译
    processTestResources(type: Copy)	//拷贝 Test Resources 资源
    testClasses(type: Task)			//组装 Test 类
    jar(type: Jar)				//合成Jar包
    javadoc(type: Javadoc)			//生成 doc 文档
    test(type: Test)			//运行测试
    uploadArchives(type: Upload)		//上传 jar 到仓库
    clean(type: Delete)			//clean

### 5 依赖配置 ###

#### 5.1 依赖配置项 ####

<table> 
 <thead> 
  <tr> 
   <th>配置名称</th> 
   <th>角色</th> 
   <th>可消耗</th> 
   <th>可分解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>api</td> 
   <td>声明API依赖项</td> 
   <td>没有</td> 
   <td>没有</td> 
   <td>声明可传递给消费者的依赖项，以便进行编译。</td> 
  </tr> 
  <tr> 
   <td>implementation</td> 
   <td>声明实现依赖性</td> 
   <td>没有</td> 
   <td>没有</td> 
   <td>声明纯粹内部的依赖关系，而不是要向消费者公开。</td> 
  </tr> 
  <tr> 
   <td>compileOnly</td> 
   <td>声明仅编译依赖项</td> 
   <td>是</td> 
   <td>是</td> 
   <td>声明仅在编译时需要的依赖项，但不应泄漏到运行时，这通常包括在运行时找到时被着色的依赖项。</td> 
  </tr> 
  <tr> 
   <td>runtimeOnly</td> 
   <td>声明运行时依赖项</td> 
   <td>没有</td> 
   <td>没有</td> 
   <td>声明仅在运行时需要的依赖项，而不是在编译时。</td> 
  </tr> 
  <tr> 
   <td>testImplementation</td> 
   <td>测试依赖关系</td> 
   <td>没有</td> 
   <td>没有</td> 
   <td>声明用于编译测试的依赖项的地方。</td> 
  </tr> 
  <tr> 
   <td>testCompileOnly</td> 
   <td>声明测试只编译依赖项</td> 
   <td>是</td> 
   <td>是</td> 
   <td>声明仅在测试编译时需要的依赖项，但不应泄漏到运行时。这通常包括在运行时找到时被着色的依赖项。</td> 
  </tr> 
  <tr> 
   <td>testRuntimeOnly</td> 
   <td>声明测试运行时依赖项</td> 
   <td>没有</td> 
   <td>没有</td> 
   <td>声明仅在测试运行时需要的依赖项，而不是在测试编译时。</td> 
  </tr> 
 </tbody> 
</table>

**依赖之间的关系**：  
![在这里插入图片描述][20190726175228908.png]**Test部分**：  
![在这里插入图片描述][20190727082618531.png]

> 绿色配置是用户用来声明依赖关系的配置  
> 粉色的配置是组件编译或运行库时使用的配置  
> 蓝色配置是组件内部的，供自己使用  
> 在配置白色的配置从Java插件继承

常用的如下：

*  1.compileOnly 编译时依赖
 *  2.runtimeOnly 运行时依赖
 *  3.api 可传递依赖
 *  4.implementation 非传递依赖
 *  5.testCompile 测试编译时依赖
 *  6.testRuntime 测试运行时依赖

注： compile， testCompile，runtime ， testRuntime 已经被废弃，要尽量避免使用。

> *参考：[https://docs.gradle.org/current/userguide/java\_library\_plugin.html\#sec:java\_library\_separation][https_docs.gradle.org_current_userguide_java_library_plugin.html_sec_java_library_separation]*

#### 5.2 依赖配置项属性 ####

*  1.group属性指定依赖的分组（在Maven中，就是groupId）
 *  2.name属性指定依赖的名称（在Maven中，就是artifactId）
 *  3.version属性指定外部依赖的版本（在Maven中，就是version）

dependencies { 
       implementation group: 'foo', name: 'foo', version: '0.1'
    }
    //也可以合并到一起去
    dependencies { 
       implementation 'foo:foo:0.1'
    }

#### 5.3 本地依赖 ####

本地依赖:

dependencies { 
           implementation files('libs/commons-lang.jar', 'libs/log4j.jar')
        }

#### 5.4 排除依赖 ####

排除依赖:

compile('com.example.m:m:1.0') { 
       exclude group: 'org.unwanted', module: 'x
       }

#### 5.5 中央仓库以外的文件依赖 ####

添加来自 ant、libs 和 tools 目录的文件依赖：

configurations { 
        antContrib 
        externalLibs
        deploymentTools
    }
    
    dependencies { 
        antContrib files('ant/antcontrib.jar')
        externalLibs files('libs/commons-lang.jar', 'libs/log4j.jar')
        deploymentTools(fileTree('tools') {  include '*.exe' })
    }

#### 5.6 项目间依赖 ####

对于比较复杂的项目，会有模块(项目)间的依赖：

project(':student-service') { 
        dependencies { 
            implementation project(':utils')
            implementation project(':api')
        }
    }

### 6 Gradle Wrapper ###

Gradle Wrapper是对Gradle 的包装，它的作用是简化Gradle本身的下载、安装和构建，比如它会在我们没有安装Gradle的情况下，去下载指定版本的Gradle并进行构建。  
Gradle的版本很多，所以有可能出现版本兼容的问题，这时就需要Gradle Wrapper去统一Gradle的版本，避免开发团队因为Gradle版本不一致而产生问题。  
步骤：

*  1.解析参数传入 gradlew
 *  2.安装正确的 Gradle 版本
 *  3.调用 Gradle 执行命令

### 7 完整配置 ###

我练习项目的Gradle完整配置：

plugins {
        id 'org.springframework.boot' version '2.1.5.RELEASE'
        id 'groovy'
    }
    
    apply plugin: 'io.spring.dependency-management'
    
    group = 'com.wxx.modules'
    version = '0.0.1-SNAPSHOT'
    sourceCompatibility = '1.8'
    
    repositories {
        maven {
            url 'http://repo1.maven.org/maven2'
        }
    }
    
    
    dependencies {
        //非传递依赖
        implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
        implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
        implementation 'org.springframework.boot:spring-boot-starter-data-mongodb-reactive'
        implementation 'org.springframework.boot:spring-boot-starter-data-redis-reactive'
    
        implementation 'org.springframework.boot:spring-boot-starter-webflux'
        implementation 'org.springframework.boot:spring-boot-starter-reactor-netty'
        implementation 'org.springframework.boot:spring-boot-starter-webflux'
        implementation 'org.springframework.boot:spring-boot-starter-validation'
        implementation 'org.springframework.boot:spring-boot-starter-aop'
    
        implementation 'com.google.guava:guava:27.0.1-jre'
        implementation 'org.apache.commons:commons-lang3:3.8.1'
        implementation 'org.apache.commons:commons-text:1.6'
        implementation 'org.apache.cxf:cxf-rt-transports-http-hc:3.2.0'
        implementation 'org.apache.cxf:cxf-rt-frontend-jaxws:3.2.0'
        implementation 'com.sun.xml.bind:jaxb-core:2.2.11'
        implementation 'com.sun.xml.bind:jaxb-impl:2.2.11'
    
        implementation 'commons-lang:commons-lang:2.6'
        implementation 'commons-collections:commons-collections:3.2.2'
        implementation 'org.apache.commons:commons-collections4:4.3'
        implementation 'joda-time:joda-time:2.10.1'
        implementation 'com.graphql-java:java-dataloader:2.2.1'
        implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.0.1'
        implementation group: 'com.alibaba', name: 'druid', version: '1.1.17'
        implementation group: 'mysql', name: 'mysql-connector-java', version: '8.0.15'
        implementation group: 'com.microsoft.sqlserver', name: 'mssql-jdbc', version: '6.1.0.jre7'
        implementation group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.4'
    
        //测试时编译
        testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.4'
    
        //编译时依赖
        compileOnly 'org.projectlombok:lombok'
    
        //测试时依赖
        testImplementation 'org.springframework.boot:spring-boot-starter-test'
        testImplementation "org.spockframework:spock-core:1.2-groovy-2.4"
        testImplementation 'org.mockito:mockito-core:2.24.5'
        testImplementation 'io.projectreactor:reactor-test:3.2.6.RELEASE'
    }

*参考资料：*

> \[ 1 \].[https://docs.gradle.org/current/userguide/userguide.html][https_docs.gradle.org_current_userguide_userguide.html]  
> \[ 2 \].[https://docs.gradle.org/current/userguide/declaring\_dependencies.html][https_docs.gradle.org_current_userguide_declaring_dependencies.html]  
> \[ 3 \].[https://gradle.org/guides/][https_gradle.org_guides]  
> \[ 4 \].[https://docs.gradle.org/current/userguide/java\_library\_plugin.html\#sec:java\_library\_separation][https_docs.gradle.org_current_userguide_java_library_plugin.html_sec_java_library_separation]

[2019072615375968.png]: /images/20210911/2e537d6118314ec7b2ee554f16e14d84.png
[https_docs.gradle.org_current_userguide_declaring_dependencies.html]: https://docs.gradle.org/current/userguide/declaring_dependencies.html
[20190726175228908.png]: /images/20210911/b671f76a1f53419d9b758f59fad7108b.png?
[20190727082618531.png]: /images/20210911/a21cad7ea9d54ff28068d53066e02ff0.png
[https_docs.gradle.org_current_userguide_java_library_plugin.html_sec_java_library_separation]: https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_separation
[https_docs.gradle.org_current_userguide_userguide.html]: https://docs.gradle.org/current/userguide/userguide.html
[https_gradle.org_guides]: https://gradle.org/guides/