# 使用Gradle全面加速Spring Boot开发

大家都知道Gradle和Maven一样，是一个项目的构建工具。它通过任务来控制开发的进程，这些任务包括：编译、打包、测试、部署和发布等。Gradle诞生于2008年，仅仅比Maven晚4年。Android也采用Gradle作为默认的构建工具。

本文期望通过以下的讲述，帮助你快速轻松的使用Gradle加速您的Spring Boot开发应用。

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188384543/Ms2ZM6K9p.png align="left")

## 1、Gradle越来越流行
2012年开始，Spring框架已全部使用Gradle来构建；2020年开始，Spring Boot也全部采用Gradle来构建。官方使用Gradle的主要原因还是“构建项目花费更少的时间”。（可参考：[Spring/Spring Boot编译工具从Maven迁移到了Gradle](https://www.toutiao.com/article/7100765593200067080/)）

但对于我们普通的应用开发者来说，Gradle对于我们的优势在于：更简洁的代码和更丰富的功能。（可参考：[Gradle大战Maven，胜负已分？](https://www.toutiao.com/article/7099358673314644492/)）

最近的一些统计报告，越来越显示出Gradle有越来越多的人在使用它。

- stackoverflow的趋势报告


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188404513/hQlNzxU0e.png align="left")

- OpenLogic发布的《2022年度开源报告》


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188419790/HvfgepDqp.png align="left")

最近有出了一个振奋人心的消息是，Spring官方生成应用程序的网站：spring initializr（[https://start.spring.io/](https://start.spring.io/)），也将默认的构建工具从Maven切换到了Gradle。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188436287/x5uxRfPoz.png align="left")

综合上述种种，我觉得有必要了解一下快速易用的Gradle了。

## 2、了解Spring Boot项目的结构

- 打开:[https://start.spring.io](https://start.spring.io)，生成演示项目，项目构建工具选中的默认的Gradle。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188510689/owR0vAhsW.png align="left")

- 点击“GENERATE”生成项目压缩包，解压这个压缩包，项目的结构如下：

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188569281/fSM7BgI99.png align="left")

和Gradle有关系的有：settings.gralde 、gradle wrapper[gradle/wrapper 目录、gradlew （gradlew.bat ）]、build.gradle 。下面我们逐一的了解。

### 2.1 settings.gradle

本文件配置构建项目所需要的信息，Spring Boot项目的该文件内容很简单：

```groovy
rootProject.name = 'gradle-demo'
```

### 2.2 gradle wrapper

我们通过使用gradle wrapper脚本，可以直接下载、配置gradle，无需外部安装配置gradle。这样也可以为你的当前程序匹配最合适版本的Gradle版本。

可以直接通过gradle wrapper脚本对程序进行编译、打包、测试、部署和发布等任务操作。

针对Linux/MacOS的gradle wrapper是gradlew ；

针对Windows的gradler wrapper是gradlew.bat 。

### 2.3 如何加速gradle下载

gradle wrapper会自动下载gradle，若默认的下载gradle的url网速很慢，可以替换成阿里云或腾讯云的地址。当然可以是你公司内部的文件下载地址。

我们在
gradle/wrapper/gradle-wrapper.properties 的`distributionUrl` 类配置：

```properties
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
```
若使用阿里云的地址加速（列表页面：
[https://mirrors.aliyun.com/macports/distfiles/gradle/](https://mirrors.aliyun.com/macports/distfiles/gradle/)）：

```properties
distributionUrl=https\://mirrors.aliyun.com/macports/distfiles/gradle/gradle-7.5.1-bin.zip

```
若使用腾讯云地址加速，可在页面：
[https://mirrors.cloud.tencent.com/gradle/](https://mirrors.cloud.tencent.com/gradle/ )查找。

### 2.4 build.gradle

build.gradle 相当于Maven的pom.xml，不过它比Maven要简介很多，如同样的项目，如果用Maven生成的代码对比的话：

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667188763707/CHqotFUn7.png align="left")

xml是一门很清晰但是却很啰嗦的表意语言，在Java生态里使用的越来越少，在Spring Boot的开发中几乎没有任何和xml有关系的内容。由图中的对比也可以看出Gradle比Maven易读性更强且更易维护！

build.gradle的核心内容包括：plugins（插件）、库（repositories）、依赖（dependecies）、任务（tasks）。

因build.gradle是本文核心的内容之一，我们将专门用一个大标题来讲解build.gradle。

## 3、build.gradle

生成的build.gradle的文件内容如下：

```groovy
plugins {
	id 'org.springframework.boot' version '2.7.5'
	id 'io.spring.dependency-management' version '1.0.15.RELEASE'
	id 'java'
}

group = 'top.wisely'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	maven { url 'https://maven.aliyun.com/repository/public/' }
	maven { url 'https://mirrors.cloud.tencent.com/nexus/repository/maven-public/' }
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

tasks.named('test') {
	useJUnitPlatform()
}

```
下面我们对重点内容进行讲解。

### 3.1 plugins（插件）

build.gradle中声明了plugins的依赖。

核心插件只需要使用id简称即可，社区插件需要使用全名称的id。

```groovy
plugins {
	id 'org.springframework.boot' version '2.7.5'
	id 'io.spring.dependency-management' version '1.0.15.RELEASE'
	id 'java'
}
```

社区插件：Spring Boot Gradle插件，它为我们提供Spring Boot运行，创建可执行jar包或者war包的能力，这个我们在下一节会着重的去讲解：

```groovy
id 'org.springframework.boot' version '2.7.5'

```

社区插件：Spring Boot依赖管理插件，它为我们提供对项目直接或间接依赖的库的版本的控制，这些版本都是Spring Boot做过兼容性测试的版本：

```groovy
id 'io.spring.dependency-management' version '1.0.15.RELEASE'
```

核心插件：Java插件将Java编译以及测试等功能添加到项目中。

```groovy
id 'java'
```

### 3.2 repositories（库）

Gradle默认使用Maven的中心库下载依赖包：

```groovy
repositories {
	mavenCentral()
}
```
如果从中心库下载jar包的速度慢，我们可以通过阿里云或者腾讯云的Maven库镜像来加速，当然也可以使用你公司内部的Maven库私服来加速。

```groovy
repositories {
	maven { url 'https://maven.aliyun.com/repository/public/' }
	maven { url 'https://mirrors.cloud.tencent.com/nexus/repository/maven-public/' }
	mavenCentral()
}
```
### 3.3 dependecies（依赖）

- 普通依赖：implementation
我们只需要按照下面的格式即可引入依赖：

```groovy
implementation group: '***', name: '***', version: '***'
```

或简写成：

```groovy
implementation 'group:name:version'
```
因为插件，只要被Spring Boot所管理的依赖，版本也无须维护，可以更加精简的写成：

```groovy
implementation 'group:name'
```

依赖样子一般为：

```groovy
dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	//...
}
```

在我们绝大部分时间，我们和gradle做依赖相关的工作，在了解这些后都能解决了。

我们可以通过：https://mvnrepository.com 网站查找添加依赖，我们在依赖中选中Gradle（short）来复制内容到我们的依赖中。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189139857/RtVFIEHZ1.png align="left")

- 测试依赖：testImplementation

测试相关的依赖，使用testImplementation，规则和普通依赖一致。

```groovy
dependencies {
	//...
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
```

- 编译依赖：compileOnly
只在编译期起效的依赖。

```groovy
dependencies {
	//...
	compileOnly 'org.projectlombok:lombok'
  //...
}
```

- 运行时依赖：runtimeOnly

只在运行时起效的依赖。

```groovy
dependencies {
	//...
	runtimeOnly 'com.mysql:mysql-connector-j'
	//...
}
```

## 4、Spring Boot Gradle Plugin

能够让Spring Boot各种能力运行起来，主要是依靠Spring Boot Gradle插件。Spring Boot Gradle插件中包含了大量的task（任务），我们可以用gradlew来查看他提供的所有tasks（任务）。

- 项目任务列表：通过下面的任务来查询当前项目的任务列表，这些大部分任务都是由Spring Boot Gradle插件提供的。

```shell
./gradlew tasks
```

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189265758/lBqd0aSX2.png align="left")

- 查询具体的任务信息的帮助

```shell
./gradlew help --task bootRun
```

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189295501/09z-5gfiq.png align="left")

- 添加简单的演示代码

```java
@SpringBootApplication
@RestController
public class GradleDemoApplication {

   public static void main(String[] args) {
      SpringApplication.run(GradleDemoApplication.class, args);
   }
   
   @RequestMapping("/")
   public String hello(){
      return "hello gradle!!!";
   }
}
```

- 运行Spring Boot程序的task：bootRun

```shell
./gradlew bootRun
```


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189343305/oG9Khmu_-.png align="left")

访问：http://localhost:8080/

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189359877/kBMeI4dNl.png align="left")

- 编译可执行jar包task：build /bootJar

```shell
./gradlew bootJar
```

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189418618/IO6DP7Kq4.png align="left")

会在build/libs 目录下，生成可执行jar包。

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189434434/uT7pHM8HU.png align="left")

jar包的名字为
gradle-demo-0.0.1-SNAPSHOT.jar，jar包的名字是由上面的settrings.gradle 中设置的名字

- 清理build的任务：clean

```shell
./gradlew clean
```
- 执行测试的任务：test

```shell
./gradlew test
```

## 5、Intellij IDEA和Gradle：如虎添翼
### 5.1 创建Gradle的Spring Boot项目
Intellij IDEA支持新建Spring Initializr的项目，注意选择Gradle作为构建工具。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189557623/VfnNOe94v.png align="left")

### 5.2 可直接打开基于Gradle的Spring Boot项目
可直接在File-》Open选择基于Gradle的Spring Boot项目，导入到Intellij IDEA后，会自动下载相关的依赖。下面是导入项目导入到Intellij IDEA的样子。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189579553/k595Jm5Ia.png align="left")


### 5.3 在Gradle工具窗口执行tasks（任务）
在上图中，我们看见右侧有Gradle的页签，点开可以看见Gradle工具窗口，窗口中有任务列表。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189584249/tVOlRmgSl.png align="left")


在任务列表，我们选择一个任务如bootJar 双击运行：

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189590423/RIeubbYE_.png align="left")


### 5.4 加载build.gradle的变化
- 手动加载：可以点击Gradle工具窗口的刷新按钮或build.gradle文件上的刷新按钮实现手动加载。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189601274/zHA24nAzo.png align="left")

- 自动加载：在设置的Build Tool 中的Reload project after changes in the build scripts 选中Any changes 。

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189618958/9qk8J7fAx.png align="left")

### 5.5 快捷检索、添加依赖
在build.gradle 页面，MacOS下使用command + N ，Windows下使用Alt+Insert。可调出Add depedency。


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189626127/g1SD2QZJH.png align="left")


点击Add depedency后，我们会多一个依赖的检索视图，可以在此检索并添加依赖：


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189635194/N8HoWhf5t.png align="left")


### 5.6 build.gradle脚本自动补全


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189639998/Jn7Hbz9V6.png align="left")

### 5.7 在Gradle工具窗口查看项目的依赖


![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667189650383/glL7MFrZB.png align="left")

## 6、结语
通过本文的讲解，一般情况下可以满足你在项目开发中绝大部分的需求。如果有更深层的使用需求，可留言讨论。

最后送给大家一句话：

"I can’t understand why people are frightened of new ideas. I’m frightened of the old ones." — John Cage
"我不明白为什么人们害怕新想法。 我害怕那些旧的。" - 约翰凯奇。

![image.png](https://cdn.hashnode.com/res/hashnode/image/upload/v1667190757005/6Emy4qike.png align="left")

感谢对我的书《从企业级开发到云原生微服务：Spring Boot实战》的支持。

头条原文地址：[https://www.toutiao.com/article/7155054951813644803/](https://www.toutiao.com/article/7155054951813644803/)

参考资料：

https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/htmlsingle/

https://gustavopeiretti.com/spring-boot-with-gradle-wrapper/

https://tomgregory.com/10-tips-to-use-gradle-with-intellij-idea/