Spring Boot 一個接口同時支援 form 表單、form-data、json 優雅寫法

網上很多代碼都是千篇一律的 cvs，相信我隻要你認真看完我寫的這篇，你就可以完全掌握這個知識點，這篇文章不适合直接 cvs，一定要先了解。

最近重寫個項目遇到個比較棘手的問題，老項目是 PHP 接口，這個接口同時相容 POST json 和 form 表單，更騷的是連 form-data 也相容。。。因為寫 PHP 請求的對接方代碼不嚴謹。

而在 Java 中，一個接口隻支援一種 content-type，json 就用 @RequestBody，form 表單就用 @RequestParam 或不寫，form-data 就用 MultipartFile。

相容版本

如果要把在一個接口中同時相容三種，比較笨的辦法就是擷取 HttpServletRequest，然後自己再寫方法解析。類似如下：

private Map<String, Object> getParams(HttpServletRequest request) {

    String contentType = request.getContentType();
    if (contentType.contains("application/json")) {
        // json 解析...
        return null;
    } else if (contentType.contains("application/x-www-form-urlencoded")) {
        // form 表單解析 ...
        return null;
    } else if (contentType.contains("multipart")) {
        // 檔案流解析
        return null;
    } else {
         throw new BizException("不支援的content-type");
    } 

}
           

但是這樣寫有弊端

• 代碼很醜，具體到解析代碼又臭又長
• 隻能傳回固定 map 或者自己重新組裝參數類
• 無法使用 @Valid 校驗參數，像我這種幾十個參數都要檢驗的簡直是災難

優雅版本

網上有 form 表單和 json 同時相容的版本，但是沒有相容 form-data，我在這做一下補充。

1. 自定義注解

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface GamePHP {
}
           

2. 自定義注解解析

public class GamePHPMethodProcessor implements HandlerMethodArgumentResolver {

    private GameFormMethodArgumentResolver formResolver;
    private GameJsonMethodArgumentResolver jsonResolver;

    public GamePHPMethodProcessor() {
        List<HttpMessageConverter<?>> messageConverters = new ArrayList<>();
        PHPMessageConverter PHPMessageConverter = new PHPMessageConverter();
        messageConverters.add(PHPMessageConverter);

        jsonResolver = new GameJsonMethodArgumentResolver(messageConverters);
        formResolver = new GameFormMethodArgumentResolver();
    }

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        GamePHP ann = parameter.getParameterAnnotation(GamePHP.class);
        return (ann != null);
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
        ServletRequest servletRequest = nativeWebRequest.getNativeRequest(ServletRequest.class);
        String contentType = servletRequest.getContentType();
        if (contentType == null) {
            throw new IllegalArgumentException("不支援contentType");
        }

        if (contentType.contains("application/json")) {
            return jsonResolver.resolveArgument(methodParameter, modelAndViewContainer, nativeWebRequest, webDataBinderFactory);
        }

        if (contentType.contains("application/x-www-form-urlencoded")) {
            return formResolver.resolveArgument(methodParameter, modelAndViewContainer, nativeWebRequest, webDataBinderFactory);
        }

        if (contentType.contains("multipart")) {
            return formResolver.resolveArgument(methodParameter, modelAndViewContainer, nativeWebRequest, webDataBinderFactory);
        }

        throw new IllegalArgumentException("不支援contentType");
    }
}
           

3. 添加到 spring configuration

@Bean
    public MyMvcConfigurer mvcConfigurer() {
        return new MyMvcConfigurer();
    }

    public static class MyMvcConfigurer implements WebMvcConfigurer {
        public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
            resolvers.add(new GamePHPMethodProcessor());
        }
    }
           

4. form-data 的特殊處理

引入 jar 包

<dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.3.1</version>
    </dependency>
    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>2.4</version>
    </dependency>
           

新增解析 bean

@Bean(name = "multipartResolver")
public MultipartResolver multipartResolver(){
    CommonsMultipartResolver resolver = new CommonsMultipartResolver();
    resolver.setDefaultEncoding("UTF-8");
    resolver.setResolveLazily(true);//resolveLazily屬性啟用是為了推遲檔案解析，以在在UploadAction中捕獲檔案大小異常
    resolver.setMaxInMemorySize(40960);
    resolver.setMaxUploadSize(50*1024*1024);//上傳檔案大小 50M 50*1024*1024
    return resolver;
}
           

特殊說明，GameJsonMethodArgumentResolver 和 GameFormMethodArgumentResolver 是我們自定義的 json 和 form 解析，如果你沒有自定義的，使用 spring 預設的 ServletModelAttributeMethodProcessor 和 RequestResponseBodyMethodProcessor 也可以。

隻需将 @RequestParam 注解改為 @GamePHP，接口即可同時相容三種 content-type。

其流程為，spring 啟動的時候，MyMvcConfigurer 調用 addArgumentResolvers 方法将 GamePHPMethodProcessor 注入，接到請求時，supportsParameter 方法判斷是否使用此 resolver，如果為 true，則進入 resolveArgument 方法執行。