Spring Boot 一个接口同时支持 form 表单、form-data、json 优雅写法

Posted 2023-03-09

参考技术A

作者：小兵张健

链接：https://juejin.cn/post/7054441239839506446

网上很多代码都是千篇一律的 cvs，相信我只要你认真看完我写的这篇，你就可以完全掌握这个知识点，这篇文章不适合直接 cvs，一定要先理解。

最近重写个项目遇到个比较棘手的问题，老项目是 php 接口，这个接口同时兼容 POST json 和 form 表单，更骚的是连 form-data 也兼容。。。因为写 PHP 请求的对接方代码不严谨。详见这里。

而在 Java 中，一个接口只支持一种 content-type，json 就用 @RequestBody，form 表单就用 @RequestParam 或不写，form-data 就用 MultipartFile。

# 兼容版本

如果要在一个接口中同时兼容三种，比较笨的办法就是获取 HttpServletRequest，然后自己再写方法解析。类似如下：

但是这样写有弊端

# 优雅版本

网上有 form 表单和 json 同时兼容的版本，但是没有兼容 form-data，我在这做一下补充。

1. 自定义注解

2. 自定义注解解析

3. 添加到 spring configuration

4. form-data 的特殊处理

引入 jar 包

新增解析 bean

特殊说明，GameJsonMethodArgumentResolver 和 GameFormMethodArgumentResolver 是我们自定义的 json 和 form 解析，如果你没有自定义的，使用 spring 默认的 ServletModelAttributeMethodProcessor 和 RequestResponseBodyMethodProcessor 也可以。

只需将 @RequestParam 注解改为 @GamePHP，接口即可同时兼容三种 content-type。

其流程为，spring 启动的时候，MyMvcConfigurer 调用 addArgumentResolvers 方法将 GamePHPMethodProcessor 注入，接到请求时，supportsParameter 方法判断是否使用此法 resolver，如果为 true，则进入 resolveArgument 方法执行。

至此我们可以得出一个结论，PHP 是世界上最垃圾的语言。写代码一时爽，维护火葬场。