使用 Spring 创建“Hello, World”网站的过程

时间:2022-12-22 16:00:06

使用 Spring 创建“Hello, World”网站的过程

本指南将引导您完成使用 Spring 创建“Hello, World”网站的过程。

您将构建什么

您将构建一个具有静态主页的应用程序,该应用程序还将接受 HTTP GET 请求: 。​​http://localhost:8080/greeting​

它将使用显示 HTML 的网页进行响应。HTML 的正文将包含一个问候语:“你好,世界!

您可以使用查询字符串中的可选参数自定义问候语。然后,URL 可能是 。​​name​​​​http://localhost:8080/greeting?name=User​

参数值将覆盖默认值 ,并通过内容更改为“您好,用户!​​name​​​​World​

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或以后
  • 格拉德尔 4+​或梅文 3.2+
  • 您也可以将代码直接导入到 IDE 中:
  • 弹簧工具套件 (STS)
  • 智能理念
  • VSCode

如何完成本指南

像大多数春天一样入门指南,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都会得到工作代码。

要从头开始,请继续从 Spring 初始化开始.

要跳过基础知识,请执行以下操作:

  • 下载​并解压缩本指南的源存储库,或使用吉特:git clone https://github.com/spring-guides/gs-serving-web-content.git
  • 光盘成gs-serving-web-content/initial
  • 跳转到创建 Web 控制器.

完成后,您可以根据 中的代码检查结果。​​gs-serving-web-content/complete​

从 Spring 初始化开始

你可以使用这个预初始化项目,然后单击生成以下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目:

  1. 导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项,并为您完成大部分设置。
  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
  3. 单击依赖关系,然后选择Spring WebThymeleafSpring Boot DevTools
  4. 单击生成
  5. Download the resulting ZIP file, which is an archive of a web application that is configured with your choices.

如果您的 IDE 集成了 Spring Initializr,则可以从 IDE 完成此过程。

您也可以从 Github 分叉项目,然后在 IDE 或其他编辑器中打开它。

创建 Web 控制器

在Spring构建网站的方法中,HTTP请求由控制器处理。您可以通过@Controller注解。在下面的示例中,通过返回​​GreetingController​​​​/greeting​​View(在本例中为 )。A 负责呈现 HTML 内容。以下清单(来自 )显示了控制器:​​greeting​​​​View​​​​src/main/java/com/example/servingwebcontent/GreetingController.java​

package com.example.servingwebcontent;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class GreetingController {

@GetMapping("/greeting")
public String greeting(@RequestParam(name="name", required=false, defaultValue="World") String name, Model model) {
model.addAttribute("name", name);
return "greeting";
}

}

这个控制器简洁明了,但还有很多事情要做。我们一步一步地分解它。

注释确保 HTTP GET 请求映射到方法。​​@GetMapping​​​​/greeting​​​​greeting()​

@RequestParam将查询字符串参数的值绑定到方法的参数中。此查询字符串参数不是 。如果请求中不存在,则使用 of。参数的值将添加到​​name​​​​name​​​​greeting()​​​​required​​​​defaultValue​​​​World​​​​name​​Model对象,最终使其可供视图样板访问。

方法主体的实现依赖于视图技术(在本例中,百里香叶) 来执行 HTML 的服务器端呈现。Thymeleaf 分析模板并计算表达式以呈现在控制器中设置的参数的值。以下清单(来自 )显示了模板:​​greeting.html​​​​th:text​​​​${name}​​​​src/main/resources/templates/greeting.html​​​​greeting.html​

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Getting Started: Serving Web Content</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<p th:text="'Hello, ' + ${name} + '!'" />
</body>
</html>

确保类路径上有百里香叶(工件坐标:)。它已经存在于 Github 的“初始”和“完整”示例中。​​org.springframework.boot:spring-boot-starter-thymeleaf​

Spring Boot Devtools

开发 Web 应用程序的一个常见功能是编写更改代码、重新启动应用程序以及刷新浏览器以查看更改。整个过程会占用大量时间。为了加快此刷新周期,Spring Boot 提供了一个方便的模块,称为弹簧引导开发工具.Spring Boot Devtools:

  • 使热插拔.
  • 切换模板引擎以禁用缓存。
  • 启用 LiveReload 以自动刷新浏览器。
  • 其他基于开发而不是生产的合理默认值。

运行应用程序

Spring 初始化器会为您创建一个应用程序类。在这种情况下,你不需要进一步修改 Spring 初始化器提供的类。以下清单(来自 )显示了应用程序类:​​src/main/java/com/example/servingwebcontent/ServingWebContentApplication.java​

package com.example.servingwebcontent;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ServingWebContentApplication {

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

}

​@SpringBootApplication​​是一个方便的注释,它添加了以下所有内容:

  • ​@Configuration​​:将类标记为应用程序上下文的 Bean 定义源。
  • ​@EnableAutoConfiguration​​:告诉 Spring 引导根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如,如果 在类路径上,则此注释会将应用程序标记为 Web 应用程序并激活关键行为,例如设置 .spring-webmvcDispatcherServlet
  • ​@ComponentScan​​:告诉 Spring 在包中查找其他组件、配置和服务,让它找到控制器。com/example

该方法使用 Spring Boot 的方法启动应用程序。您是否注意到没有一行 XML?也没有文件。此 Web 应用程序是 100% 纯 Java,您无需处理配置任何管道或基础结构。​​main()​​​​SpringApplication.run()​​​​web.xml​

构建可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar,可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。

如果使用 Gradle,则可以使用 .或者,您可以使用 JAR 文件生成 JAR 文件,然后运行该文件,如下所示:​​./gradlew bootRun​​​​./gradlew build​

java -jar build/libs/gs-serving-web-content-0.1.0.jar

如果使用 Maven,则可以使用 运行应用程序。或者,您可以使用 JAR 文件生成 JAR 文件,然后运行该文件,如下所示:​​./mvnw spring-boot:run​​​​./mvnw clean package​

java -jar target/gs-serving-web-content-0.1.0.jar

此处描述的步骤将创建一个可运行的 JAR。你也可以构建经典 WAR 文件.

将显示日志记录输出。应用程序应在几秒钟内启动并运行。

测试应用程序

现在网站正在运行,请访问 ,您应该在其中看到“你好,世界!​​http://localhost:8080/greeting​

通过访问提供查询字符串参数。请注意消息如何从“Hello, World!”更改为“Hello, User!”:​​name​​​​http://localhost:8080/greeting?name=User​

此更改表明@RequestParam中的安排按预期工作。该参数的默认值为 ,但可以通过查询字符串显式覆盖它。​​GreetingController​​​​name​​​​World​

添加主页

静态资源,包括 HTML 和 JavaScript 和 CSS,可以通过将它们放在源代码中的正确位置来从 Spring Boot 应用程序中提供。缺省情况下,Spring 引导从类路径中的资源提供静态内容 (或 )。该资源是特殊的,因为如果存在,它将用作“欢迎页面,”)。因此,您需要创建以下文件(您可以在 中找到):​​/static​​​​/public​​​​index.html​​​​"serving-web-content/ which means it is served up as the root resource (that is, at `http://localhost:8080/​​​​src/main/resources/static/index.html​

<!DOCTYPE HTML>
<html>
<head>
<title>Getting Started: Serving Web Content</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<p>Get your greeting <a href="/greeting">here</a></p>
</body>
</html>

重新启动应用程序时,您将在 处看到 HTML。​​http://localhost:8080/​

总结

祝贺!您刚刚使用 Spring 开发了一个网页。