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

相关文章

Spring Security中用户名和密码的验证完整流程

《SpringSecurity中用户名和密码的验证完整流程》本文给大家介绍SpringSecurity中用户名和密码的验证完整流程,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定... 首先创建了一个UsernamePasswordAuthenticationTChina编程oken对象,这是S

java实现docker镜像上传到harbor仓库的方式

《java实现docker镜像上传到harbor仓库的方式》:本文主要介绍java实现docker镜像上传到harbor仓库的方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 前 言2. 编写工具类2.1 引入依赖包2.2 使用当前服务器的docker环境推送镜像2.2

一文详解Git中分支本地和远程删除的方法

《一文详解Git中分支本地和远程删除的方法》在使用Git进行版本控制的过程中,我们会创建多个分支来进行不同功能的开发,这就容易涉及到如何正确地删除本地分支和远程分支,下面我们就来看看相关的实现方法吧... 目录技术背景实现步骤删除本地分支删除远程www.chinasem.cn分支同步删除信息到其他机器示例步骤

Java easyExcel实现导入多sheet的Excel

《JavaeasyExcel实现导入多sheet的Excel》这篇文章主要为大家详细介绍了如何使用JavaeasyExcel实现导入多sheet的Excel,文中的示例代码讲解详细,感兴趣的小伙伴可... 目录1.官网2.Excel样式3.代码1.官网easyExcel官网2.Excel样式3.代码

Java MQTT实战应用

《JavaMQTT实战应用》本文详解MQTT协议,涵盖其发布/订阅机制、低功耗高效特性、三种服务质量等级(QoS0/1/2),以及客户端、代理、主题的核心概念,最后提供Linux部署教程、Sprin... 目录一、MQTT协议二、MQTT优点三、三种服务质量等级四、客户端、代理、主题1. 客户端(Clien

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

在Spring Boot中集成RabbitMQ的实战记录

《在SpringBoot中集成RabbitMQ的实战记录》本文介绍SpringBoot集成RabbitMQ的步骤,涵盖配置连接、消息发送与接收,并对比两种定义Exchange与队列的方式:手动声明(... 目录前言准备工作1. 安装 RabbitMQ2. 消息发送者(Producer)配置1. 创建 Spr

java向微信服务号发送消息的完整步骤实例

《java向微信服务号发送消息的完整步骤实例》:本文主要介绍java向微信服务号发送消息的相关资料,包括申请测试号获取appID/appsecret、关注公众号获取openID、配置消息模板及代码... 目录步骤1. 申请测试系统2. 公众号账号信息3. 关注测试号二维码4. 消息模板接口5. Java测试

深度解析Spring Boot拦截器Interceptor与过滤器Filter的区别与实战指南

《深度解析SpringBoot拦截器Interceptor与过滤器Filter的区别与实战指南》本文深度解析SpringBoot中拦截器与过滤器的区别,涵盖执行顺序、依赖关系、异常处理等核心差异,并... 目录Spring Boot拦截器(Interceptor)与过滤器(Filter)深度解析:区别、实现