当前位置: 开发笔记 > 前端 > 正文

使用Feign扩展包实现微服务间文件上传

作者：手机用户2502873393 | 来源：互联网 | 2022-04-25 12:32

在Spring Cloud 的Feign组件中并不支持文件的传输，会出现这样的错误提示： feign.codec.EncodeEx

在Spring Cloud 的Feign组件中并不支持文件的传输，会出现这样的错误提示：

feign.codec.EncodeException: class [Lorg.springframework.web.multipart.MultipartFile; is not a type supported by this encoder.
  at feign.codec.Encoder$Default.encode(Encoder.java:90) ~[feign-core-9.5.1.jar:na]
  at feign.form.FormEncoder.encode(FormEncoder.java:87) ~[feign-form-3.3.0.jar:3.3.0]
  at feign.form.spring.SpringFormEncoder.encode(SpringFormEncoder.java:64) ~[feign-form-spring-3.3.0.jar:3.3.0]

但是我们可以通过使用Feign的扩展包实现这个功能。

一. 示例介绍

我们调用feign_upload_second的上传文件接口上传文件，feign_upload_second内部使用feign调用feign_upload_first实现文件上传。

二、单文件上传

2.1 feign_upload_first服务提供者

文件上传的服务提供者接口比较简单，如下所示：

@SpringBootApplication
public class FeignUploadFirstApplication {
 @RestController
 public class UploadController {

  @RequestMapping(value = "/uploadFile",method = RequestMethod.POST, cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
  public String handleFileUpload(@RequestPart(value = "file") MultipartFile file) {
   return file.getOriginalFilename();
  }
 }
 public static void main(String[] args) {
  SpringApplication.run(FeignUploadFirstApplication.class, args);
 }
}

2.2 feign_upload_second服务消费者

增加扩展包依赖


   io.github.openfeign.form
   feign-form
   3.3.0
  
  
   io.github.openfeign.form
   feign-form-spring
   3.3.0
  
  
   commons-fileupload
   commons-fileupload
   1.3.3

新增feign实现文件上传的配置类

@Configuration
public class FeignSupportConfig {
 @Bean
 public Encoder feignFormEncoder() {
  return new SpringFormEncoder();
 }
}

feign远程调用接口

@FeignClient(name = "file",url = "http://localhost:8100",cOnfiguration= FeignSupportConfig.class)
public interface UploadService {
 @RequestMapping(value = "/uploadFile", cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
 String handleFileUpload(@RequestPart(value = "file") MultipartFile file);
}

上传文件接口

@RestController
public class UploadController {
 @Autowired
 UploadService uploadService;

 @RequestMapping(value = "/uploadFile",method = RequestMethod.POST, cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
 public String handleFileUpload(@RequestPart(value = "file") MultipartFile file) {
  return uploadService.handleFileUpload(file);
 }
}

2.3 测试

使用postman进行测试，可以正常上传文件

三、多文件上传

既然单个文件可以上传，那么多文件应该也没问题吧，我们对上面的代码进行修改

3.1 feign_upload_first服务提供者

文件上传的服务提供者接口比较简单，如下所示：

@SpringBootApplication
public class FeignUploadFirstApplication {
 @RestController
 public class UploadController {

  @RequestMapping(value = "/uploadFile",method = RequestMethod.POST, cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
  public String handleFileUpload(@RequestPart(value = "file") MultipartFile file) {
   return file.getOriginalFilename();
  }

  @RequestMapping(value = "/uploadFile2",method = RequestMethod.POST, cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
  public String handleFileUpload(@RequestPart(value = "file") MultipartFile[] file) {
   String fileName = "";
   for(MultipartFile f : file){
    fileName += f.getOriginalFilename()+"---";
   }
   return fileName;
  }
 }
 public static void main(String[] args) {
  SpringApplication.run(FeignUploadFirstApplication.class, args);
 }
}

3.2 feign_upload_second服务消费者

feign远程调用接口

@FeignClient(name = "file",url = "http://localhost:8100",cOnfiguration= FeignSupportConfig.class)
public interface UploadService {
 @RequestMapping(value = "/uploadFile", cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
 String handleFileUpload(@RequestPart(value = "file") MultipartFile file);

 @RequestMapping(value = "/uploadFile2", cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
 String handleFileUpload(@RequestPart(value = "file") MultipartFile[] file);
}

上传文件接口

@RestController
public class UploadController {
 @Autowired
 UploadService uploadService;

 @RequestMapping(value = "/uploadFile",method = RequestMethod.POST, cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
 public String handleFileUpload(@RequestPart(value = "file") MultipartFile file) {
  return uploadService.handleFileUpload(file);
 }

 @RequestMapping(value = "/uploadFile2",method = RequestMethod.POST, cOnsumes= MediaType.MULTIPART_FORM_DATA_VALUE)
 public String handleFileUpload2(@RequestPart(value = "file") MultipartFile[] file) {
  return uploadService.handleFileUpload(file);
 }
}

3.3 测试

经过测试发现，无法上传多个文件。经过检查，发现源码里底层是有对MultipartFile[]类型的支持的，源码中有个类叫SpringManyMultipartFilesWriter，是专门针对文件数组类型进行操作的，但是配置到项目里的SpringFormEncoder类里却没有对文件数组类型的判断，以致不能支持文件数组的上传

SpringManyMultipartFilesWriter源码

public class SpringManyMultipartFilesWriter extends AbstractWriter {
 private final SpringSingleMultipartFileWriter fileWriter = new SpringSingleMultipartFileWriter();

 public SpringManyMultipartFilesWriter() {
 }

 public void write(Output output, String boundary, String key, Object value) throws Exception {
  if (value instanceof MultipartFile[]) {
   MultipartFile[] files = (MultipartFile[])((MultipartFile[])value);
   MultipartFile[] var6 = files;
   int var7 = files.length;

   for(int var8 = 0; var8  iterable = (Iterable)value;
   Iterator var11 = iterable.iterator();

   while(var11.hasNext()) {
    Object file = var11.next();
    this.fileWriter.write(output, boundary, key, file);
   }
  }

 }

 public boolean isApplicable(Object value) {
  if (value == null) {
   return false;
  } else if (value instanceof MultipartFile[]) {
   return true;
  } else {
   if (value instanceof Iterable) {
    Iterable<&＃63;> iterable = (Iterable)value;
    Iterator<&＃63;> iterator = iterable.iterator();
    if (iterator.hasNext() && iterator.next() instanceof MultipartFile) {
     return true;
    }
   }

   return false;
  }
 }
}

SpringFormEncoder源码

public class SpringFormEncoder extends FormEncoder {
 public SpringFormEncoder() {
  this(new Default());
 }

 public SpringFormEncoder(Encoder delegate) {
  super(delegate);
  MultipartFormContentProcessor processor = (MultipartFormContentProcessor)this.getContentProcessor(ContentType.MULTIPART);
  processor.addWriter(new SpringSingleMultipartFileWriter());
  processor.addWriter(new SpringManyMultipartFilesWriter());
 }

 public void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {
  if (!bodyType.equals(MultipartFile.class)) {
   super.encode(object, bodyType, template);
  } else {
   MultipartFile file = (MultipartFile)object;
   Map data = Collections.singletonMap(file.getName(), object);
   super.encode(data, MAP_STRING_WILDCARD, template);
  }
 }
}

从上面SpringFormEncoder的源码上可以看到SpringFormEncoder类构造时把SpringManyMultipartFilesWriter实例添加到了处理器列表里了，但是在encode方法里又只判断了MultipartFile类型，没有判断数组类型，底层有对数组的支持但上层却缺少了相应判断。那么我们可以自己去扩展FormEncoder，仿照SpringFormEncoder源码，只修改encode方法。

3.3 扩展FormEncoder支持多文件上传

扩展FormEncoder,命名为FeignSpringFormEncoder

public class FeignSpringFormEncoder extends FormEncoder {
 /**
  * Constructor with the default Feign's encoder as a delegate.
  */
 public FeignSpringFormEncoder() {
  this(new Default());
 }


 /**
  * Constructor with specified delegate encoder.
  *
  * @param delegate delegate encoder, if this encoder couldn't encode object.
  */
 public FeignSpringFormEncoder(Encoder delegate) {
  super(delegate);

  MultipartFormContentProcessor processor = (MultipartFormContentProcessor) getContentProcessor(ContentType.MULTIPART);
  processor.addWriter(new SpringSingleMultipartFileWriter());
  processor.addWriter(new SpringManyMultipartFilesWriter());
 }


 @Override
 public void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {
  if (bodyType.equals(MultipartFile.class)) {
   MultipartFile file = (MultipartFile) object;
   Map data = Collections.singletonMap(file.getName(), object);
   super.encode(data, MAP_STRING_WILDCARD, template);
   return;
  } else if (bodyType.equals(MultipartFile[].class)) {
   MultipartFile[] file = (MultipartFile[]) object;
   if(file != null) {
    Map data = Collections.singletonMap(file.length == 0 &＃63; "" : file[0].getName(), object);
    super.encode(data, MAP_STRING_WILDCARD, template);
    return;
   }
  }
  super.encode(object, bodyType, template);
 }
}

注册配置类

@Configuration
public class FeignSupportConfig {
 @Bean
 public Encoder feignFormEncoder() {
  return new FeignSpringFormEncoder();
 }
}

经过测试可以上传多个文件。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

git
postman

推荐阅读

overflow
实用浏览器插件与高效工具推荐

本文旨在介绍一系列提升工作效率的浏览器插件和实用小工具，帮助用户在日常工作中更加便捷高效。内容由原作者授权发布。 ... [详细]

蜡笔小新 2024-11-26 10:10:09
postman
常用开发工具概览

本文介绍了多种常用的开发工具，包括PyCharm、Appium、Jenkins、Postman、Fiddler、Charles、Airtest、Android Studio、Navicat和Typora，并提供了它们的基本使用方法。 ... [详细]

蜡笔小新 2024-11-16 14:39:15
postman
数据结构与算法：HyperLogLog 统计、布隆过滤器应用、缓存机制挑战及解决方案、Redis 性能优化与监控、哨兵模式、版本控制工具 Git

本文探讨了数据结构与算法在实际应用中的多个方面。首先介绍了HyperLogLog算法，用于高效地进行基数统计，能够准确估算大规模数据集中的唯一元素数量。接着讨论了布隆过滤器的应用，该过滤器在空间效率和查询速度上具有显著优势，适用于大数据场景下的快速成员检测。此外，文章分析了缓存机制面临的挑战及其解决方案，包括LRU和LFU等策略，并详细阐述了Redis的性能优化与监控方法，如使用哨兵模式实现高可用性。最后，介绍了版本控制工具Git的基本操作和最佳实践，帮助开发者有效管理代码版本。 ... [详细]

蜡笔小新 2024-10-30 16:23:50
dom
Fast Request v1.1.4 发布，基于 IDEA 的 Postman 插件，优化了诸多交互

FastRequest1.1.4正式发布，优化了诸多操作的交互和用户体验,更新内容如下：curlsupport(支持curl拷贝)supportaddparamstoheaderfrom(支持了将参数从response添加到header)supportprettyandraw ... [详细]

蜡笔小新 2024-10-19 11:29:46
dom
如何利用Sitecore API密钥进行项目检索

本文探讨了如何在Sitecore 9环境中通过Postman使用API密钥发送请求，包括解决常见错误的方法。 ... [详细]

蜡笔小新 2024-11-25 09:44:38
postman
软件测试行业深度解析：迈向高薪的必经之路

本文深入探讨了软件测试行业的发展现状及未来趋势，旨在帮助有志于在该领域取得高薪的技术人员明确职业方向和发展路径。 ... [详细]

蜡笔小新 2024-11-21 17:32:44
postman
如何将PostMan接口脚本快速集成至JMeter进行压力测试

本文详细介绍了如何将PostMan中的接口脚本快速迁移至JMeter中，以实现高效的压力测试。适合希望利用现有PostMan资源进行性能测试的技术人员。 ... [详细]

蜡笔小新 2024-11-18 20:55:41
上传
使用Postman构建API请求

本文介绍了如何使用Postman构建和发送HTTP请求，包括四个主要部分：方法（Method）、URL、头部（Headers）和主体（Body）。特别强调了Body部分的重要性，并详细说明了不同类型的请求体。 ... [详细]

蜡笔小新 2024-11-15 13:35:01
上传
20款必备PS插件免费大放送，附详细安装指南

对于众多关注小资源并学习PS的用户来说，每次分享设计素材都会收到大量反馈。为了更好地满足大家的需求，今天我们特别推出了20款必备的PS插件大合集，并附有详细的安装指南，确保每位用户都能轻松上手，提升设计效率。 ... [详细]

蜡笔小新 2024-11-11 22:08:49
js
利用爬虫技术抓取数据，结合Fiddler与Postman在Chrome中的应用优化提交流程

本文探讨了如何利用爬虫技术抓取目标网站的数据，并结合Fiddler和Postman工具在Chrome浏览器中的应用，优化数据提交流程。通过详细的抓包分析和模拟提交，有效提升了数据抓取的效率和准确性。此外，文章还介绍了如何使用这些工具进行调试和优化，为开发者提供了实用的操作指南。 ... [详细]

蜡笔小新 2024-11-09 09:05:16
postman
深入解析Postman内置变量的实用技巧与示例代码

本文详细探讨了Postman内置变量的实用技巧和应用案例，通过具体的示例代码，全面解析了这些变量在实际开发和测试中的使用方法，为读者提供了宝贵的学习和参考资源。 ... [详细]

蜡笔小新 2024-11-06 17:07:34
html
Spring Boot 参数处理与请求转发：深入探讨RESTful风格下的表单请求解决方案（学习笔记）

本文深入探讨了在Spring Boot中处理RESTful风格的表单请求的方法，包括请求参数处理、请求映射以及RESTful设计原则的应用。文章详细介绍了如何利用HTTP动词（如GET、POST、PUT、DELETE）来操作资源，并结合Spring Boot的注解（如@GetMapping、@PostMapping等）实现高效、清晰的请求处理逻辑。通过实例分析，展示了如何在实际项目中应用这些技术，提高开发效率和代码可维护性。 ... [详细]

蜡笔小新 2024-11-04 16:05:50
postman
Spring Boot 实战（一）：基础的CRUD操作详解

在《Spring Boot 实战（一）》中，详细介绍了基础的CRUD操作，涵盖创建、读取、更新和删除等核心功能，适合初学者快速掌握Spring Boot框架的应用开发技巧。 ... [详细]

蜡笔小新 2024-10-31 21:03:29
js
全面解析：安检利器的高效应用与技术特点

全面解析：安检利器的高效应用与技术特点 ... [详细]

蜡笔小新 2024-10-25 18:04:07
postman
postman使用教程6引用随机变量

前言在接口测试中，有些接口的请求参数具有唯一性，比如注册接口，注册一个账号后就不能重复注册了。为了能重复执行这个接口，可以 ... [详细]

蜡笔小新 2024-10-19 17:57:33

手机用户2502873393

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章