Spring MVC可以接收哪些类型的参数？

嗨，你好啊，我是猿java

作为 Java程序员，Spring MVC是我们日常开发中最常见，用于构建 Web应用的框架。那么，Spring MVC 到底可以接收哪些类型的参数呢？这篇文章我们就来详细的聊一聊。

整体上看，Spring MVC可以接收的数据类型有以下 12种：

1. 基本类型
2. 包装类型
3. 字符串
4. 自定义对象
5. 集合和数组
6. 路径变量
7. 请求头
8. Cookie值
9. 请求体
10. Model 和 ModelMap
11. Session和Servlet API
12. 注解组合

下面我们将一一分析它们。

基本类型

Spring MVC 可以自动将请求参数绑定到控制器方法的基本数据类型上。比如 int、double、boolean 等。

示例：

@GetMapping("/add")
public String add(@RequestParam("a") int a, @RequestParam("b") Integer b) {
    int sum = a + b;
    return "Sum is: " + sum;
}

在这个例子中，add 方法接收两个请求参数 a 和 b，它们都是 int 类型。

包装类型

Spring MVC 可以自动将请求参数绑定到控制器方法的包装类型上。比如 Integer、Double、Boolean 等。

示例：

@GetMapping("/add")
public String add(@RequestParam("a") Integer a, @RequestParam("b") Integer b) {
    int sum = a + b;
    return "Sum is: " + sum;
}

在这个例子中，add 方法接收两个请求参数 a 和 b，它们都是 Integer 类型。

字符串

字符串是最常用的请求参数类型。Spring MVC 可以直接将请求参数绑定到 String 类型的参数上。

示例：

@GetMapping("/greet")
public String greet(@RequestParam("name") String name) {
    return "Hello, " + name;
}

在这个例子中，greet 方法接收一个 name 参数，并返回一个问候语。

自定义对象

Spring MVC 支持将请求参数绑定到自定义对象的字段上。这对于处理复杂的请求数据非常有用。

示例：

public class User {
    private String username;
    private String email;

    // Getters and setters
}

@PostMapping("/register")
public String register(User user) {
    // Use user.getUsername() and user.getEmail()
    return "User registered: " + user.getUsername();
}

在这个例子中，register 方法接收一个 User 对象，Spring MVC 会自动将请求参数 username 和 email 绑定到 User 对象的相应字段上。

集合和数组

Spring MVC 允许将请求参数绑定到集合类型（如 List、Set）或数组上。这在传递多个值时很有用。

示例：

@GetMapping("/numbers")
public String numbers(@RequestParam("num") List<Integer> numbers) {
    int sum = numbers.stream().mapToInt(Integer::intValue).sum();
    return "Sum is: " + sum;
}

在这个例子中，numbers 方法接收一个名为 num 的请求参数列表，并计算这些数字的和。

路径变量

路径变量是 URL 中的一部分，可以用来传递参数。Spring MVC 可以通过 @PathVariable 注解将路径变量绑定到方法参数上。

示例：

@GetMapping("/user/{id}")
public String getUser(@PathVariable("id") Long userId) {
    return "User ID: " + userId;
}

在这个例子中，getUser 方法接收一个路径变量 id，并将其绑定到 userId 参数上。

请求头

请求头包含了客户端请求的一些元数据信息。Spring MVC 可以通过 @RequestHeader 注解将请求头信息绑定到方法参数上。

示例：

@GetMapping("/check")
public String check(@RequestHeader("User-Agent") String userAgent) {
    return "User-Agent: " + userAgent;
}

在这个例子中，check 方法接收 User-Agent 请求头的值。

Cookie值

Spring MVC 可以通过 @CookieValue 注解来获取 cookie 的值。

示例：

@GetMapping("/cookie")
public String cookie(@CookieValue(value = "sessionId", defaultValue = "defaultSessionId") String sessionId) {
    return "Session ID: " + sessionId;
}

在这个例子中，cookie 方法接收名为 sessionId 的 cookie 值。

请求体

对于 POST、PUT 等请求方法，Spring MVC 可以通过 @RequestBody 注解将请求体绑定到方法参数上。通常用于接收 JSON、XML 等格式的数据。

示例：

@PostMapping("/json")
public String json(@RequestBody User user) {
    return "Received user: " + user.getUsername();
}

在这个例子中，json 方法接收 JSON 格式的请求体并将其转换为 User 对象。

Model 和 ModelMap

通过 Model 或 ModelMap 参数，开发人员可以向视图传递数据。

示例：

@GetMapping("/model")
public String model(Model model) {
    model.addAttribute("message", "Hello, World!");
    return "viewName";
}

在这个例子中，model 方法向视图传递了一个名为 message 的属性。

Session 和 Servlet API

Spring MVC 也允许直接访问 HTTP 会话和 Servlet API。例如，可以通过 HttpSession 或 HttpServletRequest 参数访问会话和请求信息。

示例：

@GetMapping("/session")
public String session(HttpSession session) {
    session.setAttribute("attributeName", "attributeValue");
    return "Session attribute set.";
}

在这个例子中，session 方法直接访问 HTTP 会话并设置一个会话属性。

注解组合

Spring MVC 提供了一种强大的功能，允许开发人员创建自定义注解来组合现有的注解，从而简化代码和提高可读性。

示例：

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestParam
public @interface MyRequestParam {
    String value() default "";
}

@GetMapping("/custom")
public String custom(@MyRequestParam("param") String param) {
    return "Custom param: " + param;
}

在这个例子中，我们定义了一个自定义注解 @MyRequestParam，并在 custom 方法中使用。

总结

本文，我们详细地介绍了 Spring MVC可以接收的12种参数类型，了解和掌握它们的差异和适用场景，可以帮助我们选择最合适的方式来处理请求数据，从而更加熟练的使用 Spring MVC。

学习交流

如果你觉得文章有帮助，请帮忙转发给更多的好友，或关注公众号：猿java，持续输出硬核文章。