Spring Boot前端请求时的参数绑定

Spring Boot前端请求时的参数绑定在 Spring Boot 中处理前端请求时有多个关键的参数绑定注解。来聊聊这些注解的用法和区别。核心注解对比表注解作用位置获取来源适用场景示例RequestBody方法参数请求体JSON/XML接收复杂对象创建/更新操作PathVariable方法参数URL路径中的变量RESTful资源定位/users/{id}RequestParam方法参数URL查询参数简单参数过滤?name张三age20RequestHeader方法参数请求头获取Header信息Token、Content-TypeCookieValue方法参数Cookie获取Cookie值Session信息ModelAttribute方法参数多种来源表单数据绑定传统表单提交详细讲解每个注解1. RequestBody - 接收JSON数据用途从请求体中获取JSON数据自动转换为Java对象RestController RequestMapping(/api/users) public class UserController { // 创建用户 - 接收JSON对象 PostMapping public Result createUser(RequestBody UserDTO userDTO) { // 前端发送{name:张三,age:25,email:zhangsanexample.com} // Spring会自动将JSON转换为UserDTO对象 User user userService.create(userDTO); return Result.success(user); } // 批量创建 - 接收JSON数组 PostMapping(/batch) public Result batchCreate(RequestBody ListUserDTO userDTOs) { // 前端发送[{...}, {...}, {...}] ListUser users userService.batchCreate(userDTOs); return Result.success(users); } } // DTO类 public class UserDTO { private String name; private Integer age; private String email; // 必须有无参构造器 getters/setters }注意事项只支持POST、PUT、PATCH等有请求体的方法前端需要设置Content-Type: application/json默认不支持GET请求GET通常没有请求体2. PathVariable - 获取URL路径参数用途从URL路径中获取参数用于RESTful风格APIRestController RequestMapping(/api/users) public class UserController { // 获取单个用户 - /api/users/1 GetMapping(/{id}) public Result getUser(PathVariable Long id) { // {id} 对应 PathVariable 的 id User user userService.findById(id); return Result.success(user); } // 多个路径变量 - /api/users/1/orders/100 GetMapping(/{userId}/orders/{orderId}) public Result getOrder( PathVariable Long userId, PathVariable Long orderId) { Order order orderService.findById(userId, orderId); return Result.success(order); } // 指定变量名 - 当参数名与路径变量名不同时 GetMapping(/{uid}) public Result getUserById(PathVariable(uid) Long userId) { // 路径是{uid}但参数名是userId需要指定映射 return Result.success(userService.findById(userId)); } // 可选路径变量Spring 5 GetMapping({/profile, /profile/{userId}}) public Result getProfile(PathVariable(required false) Long userId) { if (userId null) { return Result.success(getCurrentUserProfile()); } return Result.success(userService.getProfile(userId)); } }3. RequestParam - 获取查询参数用途从URL的?后面获取参数RestController RequestMapping(/api/users) public class UserController { // 搜索用户 - /api/users/search?name张三age20 GetMapping(/search) public Result searchUsers( RequestParam String name, // 必需参数 RequestParam(required false) Integer age, // 可选参数 RequestParam(defaultValue 1) int page, // 默认值 RequestParam(defaultValue 10) int size) { ListUser users userService.search(name, age, page, size); return Result.success(users); } // 获取所有参数 - 使用Map接收 GetMapping(/filter) public Result filterUsers(RequestParam MapString, String params) { // /api/users/filter?name张三age20city北京 // params {name张三, age20, city北京} ListUser users userService.filter(params); return Result.success(users); } // 数组参数 - /api/users?ids1,2,3 或 /api/users?ids1ids2ids3 GetMapping public Result getUsersByIds(RequestParam ListLong ids) { ListUser users userService.findByIds(ids); return Result.success(users); } }4. RequestHeader - 获取请求头用途从HTTP请求头中获取信息RestController RequestMapping(/api) public class AuthController { GetMapping(/profile) public Result getProfile( RequestHeader(Authorization) String token, // 获取Token RequestHeader(value User-Agent, defaultValue Unknown) String userAgent, RequestHeader HttpHeaders headers) { // 获取所有Header // 验证Token if (!isValidToken(token)) { return Result.error(401, Token无效); } // 记录访问日志 log.info(User-Agent: {}, Accept: {}, userAgent, headers.getFirst(Accept)); UserProfile profile authService.getProfile(token); return Result.success(profile); } // 获取特定Header PostMapping(/upload) public Result uploadFile( RequestHeader(Content-Type) String contentType, RequestHeader(Content-Length) long contentLength) { if (!contentType.startsWith(multipart/)) { return Result.error(400, 只支持文件上传); } if (contentLength 10 * 1024 * 1024) { // 10MB限制 return Result.error(400, 文件大小超过限制); } return Result.success(文件上传成功); } }5. CookieValue - 获取Cookie用途从Cookie中获取值RestController RequestMapping(/api) public class SessionController { GetMapping(/cart) public Result getCart(CookieValue(sessionId) String sessionId) { // 从Cookie获取sessionId Cart cart cartService.getCart(sessionId); return Result.success(cart); } // 可选Cookie值 GetMapping(/preferences) public Result getPreferences( CookieValue(value theme, defaultValue light) String theme, CookieValue(value language, defaultValue zh-CN) String language) { UserPreferences prefs new UserPreferences(theme, language); return Result.success(prefs); } // 设置Cookie通过HttpServletResponse PostMapping(/login) public Result login(RequestBody LoginDTO loginDTO, HttpServletResponse response) { User user authService.login(loginDTO); // 设置Cookie Cookie sessionCookie new Cookie(sessionId, user.getSessionId()); sessionCookie.setHttpOnly(true); sessionCookie.setMaxAge(7 * 24 * 60 * 60); // 7天 sessionCookie.setPath(/); response.addCookie(sessionCookie); return Result.success(user); } }实际场景综合应用场景1用户管理CRUDRestController RequestMapping(/api/users) public class UserController { // 1. 查询用户列表分页过滤 - GET RequestParam // GET /api/users?page1size10name张status1 GetMapping public Result getUsers( RequestParam(defaultValue 1) int page, RequestParam(defaultValue 10) int size, RequestParam(required false) String name, RequestParam(required false) Integer status) { PageUser users userService.findUsers(page, size, name, status); return Result.success(users); } // 2. 查询单个用户 - GET PathVariable // GET /api/users/123 GetMapping(/{id}) public Result getUser(PathVariable Long id) { User user userService.findById(id); return Result.success(user); } // 3. 创建用户 - POST RequestBody // POST /api/users // Body: {name:张三,email:zhangsanexample.com,age:25} PostMapping public Result createUser(RequestBody UserDTO userDTO) { User user userService.create(userDTO); return Result.success(创建成功, user); } // 4. 更新用户 - PUT PathVariable RequestBody // PUT /api/users/123 // Body: {name:张三,age:26} PutMapping(/{id}) public Result updateUser( PathVariable Long id, RequestBody UserDTO userDTO) { User user userService.update(id, userDTO); return Result.success(更新成功, user); } // 5. 删除用户 - DELETE PathVariable // DELETE /api/users/123 DeleteMapping(/{id}) public Result deleteUser(PathVariable Long id) { userService.delete(id); return Result.success(删除成功); } // 6. 搜索用户 - GET RequestParam // GET /api/users/search?keyword张minAge20maxAge30 GetMapping(/search) public Result searchUsers( RequestParam String keyword, RequestParam(required false) Integer minAge, RequestParam(required false) Integer maxAge) { ListUser users userService.search(keyword, minAge, maxAge); return Result.success(users); } }场景2订单系统RestController RequestMapping(/api/orders) public class OrderController { // 创建订单 - 需要Token验证 PostMapping public Result createOrder( RequestBody OrderCreateDTO orderDTO, RequestHeader(Authorization) String token) { // 验证Token Long userId authService.getUserIdFromToken(token); // 创建订单 Order order orderService.createOrder(userId, orderDTO); return Result.success(订单创建成功, order); } // 获取用户订单列表 GetMapping(/my-orders) public Result getMyOrders( RequestHeader(Authorization) String token, RequestParam(defaultValue 1) int page, RequestParam(defaultValue 10) int size, RequestParam(required false) Integer status) { Long userId authService.getUserIdFromToken(token); PageOrder orders orderService.getUserOrders(userId, page, size, status); return Result.success(orders); } // 获取订单详情 GetMapping(/{orderId}) public Result getOrderDetail( PathVariable String orderId, RequestHeader(Authorization) String token) { Long userId authService.getUserIdFromToken(token); OrderDetailVO orderDetail orderService.getOrderDetail(userId, orderId); return Result.success(orderDetail); } // 取消订单 PutMapping(/{orderId}/cancel) public Result cancelOrder( PathVariable String orderId, RequestHeader(Authorization) String token, RequestParam(required false) String reason) { Long userId authService.getUserIdFromToken(token); orderService.cancelOrder(userId, orderId, reason); return Result.success(订单已取消); } }常见问题和注意事项1. 参数绑定失败// ❌ 问题缺少必需参数时报400 GetMapping public Result test(RequestParam String requiredParam) { // 如果请求没有传requiredParam会报400 } // ✅ 解决设置requiredfalse或默认值 GetMapping public Result test(RequestParam(required false) String optionalParam) { // 现在不传参也可以 }2. 类型转换错误// ❌ 问题传了非数字值 GetMapping(/{id}) public Result test(PathVariable Long id) { // 如果访问 /api/users/abc会报400无法将abc转为Long } // ✅ 解决在ControllerAdvice中统一处理 ControllerAdvice public class GlobalExceptionHandler { ExceptionHandler(MethodArgumentTypeMismatchException.class) public Result handleTypeMismatch(MethodArgumentTypeMismatchException ex) { return Result.error(400, 参数类型错误: ex.getName()); } }3. 多个同类型参数// ❌ 问题多个RequestBody PostMapping public Result test(RequestBody UserDTO user, RequestBody AddressDTO address) { // 错误一个请求只能有一个RequestBody } // ✅ 解决封装到一个DTO中 PostMapping public Result test(RequestBody OrderCreateDTO orderDTO) { // orderDTO中包含user和address }4. GET请求使用RequestBody// ❌ 问题GET请求不能用RequestBody GetMapping public Result test(RequestBody FilterDTO filter) { // 错误GET请求通常没有请求体 } // ✅ 解决用RequestParam或PathVariable GetMapping public Result test(RequestParam String name, RequestParam Integer age) { // 正确 }参数验证结合注解RestController RequestMapping(/api/users) public class UserController { PostMapping public Result createUser(Valid RequestBody UserDTO userDTO) { // Valid 会触发验证 User user userService.create(userDTO); return Result.success(user); } } // DTO类添加验证注解 public class UserDTO { NotBlank(message 用户名不能为空) Size(min 2, max 20, message 用户名长度2-20) private String name; NotNull(message 年龄不能为空) Min(value 1, message 年龄不能小于1) Max(value 150, message 年龄不能大于150) private Integer age; Email(message 邮箱格式不正确) private String email; Pattern(regexp ^1[3-9]\\d{9}$, message 手机号格式不正确) private String phone; }最佳实践总结RESTful设计查询用GETPathVariable/RequestParam创建用POSTRequestBody更新用PUTPathVariableRequestBody删除用DELETEPathVariable参数选择路径参数用PathVariable查询参数用RequestParamJSON数据用RequestBody认证信息用RequestHeader验证机制始终验证输入参数使用Valid进行自动验证提供清晰的错误信息安全性敏感信息不要放在URL中使用RequestHeader获取Token验证参数合法性记住这个简单的选择指南要获取资源→GetMappingPathVariable/RequestParam要提交数据→PostMapping/PutMappingRequestBody要身份验证→RequestHeader获取Token要参数过滤→RequestParam获取查询条件