开发入门程序

本文翻译自如下链接的官方文档并且做了适当的节选 https://docs.spring.io/spring-boot/docs/current/reference/html/getting-started.html

1. Spring Boot简介

你可以使用 Spring Boot 创建可用java -jar运行或者更传统的War部署的应用程序。Spring 还提供了一个运行 “Spring 脚本” 的命令行工具。

Spring Boot 的主要目标是:

• 为所有Spring开发提供一个完全更快、更容易获得的入门体验。
• 自以为是的开箱即用，但当需求开始偏离默认值时，要迅速离开。
• 提供大型项目 (如嵌入式服务器、安全性、度量、运行状况检查和外部化配置) 共有的一系列非功能性功能。
• 绝对没有代码生成，也不需要XML配置。

  2. 系统要求

  Spring Boot 2.5.0 需要 Java 8 向上兼容直到Java 16版本。 Spring Framework 5.3.7 或以上也是必需的。
  为以下构建工具提供了显式构建支持:

2.1. Servlet 容器

Spring Boot支持以下嵌入式Servlet容器:

你也可以把Spring Boot应用程序部署在任何与Servlet 3.1+兼容的容器上。

Spring Boot可以与 “经典” Java开发工具一起使用，也可以作为命令行工具安装。无论哪种方式,,你需要 Java SDK v1.8 或更高的版本（我们的选择是 JDK 11）。在你开始之前，应该使用以下命令检查当前的Java安装:

$ java -version

3. 开发你的第一个 Spring Boot应用程序

本节介绍如何开发小型 “Hello World!” Web应用程序，其中重点介绍了Spring Boot的一些关键功能。我们使用Maven来构建这个项目，因为大多数IDE都支持它。

spring.io网站包含许多关于使用Spring Boot的 “入门指南”。如果你需要解决一个特定的问题，先检查一下。

你可以前往start.spring.io 并从依赖项搜索器中选择 “Web” 启动器来减少步骤。这样做会生成一个新的项目结构，以便你可以立即开始用正确的方式编码。更多详情可以去看start.spring.io用户指南。

在开始之前，请打开终端并运行以下命令，以确保你安装了有效版本的Java和Maven:

$ java -version
java version "1.8.0_102"
Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)

$ mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00)
Maven home: /usr/local/Cellar/maven/3.3.9/libexec
Java version: 1.8.0_102, vendor: Oracle Corporation

此示例需要在其自己的目录中创建。后续说明假定你已经创建了一个合适的目录，并且它是你当前的目录。

3.1. 创建POM

我们需要从创建Maven的pom.xml文件开始。pom.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.5.0</version>
    </parent>
    <!-- Additional lines to be added here... -->
</project>

前面的列表应该为你提供一个有效的构建。你可以通过运行mvn package来测试它(目前，你可以忽略 “jar will be empty - no content was marked for inclusion!” 警告)。

此时，你可以将项目导入到IDE中 (大多数现代Java IDE包含对Maven的内置支持)。为简单起见，我们在此示例中继续使用纯文本编辑器。

3.2. 添加类路径依赖项

Spring Boot提供了许多 “启动器（Starters）”，可让你向类路径添加jar。我们的烟雾测试应用程序在POM的parent section使用 spring-boot-starter-parent。parent section使用 spring-boot-starter-parent是提供有用的Maven默认值的特殊启动器。它还提供了一个依赖关系管理部分，以便你可以省略依赖项的版本标签。

其他 “启动器（Starters）”提供你在开发特定类型的应用程序时可能需要的依赖关系。由于我们正在开发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并紧接在父部分添加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本身。

3.3. 编写代码

为了完成我们的应用程序，我们需要创建一个Java文件。默认情况下，Maven编译 src/main/java 目录下的源代码，因此你需要创建该目录结构并且增加一个包含如下代码、名为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);
    }

}

虽然这里没有太多的代码，但是很多事情正在发生。在接下来的几节中，我们将逐步介绍重要部分。

3.3.1 @RestController 喝 @RequestMapping 注解

我们MyApplication类的第一个注解是@RestController。这被称为刻板注解（stereotype annotation）。它为阅读代码的人们提供了提示，并为Spring提供了类发挥特定作用的提示。 在这种情况下，我们的类是一个Web @Controller 控制器，因此Spring在处理传入的Web请求时会考虑它。

@RequestMapping注解提供 “路由” 信息。它告诉Spring任何带有/路径的HTTP请求应映射到home方法。@RestController注解告诉Spring将生成的字符串直接渲染回调用方。

@RestController 和 @RequestMapping 注解是Spring MVC 注解 (他们不仅限于Spring Boot)。查看有关MVC的更多详细信息，请参阅Spring参考文档。

3.3.2 @EnableAutoConfiguration 注解

第2个类级别的注解是@ EnableAutoConfiguration。这个注解告诉Spring Boot根据你添加的jar依赖项 “猜测” 如何配置Spring。因为spring-boot-starter-web添加了Tomcat和Spring MVC，自动配置假定你正在开发web应用程序并相应地设置Spring。

自动配置旨在与 “启动器（Starter）” 配合使用，但这两个概念并不直接相关。你可以自由选择启动程序之外的jar依赖项。Spring Boot仍然会尽最大努力自动配置你的应用程序。

3.3.3 main方法

我们应用程序的最后一部分是main方法。这是遵循应用程序入口点Java约定的标准方法。我们的main方法代表Spring Boot的SpringApplication类被调用运行。SpringApplication启动我们的应用程序，启Spring，然后启动自动配置的Tomcat web服务器。我们并MyApplication.class作为参数传给运行的法，告诉SpringApplication这是主要的Spring组件。这里还传递args数组来传递命令行参数。

3.4 运行例子

此时，你的应用程序应该可以工作。因为你使用了spring-boot-starter-parentPOM，你有一个可用的启动应用程序的运行目标。在项目的根目录输入mvn spring-boot:run命令启动应用程序。你应该看到类似于以下内容的输出:

$ mvn spring-boot:run

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

如果你用浏览器访问localhost:8080，你可以看到下面的输出：

Hello World!

Ctrl-C可以优雅地退出应用程序。

3.5. 创建可执行的Jar文件

我们通过创建一个可以在生产中运行的完全独立的可执行jar文件来完成示例。可执行jar (有时称为 “fat jar”) 是包含已编译类以及代码需要运行的所有jar依赖项的存档。

Java没有提供标准的方式来加载嵌套的jar文件 (jar文件本身包含在jar中)。如果你希望分发独立的应用程序，这可能会出现问题。

为了解决这个问题，许多开发人员使用 “uber” jar。Uber jar将应用程序所有依赖项中的所有类打包到单个存档中。这种方法的问题在于很难看到应用程序中有哪些库。如果在多个jar中使用相同的文件名 (但内容不同)，也可能会出现问题。

Spring Boot使用不同的方法，让你直接嵌套jar。

为了创建可执行jar，我们需要在pom.xml中添加spring-boot-maven-plugin。插入下面的依赖：

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

spring-boot-starter-parent POM包括 配置要绑定目标包。如果不使用父POM，则需要自己声明此配置。详情请见插件文档。

Save your pom.xml and run mvn package from the command line, as follows:
保存你的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.5.0:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

如果你去查看目标目录，应该可以看到myproject-0.0.1-SNAPSHOT.jar文件。文件大小应在10 MB左右。如果你想看里面，可以使用jar tvf命令，如下所示:

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

在目标目录里，你还应该看到一个更小的名为myproject-0.0.1-SNAPSHOT.jar.original的文件。这是Maven在Spring Boot重新打包之前创建的原始jar文件。要运行该应用程序，请使用java -jar命令，如下所示:

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

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

和以前一下，按Ctrl-C键退出应用程序。

4. 接下来要读什么

希望本节提供了一些Spring Boot的基础知识，并帮助你编写自己的应用程序。如果你是面向任务的开发人员，则可能需要跳转到spring.io看一些入门指南，用来解决类似 “我如何使用Spring做到这一点？”之类的问题。官方也有特定于Spring Boot的“如何做”方面的参考文档。