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。

相关文章

Spring Boot中WebSocket常用使用方法详解

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP
阅读更多...
SpringBoot+Docker+Graylog 如何让错误自动报警

SpringBoot+Docker+Graylog 如何让错误自动报警

《SpringBoot+Docker+Graylog如何让错误自动报警》SpringBoot默认使用SLF4J与Logback,支持多日志级别和配置方式,可输出到控制台、文件及远程服务器,集成ELK... 目录01 Spring Boot 默认日志框架解析02 Spring Boot 日志级别详解03 Sp
阅读更多...
java中反射Reflection的4个作用详解

java中反射Reflection的4个作用详解

《java中反射Reflection的4个作用详解》反射Reflection是Java等编程语言中的一个重要特性,它允许程序在运行时进行自我检查和对内部成员（如字段、方法、类等）的操作,本文将详细介绍... 目录作用1、在运行时判断任意一个对象所属的类作用2、在运行时构造任意一个类的对象作用3、在运行时判断
阅读更多...
java如何解压zip压缩包

java如何解压zip压缩包

《java如何解压zip压缩包》：本文主要介绍java如何解压zip压缩包问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解压zip压缩包实例代码结果如下总结java解压zip压缩包坐在旁边的小伙伴问我怎么用 java 将服务器上的压缩文件解压出来，
阅读更多...
SpringBoot中SM2公钥加密、私钥解密的实现示例详解

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具
阅读更多...
Spring WebFlux 与 WebClient 使用指南及最佳实践

Spring WebFlux 与 WebClient 使用指南及最佳实践

《SpringWebFlux与WebClient使用指南及最佳实践》WebClient是SpringWebFlux模块提供的非阻塞、响应式HTTP客户端,基于ProjectReactor实现,... 目录Spring WebFlux 与 WebClient 使用指南1. WebClient 概述2. 核心依
阅读更多...
Spring Boot @RestControllerAdvice全局异常处理最佳实践

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理？二、核心注解解析1. @RestControllerAdvice2
阅读更多...
Spring IoC 容器的使用详解(最新整理)

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注
阅读更多...
Spring事务传播机制最佳实践

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED（默认）2.2 SUPPORTS2
阅读更多...
怎样通过分析GC日志来定位Java进程的内存问题

怎样通过分析GC日志来定位Java进程的内存问题

《怎样通过分析GC日志来定位Java进程的内存问题》：本文主要介绍怎样通过分析GC日志来定位Java进程的内存问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、GC 日志基础配置1. 启用详细 GC 日志2. 不同收集器的日志格式二、关键指标与分析维度1.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2