Spring Web MVC 核心概念与实战指南

该依赖包含了 Spring MVC 组件、Servlet API 以及嵌入式 Tomcat 容器。

3. 核心注解与应用

3.1 路由映射 @RequestMapping

这是最基础的路由注解，用于关联 URL 与 Java 方法。支持类级和方法级修饰。

@RestController
@RequestMapping("/user")
public class UserController {
    // 完整路径：/user/sayHi
    @RequestMapping("/sayHi")
    public String sayHi() {
        return "hello, Spring MVC";
    }
}

• 类级注解：设置请求路径前缀。
• 方法级注解：定义具体路径，支持多层结构。
• 注意：URL 路径前是否加 / 不影响访问，但请求方式（GET/POST）必须唯一。

3.2 请求参数接收

3.2.1 @RequestParam

解决前后端参数名不一致问题，并可设置必填项。

@RequestMapping("/r6")
public String r6(@RequestParam(value = "sa", required = false) String resouce) {
    return "接收到 resouce = " + resouce;
}

• value：指定前端参数名。
• required：默认 true，设为 false 表示非必传。

3.2.2 @PathVariable

适用于 RESTful 风格，直接从 URL 路径提取参数。

@RequestMapping("/r11/{articleId}/{type}")
public String r11(@PathVariable("articleId") Integer id, @PathVariable String type) {
    return "id: " + id + ", type: " + type;
}

访问示例：http://127.0.0.1:8080/r11/5/zhangsan

3.3 响应处理

• @ResponseBody：标识方法返回数据而非视图。
• @RestController：组合注解（@Controller + @ResponseBody），类中所有方法默认返回数据。

// 返回视图
@Controller
public class IndexController {
    @RequestMapping("/index")
    public String index() {
        return "/index.html";
    }
}

// 返回数据
@RestController
public class DataController {
    @RequestMapping("/data")
    public String getData() {
        return "这是返回的数据内容";
    }
}

4. 请求处理全场景实战

4.1 基础参数传递

单个参数

直接通过方法参数接收，名称需一致。

@RequestMapping("/r1")
public String r1(String name) {
    return "name = " + name;
}

多个参数

支持同时接收，顺序不影响绑定。

@RequestMapping("/r4")
public String r4(String name, String password, Integer age) {
    return "name: " + name + ", age: " + age;
}

4.2 复杂参数处理

对象参数接收

参数较多时，封装为实体类，Spring 按属性名自动绑定。

public class Person {
    private String name;
    private int age;
    // getter/setter 省略
}

@RequestMapping("/r5")
public String r5(Person person) {
    return "person = " + person;
}

数组与集合

数组可直接接收，集合需配合 @RequestParam。

// 数组
@RequestMapping("/r7")
public String r7(String[] names) {
    return Arrays.toString(names);
}

// 集合
@RequestMapping("/r8")
public String r8(@RequestParam List<String> names) {
    return names.toString();
}

4.3 JSON 数据处理

JSON 是轻量级数据交换格式，跨平台兼容性好。Spring MVC 默认集成 Jackson 工具包。

4.3.1 对象互转

使用 ObjectMapper 进行序列化和反序列化。

import com.fasterxml.jackson.databind.ObjectMapper;

public class JSONTests {
    private static ObjectMapper objectMapper = new ObjectMapper();
    
    public void test() throws Exception {
        Person p = new Person();
        p.setName("zhangsan");
        // 对象转 JSON
        String json = objectMapper.writeValueAsString(p);
        // JSON 转对象
        Person p1 = objectMapper.readValue(json, Person.class);
    }
}

4.3.2 接收 JSON 请求

后端需使用 @RequestBody 注解绑定请求正文，并设置 Content-Type: application/json。

@RequestMapping("/r9")
public String r9(@RequestBody Person person) {
    return "接收到的参数 person = " + person;
}

4.4 文件上传

使用 @RequestPart 或 MultipartFile 处理。

@RequestMapping("/r12")
public String r12(MultipartFile file) throws IOException {
    // 获取原始文件名
    System.out.println(file.getOriginalFilename());
    // 保存文件
    File destFile = new File("D:/temp/" + file.getOriginalFilename());
    file.transferTo(destFile);
    return "文件已保存";
}

4.5 Cookie 与 Session

Cookie 操作

可通过 HttpServletRequest 或 @CookieValue 读取。

@RequestMapping("/getCookie2")
public String getCookie2(@CookieValue("class") String className) {
    return "className: " + className;
}

Session 操作

Session 存储在服务器端，通过 SessionID 关联客户端。

// 设置 Session
@RequestMapping("/setSession")
public String setSession(HttpSession session) {
    session.setAttribute("name", "zhangsan");
    return "设置成功";
}

// 获取 Session
@RequestMapping("/getSession")
public String getSession(HttpSession session) {
    String name = (String) session.getAttribute("name");
    return "name: " + name;
}

注意：不同浏览器拥有独立的 SessionID，若手动替换 Cookie 中的 SessionID，服务器会识别为同一会话，导致数据混淆。

4.6 Header 获取

@RequestMapping("/getHeader")
public String getHeader(@RequestHeader("User-Agent") String userAgent) {
    return "ua: " + userAgent;
}

5. 响应处理高级应用

5.1 静态页面

需使用 @Controller 并返回视图路径，静态资源放在 resources/static 下。

@Controller
public class IndexController {
    @RequestMapping("/index")
    public String index() {
        return "/index.html";
    }
}

5.2 JSON 响应

Spring MVC 可自动将对象转换为 JSON。

@ResponseBody
@RequestMapping("/returnJson")
public HashMap<String, String> returnJson() {
    HashMap<String, String> map = new HashMap<>();
    map.put("Java", "Java Value");
    return map;
}

5.3 状态码与 Header

@RequestMapping("/setStatus")
public String setStatus(HttpServletResponse response) {
    response.setStatus(401); // 未授权
    return "状态码已设置";
}

6. 综合项目实战

6.1 加法计算器

简单的 GET/POST 接口，接收两个数字并返回结果。

@RestController
@RequestMapping("/calc")
public class CalcController {
    @RequestMapping("/sum")
    public String sum(Integer num1, Integer num2) {
        return "<h1>结果：" + (num1 + num2) + "</h1>";
    }
}

6.2 用户登录系统

结合 Session 保持登录状态。

@RestController
@RequestMapping("/user")
public class LoginController {
    @RequestMapping("/login")
    public boolean login(String userName, String password, HttpSession session) {
        if ("zhangsan".equals(userName) && "123456".equals(password)) {
            session.setAttribute("userName", userName);
            return true;
        }
        return false;
    }
}

6.3 图书管理系统

演示列表查询与 AJAX 渲染。

@RestController
@RequestMapping("/book")
public class BookController {
    @RequestMapping("/getList")
    public List<BookInfo> getList() {
        return bookService.getBookList();
    }
}

7. 开发工具与规范

7.1 Postman 测试

Postman 是常用的接口调试工具，支持多种请求方式和参数类型。配置 Headers 时注意 Content-Type。

7.2 Lombok 简化代码

Lombok 通过注解自动生成 Getter/Setter 等方法。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private int id;
    private String name;
}

7.3 企业开发规范

1. 命名：类名大驼峰，变量小驼峰，包名全小写。
2. 格式：4 空格缩进，关键逻辑添加注释。
3. 注解：优先使用组合注解，属性较多时分行书写。

8. 参考资料

• Spring MVC 官方文档
• Spring Boot 官方文档