Spring Boot @Controller
最后修改于 2023 年 7 月 25 日
Spring Boot @Controller 教程展示了如何在 Spring 应用程序中使用 @Controller 注解来构建 Web 控制器。
Spring Boot 是一个流行的应用程序框架，用于使用 Java、Kotlin 或 Groovy 创建企业级应用程序。
Spring MVC
Spring MVC 是基于 Servlet API 构建的原始 Web 框架。它基于流行的 MVC 设计模式构建。 MVC(模型-视图-控制器) 是一种软件架构模式，它将应用程序分为三个区域：模型、视图和控制器。模型表示一个包含数据的 Java 对象。视图表示模型中包含的数据的可视化。控制器控制数据流到模型对象中，并在数据更改时更新视图。它保持视图和模型的独立性。
Spring Framework 5.0 引入了一个并行的响应式栈 Web 框架，名为 Spring WebFlux。
Spring Boot @Controller
@Controller 注解表示被注解的类是一个控制器。它是 @Component 的一个特例，并通过类路径扫描自动检测。它通常与基于 @RequestMapping 注解的注解处理程序方法结合使用。 @RestController 是用于创建 Restful 控制器的便捷注解。
Spring Boot @Controller 示例
在以下应用程序中，我们演示了 @Controller 的用法。 应用程序向客户端返回当前日期和时间。
build.gradle
...
src
├── main
│ ├── java
│ │ └── com
│ │ └── zetcode
│ │ ├── Application.java
│ │ └── controller
│ │ └── MyController.java
│ └── resources
│ ├── static
│ │ └── index.html
│ └── templates
│ └── showMessage.ftlh
└── test
├── java
└── resources
这是 Spring 应用程序的项目结构。
plugins {
id 'org.springframework.boot' version '3.1.1'
id 'io.spring.dependency-management' version '1.1.0'
id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-starter-freemarker'
}
这是 Gradle 构建文件。 org.springframework.boot:spring-boot-starter-web 是一个用于构建 Web 应用程序（包括 RESTful 应用程序）的启动器，使用 Spring MVC。spring-boot-starter-freemarker 是 Freemarker 模板引擎的依赖项。
package com.zetcode.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.HashMap;
@Controller
public class MyController {
@RequestMapping(value = "/getDateAndTime")
public ModelAndView getDateAndTime() {
var now = LocalDateTime.now();
var dtf = DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss");
var date_time = dtf.format(now);
var params = new HashMap<String, Object>();
params.put("date_time", date_time);
return new ModelAndView("showMessage", params);
}
}
这是 MyController。它响应来自客户端的请求。它找出当前日期和时间，并将处理解析为 showMessage.ftlh 模板，向其传递数据。
@Controller
public class MyController {
MyController 使用 @Controller 注解进行注解。
@RequestMapping(value = "/getDateAndTime")
public ModelAndView getDateAndTime() {
getDateAndTime 方法被映射到 getDateAndTime URL 模式；它返回一个 ModelAndView，它是 Web MVC 框架中模型和视图的持有者。
var now = LocalDateTime.now();
var dtf = DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss");
var date_time = dtf.format(now);
我们获取并格式化本地日期和时间。
var params = new HashMap<String, Object>();
params.put("date_time", date_time);
日期和时间字符串被添加到参数的映射中。
return new ModelAndView("showMessage", params);
我们返回 ModelAndView。由于 POM 文件中有 Freemarker 依赖项，Spring 将处理解析为 showMessage.ftlh 模板文件，并向其传递 params 对象。
<!DOCTYPE html>
<html>
<head>
<title>Home page</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<p>
<a href="getDateAndTime">Get date and time</a>
</p>
</body>
</html>
这是主页。它包含一个调用 Spring 控制器的链接。它是一个静态资源，位于预定义的 src/main/resources/static 目录中。
<!DOCTYPE html>
<html>
<head>
<title>Show message</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
Date and time: ${date_time}
</body>
</html>
showMessage.ftlh 是一个 Freemarker 模板文件。它位于预定义的 src/main/resources/templates 目录中。它使用 ${} 语法输出日期和时间。
package com.zetcode;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Application 是设置 Spring Boot 应用程序的入口点。 @SpringBootApplication 注解启用自动配置和组件扫描。在扫描过程中，会查找 @Controller 注解，并从 MyController 类创建一个 Spring Bean。
$ ./gradlew bootRun
运行应用程序后，我们可以导航到 localhost:8080。
在本文中，我们展示了如何在 Spring Boot 应用程序中使用 @Controller 注解。