IO流--13--MultipartFile

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

MultipartFile

• MulitpartFile 接口时Spring框架提供的一个用于处理文件上传的工具, 在SpringMVC和SpringBoot中,
  它允许用户将文件作为请求的一部分上传.

1. 概述

MultipartFile为org.springframework.web.mutipart包下的一个类，也就是说如果想使用MultipartFile这个类就必须引入spring框架，

    <parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.3.RELEASE</version></parent><properties><maven.complier.source>8</maven.complier.source><mavem.complier.target>8</mavem.complier.target><java.version>8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency></dependencies>

换句话说，如果想在项目中使用MultipartFile这个类，那么项目必须要使用spring框架才可以，否则无法引入这个类。MultipartFile翻译成中文来讲就是“多组件的文档”，不用太在乎他的中文含义，一般来讲使用MultipartFile这个类主要是来实现以表单的形式进行文件上传功能。

2. 常用方法解析

• 首先MultipartFile是一个接口，并继承自InputStreamSource，
• 且在InputStreamSource接口中封装了getInputStream方法，该方法的返回类型为InputStream类型，这也就是为什么MultipartFile文件可以转换为输入流。通过以下代码即可将MultipartFile格式的文件转换为输入流。
  

2.1 getName方法

2.2 getOriginalFileName方法

getOriginalFileName方法获取的是文件的完整名称，包括文件名称+文件拓展名。

    /*** 物媒导入** @param file 文件* @return 无*/@PostMapping("/import")public ApiResponse<String> importByExcel(@RequestParam("file") MultipartFile file, HttpServletResponse response) throws IOException, InterruptedException {String fileName = file.getOriginalFilename();String fileType = fileName.substring(fileName.lastIndexOf(".") + 1);InputStream inputStream = file.getInputStream();if (!fileType.equals("csv") && !fileType.equals("xls") && !fileType.equals("xlsx")) {throw new AppException(GoodsMediaError.FILE_TYPE_ERROR);}String failExportFileName = goodsMediaService.importByExcel(inputStream, fileType, response);log.info("导入失败名单文件名：{}",failExportFileName);return ApiResponse.createBySuccess(failExportFileName);}

2.3 getContentType方法

getContentType方法获取的是文件的类型，注意是文件的类型，不是文件的拓展名。

2.4 isEmpty方法

isEmpty方法用来判断传入的文件是否为空，如果为空则表示没有传入任何文件。

2.5 getSize方法

getSize方法用来获取文件的大小，单位是字节。

2.6 getBytes方法

getBytes方法用来将文件转换成一种字节数组的方式进行传输，会抛出IOException异常。

2.7 getInputStream方法

getInputStream方法用来将文件转换成输入流的形式来传输文件，会抛出IOException异常。

@Test
public void testTT(MultipartFile file) throws IOException {InputStream inputStream = file.getInputStream();
}

2.8 transferTo方法

transferTo方法用来将接收文件传输到给定目标路径，会抛出IOException、IllegalStateException异常。该方法在实际项目开发中使用较少。

@PostMapping("/upload")
public String handleFileUpload(@RequestParam("file") MultipartFile file, RedirectAttributes redirectAttributes) {if (file.isEmpty()) {redirectAttributes.addFlashAttribute("message", "请选择一个文件上传！");return "redirect:/status";}try {// 保存文件到服务器String uploadDir = "/path/to/uploads/";String filePath = uploadDir + file.getOriginalFilename();File dest = new File(filePath);file.transferTo(dest);redirectAttributes.addFlashAttribute("message", "文件上传成功: " + file.getOriginalFilename());} catch (IOException e) {e.printStackTrace();redirectAttributes.addFlashAttribute("message", "上传失败！");}return "redirect:/status";
}

3.配置注意事项

4.常见问题

案例

//设定文件存储路径为项目根目录下的 upload 文件夹, 也可以是直接定义绝对路径,比如:"D:\\upload"private final String UPLOAD_DIR = System.getProperty("user.dir") + "\\upload\\";/*** 上传单个文件** @param multipartFile* @return*/@PostMapping("/upload")public ResponseEntity<String> uploadFile(@RequestParam("file") MultipartFile multipartFile) {//1.检查文件是否为空if (multipartFile.isEmpty()) {return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("No file upload");}//获取文件名String filename = multipartFile.getOriginalFilename();//2.检查文件名是否为空或者空字符串if (filename == null || filename.trim().isEmpty()) {return ResponseEntity.badRequest().body("Filename cannot be null or empty");}//3.(可选) 检查文件大小: 数字 10485760 等于10 * 1024 * 1024, 也就是 10MB 的字节大小long fileSize = multipartFile.getSize();if (fileSize > 10485760) {return ResponseEntity.status(HttpStatus.PAYLOAD_TOO_LARGE).body("File size exceeds the limit!");}//4.(可选) 检查文件类型String contentType = multipartFile.getContentType();if (!("image/png".equals(contentType) || "image/jpeg".equals(contentType))) {return ResponseEntity.status(HttpStatus.UNSUPPORTED_MEDIA_TYPE).body("File type not support");}try {//如果目标路径下的文件夹不存在, 则创建新文件夹File file = new File(UPLOAD_DIR);if (!file.exists()) {if (file.mkdirs()) {System.out.println("Directory created: " + UPLOAD_DIR);} else {System.out.println("Failed to create directory: " + UPLOAD_DIR);}} else {System.out.println("Directory already exists: " + UPLOAD_DIR);}File uploadFile = new File(file, filename);multipartFile.transferTo(uploadFile);return ResponseEntity.ok("File uploaded successfully: " + multipartFile.getOriginalFilename());} catch (IOException e) {e.printStackTrace();return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("File upload failed");}}

处理多个文件下载

• 进行批量下载已上传的文件

/*** 批量下载文件** @param filenames* @return*/
@GetMapping("/downloadMultiple")
public ResponseEntity<byte[]> downloadMultipleFiles(@RequestParam List<String> filenames) {try {//创建一个字节数组输出流ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();ZipOutputStream zipOutputStream = new ZipOutputStream(byteArrayOutputStream);//遍历要下载的文件for (String filename : filenames) {File file = new File(UPLOAD_DIR + filename);if (file.exists()) {//将文件添加到ZIP文件中ZipEntry zipEntry = new ZipEntry(filename);zipOutputStream.putNextEntry(zipEntry);//读取文件, 并写入ZIP输出流FileInputStream fis = new FileInputStream(file);byte[] buffer = new byte[1024];int length;while ((length = fis.read(buffer)) >= 0) {zipOutputStream.write(buffer, 0, length);}fis.close();zipOutputStream.closeEntry();} else {return ResponseEntity.status(HttpStatus.NOT_FOUND).body(("File not found: " + filename).getBytes());}}zipOutputStream.close();//设置响应头HttpHeaders headers = new HttpHeaders();headers.add("Content-Disposition", "attachment; filename=\"files.zip\"");headers.add("Content-Length", String.valueOf(byteArrayOutputStream.size()));return ResponseEntity.ok().headers(headers).body(byteArrayOutputStream.toByteArray());} catch (IOException e) {return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Error occurred during file download.".getBytes());}
}

处理多个文件上传

• 需要一次性上传多个文件, 可以增加接口来接收 MultipartFile[]:

 /*** 进行批量上传文件** @param multipartFiles* @return*/@PostMapping("/uploadMultiple")public ResponseEntity<String> uploadMultipleFiles(@RequestParam("files") MultipartFile[] multipartFiles) {List<String> failedFiles = new ArrayList<>();//遍历每个文件for (MultipartFile multipartFile : multipartFiles) {//1. 检查文件是否为空if (multipartFile.isEmpty()) {failedFiles.add("No file uploaded for one or more files");continue; //如果某个文件为空, 则跳过这一轮}//获取文件名String filename = multipartFile.getOriginalFilename();//2.检查文件名是否为空或者空字符串if (filename == null || filename.trim().isEmpty()) {failedFiles.add("Filename cannot be null or empty for empty for one or more");continue;//跳过这一轮}//3.(可选)检查文件大小long fileSize = multipartFile.getSize();if (fileSize > 10486760) { //10MBfailedFiles.add("File size exceeds the limit for file: " + filename);continue; //跳过这一轮}//4.(可选) 检查文件类型String contentType = multipartFile.getContentType();if (!("image/png".equals(contentType) || "image/jpeg".equals(contentType))) {failedFiles.add("File type not support for files: " + filename);continue;//跳过这一轮}//5.保存文件try {//如果目标路径下的文件夹不存在, 则创建新文件夹File file = new File(UPLOAD_DIR);if (!file.exists()) {if (file.mkdirs()) {System.out.println("Directory created: " + UPLOAD_DIR);} else {System.out.println("Failed to create directory: " + UPLOAD_DIR);}} else {System.out.println("Directory already exists: " + UPLOAD_DIR);}File uploadFile = new File(file, filename);multipartFile.transferTo(uploadFile);System.out.println("File uploaded successfully: " + filename);} catch (IOException e) {e.printStackTrace();failedFiles.add("File upload failed for file: " + filename);}}//检查是否存在失败的文件if (failedFiles.isEmpty()) {return ResponseEntity.ok("All files uploaded successfully.");} else {return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Some files failed to upload: " + String.join(", ", failedFiles));}}

MultipartFile转File

其实转换的本质都是要创建一个file的临时文件，然后通过各种实现方式将MultipartFile中的内容写入到file中

1.FileUtils.copyInputStreamToFile转换

package com.cxstar.file.util;import org.apache.commons.io.FileUtils;
import org.springframework.web.multipart.MultipartFile;import java.io.File;
import java.io.IOException;/*** @author zhouquan* @description 测试MultipartFile与File互转* @date 2023-03-12 17:31**/
public class FileTestUtils {/*** MultipartFile转File* <p>* 项目根路径创建临时文件，转换得到File，再删除临时文件** @param multipartFile* @return*/public static File multiPartFileToFile(MultipartFile multipartFile) throws IOException {//获取文件名String originalFilename = multipartFile.getOriginalFilename();//获取默认定位到的当前用户目录("user.dir"),也就是当前应用的根路径String tempDir = System.getProperty("user.dir");//根目录下生成临时文件File file = new File(tempDir+File.separator+originalFilename);FileUtils.copyInputStreamToFile(multipartFile.getInputStream(), file);return file;}}

此种方式的弊端就是需要在调用此方法后需要再手动删除，也就是要在业务代码中再掺杂删除的逻辑。

2.multipartFile.transferTo(tempFile);

/*** MultipartFile转File* <p>* 项目根路径创建缓冲区来实现这个转换** @param multipartFile* @return*/public static File multiPartFileToFile2(MultipartFile multipartFile) throws IOException {//获取文件名String originalFilename = multipartFile.getOriginalFilename();//获取默认定位到的当前用户目录("user.dir"),也就是当前应用的根路径String tempDir = System.getProperty("user.dir");//获取文件名String filename = StringUtils.substringBeforeLast(originalFilename, ".");//获取文件后缀String fileExt = StringUtils.substringAfterLast(originalFilename, ".");//在项目根路径生成临时文件File tempFile = File.createTempFile(filename, "." + fileExt, new File(tempDir));multipartFile.transferTo(tempFile);//在jvm退出时执行删除此路径下的文件tempFile.deleteOnExit();return tempFile;}

3. (推荐）FileUtils.writeByteArrayToFile(file, multipartFile.getBytes());

package com.cxstar.file.util;import org.apache.commons.io.FileUtils;
import org.springframework.web.multipart.MultipartFile;import java.io.*;/*** @author zhouquan* @description 测试MultipartFile与File互转* @date 2023-03-12 17:31**/
public class FileTestUtils {/*** MultipartFile 转 File** @param multipartFile* @throws Exception*/public static File multiPartFileToFile3(MultipartFile multipartFile) {File file = null;if (multipartFile.isEmpty()) {return null;}try {//本质上还是在项目根路径创建文件file = new File(multipartFile.getOriginalFilename());//将MultipartFile的byte[]写入到file中FileUtils.writeByteArrayToFile(file, multipartFile.getBytes());} catch (IOException e) {e.printStackTrace();}return file;}
}