Java中的MultipartFile接口和File类

已于 2024-05-31 16:14:33 修改
阅读量1.9k 收藏 22
点赞数 13
文章标签： java 开发语言
于 2024-05-23 18:27:55 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_78992368/article/details/139153435
版权

一、File类

java.io.File是 Java 标准库中用于操作文件和目录路径的类。它提供了很多方法，用于创建、删除、重命名、判断文件是否存在、获取文件信息等操作。

获取文件信息

boolean exists(): 判断文件或目录是否存在。
boolean isFile(): 判断是否是文件。
boolean isDirectory(): 判断是否是目录。
String getName(): 获取文件或目录的名称。
String getPath(): 获取文件或目录的路径。
String getAbsolutePath(): 获取文件或目录的绝对路径。
long length(): 获取文件的大小（字节数）。
文件和目录操作

boolean createNewFile(): 创建新文件。如果文件已存在，则不创建，返回 false。
boolean mkdir(): 创建新目录。如果目录已存在，则不创建，返回 false。
boolean mkdirs(): 创建新目录及其父目录，如果不存在的话。
boolean delete(): 删除文件或目录。
文件路径操作

boolean renameTo(File dest): 重命名文件或目录。如果成功，返回 true；否则，返回 false。
String[] list(): 返回目录下的文件和目录名数组。
File[] listFiles(): 返回目录下的文件和目录的 File 对象数组。
文件过滤

String[] list(FilenameFilter filter): 返回目录下满足指定过滤器条件的文件和目录名数组。
File[] listFiles(FileFilter filter): 返回目录下满足指定过滤器条件的文件和目录的 File 对象数组。

 二、MultipartFile接口

MultipartFile是 Spring 框架提供的一个接口，用于表示处理文件上传的对象。它通常用于处理multipart/form-data类型的请求，例如处理文件上传的表单。首先我们依旧可以通过源码的学习来进一步了解这个接口。

2.1 源码和方法功能 

public interface MultipartFile extends InputStreamSource {
    String getName();
 
    @Nullable
    String getOriginalFilename();
 
    @Nullable
    String getContentType();
 
    boolean isEmpty();
 
    long getSize();
 
    byte[] getBytes() throws IOException;
 
    InputStream getInputStream() throws IOException;
 
    default Resource getResource() {
        return new MultipartFileResource(this);
    }
 
    void transferTo(File dest) throws IOException, IllegalStateException;
 
    default void transferTo(Path dest) throws IOException, IllegalStateException {
        FileCopyUtils.copy(this.getInputStream(), Files.newOutputStream(dest));
    }
}

String getName()：获取上传文件的表单字段名称
String getOriginalFilename()：获取上传文件的原始文件名
String getContentType()：获取上传文件的内容类型
boolean isEmpty()：判断上传文件是否为空
long getSize()：获取上传文件的大小，单位是字节
byte[] getBytes() throws IOException：获取上传文件的字节数组表示
InputStream getInputStream() throws IOException：获取上传文件的输入流
default Resource getResource() ：将 MultipartFile 封装成了 Resource 对象，从而可以使用 Resource 接口提供的方法来操作上传文件的内容。
void transferTo(File dest) throws IOException, IllegalStateException：将上传文件保存到指定的文件；
default void transferTo(Path dest) throws IOException, IllegalStateException ：将上传文件保存在指定的路径下；

2.2 void transferTo(File dest)

前面我们已经介绍了该方法是Spring中提供的将上传文件保存到指定的文件中的抽象方法，溯源源码我们可以看到这个接口方法被三个实现类实现了，分别是CommonsMultipartFile、MockMultipartFile 和 StandardMultipartHttpServletRequest。

CommonsMultipartFile中的方法体

我们可以看到CommonsMultipartFile中的方法体主要是通过检测传进来的文件是否可用、是否存在，并在检测完成就执行写入的操作

public void transferTo(File dest) throws IOException, IllegalStateException {
        if (!this.isAvailable()) {
            throw new IllegalStateException("File has already been moved - cannot be transferred again");
        } else if (dest.exists() && !dest.delete()) {
            throw new IOException("Destination file [" + dest.getAbsolutePath() + "] already exists and could not be deleted");
        } else {
            try {
                this.fileItem.write(dest);
                LogFormatUtils.traceDebug(logger, (traceOn) -> {
                    String action = "transferred";
                    if (!this.fileItem.isInMemory()) {
                        action = this.isAvailable() ? "copied" : "moved";
                    }
 
                    return "Part '" + this.getName() + "',  filename '" + this.getOriginalFilename() + "'" + (traceOn ? ", stored " + this.getStorageDescription() : "") + ": " + action + " to [" + dest.getAbsolutePath() + "]";
                });
            } catch (FileUploadException var3) {
                throw new IllegalStateException(var3.getMessage(), var3);
            } catch (IOException | IllegalStateException var4) {
                throw var4;
            } catch (Exception var5) {
                throw new IOException("File transfer failed", var5);
            }
        }
    }

上面这段demo中可能对于this.isAvailable()有疑问，我们知晓这里的this其实是该类的实例化对象，但是这里的this.isAvailable()就是拿来判断目的文件是否可用，调用的就是类的内部方法，判断是否可用的条件就是该目标文件是否被加载进内存中！

这里给出一个使用该方法的例子，需要注意的是这时候方法要求的是一个目标File对象，我们需要在调用该目标方法的时候就根据目标路径创建了目标的File对象。

// 获取上传文件的原始文件名
String originalFilename = StringUtils.cleanPath(file.getOriginalFilename());
 
// 构建目标文件对象
File destFile = new File("/path/to/destination/directory", originalFilename);
 
try {
    // 将上传文件保存到目标文件
    file.transferTo(destFile);
    return "File uploaded successfully!";
} catch (IOException e) {
    e.printStackTrace();
    return "Failed to upload the file.";
}
StandardMultipartHttpServletRequest实现类 

而另一个实现类StandardMultipartHttpServletRequest和CommonsMultipartFile的区别就在于使用StandardMultipartHttpServletRequest直接上传文件的话可能会出现目录跳跃的问题，而CommonsMultipartFile不会，这是因为其对路劲分隔符了相关的限制，具体的部分大家可以看看这篇博客：https://www.cnblogs.com/zpchcbd/p/17148291.html而MockMultipartFile这个实现类就更简单了，做了简单的输入输出流的copy，这里就不再水字数了。

2.3 default void transferTo(Path dest) 

该默认方法在实现类中被重写了，但主要的功能还是不变，就是将上传的文件写入到指定路径的Path对象中实现文件上传的功能。 

这里给出使用的示例代码：

// 构建目标文件路径
String uploadDirectory = "/path/to/destination/directory";
String originalFilename = file.getOriginalFilename();
Path filePath = Paths.get(uploadDirectory, originalFilename);
 
try {
// 将上传文件保存到目标文件
    file.transferTo(filePath);
    return "File uploaded successfully!";
} catch (IOException e) {
    e.printStackTrace();
    return "Failed to upload the file.";
}

 实际项目使用文件上传和下载

@PostMapping("/file/upload")
    public Result uploadFile(MultipartFile file) {
        String originalFilename = file.getOriginalFilename();
        if (StrUtil.isBlank(originalFilename)) {
            return Result.error("文件上传失败");
        }
        long flag = System.currentTimeMillis();
        String filePath = BASE_FILE_PATH + flag + "_" + originalFilename;
        try {
            FileUtil.mkParentDirs(filePath);  // 创建父级目录
            file.transferTo(FileUtil.file(filePath));
            Admin currentAdmin = TokenUtils.getCurrentAdmin();
            String token = TokenUtils.genToken(currentAdmin.getId().toString(), currentAdmin.getPassword(), 15);
            String url = "http://localhost:9090/api/book/file/download/" + flag + "?&token=" + token;
            if (originalFilename.endsWith("png") || originalFilename.endsWith("jpg") || originalFilename.endsWith("pdf")) {
                url += "&play=1";
            }
            return Result.success(url);
        } catch (Exception e) {
            log.info("文件上传失败", e);
        }
        return Result.error("文件上传失败");
    }

    @GetMapping("/file/download/{flag}")
    public void download(@PathVariable String flag, @RequestParam(required = false) String play, HttpServletResponse response) {
        OutputStream os;
        List<String> fileNames = FileUtil.listFileNames(BASE_FILE_PATH);
        String fileName = fileNames.stream().filter(name -> name.contains(flag)).findAny().orElse(""); //  System.currentTimeMillis() + originalFilename
        try {
            if (StrUtil.isNotEmpty(fileName)) {
                String realName = fileName.substring(fileName.indexOf("_") + 1);
                if ("1".equals(play)) {
                    response.addHeader("Content-Disposition", "inline;filename=" + URLEncoder.encode(realName, "UTF-8"));
                } else {
                    response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(realName, "UTF-8"));
                }
                byte[] bytes = FileUtil.readBytes(BASE_FILE_PATH + fileName);
                os = response.getOutputStream();
                os.write(bytes);
                os.flush();
                os.close();
            }
        } catch (Exception e) {
            log.error("文件下载失败", e);
        }
    }
文件上传接口
  1. 1接口设置
  1. @postMapping(“file/upload”):这个注解表明这个方法处理HTTP POST请求，请求路径是/file/upload。
  2. Public Result uploadFile(Multipartfile file):Result是一个自定义的响应对象，包含了操作成功或操作失败的状态，以及相关数据。
  1. 2文件处理
  1. String originalFilename = file.getOriginalFilename():获取上传文件的原始文件名。
  2. if (StrUtil.isBlank(originalFilename)):检查文件名是否为空，如果为空，返回错误响应(Result.error)。
  3. long flag = System.currentTimeMillis():获取当前时间戳(毫秒)，用于创建唯一的文件名。
  4. String filePath = BASE_FILE_PATH + flag + "_" + originalFilename:构建完整的文件保存路径。BASE_FILE_PATH指存储文件的根目录，文件名由时间戳和原始文件名拼接而成。
  1. 3文件保存
  1. FileUtil.mkParentDirs(filePath):确保所有父目录都存在，如果不存在，则创建它们。
  2. file.transferTo(FileUtil.file(filePath)):这行关键代码将上传的文件内容保存到服务器上的filePath路径。
  1. 4令牌生成(可选)
  1. Admin currentAdmin = TokenUtils.getCurrentAdmin():获取当前登录的管理员用户，这意味着实现了身份验证。
  2. String token = TokenUtils.genToken(currentAdmin.getId().toString(), currentAdmin.getPassword(), 15):根据管理员ID、密码和15分钟的过期时间生成一个jwt令牌。
  1. 5URL构建
  1. String url = "http://localhost:9090/api/book/file/download/" + flag + "?&token=" + token:构建一个指向下载接口(/api/book/file/download/)的URL，包含时间戳(flag)和生成的令牌。
  2. if(originalFilename.endsWith("png")||originalFilename.endsWith("jpg") || originalFilename.endsWith("pdf")):如果是图片(png、jpg)或pdf文件，则在URL后面添加&play=1，这表示服务器可能提供文件预览功能。
  1. 6响应
  1. return Result.success(url):上传成功后，返回包含下载的Result.success(url)响应
  2. catch (Exception e):处理过程中可能出现的异常，记录错误日志并返回一个通用的Result.error响应。

 文件下载接口

1.注解

（1）@GetMapping("/file/download/{flag}"):使用GetingMapping注解处理Get请求，路径包含一个变量{flag}，将被捕获并传递给方法。

（2）@PathVariable String flag：此注解将{flag}路径变量的值绑定到方法的flag参数。

（3）@RequestParam(required = false) String play:此注解将可选查询参数”play”的值绑定到方法的play参数。required=false使此参数成为可选参数。

2.方法参数：

（1）String flag:此参数将包含作为URL中{flag}传递的值。它用于标识要下载的文件。

（2）String play:此可选参数（来自查询字符串）可用于控制下载行为。如果其值为“1”，则文件可能会直接在浏览器中打开（内联）。否则，它将被视为常规下载。

（3）HttpServletResponse response：此对象用于操作发送回客户端的HTTP响应。

3.文件处理

 （1）List<String> fileNames = FileUtil.listFileNames(BASE_FILE_PATH):此行假设存在一个FileUtil类，其中包含一个listFileNames方法，该方法从BASE_FILE_PATH指定的目录中检索文件名列表。

（2）String fileName = fileNames.stream().filter(name -> name.contains(flag)).findAny().orElse("")：此行使用Java流查找包含提供的flag的文件名。

（3）String realName = fileName.substring(fileName.indexOf("_") + 1)：通过删除找到的文件名中的任何前缀（第一个”_”之前）来提取实际文件名。

  1. 响应处理

（1）if ("1".equals(play)) {

                    response.addHeader("Content-Disposition", "inline;filename=" + URLEncoder.encode(realName, "UTF-8"));

                } else {

                    response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(realName, "UTF-8"));

                }：检查play参数的值。如果play为“1”，则将Content-Disposition标头设置为"inline;filename=" + URLEncoder.encode(realName, "UTF-8")，这通常告诉浏览器尝试直接打开文件。否则，他会将标头设置为 "attachment;filename=" + URLEncoder.encode(realName, "UTF-8")，这通常会强制浏览器下载文件。

（2）URLEncoder.encode(realName, "UTF-8")使用UTF-8编码对文件名进行编码，以正确处理文件名中的特殊字符和空格。

（3）byte[] bytes = FileUtil.readBytes(BASE_FILE_PATH + fileName);使用FileUtil类中的另一个假设方法将文件内容读入字节数组。

（4）os = response.getOutputStream()：从response对象获取输出流，允许代码将数据直接写入HTTP响应体。

（5）os.write(bytes);os.flush(); os.close();：将文件内容（字节数组）写入输出流，刷新流以确保发送所有数据，然后关闭流。

（6）catch (Exception e) { log.error("文件下载失败", e);}：此catch块捕获在文件下载过程中抛出的任何异常，并记录错误消息。

 

执念1314
关注
  • 13
    点赞
  • 踩
  • 22
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java File与MultipartFile互转
qq_46189741的博客
06-02 713
pom中添加依赖 <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.4</version> </dependency> File转MultipartFile /**
multipartfile 接口验证文件_利用SpirngBoot实现文件上传功能
weixin_39855944的博客
01-23 940
零、本篇要点介绍SpringBoot对文件上传的自动配置。介绍MultipartFile接口。介绍SpringBoot+Thymeleaf文件上传demo的整合。介绍对文件类型，文件名长度等判断方法。一、SpringBoot对文件处理相关自动配置自动配置是SpringBoot为我们提供的便利之一，开发者可以在不作任何配置的情况下，使用SpringBoot提供的默认设置，如处理文件需要的Multip...
SpringMVC 上传文件 MultipartFile 转为 File的方法
08-25
主要介绍了SpringMVC 上传文件 MultipartFile 转为 File的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
【Java】MultipartFile工具类方法详解
最新发布
科技改变人类，技术成就未来
08-06 910
在现代Web应用中，文件上传是一个常见需求。Spring框架通过`MultipartFile`接口给我们提供了方便的文件上传支持。为了方便对这些文件进行处理，创建一个工具类可以极大地简化我们的工作。本篇博客将详细介绍如何实现一个`MultipartFile`工具类，并详解其方法的功能。
java multipartfile本地文件
weixin_28785681的博客
06-29 128
在Java开发中，我们经常会遇到需要处理上传文件的情况，而MultipartFile类是Spring框架中用于处理文件上传的类之一。在本文中，我们将介绍如何使用MultipartFile类处理本地文件上传的操作。 MultipartFile类简介 MultipartFile是Spring框架中的一个接口，用于处理HTTP请...
springboot的MultipartFile转File读取
m0_72642319的博客
07-03 508
在Spring Boot中，处理文件上传时，MultipartFile接口被用来封装上传的文件信息。
文件对象MultipartFile和文件对象File的使用方法
zerodiyi的博客
04-25 2905
file.transferTo(new File("/AA/BB/aa.txt") ) //可以传入java自动的文件对象。结果生成的文件夹的具体位置: D:/桌面/SS/AA/BB, 它并不会将文件夹生成到项目的内部，而是会将目录生成到jar包所在的目录中。//获取文件大小,单位kb。File file=new File("/AA/BB") //这里的路径是"/AA/BB"如果将jar包放在A:/桌面/SS中，生成文件夹的路径就是: A:/AA/BB。
MultipartFile与File
sunny潘先生的博客
10-15 7042
前言 前段时间碰到了中转文件的需求，需要使用HttpClient中转一下文件，过程为： 在实现这个需求的过程中就用得到了MultipartFile与File，而且我对前一个也不是很熟悉。记录一下 什么是MultipartFile MultipartFile是spring类型，代表HTML中form data方式上传的文件，包含二进制数据+文件名称。【来自百度知道】 Multipart...
java 文件操作（FIle类和MultipartFile接口）
weixin_61545912的博客
12-12 1738
Java中的MultipartFile接口和File类。
MultipartFile接口
lgb1997的博客
10-24 1688
MultipartFile接口 spring-web-4.1.6.RELEASE.jar    ====>   org.springframework.web.multipart可以找到这个接口 已知的实现类：CommonsMultipartFile,MockMultipartFile         Multi...
Java利用MultipartFile实现上传多份文件的代码
08-25
主要介绍了Java利用MultipartFile实现上传多份文件的代码，非常不错，具有一定的参考借鉴价值,需要的朋友可以参考下
File 转 MultipartFile 和MultipartFile的maven配置
05-10
在Java Web开发中，我们经常会遇到需要处理上传文件的情况，其中`MultipartFile`是Spring MVC框架提供的一种用于处理文件上传的接口。然而，在实际操作中，我们可能需要将已有的`File`对象转换为`MultipartFile`，...
java POI 通过MultipartFile删除Excel文件解析写入数据库
09-02
总之，Java POI结合Spring的MultipartFile接口，为我们在Web应用中处理Excel文件提供了一个强大且灵活的解决方案。通过解析Excel数据并将其写入数据库，我们可以实现数据的高效迁移或自动化处理，大大提升了工作效率...
Java-- 使用RestTemplate调用带有MultiPartFile的接口总结
qq_39148846的博客
07-05 2406
自己琢磨加找资料，花了不少时间，话不多说上代码 把File转成MultiPartFile的操作 添加参数并请求接口 解决问题后请点赞加评论，谢谢
Java_File类和MultipartFile类
雪小白
03-23 9952
一、前言 之前使用这两个类的时候，都是现用现找，没有太研究过，最近研究文档的上传和解析，觉得有必要对这两个类进行一下深入的学习，总结成文，做个笔记吧。 二、File类 2.1 定义 File类（文件类）是java.io包中的类，是以抽象的方式代表文件名和目录路径名。该类主要用于文件和目录的创建、文件的查找和文件的删除等。 File类代表磁盘中实际存在的文件和目录，这个文件或者目录的路径可以是绝对路径，也可以是相对路径。 2.2 构造器 1、根据路径名字符串转换为...
文件上传操作（MultipartFile 接口） 案例
weixin_50029329的博客
09-29 3788
文件VO返回值对象： package com.jt.vo; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import lombok.experimental.Accessors; import java.io.Serializable; @Data @Accessors(chain = true) @NoArgsConstructor @AllArgsConstructor
Java使用 MultipartFile 及 File实现文件上传功能
weixin_53900696的博客
07-07 5700
Java 使用 MulipartFile ,File 基于spring框架实现文件上传功能
Java实现multipartfile与file互转
05-18
Java中，MultipartFile和File都是常用的文件上传和处理类，MultipartFile是Spring框架提供的文件上传接口，而File是Java IO包中的文件类。下面代码示例演示如何将MultipartFile和File类型相互转换。 1. 将MultipartFile类型转换为File类型 ```java public static File convertMultipartFileToFile(MultipartFile multipartFile) throws IOException { File file = new File(multipartFile.getOriginalFilename()); FileOutputStream outputStream = new FileOutputStream(file); outputStream.write(multipartFile.getBytes()); outputStream.close(); return file; } ``` 2. 将File类型转换为MultipartFile类型 ```java public static MultipartFile convertFileToMultipartFile(File file) throws IOException { FileInputStream input = new FileInputStream(file); MultipartFile multipartFile = new MockMultipartFile("file", file.getName(), "text/plain", IOUtils.toByteArray(input)); return multipartFile; } ``` 需要注意的是，在将MultipartFile类型转换为File类型时，需要使用multipartFile.getBytes()方法获取文件内容，而在将File类型转换为MultipartFile类型时，需要使用IOUtils.toByteArray(input)方法将文件内容转换为字节数组。另外，在将File类型转换为MultipartFile类型时，需要使用MockMultipartFile类来模拟MultipartFile对象。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值