spring boot3.x快速入门

下一篇：Spring Boot 3.x gradle脚手架工程build.gradle详解

本教程将基于gradle项目构建工具来快速构建一个spring boot 3.x的最简单的web应用，其中涉及各种构建技巧和细节，希望能帮到初学者~

文章目录

- 先决条件
- - JDK17
  - gradle全局配置
- gradle项目构建工具
- [创建spring boot工程](#创建spring boot工程)
- 熟悉项目结构和构建方式
- - 项目结构
  - 项目的配置
  - [开发Hello API](#开发Hello API)
  - 单元测试
  - 服务启动与测试
  - gradle打包和运行项目

先决条件

JDK17

参考：JDK17安装与配置

gradle全局配置

参考：gradle全局配置

gradle项目构建工具

相比传统项目构建工具maven，gradle提供了更加简洁且高效的配置方式，在大中型spring微服务项目中得到广泛的使用。在搭建spring boot项目时，spring官方提供的初始化器也推荐使用gradle。一起来看下gradle在本地项目构建所充当的角色吧。

创建spring boot工程

新建一个项目，选择spring初始化器来创建：

位置：E:\juan\springboot\code\001_spring_boot项目搭建\demo

这里我们添加了几个基本的依赖项：

Spring Boot DevTools

提供了spring boot服务重启和热加载的开发环境动态更新代码和配置的能力
Lombok

简化了开发中对POJO相关代码生成以及日志框架使用时提供隐式日志对象的能力
Spring Configuration Processor

提供了根据@ConfigurationProperties注解生成配置元数据的能力，比如在我们使用.yml配置文件以及做一些自定义配置时，这个依赖项是必须的。
Spring Web

用于spring mvc的开发

点创建，项目构建时，如果wrapper方式管理的Gradle软件下载很慢，或者连不上，出现下面情况：

可以修改下，gradle-wrapper.properties

properties 复制代码

#distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
distributionUrl=https\://mirrors.cloud.tencent.com/gradle/gradle-8.7-bin.zip

改完后，刷新下gradle。

项目构建成功！

熟悉项目结构和构建方式

项目结构

项目的配置

软件环境的配置由idea集成开发环境以及gradle的wrapper管家帮我们自动完成了。可以看下完成了哪些设置：

全局使用的jdk
gradle软件设置
Java编译器

开发Hello API

java 复制代码

package com.juan.demo;

import ...

// 为简化api开发，索性在启动类上启用rest控制器
@RestController
...
public class DemoApplication {

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

    ...

}

单元测试

java 复制代码

package com.juan.demo;

import ...

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
// 启用mockMvc自动配置
@AutoConfigureMockMvc
class DemoApplicationTests {

    ...

    @SneakyThrows
    @Test
    void hello(@Autowired MockMvc mvc) {
        mvc.perform(get("/hello")).andExpect(status().isOk()).andExpect(content().string("hello boot3!"));
    }

}

build.gradle中调整依赖

groovy 复制代码

configurations {
    ...
    // 实现依赖范围配置的局部扩展    
    testCompileOnly {
        extendsFrom testAnnotationProcessor
    }
}

...

dependencies {
    ...
    annotationProcessor 'org.projectlombok:lombok'
    // 为单元测试环境引入和启用lombok编译功能
    testAnnotationProcessor 'org.projectlombok:lombok'
    ...
}

修改好后，在当前编辑的build.gradle文件右上角会显式一个gradle的小象图标，点击以刷新gradle设置

服务启动与测试

idea会智能的识别项目的启用类，并添加spring boot快捷启动项，当然我们也可以在该界面中点Modify options来设置更多的可选项，比如添加jvm启用的参数等等。

启动本地web服务

用idea提供的http client测试工具进行rest api的测试：

执行单元测试，可以先调整下编译和测试环境由gradle任务构建方式，改为IntelliJ Idea构建方式：

同时，开启注解处理器功能：

运行单元测试：

gradle打包和运行项目

通过命令方式来构建：

shell 复制代码

./gradlew clean build -x test

或者使用gradle插件提供的命令行：

或者直接双击执行构建目标任务：

运行项目的方式

创建jar-application的启动项

启动jar-application服务，并用http client工具测试hello api。

还可以使用gradle的JavaExec基础任务，编写一个runBootJar

build.gradle

groovy 复制代码

tasks.register('runBootJar', JavaExec) {
    classpath = files('build/libs/demo-0.0.1-SNAPSHOT.jar')
}