Spring Boot Controller处理HTTP请求体的方法

2025-05-10 02:50

本文主要是介绍Spring Boot Controller处理HTTP请求体的方法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《SpringBootController处理HTTP请求体的方法》SpringBoot提供了强大的机制来处理不同Content-Type​的HTTP请求体,这主要依赖于HttpMessageCo...

Spring Boot (通过Spring MVC) 提供了强大的机制来处理不同 Content-Type​ 的HTTP请求体。这主要依赖于 HttpMessageConverter​ 接口的各种实现,它们能够自动将请求体内容转换成Java方法参数。

一、核心机制:HttpMessageConverter​

Spring MVC会根据请求头中的 Content-Type​ 和Controller方法参数的类型,选择一个合适的 HttpMessageConverter​ 来执行数据转换。常见的转换器包括:

  • ​MappingJackson2HttpMessageConverter​: 处理 application/json​,将JSON数据绑定到POJO。
  • ​FormHttpMessageConverter​: 处理 application/x-www-form-urlencoded​,可以将表单数据绑定到POJO或 MultiValueMap​。
  • ​Jaxb2RootElementHttpMessageConverter​: 处理 application/xml​,将XML数据绑定到用JAXB注解的POJO。
  • ​ByteArrayHttpMessageConverter​: 处理原始字节流,绑定到 byte[]​。
  • ​StringHttpMessageConverter​: 处理纯文本,绑定到 String​。
  • ​StandardServletMultipartResolver​ (配合相关转换器): 处理 multipart/form-data​,通常用于文件上传,将文件部分绑定到 MultipartFile​。

二、按Content-Type​处理详解

1. applrSpUkZication/json​

  • 注解: @RequestBody​
  • 目标类型: POJO (Plain Old Java Object)
  • 示例:
// POJO
// public class User {
//     private Strpythoning username;
//     private String email;
//     // getters and setters
// }
@PostMapping("/users")
public User createUser(@RequestBody User user) {
    // user 对象已从JSON填充
    return userService.save(user);
}

说明: 请求体中的JSON字符串会被自动映射到 User​ 对象的字段。

2. application/x-www-form-urlencoded​

  • 方式一:使用 @RequestParam​ 逐个接收
    • 注解: @RequestParam("paramName")​
    • 目标类型: 基本类型 (String​, int​, etc.)
    • 示例:
@PostMapping("/login")
public String login(@RequestParam String username, @RequestParam String password) {
    // username 和 password 从表单数据填充
    // ...
}
  • 方式二:直接绑定到POJO (无需 @RequestBody​)
    • 目标类型: POJO
    • 说明: 表单字段名需与POJO属性名匹配。
    • 示例:
// POJO
// public class RegistrationForm {
//     private String username;
//     private String password;
//     // getters and setters
// }
@PostMapping("/register")
public String register(RegistrationForm form) {
    // form 对象已从表单数据填充
    // ...
}

3. multipart/form-data​ (常用于文件上传)

  • 注解: @RequestParam​ 或 @RequestPart​
  • 目标类型: MultipartFile​ (用于文件), 其他表单字段可以是基本类型或POJO。
  • 配置: 可能需要在 application.properties​ 中启用和配置multipart处理:
spring.servlet.multipart.enabled=true
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

示例:

@PostMapping("/upload/profile")
public String uploadProfile(@RequestParam("userId") Long userId,
                            @RequestParam("image") MultipartFile imageFile) throws IOException {
    // userId 是普通表单字段
    // imageFile 是上传的文件
    String fileName = imageFile.getOriginalFilename();
    // ... 保存文件 ...
    return "File " + fileName + " uploaded for user " + userId;
}
// 使用 @RequestPart 处理复杂multipart (例如,一个部分是JSON)
@PostMapping("/upload/advanced")
public String advancedUpload(@RequestPart("metadata") UserMetadata metadata, // UserMetadata 是一个POJO
                             @RequestPart("document") MultipartFile document) {
    // metadata 从一个JSON part解析
    // document 是文件 part
    // ...
    return "Advanced upload successful.";
}

4. text/plain​

  • 注解: @RequestBody​
  • 目标类型: String​
  • 示例:
@PostMapping("/logs")
public void submitLog(@RequestBody String logEntry) {
    // logEntry 包含请求体中的纯文本
    System.out.println(logEntry);
}

5. application/xml​

  • 注解: @RequestBody​
  • 目标类型: 用JAXB注解的POJO (e.g., @XmlRootElement​)
  • 依赖: 通常需要 jaxb-api​ 和实现 (如 org.glassfish.jaxb:jaxb-runtime​)。Spring Boot的 spring-boot-starter-web​ 默认可能不直接包含完整的JAXB运行时,需要时可添加。
  • 示例:
// POJO (用JAXB注解)
// @XmlRootElement(name = "item")
// public class Item {
//     @XmlElement public String name;
//     @XmlElement public double price;
// }
@PostMappijavascriptng(value = "/items", consumes = "application/xml", produces = "application/xml")
public Item createItem(@RequestBody Item item) {
    // item 对象已从XML填充
    return itemService.save(item);
}

6. application/ocjavascripttet-stream​ (或其他二进制数据)

  • 注解: @RequestBody​
  • 目标类型: byte[]​
  • 示例:
@PostMapping(value = "/data", consumes = "application/octet-stream")
public String processBinaryData(@RequestBody byte[] data) {
    // data 包含原始二进制数据
    System.out.println("Received " + data.length + " bytes.");
    return "Binary data processed.";
}

或者直接使用 InputStream​ (通常不带 @RequestBody​):

@PostMapping(value = "/data-stream", consumes = "application/octet-stream")
public String processDataStream(InputStream inputStream) throws IOException {
    // 手动从 inputStream 读取数据
    // ...
    return "Stream processed.";
}

三、错误处理

如果请求的 Content-Type​ 不被支持,或者请求体格式错误(如无效的JSON),Spring Boot 通常会返回:

  • HTTP 415 Unsupported Media Type: 如果没有HttpMessageConverter能处理该 Content-Type​。
  • HTTP 400 Bad Requestandroid: 如果选择的HttpMessageConverter无法解析请求体 (例如,JSON语法错误)。

四、自定义与扩展

开发者可以注册自定义的 HttpMessageConverter​ 来支持非标准或特定的数据格式,通过配置 WebMvcConfigurer​。

// @Configuration
// public class WebConfig implements WebMvcConfigurer {
//     @Override
//     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
//         converters.add(new MyCustomMessageConverter());
//     }
//
//     @Override
//     public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
//         // 用来添加转换器,同时不影响默认注册的转换器
//         // 或者调整已注册转换器的顺序
//     }
// }

理解这些机制对于构建健壮和灵活的Spring Boot API至关重要。

到此这篇关于Spring Boot Controller 如何处理HTTP请求体的文章就介绍到这了,更多相关Spring Boot Controller HTTP请求体内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!

这篇关于Spring Boot Controller处理HTTP请求体的方法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154553

相关文章

SpringBoot连接Redis集群教程

《SpringBoot连接Redis集群教程》:本文主要介绍SpringBoot连接Redis集群教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. 依赖2. 修改配置文件3. 创建RedisClusterConfig4. 测试总结1. 依赖 <de

SpringBoot+Redis防止接口重复提交问题

《SpringBoot+Redis防止接口重复提交问题》:本文主要介绍SpringBoot+Redis防止接口重复提交问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录前言实现思路代码示例测试总结前言在项目的使用使用过程中,经常会出现某些操作在短时间内频繁提交。例

SpringSecurity显示用户账号已被锁定的原因及解决方案

《SpringSecurity显示用户账号已被锁定的原因及解决方案》SpringSecurity中用户账号被锁定问题源于UserDetails接口方法返回值错误,解决方案是修正isAccountNon... 目录SpringSecurity显示用户账号已被锁定的解决方案1.问题出现前的工作2.问题出现原因各

Java继承映射的三种使用方法示例

《Java继承映射的三种使用方法示例》继承在Java中扮演着重要的角色,它允许我们创建一个类(子类),该类继承另一个类(父类)的所有属性和方法,:本文主要介绍Java继承映射的三种使用方法示例,需... 目录前言一、单表继承(Single Table Inheritance)1-1、原理1-2、使用方法1-

Spring @Scheduled注解及工作原理

《Spring@Scheduled注解及工作原理》Spring的@Scheduled注解用于标记定时任务,无需额外库,需配置@EnableScheduling,设置fixedRate、fixedDe... 目录1.@Scheduled注解定义2.配置 @Scheduled2.1 开启定时任务支持2.2 创建

SpringBoot中使用Flux实现流式返回的方法小结

《SpringBoot中使用Flux实现流式返回的方法小结》文章介绍流式返回(StreamingResponse)在SpringBoot中通过Flux实现,优势包括提升用户体验、降低内存消耗、支持长连... 目录背景流式返回的核心概念与优势1. 提升用户体验2. 降低内存消耗3. 支持长连接与实时通信在Sp

Conda虚拟环境的复制和迁移的四种方法实现

《Conda虚拟环境的复制和迁移的四种方法实现》本文主要介绍了Conda虚拟环境的复制和迁移的四种方法实现,包括requirements.txt,environment.yml,conda-pack,... 目录在本机复制Conda虚拟环境相同操作系统之间复制环境方法一:requirements.txt方法

Nginx 重写与重定向配置方法

《Nginx重写与重定向配置方法》Nginx重写与重定向区别:重写修改路径(客户端无感知),重定向跳转新URL(客户端感知),try_files检查文件/目录存在性,return301直接返回永久重... 目录一.try_files指令二.return指令三.rewrite指令区分重写与重定向重写: 请求

MySQL 打开binlog日志的方法及注意事项

《MySQL打开binlog日志的方法及注意事项》本文给大家介绍MySQL打开binlog日志的方法及注意事项,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录一、默认状态二、如何检查 binlog 状态三、如何开启 binlog3.1 临时开启(重启后失效)

Spring Boot 实现 IP 限流的原理、实践与利弊解析

《SpringBoot实现IP限流的原理、实践与利弊解析》在SpringBoot中实现IP限流是一种简单而有效的方式来保障系统的稳定性和可用性,本文给大家介绍SpringBoot实现IP限... 目录一、引言二、IP 限流原理2.1 令牌桶算法2.2 漏桶算法三、使用场景3.1 防止恶意攻击3.2 控制资源