Spring中MultipartFile和File转换

2023-12-04 10:20
文章标签 java spring 转换 file multipartfile

本文主要是介绍Spring中MultipartFile和File转换，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言：在SpringBoot项目中经常用到的就是MultipartFile和File转换的问题，一开始我也并不是非常了解，参考了一些资料和ChatGPT的帮助后完成的业务开发，现在有时间就自己总结一下并记录一下简单的用法，可能不是很全

正文：

首先说一下MultipartFile和File是什么：

        MultipartFile是Spring框架提供的一个接口，用于处理HTTP请求中的文件上传。它提供了一些方法来获取文件的相关信息，如文件名、文件大小、文件类型等，并且可以通过流的方式读取文件内容；在使用MultipartFile时，需要导入org.springframework.web.multipart.MultipartFile包路径

        File是Java标准库中的一个类，用于表示操作系统中的文件。它提供了一些方法来操作文件，如创建文件、删除文件、重命名文件等，并且可以通过流的方式读取或写入文件内容；在使用File时，需要导入java.io.File包路径

下面是一个使用MultipartFile接收上传文件并保存到指定路径的快速入门示例代码：

import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;public class FileUploadController {public void uploadFile(MultipartFile file) {if (!file.isEmpty()) {try {// 获取文件名String fileName = file.getOriginalFilename();// 指定保存路径String filePath = "D:/upload/";// 创建文件对象File dest = new File(filePath + fileName);// 判断保存路径是否存在，如果不存在则创建if (!dest.getParentFile().exists()) {dest.getParentFile().mkdirs();}// 保存文件file.transferTo(dest);System.out.println("文件上传成功");} catch (IOException e) {e.printStackTrace();System.out.println("文件上传失败");}}}
}

 在上述代码中，首先通过file.getOriginalFilename()方法获取上传文件的文件名，然后指定保存路径，创建一个File对象表示保存的文件路径和文件名。接着判断保存路径是否存在，如果不存在则创建。最后通过file.transferTo(dest)方法将上传的文件保存到指定路径

一、MultipartFile转换为File的三种方式：

1、方式一：transferTo

        这是一种最简单的方法，也是上面快速入门用的方式；transferTo 是MultipartFile自带的方法，它将MultipartFile转换为File，将MultipartFile转换为File格式，然后输出到特定的路径，具体写法如下：

package com.xkcoding.upload.controller;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;import java.io.File;
import java.io.IOException;/*** @author 听着晴天看星晴*/
@RestController
@Slf4j
@RequestMapping("/upload")
public class FileController {/*** 需要保存的本地目录路径*/private static final String UPLOAD_DIR = "D:\\desktop\\ck\\testFile";/*** 上传文件至本地* MediaType.MULTIPART_FORM_DATA_VALUE 用于表示HTTP请求的Content-Type为multipart/form-data** @param file 上传文件* @return 字符串*/@PostMapping(value = "/local", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)public String uploadFile(@RequestParam("file") MultipartFile file) {if (file.isEmpty()) {return "文件为空";}//确保上传目录存在File uploadDir = new File(UPLOAD_DIR);if (!uploadDir.exists()) {uploadDir.mkdirs();}//准备要保存的文件String fileName = file.getOriginalFilename();String localFilePath = UPLOAD_DIR + File.separator + fileName;File targetFile = new File(localFilePath);try {//将上传的文件输出到指定的目标文件中file.transferTo(targetFile);} catch (IOException e) {log.error("【文件上传至本地】失败，绝对路径：{}", localFilePath);return "上传文件异常";}log.info("【文件上传至本地】绝对路径：{}", localFilePath);return "上传成功";}
}

2、方式二：使用 FileOutputStream

        这是最常用的一种方法，利用MultipartFile提供的getBytes方法获取上传文件的字节数组，使用FileOutputStream 可以将字节写入文件。具体写法如下：

package com.xkcoding.upload.controller;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;/*** @author 听着晴天看星晴*/
@RestController
@Slf4j
@RequestMapping("/upload")
public class FileController {/*** 需要保存的本地目录路径*/private static final String UPLOAD_DIR = "D:\\desktop\\ck\\testFile";/*** 上传文件至本地* MediaType.MULTIPART_FORM_DATA_VALUE 用于表示HTTP请求的Content-Type为multipart/form-data** @param file 上传文件* @return 字符串*/@PostMapping(value = "/local", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)public String uploadFile(@RequestParam("file") MultipartFile file) {//简单的前置校验if (file.isEmpty()) {return "文件为空";}//确保上传目录存在File uploadDir = new File(UPLOAD_DIR);if (!uploadDir.exists()) {uploadDir.mkdirs();}//准备要保存的文件String fileName = file.getOriginalFilename();String localFilePath = UPLOAD_DIR + File.separator + fileName;File targetFile = new File(localFilePath);//获取上传文件的字节数组，使用 FileOutputstream 将字节数组写入到指定的文件try(FileOutputStream fileOutputStream = new FileOutputStream(targetFile)) {fileOutputStream.write(file.getBytes());} catch (IOException e) {log.error("【文件上传至本地】失败，绝对路径：{}", localFilePath);return "文件上传失败";}log.info("【文件上传至本地】绝对路径：{}", localFilePath);return "上传成功";}
}

3、方式三：使用 Java NIO

        Java NIO 提供了Files.copy()方法，通过获取上传文件的输入流，将输入流的内容通copy方法复制到本地文件路径中，实现了文件的上传功能，具体解释如下：

  • file.getInputStream()：获取上传文件的输入流，即文件内容的输入流。
  • localFilePath：表示本地文件路径的Path对象，指定了文件复制的目标位置。
  • StandardCopyOption.REPLACE_EXISTING：表示如果目标文件已经存在，则替换目标文件。这个选项用于确保如果目标文件已经存在，会被新的上传文件覆盖。

其中：

     StandardCopyOption是Java NIO中的一个枚举常量，用于指定在复制文件时如果目标文件已存在时的处理方式

     StandardCopyOption.REPLACE_EXISTING：表示如果目标文件已存在，则替换目标文件。如果目标文件不存在，则会创建一个新的文件

                  StandardCopyOption.COPY_ATTRIBUTES： 在文件复制过程中，如果目标文件已存在且不希望被替换，可以使用选项来保留目标文件的属性。

package com.xkcoding.upload.controller;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;/*** @author 听着晴天看星晴*/
@RestController
@Slf4j
@RequestMapping("/upload")
public class FileController {/*** 需要保存的本地目录路径*/private static final String UPLOAD_DIR = "D:\\desktop\\ck\\testFile";/*** 上传文件至本地* MediaType.MULTIPART_FORM_DATA_VALUE 用于表示HTTP请求的Content-Type为multipart/form-data** @param file 上传文件* @return 字符串*/@PostMapping(value = "/local", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)public String uploadFile(@RequestParam("file") MultipartFile file) {//简单的前置校验if (file.isEmpty()) {return "文件为空";}//确保上传目录存在File uploadDir = new File(UPLOAD_DIR);if (!uploadDir.exists()) {uploadDir.mkdirs();}//定义保存文件的路径//创建一个Path对象，表示上传目录的路径Path uploadPath = Paths.get(UPLOAD_DIR);//获取上传文件的原始文件名String fileName = file.getOriginalFilename();//使用上传目录路径和文件名创建一个新的Path对象，表示上传文件的本地路径Path localFilePath = uploadPath.resolve(fileName);//将上传文件的内容复制到本地文件路径中try (InputStream inputStream = file.getInputStream()) {//file.getInputStream()：获取上传文件的输入流，即文件内容的输入流。//localFilePath：表示本地文件路径的Path对象，指定了文件复制的目标位置。//StandardCopyOption.REPLACE_EXISTING：表示如果目标文件已经存在，则替换目标文件。这个选项用于确保如果目标文件已经存在，会被新的上传文件覆盖。Files.copy(inputStream, localFilePath, StandardCopyOption.REPLACE_EXISTING);} catch (IOException e) {log.error("【文件上传至本地】失败，绝对路径：{}", localFilePath);return "文件上传失败";}log.info("【文件上传至本地】绝对路径：{}", localFilePath);return "上传成功";}
}

二、File转换为MultipartFile

        从File转换为MultipartFile 通常在测试或模拟场景中使用，生产环境一般不这么用，这里只介绍一种最常用的方法。

        使用 MockMultipartFile：通过获得File文件的名称、mime类型以及内容将其转换为MultipartFile格式。具体写法如下

在转换之前先确保引入了spring-test 依赖（以Maven举例）

<dependency><groupId>org.springframework</groupId><artifactId>spring-test</artifactId><version>version</version><scope>test</scope>
</dependency>
package com.xkcoding.upload.controller;import org.springframework.web.multipart.MultipartFile;import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;/*** @author 听着晴天看星晴*/
public class MultiToFileUtil {public static MultipartFile convertMockMultipartFile(String filePath) throws IOException {//根据提供的文件路径创建对象Path path = Paths.get( filePath );// 获取文件的名字String name = path.getFileName().toString();//使用 Java NIO 的 Files 类探测文件的 MIME 类型String contentType = Files.probeContentType(path);//读取文件内容为字节数组byte[] content = Files.readAllBytes(path);//需要引入spring-test依赖return new MockMultipartFile(name, name, contentType, content);}
}

这篇关于Spring中MultipartFile和File转换的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/453112。

相关文章

Java实现检查多个时间段是否有重合

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1：定义时间段类步骤2：添加时间段步骤3：检查时间段是否有重合步骤4：输出结果示例代码结语作
阅读更多...
Java中String字符串使用避坑指南

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下：1. 字符串的不可变性：每次修改都创建新对象2. 使用 == 比较字符串，陷阱满
阅读更多...
Java判断多个时间段是否重合的方法小结

Java判断多个时间段是否重合的方法小结

《Java判断多个时间段是否重合的方法小结》这篇文章主要为大家详细介绍了Java中判断多个时间段是否重合的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录判断多个时间段是否有间隔判断时间段集合是否与某时间段重合判断多个时间段是否有间隔实体类内容public class D
阅读更多...
IDEA编译报错“java: 常量字符串过长”的原因及解决方法

IDEA编译报错“java: 常量字符串过长”的原因及解决方法

《IDEA编译报错“java:常量字符串过长”的原因及解决方法》今天在开发过程中,由于尝试将一个文件的Base64字符串设置为常量,结果导致IDEA编译的时候出现了如下报错java:常量字符串过长,... 目录一、问题描述二、问题原因2.1 理论角度2.2 源码角度三、解决方案解决方案①：StringBui
阅读更多...
Java覆盖第三方jar包中的某一个类的实现方法

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下：需要在
阅读更多...
Java中ArrayList和LinkedList有什么区别举例详解

Java中ArrayList和LinkedList有什么区别举例详解

《Java中ArrayList和LinkedList有什么区别举例详解》：本文主要介绍Java中ArrayList和LinkedList区别的相关资料,包括数据结构特性、核心操作性能、内存与GC影... 目录一、底层数据结构二、核心操作性能对比三、内存与 GC 影响四、扩容机制五、线程安全与并发方案六、工程
阅读更多...
JavaScript中的reduce方法执行过程、使用场景及进阶用法

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》：本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程
阅读更多...
如何使用Java实现请求deepseek

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2
阅读更多...
Java调用DeepSeek API的最佳实践及详细代码示例

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》：本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.
阅读更多...
Spring AI集成DeepSeek的详细步骤

Spring AI集成DeepSeek的详细步骤

《SpringAI集成DeepSeek的详细步骤》DeepSeek作为一款卓越的国产AI模型,越来越多的公司考虑在自己的应用中集成,对于Java应用来说,我们可以借助SpringAI集成DeepSe... 目录DeepSeek 介绍Spring AI 是什么？1、环境准备2、构建项目2.1、pom依赖2.2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2