最近經常有人問Spring Cloud Feign如何上傳文件。有團隊的新成員，也有其他公司的兄弟。本文簡單做個總結——
早期的Spring Cloud中，Feign本身是沒有上傳文件的能力的（1年之前），要想實現這一點，需要自己去編寫Encoder 去實現上傳?，F在我們幸福了很多。因為Feign官方提供了子項目feign-form ，其中實現了上傳所需的 Encoder 。
注：筆者測試的版本是Edgware.RELEASE。Camden、Dalston同樣適應本文所述。
加依賴
|
1
2
3
4
5
6
7
8
9
10
|
<dependency> <groupId>io.github.openfeign.form</groupId> <artifactId>feign-form</artifactId> <version>3.0.3</version></dependency><dependency> <groupId>io.github.openfeign.form</groupId> <artifactId>feign-form-spring</artifactId> <version>3.0.3</version></dependency> |
編寫Feign Client
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
@FeignClient(name = "ms-content-sample", configuration = UploadFeignClient.MultipartSupportConfig.class)public interface UploadFeignClient { @RequestMapping(value = "/upload", method = RequestMethod.POST, produces = {MediaType.APPLICATION_JSON_UTF8_VALUE}, consumes = MediaType.MULTIPART_FORM_DATA_VALUE) @ResponseBody String handleFileUpload(@RequestPart(value = "file") MultipartFile file); class MultipartSupportConfig { @Bean public Encoder feignFormEncoder() { return new SpringFormEncoder(); } }} |
如代碼所示，在這個Feign Client中，我們引用了配置類MultipartSupportConfig ，在MultipartSupportConfig 中，我們實例化了SpringFormEncoder 。這樣這個Feign Client就能夠上傳啦。
注意點
|
1
2
3
4
|
@RequestMapping(value = "/upload", method = RequestMethod.POST, produces = {MediaType.APPLICATION_JSON_UTF8_VALUE}, consumes = MediaType.MULTIPART_FORM_DATA_VALUE)中的produeces 、consumes 不能少； |
接口定義中的注解@RequestPart(value = "file") 不能寫成@RequestParam(value = "file" 。
最好將Hystrix的超時時間設長一點，例如5秒，否則可能文件還沒上傳完，Hystrix就超時了，從而導致客戶端側的報錯。
SpringCloud中使用Feign的坑
示例如下：
|
1
2
3
4
5
6
7
8
9
|
@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中進行如下配置即可
|
1
2
3
4
5
6
7
8
9
10
11
|
@Beanpublic MapFormHttpMessageConverter mapFormHttpMessageConverter(MultipartFileHttpMessageConverter multipartFileHttpMessageConverter) { MapFormHttpMessageConverter mapFormHttpMessageConverter = new MapFormHttpMessageConverter(); mapFormHttpMessageConverter.addPartConverter(multipartFileHttpMessageConverter); return mapFormHttpMessageConverter;}@Beanpublic MultipartFileHttpMessageConverter multipartFileHttpMessageConverter() { return new MultipartFileHttpMessageConverter();} |
方案二：
使用FeignSpringFormEncoder.java
在Spring中配置如下：
|
1
2
3
4
|
@Beanpublic Encoder feignEncoder(ObjectFactory<HttpMessageConverters> messageConverters) { return new FeignSpringFormEncoder(messageConverters);} |
推薦使用方案一
方案二為參考https://github.com/pcan/feign-client-test而來，未測
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：http://www.itmuch.com/spring-cloud-sum/spring-cloud-feign-upload/
