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

相关文章

java -jar example.jar 产生的日志输出到指定文件的方法

《java-jarexample.jar产生的日志输出到指定文件的方法》这篇文章给大家介绍java-jarexample.jar产生的日志输出到指定文件的方法,本文给大家介绍的非常详细,对大家的... 目录怎么让 Java -jar example.jar 产生的日志输出到指定文件一、方法1:使用重定向1、

Java报错:org.springframework.beans.factory.BeanCreationException的五种解决方法

《Java报错:org.springframework.beans.factory.BeanCreationException的五种解决方法》本文解析Spring框架中BeanCreationExce... 目录引言一、问题描述1.1 报错示例假设我们有一个简单的Java类,代表一个用户信息的实体类:然后,

SpringBoot集成P6Spy的实现示例

《SpringBoot集成P6Spy的实现示例》本文主要介绍了SpringBoot集成P6Spy的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面... 目录本节目标P6Spy简介抛出问题集成P6Spy1. SpringBoot三板斧之加入依赖2. 修改

Go语言使用net/http构建一个RESTful API的示例代码

《Go语言使用net/http构建一个RESTfulAPI的示例代码》Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架(如Gin、Echo)已经封装了很多功能,但... 目录引言一、什么是 RESTful API?二、实战目标:用户信息管理 API三、代码实现1. 用户数据

Linux查询服务器系统版本号的多种方法

《Linux查询服务器系统版本号的多种方法》在Linux系统管理和维护工作中,了解当前操作系统的版本信息是最基础也是最重要的操作之一,系统版本不仅关系到软件兼容性、安全更新策略,还直接影响到故障排查和... 目录一、引言:系统版本查询的重要性二、基础命令解析:cat /etc/Centos-release详

Spring Integration Redis 使用示例详解

《SpringIntegrationRedis使用示例详解》本文给大家介绍SpringIntegrationRedis的配置与使用,涵盖依赖添加、Redis连接设置、分布式锁实现、消息通道配置及... 目录一、依赖配置1.1 Maven 依赖1.2 Gradle 依赖二、Redis 连接配置2.1 配置 R

Python WSGI HTTP服务器Gunicorn使用详解

《PythonWSGIHTTP服务器Gunicorn使用详解》Gunicorn是Python的WSGI服务器,用于部署Flask/Django应用,性能高且稳定,支持多Worker类型与配置,可处... 目录一、什么是 Gunicorn?二、为什么需要Gunicorn?三、安装Gunicorn四、基本使用启

MyBatis的xml中字符串类型判空与非字符串类型判空处理方式(最新整理)

《MyBatis的xml中字符串类型判空与非字符串类型判空处理方式(最新整理)》本文给大家介绍MyBatis的xml中字符串类型判空与非字符串类型判空处理方式,本文给大家介绍的非常详细,对大家的学习或... 目录完整 Hutool 写法版本对比优化为什么status变成Long?为什么 price 没事?怎

Spring Security重写AuthenticationManager实现账号密码登录或者手机号码登录

《SpringSecurity重写AuthenticationManager实现账号密码登录或者手机号码登录》本文主要介绍了SpringSecurity重写AuthenticationManage... 目录一、创建自定义认证提供者CustomAuthenticationProvider二、创建认证业务Us

Java Stream流以及常用方法操作实例

《JavaStream流以及常用方法操作实例》Stream是对Java中集合的一种增强方式,使用它可以将集合的处理过程变得更加简洁、高效和易读,:本文主要介绍JavaStream流以及常用方法... 目录一、Stream流是什么?二、stream的操作2.1、stream流创建2.2、stream的使用2.