Spring Web MVC 入门指南：从概念到实践

2. @RestController 注解介绍

@RestController 注解就像给控制器类贴了一个特殊标签，告诉 Spring 框架：这个类里的方法是传给前端的返回数据。它让控制器里的方法直接返回的内容当成响应内容发给前端，省去了'找页面'的流程。

如果不加 @RestController 注解会怎么样？

如果只使用普通的 @Controller 注解，方法返回的是'页面地址'，而不是直接的数据内容。如果什么都不加，该类只是一个普通类，接口无法被访问。

@RestController 的核心作用就是'让方法直接返回数据'。

3. @RequestMapping 注解

@RequestMapping 是 Spring 框架中非常重要的注解，用于将特定的 HTTP 请求方法映射到对应的处理方法。括号内的路径如 /hello 表示调用该方法的代码。路径不加 / 也可以，但建议加上以保持规范。

@RequestMapping 既可以用在类上，也可以用在方法上：

1. @RequestMapping 只用在类上

相当于'只给文件夹起名，不给文件起名'。

@RestController
@RequestMapping("/sayhello")
public class Hello {
    public String say() {
        return "hello";
    }
}

此时系统找到了文件夹，但不知道具体是哪个文件，就像只知道身份却不知道具体县乡一样，找不到确切位置。

2. @RequestMapping 只用在方法上

相当于'只给文件起名，不给文件夹起名'。

@RestController
public class Hello {
    @RequestMapping("/sayhello")
    public String say() {
        return "hello";
    }
}

系统不知道是哪个文件夹的文件，但会搜索所有文件夹来查找。如果出现相同的文件名，会发生路径重复报错。

3. @RequestMapping 用在类和方法上

相当于给文件夹和文件都取名，可以进行具体定位，不容易报错。

@RestController
@RequestMapping("/sayhello")
public class Hello {
    @RequestMapping("/hello1")
    public String say1() {
        return "hello1";
    }
    
    @RequestMapping("/hello2")
    public String say2() {
        return "hello2";
    }
}

请求方法支持 RestMapping 默认支持 Post 和 Get。如果需要限制只用一种，可以这样写：

只用 Get

// 写法 1
@RequestMapping(value = "/2", method = RequestMethod.GET)
public Integer num2() { return 2; }

// 写法 2
@GetMapping("/3")
public Integer num3() { return 3; }

只用 Post

// 写法 1
@RequestMapping(value = "/4", method = RequestMethod.POST)
public Integer num4() { return 4; }

// 写法 2
@PostMapping("/5")
public Integer num5() { return 5; }

三、Postman 测试

1. 什么是 Postman？

Postman 是一款广泛用于 API 开发、测试和调试的工具，其核心价值体现在高效、便捷地处理 API 相关工作。

核心优势：

• 调试简单：图形化界面，填好参数就能发送请求，不用写代码，响应结果直观展示。
• 功能全面：支持各种 HTTP 请求方法和数据格式。
• 协作方便：可将 API 分组管理，共享给团队；多环境一键切换。
• 自动化测试：可写脚本验证响应，批量运行测试并生成报告。

2. 关于 API

API（Application Programming Interface）是不同软件之间进行交互的一套规则、协议和工具的集合。它规定了一方如何向另一方请求服务或数据，以及另一方如何响应。API 就像两个软件之间的'桥梁'，让他们能按照统一的方式沟通。

3. 传参介绍

1. 普通传参：通过查询字符串来传参

直接在 URL 后面拼接参数，如 ?key=value。

2. form-data (multipart/form-data)

表单提交数据，通常用于提交图片/文件。对应 Content-type：multipart/form-data。

3. x-www-form-urlencoded

对应 Content-type：application/x-www-form-urlencoded，是最常见的表单提交方式。

4. raw

可以上传任意格式的文本，比如 text、JavaScript、json、html、xml。

4. 传递参数实战

1. 传递单个参数

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/request")
public class RequestController {
    @RequestMapping("/1")
    public String method(String string) {
        return "接收单个参数:" + string;
    }
}

注意：接收时参数名要一致，否则无法接收到参数。如果接受的参数基本类型不对应，会发生报错。

基本类型和引用类型传参的区别：

• 引用类型：传参时若不传值，会赋值为 null，不会发生报错现象。
• 基本类型：传参时若不传值，可能会发生空指针异常或类型转换错误。

2. 传递多个参数

@RequestMapping("/4")
public String method(String name, Integer age) {
    return "接收多个参数：姓名：" + name + " 年龄：" + age;
}

3. 传递对象

@RestController
@RequestMapping("/User")
public class UserController {
    @RequestMapping("/5")
    public String method(User user) {
        return "接收对象参数：" + user.toString();
    }
}

// User 实体类
public class User {
    private String name;
    private int password;
    private int age;
    // getter and setter...
    @Override
    public String toString() {
        return "User{" + "name='" + name + '\'' + ", password=" + password + ", age=" + age + '}';
    }
}

后端参数重命名：@RequestParam 如果前后端参数命名不一致，可以使用 @RequestParam 来重命名。

// 将其重命名为 str
@RequestMapping("/6")
public String method(@RequestParam("str") String s) {
    return "接收参数：" + s;
}

使用 @RequestParam 重命名时，参数默认成为必传参数，否则将会报错。如果不想必填，可以设置 required=false。

@RequestMapping("/7")
public String method(@RequestParam(value = "str", required = false) String s) {
    return "接收参数：" + s;
}

4. 传递数组

@RequestMapping("/8")
public String method(String[] s) {
    return Arrays.toString(s);
}

5. 传递集合

传递集合需要使用 @RequestParam 用于接收单个请求参数。如果要接收 List 类型，需要显示开启'允许多值'模式，否则 Spring 无法解析。

@RequestMapping("/9")
public List<Integer> method(@RequestParam List<Integer> num) {
    return num;
}