使用Spring Cloud Feign上传文件

最近经常有人问Spring Cloud Feign如何上传文件。有团队的新成员，也有其他公司的兄弟。本文简单做个总结——

早期的Spring Cloud中，Feign本身是没有上传文件的能力的（1年之前），要想实现这一点，需要自己去编写Encoder 去实现上传。现在我们幸福了很多。因为Feign官方提供了子项目feign-form (opens new window) ，其中实现了上传所需的 Encoder 。

注：笔者测试的版本是Edgware.RELEASE。Camden、Dalston同样适应本文所述。

加依赖

<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

@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就能够上传啦。

注意点

• @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就超时了，从而导致客户端侧的报错。