Spring中MultipartFile和File转换

2023-12-04 10:20

本文主要是介绍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中的方法重载Overloading和方法重写Overriding的区别联系,方法重载是指在同一个类中,允许存在多个方法名相同... 目录Java方法重载与重写:同名方法的双面魔法方法重载(Overloading):同门师兄弟的不同绝

Spring配置扩展之JavaConfig的使用小结

《Spring配置扩展之JavaConfig的使用小结》JavaConfig是Spring框架中基于纯Java代码的配置方式,用于替代传统的XML配置,通过注解(如@Bean)定义Spring容器的组... 目录JavaConfig 的概念什么是JavaConfig?为什么使用 JavaConfig?Jav

Java数组动态扩容的实现示例

《Java数组动态扩容的实现示例》本文主要介绍了Java数组动态扩容的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录1 问题2 方法3 结语1 问题实现动态的给数组添加元素效果,实现对数组扩容,原始数组使用静态分配

Java中ArrayList与顺序表示例详解

《Java中ArrayList与顺序表示例详解》顺序表是在计算机内存中以数组的形式保存的线性表,是指用一组地址连续的存储单元依次存储数据元素的线性结构,:本文主要介绍Java中ArrayList与... 目录前言一、Java集合框架核心接口与分类ArrayList二、顺序表数据结构中的顺序表三、常用代码手动

JAVA项目swing转javafx语法规则以及示例代码

《JAVA项目swing转javafx语法规则以及示例代码》:本文主要介绍JAVA项目swing转javafx语法规则以及示例代码的相关资料,文中详细讲解了主类继承、窗口创建、布局管理、控件替换、... 目录最常用的“一行换一行”速查表(直接全局替换)实际转换示例(JFramejs → JavaFX)迁移建

Spring Boot Interceptor的原理、配置、顺序控制及与Filter的关键区别对比分析

《SpringBootInterceptor的原理、配置、顺序控制及与Filter的关键区别对比分析》本文主要介绍了SpringBoot中的拦截器(Interceptor)及其与过滤器(Filt... 目录前言一、核心功能二、拦截器的实现2.1 定义自定义拦截器2.2 注册拦截器三、多拦截器的执行顺序四、过

JAVA线程的周期及调度机制详解

《JAVA线程的周期及调度机制详解》Java线程的生命周期包括NEW、RUNNABLE、BLOCKED、WAITING、TIMED_WAITING和TERMINATED,线程调度依赖操作系统,采用抢占... 目录Java线程的生命周期线程状态转换示例代码JAVA线程调度机制优先级设置示例注意事项JAVA线程

Python轻松实现Word到Markdown的转换

《Python轻松实现Word到Markdown的转换》在文档管理、内容发布等场景中,将Word转换为Markdown格式是常见需求,本文将介绍如何使用FreeSpire.DocforPython实现... 目录一、工具简介二、核心转换实现1. 基础单文件转换2. 批量转换Word文件三、工具特性分析优点局

JavaWeb项目创建、部署、连接数据库保姆级教程(tomcat)

《JavaWeb项目创建、部署、连接数据库保姆级教程(tomcat)》:本文主要介绍如何在IntelliJIDEA2020.1中创建和部署一个JavaWeb项目,包括创建项目、配置Tomcat服务... 目录简介:一、创建项目二、tomcat部署1、将tomcat解压在一个自己找得到路径2、在idea中添加

Java使用Spire.Doc for Java实现Word自动化插入图片

《Java使用Spire.DocforJava实现Word自动化插入图片》在日常工作中,Word文档是不可或缺的工具,而图片作为信息传达的重要载体,其在文档中的插入与布局显得尤为关键,下面我们就来... 目录1. Spire.Doc for Java库介绍与安装2. 使用特定的环绕方式插入图片3. 在指定位