spring cloud feign上传文件

2019年12月11日 panlobal编写第1版
有任何意见和建议，请反馈给我；我会继续优化该文章。

成果展示

系统环境

本篇文章中环境：spring boot 1.5.4.RELEASE 、spring cloud Dalston.SR4 ；
整个实现过程中，遇到了1个坑，在文中也标出并给出的解决方案（大家若未遇到，请跳过）

1.添加依赖

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

在pom.xml中，添加依赖

    <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>
    <dependency>
        <groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.3.3</version>
    </dependency>

2.编写Feign Client

@FeignClient(value = "file-service",configuration = FileRemoteClient.MultipartSupportConfig.class)
public interface FileRemoteClient {

@PostMapping(value = "/files/fileupload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public String fileupload(@RequestPart("file") MultipartFile file);

class MultipartSupportConfig {
        @Bean
        public Encoder feignFormEncoder() {
            return new SpringFormEncoder();
        }
        @Bean 
        Logger.Level feignLoggerLevel() {
            return Logger.Level.FULL;
        }
    }

}

如代码所示，在这个Feign Client中，我们引用了配置类MultipartSupportConfig ，在MultipartSupportConfig 中，我们实例化了SpringFormEncoder 。这样这个Feign Client就能够上传啦。

@PostMapping(value = "/files/fileupload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)

注意点:
1).接口定义中的consumes 不能少；
2).接口定义中的注解@RequestPart("file") 不能写成@RequestParam("file")
3).最好将Hystrix的超时时间设长一点，例如5秒，否则可能文件还没上传完，Hystrix就超时了，从而导致客户端侧的报错。

3. 调用Feign接口

先实例化：

@Autowired 
private FileRemoteClient fileRemoteClient;

再调用，此处涉及到File转FileItem，再转成MultipartFile：

File file = new File(fileName);
FileItem fileItem = createFileItem(file.getPath(),file.getName());  
MultipartFile multipartFile = new CommonsMultipartFile(fileItem);   
log.info("multipartFile的值为：" + multipartFile);

//上传到文件服务器，获得二维码图片URL
String str= fileRemoteClient.fileupload(multipartFile);
log.info("上传到文件服务器，获得二维码图片URL，返回结果:" + str);

解释下，createFileItem函数，将File转成FileItem，具体的代码如下：

//创建FileItem
public static FileItem createFileItem(String filePath,String fileName){
    String fieldName = "file";
    FileItemFactory factory = new DiskFileItemFactory(16, null);
    FileItem item = factory.createItem(fieldName, "text/plain", false,fileName);
    File newfile = new File(filePath);
    int bytesRead = 0;
    byte[] buffer = new byte[8192];
    try
    {
        FileInputStream fis = new FileInputStream(newfile);
        OutputStream os = item.getOutputStream();
        while ((bytesRead = fis.read(buffer, 0, 8192))!= -1)
        {
            os.write(buffer, 0, bytesRead);
        }
        os.close();
        fis.close();
    }
    catch (IOException e)
    {
        e.printStackTrace();
    }
    return item;
}

此处，我遇到的坑1：
file-service微服务中，报错：Required request part 'file' is not present
原因：这个 file 是代码中参数的名字，调用接口没有指定该参数名；在创建FileItem函数中，缺少代码：String fieldName = "file";

代码运行结果：

最后编辑于：2019.12.11 19:23:54