Spring Boot 入门

简介

Spring Boot 帮助您创建可以独立运行的、基于产品级 Spring 的应用程序。

您可以使用 Spring Boot 创建 Java 应用程序，这些应用程序可以通过使用 java -jar 或更传统的 war 部署启动。

Spring Boot 的主要目标是：

为所有 Spring 开发提供快速开发体验。
提供对大型项目通用的一系列非功能性特性(例如嵌入式服务器、安全、Metrics、健康检查和外部化配置)。
完全不需要代码生成，也不需要XML配置。

系统要求

Spring Boot 2.6.11 需要 Java 8，并且兼容到 Java 18。同时为以下构建工具提供了支持：

构建工具	版本
Maven	3.5+
Gradle	6.8.x, 6.9.x, and 7.x

创建 Spring Boot 项目

在我们开始之前，打开一个终端并运行以下命令，以确保您安装了有效版本的 Java 和 Maven：

$ java -version
java version "1.8.0_161"
Java(TM) SE Runtime Environment (build 1.8.0_161-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.161-b12, mixed mode)

$ mvn -v
Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: D:\apache-maven-3.6.3\bin\..
Java version: 1.8.0_161, vendor: Oracle Corporation, runtime: D:\jdk1.8.0_161\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Spring Boot 兼容 Apache Maven 3.3 或以上版本。如果您还没有安装 Maven，您可以点击此处按照说明操作。

SpringBoot 依赖使用 groupId org.springframe.boot。通常，您的 Maven POM 文件继承自 spring-boot-starter-parent 项目，并声明一个或多个 Starters 依赖。Spring Boot 还提供了一个可选的 Maven 插件来创建可执行 jar 文件。

您也可以通过转到 start.spring.io，快速创建一个 Spring Boot 项目。当然，如果你想对创建一个更干净的 Spring Boot 项目，可以按以下步骤。

创建 POM

我们需要从创建一个 Maven pom.xml 文件开始。该 xml 是用于构建项目的配方。打开你最喜欢的文本编辑器，添加以下内容:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>myproject</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.11</version>
    </parent>
</project>

上面的清单应该为您提供了一个有效的构建。此时，您可以将项目导入 IDEA，它会自动帮您创建项目结构。

或者，您也可以直接使用 IDEA 创建一个 Maven 项目，具体是 File -> New -> Project... -> 在左侧的菜单中选择 Maven -> Next -> 输入 Name，GAV 坐标 -> 点击完成即可。然后在创建的项目中，将根目录下的 pom.xml 修改成上面描述的那样。至此 Spring Boot 项目便创建完成，如果想继续完成官方入门案例，可以继续往下阅读。

添加类路径依赖

Spring Boot 提供了许多 “Starters”，允许您向类路径添加 jar。我们在 POM 的 parent 部分使用了 spring-boot-starter-parent。spring-boot-starter-parent 是一个特殊的启动器，它提供了有用的 Maven 默认值。它还提供了一个依赖管理，以便您可以省略子 POM 中依赖的 version 标记。

其他 “Starter” 提供开发特定类型应用程序时可能需要的依赖项。因为我们正在开发一个 web 应用程序，所以我们添加了一个 spring-boot-starter-web 依赖。在此之前，我们可以通过运行以下命令查看当前的依赖树：

$ mvn dependency:tree
[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT

mvn dependency:tree 命令以树形结构打印项目依赖。您可以看到 spring-boot-starter-parent 本身不提供依赖。要添加必要的依赖，编辑你的 pom.xml，并在 parent 部分下面直接添加 spring-boot-starter-web 依赖项：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

如果您再次运行 mvn dependency:tree，您会看到现在有许多额外的依赖，包括 Tomcat web 服务器和 Spring Boot 本身。

编写代码

此外，我们需要创建一个 Java 文件。默认情况下，Maven 从 src/main/java 编译源代码，如果您没有使用 IDE，您需要手动创建该目录结构，然后添加一个名为 src/main/java/MyApplication.java 的文件，以包含以下代码：

@RestController
@EnableAutoConfiguration
public class MyApplication {

    @RequestMapping("/")
    String home() {
        return "Hello World!";
    }

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

}

虽然这里的代码不多，但是有很多代码要执行。我们将在接下来的几节中逐步介绍重要的部分。

@RestController 和 @RequestMapping 注解

MyApplication 类的第一个注解是 @RestController。这被称为原型注解。它为阅读代码的人和 Spring 提供了提示，提示该类扮演着特定的角色。

@RequestMapping 注解提供了“路由”信息。它告诉 Spring，任何带有 / 路径的 HTTP 请求都应该映射到 home 方法。@RestController 注解告诉 Spring 将结果字符串直接呈现给调用者。

@RestController 和 @RequestMapping 注解是 Spring MVC 注解(它们并不特定于 Spring Boot)。更多细节请参见 Spring 参考文档中的 MVC 部分。

@EnableAutoConfiguration 注解

第二个类级注解是 @EnableAutoConfiguration。这个注解告诉 Spring Boot 根据您添加的 jar 依赖“猜测”您想如何配置 Spring。由于 spring-boot-start-web 添加了 Tomcat 和 Spring MVC，自动配置推断您正在开发一个 web 应用程序并相应地设置 Spring。

“main” 方法

main 方法是 Java 的标准方法，它遵循了 Java 约定的应用程序入口点。main 方法通过调用 run 委托给 Spring Boot 的 SpringApplication 类。SpringApplication 引导应用程序，启动 Spring，而 Spring 又启动自动配置的 Tomcat web 服务器。我们需要将 MyApplication.class 作为参数传递给 run 方法，以告诉 SpringApplication 哪个是 Spring 的主组件。args 数组也被传递，以获取命令行参数。

运行示例

此时，您的应用程序应该可以工作了。因为您使用了 spring-boot-starter-parent POM，所以您有了一个运行目标，可以用来启动应用程序。输入mvn spring-boot:run 从根项目目录启动应用程序。你应该看到类似如下的输出:

$ mvn spring-boot:run

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v2.6.11)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.222 seconds (JVM running for 6.514)

如果你打开浏览器到 localhost:8080，你应该看到以下输出:

Hello World!

要优雅地退出应用程序，请按 ctrl-c。

创建一个可执行 Jar

我们可以创建一个完全自包含的可执行 jar 文件，并在生产中运行它。可执行 jar 是包含已编译类以及代码需要运行的所有 jar 依赖的归档文件。

要创建一个可执行的 jar，我们需要将 spring-boot-maven-plugin 添加到 pom.xml 中。为此，在 dependencies 元素的下方插入以下行:

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

保存您的 pom.xml，并从命令行运行 mvn package，如下所示：

$ mvn package

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building myproject 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] .... ..
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject ---
[INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:2.6.11:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

如果查看 target 目录，应该会看到 myproject-0.0.1-SNAPSHOT.jar。如果你想看里面的内容，你可以使用 jar tvf，如下所示:

$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar

您还应该看到一个名为 myproject-0.0.1-SNAPSHOT.jar 文件。这是 Maven 在被 Spring Boot 重新打包之前创建的原始 jar 文件。

要运行该应用程序，使用 java -jar 命令，如下所示：

$ java -jar target/myproject-0.0.1-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v2.6.11)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.536 seconds (JVM running for 2.864)

posted @ 2022-11-03 08:05 ZnPi 阅读(65) 评论(0) 编辑收藏举报

刷新页面返回顶部

zn-pi