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 路径最前是否加 / 不影响访问，但路径 + 请求方式必须唯一。

3.2 请求参数接收

3.2.1 @RequestParam 参数重命名

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

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

3.2.2 @PathVariable 路径参数

适用于 RESTful 风格接口，从 URL 中提取参数。

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

访问示例：http://127.0.0.1:8080/param/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 + ", password=" + password + ", age=" + age;
}

4.2 复杂参数处理

4.2.1 对象参数接收

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

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

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

4.2.2 数组与集合参数

数组参数接收：

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

集合参数需配合 @RequestParam：

@RequestMapping("/r8")
public String r8(@RequestParam List<String> names) {
    return "names = " + names;
}

4.3 传递 JSON 数据

JSON 是轻量级的文本数据交互格式，跨平台兼容且高效。

4.3.1 JSON 语法要点

• Key 必须用双引号包裹。
• 不支持注释（部分工具除外）。
• 结构包括对象 {} 和数组 []。

4.3.2 对象互转工具

Spring Web 依赖已集成 jackson-databind，使用 ObjectMapper 即可。

package cn.overthinker.springboot;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JSONTests {
    private static ObjectMapper objectMapper = new ObjectMapper();
    
    public static void main(String[] args) throws Exception {
        Person person = new Person();
        person.setName("zhangsan");
        person.setAge(18);
        
        // 对象转 JSON
        String jsonStr = objectMapper.writeValueAsString(person);
        System.out.println(jsonStr);
        
        // JSON 转对象
        Person p = objectMapper.readValue(jsonStr, Person.class);
        System.out.println(p);
    }
}

4.3.3 后端接收 JSON

前端需设置 Content-Type: application/json，后端使用 @RequestBody 绑定正文。

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

4.4 文件上传功能

使用 @RequestPart 或 MultipartFile 实现。

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

4.5 Cookie 与 Session 会话管理

Cookie 存储在客户端，Session 存储在服务器端。

4.5.1 Cookie 操作

可通过 HttpServletRequest 获取，或使用 @CookieValue 注解。

@RequestMapping("/getCookie")
public String getCookie(HttpServletRequest request, HttpServletResponse response) {
    Cookie[] cookies = request.getCookies();
    if (cookies != null) {
        for (Cookie cookie : cookies) {
            System.out.println(cookie.getName() + ":" + cookie.getValue());
        }
    }
    return "获取 Cookie 成功";
}

4.5.2 Session 操作

Session 数据保存在服务器内存，通过 SessionID 区分用户。

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

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

4.6 获取 Header

使用 @RequestHeader 注解可方便地获取请求头信息。

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

5. 响应处理高级应用

5.1 静态页面返回

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

@Controller
public class IndexController {
    @RequestMapping("/index")
    public Object 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");
    map.put("MySQL", "MySQL Value");
    return map;
}

5.3 状态码与 Header 设置

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

6. 综合项目实战

6.1 加法计算器

• 路径：/calc/sum
• 参数：num1, num2

@RestController
@RequestMapping("/calc")
public class CalcController {
    @RequestMapping("/sum")
    public String sum(Integer num1, Integer num2) {
        Integer result = num1 + num2;
        return "<h1>计算结果：" + result + "</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;
    }

    @RequestMapping("/getLoginUser")
    public String getLoginUser(HttpSession session) {
        String userName = (String) session.getAttribute("userName");
        return userName != null ? userName : "";
    }
}

7. 开发工具与效率提升

7.1 Postman 接口测试

Postman 是常用的接口测试工具，支持多种请求方式和参数类型，无需编写前端代码即可完成测试。

7.2 Lombok 简化开发

Lombok 通过注解自动生成 getter/setter 等冗余代码。

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

常用注解：

• @Data：生成 getter/setter、toString 等方法。
• @NoArgsConstructor / @AllArgsConstructor：构造方法。

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

8. 企业开发规范

遵循规范可提升代码可读性和维护性：

1. 命名规范：类名大驼峰，方法名小驼峰，包名全小写。
2. 代码格式：缩进 4 个空格，关键逻辑添加注释。
3. 注解使用：优先使用组合注解（如 @RestController）。