糞坑-SpringCloud中使用Feign的坑

示例如下：

@FeignClient("service-resource")
//@RequestMapping("/api/test")
public interface TestResourceItg {

   @RequestMapping(value = "/api/test/raw", method = RequestMethod.POST, consumes = "application/x-www-form-urlencoded")
   public String raw1(@PathVariable("subject") String subject, // 标题
                  @RequestParam("content") String content); // 内容

}

 

 

说明：

*使用RequestMapping中的consumes指定生成的请求的Content-Type

*RequestParam指定的参数会拼接在URL之后，如: ?name=xxx&age=18

*PathVariable指定的参数会放到一个LinkedHashMap<String, ?>传入到feign的Encoder中进行处理，而在Spring中实现了该接口的Encoder为SpringEncoder，而该实现又会使用Spring中的HttpMessageConverter进行请求体的写入。

 

 

坑：

*不要在接口类名上使用RequestMapping，虽然可以使用，但同时SpringMVC会把该接口的实例当作Controller开放出去，这个可以在启动的Mapping日志中查看到

*使用默认的SpringEncoder，在不指定consumes时，PathVariable中的参数会生成JSON字符串发送，且默认情况下不支持Form表单的生成方式，原因为:FormHttpMessageConverter只能处理MultiValueMap，而使用PathVariable参数被放在了HashMap中。默认更不支持文件上传。其实已经有支持处理各种情况的HttpMessageConverter存在。

 

填坑：

*支持Form表单提交：只需要编写一个支持Map的FormHttpMessageConverter即可，内部可调用FormHttpMessageConverter的方法简化操作。

*支持文件上传：只需要把要上传的文件封装成一个Resource(该Resource一定要实现filename接口，这个是把请求参数解析成文件的标识)，使用默认的ResourceHttpMessageConverter处理即可。

*支持处理MultipartFile参数：编写一个支持MultipartFile的MultipartFileHttpMessageConverter即可，内部可调用ResourceHttpMessageConverter实现，同时注意需要将其添加至FormHttpMessageConverter的Parts中，并重写FormHttpMessageConverter的getFilename方法支持从MultipartFile中获取filename

*所有的HttpMessageConverter直接以@Bean的方式生成即可，spring会自动识别添加

 

完美支持表单和文件上传：

方案一：

使用附件中的MapFormHttpMessageConverter.java和MultipartFileHttpMessageConverter.java

在Spring中进行如下配置即可

@Bean
public MapFormHttpMessageConverter mapFormHttpMessageConverter(MultipartFileHttpMessageConverter multipartFileHttpMessageConverter) {
   MapFormHttpMessageConverter mapFormHttpMessageConverter = new MapFormHttpMessageConverter();
   mapFormHttpMessageConverter.addPartConverter(multipartFileHttpMessageConverter);
   return mapFormHttpMessageConverter;
}

@Bean
public MultipartFileHttpMessageConverter multipartFileHttpMessageConverter() {
   return new MultipartFileHttpMessageConverter();
}

方案二：

使用FeignSpringFormEncoder.java

在Spring中配置如下：

@Bean
public Encoder feignEncoder(ObjectFactory<HttpMessageConverters> messageConverters) {
   return new FeignSpringFormEncoder(messageConverters);
}

 

推荐使用方案一

方案二为参考https://github.com/pcan/feign-client-test而来，未测

 

 

评论

4 楼 wzmxml 2017-09-01  

楼主你好，有个问题想请教一下。
我使用了你上述的配置，以及对应的MultipartFileHttpMessageConverter
利用resourceHttpMessageConverter将数据写入request，但是调用远程服务的时候报出
the request was rejected because no multipart boundary was found错误。
打印请求头看到的是
POST /image/upload?catalogId={catalogId}&name={name}&userId={userId} HTTP/1.1
Accept: application/json;charset=UTF-8
Content-Type: multipart/form-data
Content-Length: 4814328
想问一下楼主有遇到类似的问题吗？
@RequestMapping(value = "/image/upload", method = RequestMethod.POST, produces = {
MediaType.APPLICATION_JSON_UTF8_VALUE }, consumes =MediaType.MULTIPART_FORM_DATA_VALUE)
public void upload(@RequestPart("file") MultipartFile file,
@RequestParam("catalogId") Integer catalogId, @RequestParam("name") String name,@RequestParam("userId") Integer userId);
feign client 我是这样添加的，是因为注解的问题么？？ 看楼主的form表单貌似是以map提交的，不知是feign自动转成map的嘛？  如果是，那RequestParam里的值如何对应到？？
还请不吝赐教，谢谢

3 楼 b_l_east 2017-08-22  

如若_晴 写道

急求答案,
楼主你好，我用springcloud 上传文件时，按照你的配置发送请求，结果一直报错：
Could not write request: no suitable HttpMessageConverter found for request type [org.springframework.web.multipart.support.StandardMultipartHttpServletRequest$StandardMultipartFile] and content type [multipart/form-data]，我的Feign接口是这样的：
@RequestMapping(value = CGIConstants.ToolsApi.AGENT_FILE_UPLOAD, method = RequestMethod.POST ,consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    PolicyLoanStoreResponse agentFileUpload(@RequestParam(value = "store_state")Integer storeState,@RequestPart(value = "upload_file")MultipartFile file);

前端用ajax请求的，请问是怎么回事呢，还要在哪定义个HttpMessageConverter吗

不好意思，基本不看博客
建议你前后端分开测试一下，先使用postman对你的后端发请求，如果能上传成功，那说明是你前端设置错误，如果上传不成功，那就需要先修复后端了。
目前这部分我重新整理了一份放在github上:https://github.com/elvis9xu163/component-utils
使用很简单，只需要配置:
@Bean
public MapFormHttpMessageConverter mapFormHttpMessageConverter() {
return new MapFormHttpMessageConverter();
}
即可。另外：
@Bean
public RestTemplate restTemplate() {
return new AllEncompassingRestTemplate();
}
可以支持RestTemplate上传MultipartFile，且支持中文名文件上传

2 楼 紫水兰 2017-07-05  

如若_晴 写道

急求答案,
楼主你好，我用springcloud 上传文件时，按照你的配置发送请求，结果一直报错：
Could not write request: no suitable HttpMessageConverter found for request type [org.springframework.web.multipart.support.StandardMultipartHttpServletRequest$StandardMultipartFile] and content type [multipart/form-data]，我的Feign接口是这样的：
@RequestMapping(value = CGIConstants.ToolsApi.AGENT_FILE_UPLOAD, method = RequestMethod.POST ,consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    PolicyLoanStoreResponse agentFileUpload(@RequestParam(value = "store_state")Integer storeState,@RequestPart(value = "upload_file")MultipartFile file);

前端用ajax请求的，请问是怎么回事呢，还要在哪定义个HttpMessageConverter吗

1 楼 如若_晴 2017-06-28  

急求答案,
楼主你好，我用springcloud 上传文件时，按照你的配置发送请求，结果一直报错：
Could not write request: no suitable HttpMessageConverter found for request type [org.springframework.web.multipart.support.StandardMultipartHttpServletRequest$StandardMultipartFile] and content type [multipart/form-data]，我的Feign接口是这样的：
@RequestMapping(value = CGIConstants.ToolsApi.AGENT_FILE_UPLOAD, method = RequestMethod.POST ,consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    PolicyLoanStoreResponse agentFileUpload(@RequestParam(value = "store_state")Integer storeState,@RequestPart(value = "upload_file")MultipartFile file);

前端用ajax请求的，请问是怎么回事呢，还要在哪定义个HttpMessageConverter吗