Spring MVC注解详解与实战:从请求处理到数据绑定

发布时间:2024年01月02日

第一部分:注解详解

  1. @RequestBody

    • 作用:主要用来处理Content-Type为application/jsonapplication/xml等类型的请求体,将请求体中的参数绑定到方法的形参上。常用于处理POST、PUT等请求。
    • 使用场景:客户端发送的请求体中包含JSON或XML格式的数据,需要在服务器端将这些数据反序列化为Java对象。
  2. @RequestParam

    • 作用:用于获取查询参数或表单数据,并将其绑定到方法参数上。
    • 使用场景:URL中包含查询参数,或者表单提交时包含了键值对数据。
    • 属性
      • value:指定请求参数的名称。
      • required:指定参数是否必须存在。
      • defaultValue:指定参数的默认值。
  3. @PathVariable

    • 作用:用于获取URI模板变量(即URL路径中的一部分),并将其绑定到方法参数上。
    • 使用场景:实现RESTful风格的API时,经常通过URL路径来标识资源。
  4. @RequestHeader

    • 作用:用于获取HTTP请求头中的值,并将其绑定到方法参数上。
    • 使用场景:需要读取或处理特定的请求头信息。
  5. @CookieValue

    • 作用:用于获取HTTP请求中的Cookie值,并将其绑定到方法参数上。
    • 使用场景:需要根据Cookie中的信息来处理请求。
  6. @ModelAttribute(这个注解也常用于处理表单数据)

    • 作用:用于绑定请求参数到一个命令对象,该对象会被添加到模型中(通常用于视图渲染)。它也可以从模型中获取已经存在的命令对象并进行更新。
    • 使用场景:在处理表单提交时,通常使用@ModelAttribute来绑定数据到一个JavaBean对象上。
  7. 没有加入注解的情况
    当方法参数是一个简单的类型(如String、int等),并且没有使用任何注解时,Spring会尝试从请求中查找一个与参数名相匹配的参数(这通常是通过查询参数或表单数据来实现的)。但是,这种默认行为并不推荐,因为它依赖于Servlet容器的特定行为,可能会导致不可预测的结果。
    对于复杂的类型(如自定义的Java对象),如果没有使用@RequestBody或其他相关注解,Spring不会自动尝试将请求数据绑定到这些对象上。

第二部分:代码示例

下面是一个Spring Boot控制器类的示例,展示了如何使用上述注解:

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api")
public class ExampleController {

    // 使用@RequestBody接收JSON格式的数据并创建User对象
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // 保存用户逻辑...
        return user; // 假设这里返回了保存后的用户对象
    }

    // 使用@RequestParam接收查询参数并进行处理
    @GetMapping("/greet")
    public String greet(@RequestParam(name = "name", defaultValue = "World") String name) {
        return "Hello, " + name + "!";
    }

    // 使用@PathVariable从URL路径中获取用户ID并返回用户信息
    @GetMapping("/users/{userId}")
    public User getUser(@PathVariable Long userId) {
        // 根据userId查找用户逻辑...
        User foundUser = new User(); // 假设找到了用户对象
        foundUser.setId(userId);
        foundUser.setName("John Doe"); // 假设的用户名
        return foundUser;
    }

    // 使用@RequestHeader获取请求头中的User-Agent信息
    @GetMapping("/header-info")
    public String getHeaderInfo(@RequestHeader("User-Agent") String userAgent) {
        return "Your User-Agent is: " + userAgent;
    }

    // 使用@CookieValue获取Cookie中的JSESSIONID值(实际应用中不建议直接操作JSESSIONID)
    @GetMapping("/cookie-info")
    public String getCookieInfo(@CookieValue(name = "JSESSIONID", defaultValue = "NoSession") String sessionId) {
        return "Your session ID is: " + sessionId;
    }
    
    // 使用@ModelAttribute处理表单提交(通常与视图模板一起使用)
    @PostMapping("/register")
    public String registerUser(@ModelAttribute("user") User user, Model model) {
        // 注册用户逻辑...
        model.addAttribute("message", "Registration successful!"); // 添加消息到模型中以供视图使用
        return "registration_confirmation"; // 返回确认视图名称
    }
    
    // 内部的User类仅作演示用途,通常会有更复杂的字段和逻辑
    static class User {
        private Long id;
        private String name; // 以及其他字段...
        // 省略getter和setter方法... 以及可能的验证逻辑等...
    }
}

在这个示例中,定义了一个ExampleController类,它包含了多个处理不同HTTP请求的方法。每个方法都使用了至少一个Spring MVC提供的注解来简化HTTP请求的处理和数据绑定。这些注解使得控制器代码更加清晰、简洁,并且减少了样板代码的编写工作。

文章来源:https://blog.csdn.net/weixin_61034310/article/details/135327420
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。