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

相关文章

Spring Security自定义身份认证的实现方法

《SpringSecurity自定义身份认证的实现方法》:本文主要介绍SpringSecurity自定义身份认证的实现方法,下面对SpringSecurity的这三种自定义身份认证进行详细讲解,... 目录1.内存身份认证(1)创建配置类(2)验证内存身份认证2.JDBC身份认证(1)数据准备 (2)配置依

SpringBoot整合OpenFeign的完整指南

《SpringBoot整合OpenFeign的完整指南》OpenFeign是由Netflix开发的一个声明式Web服务客户端,它使得编写HTTP客户端变得更加简单,本文为大家介绍了SpringBoot... 目录什么是OpenFeign环境准备创建 Spring Boot 项目添加依赖启用 OpenFeig

Java Spring 中 @PostConstruct 注解使用原理及常见场景

《JavaSpring中@PostConstruct注解使用原理及常见场景》在JavaSpring中,@PostConstruct注解是一个非常实用的功能,它允许开发者在Spring容器完全初... 目录一、@PostConstruct 注解概述二、@PostConstruct 注解的基本使用2.1 基本代

springboot使用Scheduling实现动态增删启停定时任务教程

《springboot使用Scheduling实现动态增删启停定时任务教程》:本文主要介绍springboot使用Scheduling实现动态增删启停定时任务教程,具有很好的参考价值,希望对大家有... 目录1、配置定时任务需要的线程池2、创建ScheduledFuture的包装类3、注册定时任务,增加、删

SpringBoot整合mybatisPlus实现批量插入并获取ID详解

《SpringBoot整合mybatisPlus实现批量插入并获取ID详解》这篇文章主要为大家详细介绍了SpringBoot如何整合mybatisPlus实现批量插入并获取ID,文中的示例代码讲解详细... 目录【1】saveBATch(一万条数据总耗时:2478ms)【2】集合方式foreach(一万条数

IntelliJ IDEA 中配置 Spring MVC 环境的详细步骤及问题解决

《IntelliJIDEA中配置SpringMVC环境的详细步骤及问题解决》:本文主要介绍IntelliJIDEA中配置SpringMVC环境的详细步骤及问题解决,本文分步骤结合实例给大... 目录步骤 1:创建 Maven Web 项目步骤 2:添加 Spring MVC 依赖1、保存后执行2、将新的依赖

SpringBoot中配置文件的加载顺序解读

《SpringBoot中配置文件的加载顺序解读》:本文主要介绍SpringBoot中配置文件的加载顺序,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot配置文件的加载顺序1、命令⾏参数2、Java系统属性3、操作系统环境变量5、项目【外部】的ap

SpringBoot UserAgentUtils获取用户浏览器的用法

《SpringBootUserAgentUtils获取用户浏览器的用法》UserAgentUtils是于处理用户代理(User-Agent)字符串的工具类,一般用于解析和处理浏览器、操作系统以及设备... 目录介绍效果图依赖封装客户端工具封装IP工具实体类获取设备信息入库介绍UserAgentUtils

Spring 中的循环引用问题解决方法

《Spring中的循环引用问题解决方法》:本文主要介绍Spring中的循环引用问题解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录什么是循环引用?循环依赖三级缓存解决循环依赖二级缓存三级缓存本章来聊聊Spring 中的循环引用问题该如何解决。这里聊

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》:本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter(过滤器)1. Filter 的工作原理2. Filter 的配置与使用二、Listen