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 StringBuilder 实现原理全攻略

Java StringBuilder 实现原理全攻略

《JavaStringBuilder实现原理全攻略》StringBuilder是Java提供的可变字符序列类,位于java.lang包中,专门用于高效处理字符串的拼接和修改操作,本文给大家介绍Ja... 目录一、StringBuilder 基本概述核心特性二、StringBuilder 核心实现2.1 内部
阅读更多...
SpringBoot AspectJ切面配合自定义注解实现权限校验的示例详解

SpringBoot AspectJ切面配合自定义注解实现权限校验的示例详解

《SpringBootAspectJ切面配合自定义注解实现权限校验的示例详解》本文章介绍了如何通过创建自定义的权限校验注解,配合AspectJ切面拦截注解实现权限校验,本文结合实例代码给大家介绍的非... 目录1. 创建权限校验注解2. 创建ASPectJ切面拦截注解校验权限3. 用法示例A. 参考文章本文
阅读更多...
Java中字符编码问题的解决方法详解

Java中字符编码问题的解决方法详解

《Java中字符编码问题的解决方法详解》在日常Java开发中,字符编码问题是一个非常常见却又特别容易踩坑的地方,这篇文章就带你一步一步看清楚字符编码的来龙去脉,并结合可运行的代码,看看如何在Java项... 目录前言背景：为什么会出现编码问题常见场景分析控制台输出乱码文件读写乱码数据库存取乱码解决方案统一使
阅读更多...
Java Stream流与使用操作指南

Java Stream流与使用操作指南

《JavaStream流与使用操作指南》Stream不是数据结构,而是一种高级的数据处理工具,允许你以声明式的方式处理数据集合,类似于SQL语句操作数据库,本文给大家介绍JavaStream流与使用... 目录一、什么是stream流二、创建stream流1.单列集合创建stream流2.双列集合创建str
阅读更多...
springboot集成easypoi导出word换行处理过程

springboot集成easypoi导出word换行处理过程

《springboot集成easypoi导出word换行处理过程》SpringBoot集成Easypoi导出Word时,换行符n失效显示为空格,解决方法包括生成段落或替换模板中n为回车,同时需确... 目录项目场景问题描述解决方案第一种：生成段落的方式第二种：替换模板的情况，换行符替换成回车总结项目场景s
阅读更多...
SpringBoot集成redisson实现延时队列教程

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配
阅读更多...
SpringBoot中@Value注入静态变量方式

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php
阅读更多...
SpringBoot分段处理List集合多线程批量插入数据方式

SpringBoot分段处理List集合多线程批量插入数据方式

《SpringBoot分段处理List集合多线程批量插入数据方式》文章介绍如何处理大数据量List批量插入数据库的优化方案：通过拆分List并分配独立线程处理,结合Spring线程池与异步方法提升效率... 目录项目场景解决方案1.实体类2.Mapper3.spring容器注入线程池bejsan对象4.创建
阅读更多...
线上Java OOM问题定位与解决方案超详细解析

线上Java OOM问题定位与解决方案超详细解析

《线上JavaOOM问题定位与解决方案超详细解析》OOM是JVM抛出的错误,表示内存分配失败,：本文主要介绍线上JavaOOM问题定位与解决方案的相关资料,文中通过代码介绍的非常详细,需要的朋... 目录一、OOM问题核心认知1.1 OOM定义与技术定位1.2 OOM常见类型及技术特征二、OOM问题定位工具
阅读更多...
基于 Cursor 开发 Spring Boot 项目详细攻略

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么？基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2