Spring Boot @RequestParam
最后修改于 2023 年 7 月 16 日
在本文中，我们将使用控制器中的 @RequestParam 注解来读取请求参数。
Spring 是一个流行的 Java 应用程序框架，而 Spring Boot 是 Spring 的一个演进，它有助于轻松创建独立的、生产级别的基于 Spring 的应用程序。
Spring @RequestParam
@RequestParam 是一个 Spring 注解，用于将 Web 请求参数绑定到方法参数。
它具有以下可选元素：
- defaultValue - 当未提供请求参数或其值为空时用作后备值
- name - 要绑定的请求参数的名称
- required - 声明该参数是否为必需参数
- value - name 的别名
Spring @RequestParam 示例
以下示例创建一个 Spring Boot Web 应用程序，该应用程序使用 @RequestParam。我们有一个 HTML 表单，其中包含两个标签：文本输入和复选框。这两个标签创建了请求参数，这些参数在控制器中使用 @RequestParam 读取。
build.gradle
...
src
├── main
│ ├── java
│ │ └── com
│ │ └── zetcode
│ │ ├── Application.java
│ │ └── controller
│ │ └── MyController.java
│ └── resources
│ └── static
│ └── index.html
└── test
├── java
└── resources
这是 Spring Boot 应用程序的项目结构。
plugins {
id 'org.springframework.boot' version '3.1.1'
id 'io.spring.dependency-management' version '1.1.0'
id 'java'
}
group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-devtools'
}
在 Gradle 构建文件中，我们有 spring-boot-starter-web，这是一个使用 Spring MVC 构建 Web 应用程序的启动器。它使用 Tomcat 作为默认的嵌入式容器。 spring-boot-devtools 是一个在开发 Spring Boot 应用程序时很有用的工件；它允许自动重启或应用程序的实时重新加载。 应用程序被打包成一个 JAR 文件。
package com.zetcode.controller;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class MyController {
@RequestMapping(path="/message", produces=MediaType.TEXT_PLAIN_VALUE)
@ResponseBody
public String processForm(@RequestParam(defaultValue="Guest") String name,
@RequestParam(required = false) String adult) {
var greet = "on".equals(adult) ? "Good morning" : "Hi";
return String.format("%s %s!", greet, name);
}
}
控制器处理 HTML 表单。 它从请求中读取两个参数。
@Controller
public class MyController {
控制器类使用 @Controller 注解在 Spring 中进行注解。
@RequestMapping(path="/message", produces=MediaType.TEXT_PLAIN_VALUE) @ResponseBody
processForm 方法映射到 /message 路径并返回纯文本。 @ResponseBody 注解表明方法返回值绑定到 Web 响应正文。
public String processForm(@RequestParam(defaultValue="Guest") String name,
@RequestParam(required = false) String adult) {
使用 @RequestParam 注解，我们将请求参数绑定到方法变量。 defaultValue 选项在参数不可用（文本输入留空）时提供默认值。 required 选项声明参数是必需的。 该方法返回一个字符串。
var greet = "on".equals(adult) ? "Good morning" : "Hi";
return String.format("%s %s!", greet, name);
我们构建消息并返回它。
<!DOCTYPE html>
<html lang="en">
<head>
<title>Home page</title>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
</head>
<body>
<form action="message">
<div>
<label>Name:</label>
<input type="text" name="name">
</div>
<div>
<label><input type="checkbox" name="adult">Adult</label>
</div>
<button type="submit">Submit</button>
</form>
</body>
</html>
index.html 文件是主页。 该文件位于 src/main/resources/static 目录中，Spring Boot 在该目录中期望静态资源，例如 HTML 或 CSS 文件。 我们有一个简单的 HTML 表单，其中包含文本输入和复选框标签。
<form action="message">
action 选项包含在控制器方法映射中使用的字符串。
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 注解启用自动配置和组件扫描。
$ ./gradlew bootRun
运行应用程序后，我们可以导航到 localhost:8080。
在本文中，我们使用 Spring Boot 框架创建了 Web 应用程序。 我们已经演示了 @RequestParam 的用法。