文件上传,当前支持在vertx rest通道和servlet rest中使用。

文件上传使用标准的http form格式,可与浏览器的上传直接对接。

Producer:

支持jaxrs和springmvc开发模式

jaxrs开发模式:

  • 支持servlet定义的javax.servlet.http.Part类型

  • 可以直接使用@FormParam传递文件类型及普通参数

springmvc开发模式:

  • 支持servlet定义的javax.servlet.http.Part类型,也支持org.springframework.web.multipart.MultipartFile类型

  • 两种数据类型功能是一致的,MultipartFile的底层也是Part

  • 两种数据类型可以混合使用,比如第一个参数是Part,第二个参数是MultipartFile

  • 可以直接使用@RequestPart传递文件类型及普通参数

注意:

  • 先配置文件上传临时目录,默认为null不支持文件上传,文件上传请求Content-Type必须为multipart/form-data

  • 同名参数只支持一个文件

  • 支持一次传输多个不同参数名的文件

  • 通过MultipartFile或Part打开流后,记得关闭,否则上传的临时文件会无法删除,最终导致上传临时目录被撑爆

Springmvc模式下的代码样例:

  1. @PostMapping(path = "/upload", consumes = MediaType.MULTIPART_FORM_DATA)
  2. public String fileUpload(@RequestPart(name = "file1") MultipartFile file1, @RequestPart(name = "file2") Part file2, @RequestPart String param1) {
  3. ……
  4. }

配置说明:

配置项默认值取值范围含义
servicecomb.uploads.directorynull上传的临时文件保存在哪个目录,默认值null表示不支持文件上传
servicecomb.uploads.maxSize-1http body的最大允许大小,单位byte,默认值-1表示无限制

Consumer:

支持以下数据类型:

  • java.io.File

  • javax.servlet.http.Part

  • java.io.InputStream

  • org.springframework.core.io.Resource

使用InputStream时,因为是流的方式,此时没有客户端文件名的概念,所以producer获取客户端文件名会得到null

如果既要使用内存数据,又想让producer可以获取客户端文件名,可以使用resource类型,继承org.springframework.core.io.ByteArrayResource,且override getFilename即可。

透明RPC代码样例:

  1. interface UploadIntf {
  2. String upload(File file);
  3. }

获得接口引用后,直接调用即可:

  1. String result = uploadIntf.upload(file);

RestTemplate代码样例:

  1. Map<String, Object> map = new HashMap<>();
  2. map.put("file", new FileSystemResource("a file path!"));
  3. map.put("param1", "test");
  4. HttpHeaders headers = new HttpHeaders();
  5. headers.setContentType(org.springframework.http.MediaType.MULTIPART_FORM_DATA);
  6. HttpEntity<Map<String, Object>> entry = new HttpEntity<>(map, headers);
  7. String reseult = template.postForObject(
  8. url,
  9. entry,
  10. String.class);