使用Gradle全面加速Spring Boot开发

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

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

1、Gradle越来越流行

2012年开始，Spring框架已全部使用Gradle来构建；2020年开始，Spring Boot也全部采用Gradle来构建。官方使用Gradle的主要原因还是“构建项目花费更少的时间”。（可参考：Spring/Spring Boot编译工具从Maven迁移到了Gradle）

但对于我们普通的应用开发者来说，Gradle对于我们的优势在于：更简洁的代码和更丰富的功能。（可参考：Gradle大战Maven，胜负已分？）

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

stackoverflow的趋势报告

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

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

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

2、了解Spring Boot项目的结构

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

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

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

2.1 settings.gradle

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

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 类配置：

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/）：

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

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

2.4 build.gradle

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

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

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

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

3、build.gradle

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

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。

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包的能力，这个我们在下一节会着重的去讲解：

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

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

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

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

id 'java'

3.2 repositories（库）

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

repositories {
    mavenCentral()
}

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

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 我们只需要按照下面的格式即可引入依赖：

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

或简写成：

implementation 'group:name:version'

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

implementation 'group:name'

依赖样子一般为：

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

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

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

测试依赖：testImplementation

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

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

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

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

运行时依赖：runtimeOnly

只在运行时起效的依赖。

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插件提供的。

./gradlew tasks

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

./gradlew help --task bootRun

添加简单的演示代码

@SpringBootApplication
@RestController
public class GradleDemoApplication {

   public static void main(String[] args) {
      SpringApplication.run(GradleDemoApplication.class, args);
   }

   @RequestMapping("/")
   public String hello(){
      return "hello gradle!!!";
   }
}