注释类型 DataFile


文件参数注解

在上传文件内容时使用,被该注解修饰的方法参数会被表示为一个文件

该注解可以修饰一下几种类型的参数:

(1) 字符串类型:

     void upload(@DataFile("file") String filePath);
     
当该注解修饰的参数为字符串类型时,此参数表示为要上传的文件的路径。 此时该注解的 fileName 参数可以省略。如若省略fileName,上传的文件名默认为文件路径中对应的文件名。

(2) File 类型对象:

     void upload(@DataFile("file") File file);
     
当该注解修饰的参数为File类型对象时,此参数表示为要上传的文件对象 此时该注解的 fileName 参数可以省略。如若省略fileName,上传的文件名默认为File对象中对应的文件名。

(3) byte数组:

     void upload(@DataFile(value = "file", fileName = "xxx.jpg") byte[] bytes);
     
当该注解修饰的参数为byte数组时,此参数表示为要上传的文件二进制字节数组 此时该注解的 fileName 参数不能省略,必须指定要上传的文件名。

(4) InputStream 对象:

     void upload(@DataFile(value = "file", fileName = "xxx.jpg") InputStream in);
     
当该注解修饰的参数为InputStream对象时,此参数表示为要上传的文件流数据流 此时该注解的 fileName 参数不能省略,必须指定要上传的文件名。

(5) Spring Web MVC 中的 MultipartFile 对象:

     void upload(@DataFile(value = "file") MultipartFile multipartFile);
     
当该注解修饰的参数为MultipartFile对象时,此参数表示为要上传的文件对象。 此时该注解的 fileName 参数可以省略。如若省略fileName,上传的文件名默认为MultipartFile对象中对应的文件名。

(6) Spring 的 Resource 对象:

     void upload(@DataFile(value = "file") Resource resource);
     
当该注解修饰的参数为Resource对象时,此参数表示为要上传的文件对象。 此时该注解的 fileName 参数可以省略。如若省略fileName,上传的文件名默认为Resource对象中对应的文件名。
从以下版本开始:
2020-07-26 16:40
作者:
gongjun
  • 必需元素概要

    所需元素
    修饰符和类型
    必需的元素
    说明
    Multipart类型请求体中,要上传的文件所对应的参数名
  • 可选元素概要

    可选元素
    修饰符和类型
    可选元素
    说明
    要上传的文件的目标文件名(可省略)
    子项Content-Type
  • 元素详细资料

    • value

      String value
      Multipart类型请求体中,要上传的文件所对应的参数名
      返回:
      参数名
    • fileName

      String fileName
      要上传的文件的目标文件名(可省略)
      返回:
      目标文件名
      默认值:
      ""
    • partContentType

      String partContentType
      子项Content-Type
      返回:
      子项Content-Type
      默认值:
      ""