如何在 Spring Boot 中强力执行 @RequestMapping 的内容类型验证？

2024-03-24 06:10:33

在 Spring Boot 中强制执行 @RequestMapping 中的内容类型验证

引言

在使用 Spring Boot 构建 RESTful API 时，@RequestMapping 注解对于映射 HTTP 请求和处理程序方法至关重要。@RequestMapping 支持 consumes 参数，用于限制请求可以接受的内容类型。但是，仅使用 consumes 可能不足以强制验证内容类型。本文将深入探讨如何使用 MultipartFilter 来解决这个问题。

问题

考虑以下代码示例：

@RestController
public class AppController {
  @PostMapping(value = "/test", consumes = MediaType.APPLICATION_JSON_VALUE)
  ResponseEntity get(@RequestBody Map<String, Object> request) {
    return new ResponseEntity<>(HttpStatus.OK);
  }
}

当请求主体为 JSON 但 content-type 标头设置为 multipart/form-data 时，上述 API 将返回 500 错误，而不是 400 错误。这违背了我们使用 consumes 设置内容类型限制的初衷。

解决方法：MultipartFilter

为了解决这个问题，我们需要使用 Spring 的 MultipartFilter。该过滤器可以检测 multipart 请求，如果请求 content-type 标头与 consumes 限制不匹配，则返回 400 错误。

要启用 MultipartFilter，请在 Spring Boot 配置中添加以下代码：

@Configuration
public class WebConfig implements WebMvcConfigurer {
  @Override
  public void addFilters(WebFilterRegistry registry) {
    registry.addFilter(new MultipartFilter());
  }
}

通过注册 MultipartFilter，Spring 将在请求处理链中拦截所有 HTTP 请求。该过滤器将检查请求 content-type 标头是否与 @RequestMapping 中设置的 consumes 限制匹配。如果不匹配，则将返回 400 错误。

优点

使用 MultipartFilter 有以下优点：

强制验证 @RequestMapping 中的内容类型限制。
改善 API 的健壮性，减少意外错误。
为不符合预期的内容类型提供更合适的 400 错误。

其他注意事项

确保请求的 content-type 标头与 @RequestMapping 中指定的 consumes 类型匹配。
根据需要，可以设置多个 consumes 类型以接受多种内容类型。
如果您使用的是低版本 Spring Boot（< 2.6），则可能需要使用 DelegatingFilterProxy 代替 addFilter 方法。

常见问题解答

Q1：为什么仅使用 consumes 无法强制验证内容类型？

A1：Spring 默认允许任何内容类型，即使与 consumes 设置不匹配。MultipartFilter 通过拦截和验证请求来解决此问题。

Q2：如何使用多个 consumes 类型？

A2：在 @RequestMapping 中，使用 consumes 属性来指定多个类型，例如：

@PostMapping(value = "/test", consumes = {MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE})

Q3：如何处理 multipart/form-data 请求？

A3：Spring Boot 提供 @RequestParam 和 @ModelAttribute 等注解来处理 multipart/form-data 请求。请参阅 Spring Boot 文档了解详细信息。

Q4：MultipartFilter 是否会影响性能？

A4：MultipartFilter 的性能开销很低，对于大多数应用程序来说可以忽略不计。但是，如果您处理大量文件上传，则可能需要考虑其他优化选项。

Q5：如何在低版本 Spring Boot 中使用 MultipartFilter？

A5：在 Spring Boot < 2.6 中，使用以下代码将 MultipartFilter 添加到过滤器链：

<filter>
  <filter-name>multipartFilter</filter-name>
  <filter-class>org.springframework.web.multipart.support.MultipartFilter</filter-class>
</filter>

<filter-mapping>
  <filter-name>multipartFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>