Spring MVC 入门：从项目创建到参数接收

学习路径

学习 Spring MVC，重点就三个：建立连接、获取请求参数、返回响应。下面通过一个 Spring Boot 项目来演示。

创建项目时记得选择 Spring Web 依赖。

建立连接

@RequestMapping 注解负责路由映射，把浏览器 URL 和控制器方法关联起来。最简单的例子：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class BasicController {
    @RequestMapping("/hello")
    @ResponseBody
    public String hello() {
        return "Hello World";
    }
}

访问 http://127.0.0.1:8080/hello，页面上显示 "Hello World"。

基本流程如下：

@RequestMapping 也可以放在类上，作为路径前缀：

@RequestMapping("/basic")
@Controller
public class BasicController {
    @RequestMapping("/hello")
    @ResponseBody
    public String hello() { ... }
}

此时访问地址变为 http://127.0.0.1:8080/basic/hello。

如果没加类前缀，直接访问原路径会 404。

加上类路径后的成功页面：

用 Postman 测试，默认的 @RequestMapping 支持所有请求方法。如果想限定为 GET，可以指定 method 属性：

@RequestMapping(value = "/hello", method = RequestMethod.GET)

处理请求参数

不传参数

若方法参数是 String 类型，不传则默认 null；如果是 int 这种基本类型，不传会直接报错，因为基本类型不能为 null。

@ResponseBody
@RequestMapping("/hello")
public String hello(String name) {
    return "接受到的参数是：" + name;
}

访问 /basic/hello 不传参，name 为 null。

若参数改为 int age，访问 /basic/hello 会报 500。

解决办法：使用包装类型 Integer，或者用 @RequestParam 设置默认值。

// 方案一：包装类型
public String hello(Integer age) { ... }

// 方案二：默认值
public String hello(@RequestParam(value = "age", defaultValue = "0") int age) { ... }

单个参数

直接用方法参数接收同名 query 参数即可。

@ResponseBody
@RequestMapping("/hello")
public String hello(String name) {
    return "接受到的参数是：" + name;
}

访问 /basic/hello?name=zhangsan，正常返回。

原理：Spring MVC 会自动把请求参数与同名方法参数绑定。

多个参数

方法声明多个参数，Spring 按名称匹配，顺序无所谓。

@RequestMapping("/hello")
@ResponseBody
public String hello(String name, Integer age) {
    return "接受的 name：" + name + "，接受的 age：" + age;
}

分别测试缺参、乱序，都没问题。

对象参数

如果参数是一个自定义对象，Spring 会自动把同名参数注入对象的属性。

public class User {
    private String name;
    private Integer age;
    // getters & setters & toString
}

@RequestMapping("/save_user")
@ResponseBody
public String saveUser(User u) {
    return u.toString();
}

访问 /basic/save_user?name=lisi&age=20，返回 User{name='lisi', age=20}。

数组参数

同一个参数名传多个值，Spring 会自动封装成数组。

@RequestMapping("/hello")
@ResponseBody
public String hello(String[] arrayName) {
    return "接收到的：" + Arrays.toString(arrayName);
}

请求 /basic/hello?arrayName=zhangsan,lisi,wangwu 或 /basic/hello?arrayName=zhangsan&arrayName=lisi&arrayName=wangwu，结果一致。

集合参数

如果直接用 List<String> 接收，会报错，因为 Spring 默认把参数封装成数组，而数组无法直接赋值给 List。

// 错误写法
@RequestMapping("/hello")
@ResponseBody
public String hello(List<String> listName) { ... }

访问 /basic/hello?listName=zhangsan,lisi,wangwu 会 500。

控制台提示：没有找到 List 的主构造函数。

解决办法：加上 @RequestParam 注解。

@RequestMapping("/hello")
@ResponseBody
public String hello(@RequestParam List<String> listName) { ... }

此时两种传参方式都能正常接收。

参数重命名

如果想让前端参数名和方法参数名不同，可以在 @RequestParam 中指定 value。

@RequestMapping("/hello")
@ResponseBody
public String hello(@RequestParam("name") String username) {
    return "接受的 name 参数是：" + username;
}

前端传 ?name=lisi 时，username 获得值 lisi；但如果传 ?username=lisi，默认情况下会报错，因为 @RequestParam 默认 required=true。

设置 required = false 后，传 username 不会报错，但 username 的值仍然是 null，因为它只会从名为 name 的参数中复制值。也就是说，一旦做了重命名，前端必须传 @RequestParam 里指定的那个名字。

@RequestMapping("/hello")
@ResponseBody
public String hello(@RequestParam(value = "name", required = false) String username) {
    return "接受的 name 参数是：" + username;
}

@RequestParam 源码中 required 默认为 true：

小结

这篇文章从 MVC 概念出发，梳理了 Spring MVC 在 Spring Boot 中的定位，然后通过实际例子演示了如何建立连接、接收各种类型的请求参数，包括对象、数组、集合，以及参数重命名的注意事项。这些是使用 Spring MVC 构建 Web 服务的基础，掌握后就可以着手处理更复杂的业务了。