byte[]、MultipartFile、File转换一次看个够

约 2099 字大约 7 分钟

2024-08-14

目录

—

需求背景

当你需要将byte[]、MultipartFile、File实现互转时，无外乎以下场景：

保存第三方接口返回二进制流
前/后端文件流上传
微服务间调用
文件格式转换

正如你所需要的，通过搜索引擎筛选到我的本篇文章是因为你在开发中需要将byte[]转为MultipartFile、File格式的文件，以上需求在业务开发中是用户、客户、产品经理所喜闻乐见的，类似的文章在各大博客平台同样多如牛毛，也许你看了许多其他博主写的文章，按他们的代码按部就班去做但并没达到你需要的效果，是的，我在开发过程中也遇到了这样的痛点，因此有了这篇文章，写本文的目的意在为自己积累知识点，另外也帮助他人少走弯路。

希望我的文章能够帮您快速、高效解决您的问题，这是我莫大的荣幸。

“赠人玫瑰，手有余香” –谚语

byte[]转MultipartFile

错误示例-MockMultipartFile

首先来看一下摘自Spring官网对MockMultipartFile的一段描述：

public class MockMultipartFile extends Object implements MultipartFile

Mock implementation of the MultipartFile interface.

Useful in conjunction with a MockMultipartHttpServletRequest for testing application controllers that access multipart uploads.

虽然MockMultipartFile实现了MultipartFile接口，重点在于后一句对其作用的描述：用于测试访问分段上传， 所以这个类在正式环境是无法使用的，在我看来使用MockMultipartFile来实现byte[]转MockMultipartFile的博客都是误人子弟，因为你的代码不仅仅是运行在测试类中，而都是要发布在生产环境的。

maven坐标：

<!-- https://mvnrepository.com/artifact/org.springframework/spring-mock -->
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-mock</artifactId>
  <version>2.0.8</version>
  <scope>test</scope>
</dependency>

byte[] testFile = new byte[1024];
InputStream inputStream = new ByteArrayInputStream(testFile);
MultipartFile file = new MockMultipartFile(ContentType.APPLICATION_OCTET_STREAM.toString(), inputStream);

CommonsMultipartFile介绍

CommonsMultipartFile是 Spring 框架3.1版本后引入，用于与Apache Commons FileUpload 库集成的适配器。它实现了 Spring 的 MultipartFile 接口，允许你将Apache Commons FileUpload 的 FileItem 对象作为 Spring 的 MultipartFile 来使用。

CommonsMultipartFile实现

以maven的方式如何引入CommonsMultipartFile：

<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.4</version>
</dependency>

以下是从第三方接口获取到的byte[]转化为MultipartFile，以从微信开发文档中提供的小程序码为例，假设imageBytes是微信接口返回的图片数据，那么我需要将它转换为MultipartFile文件，实现代码如下：

private static MultipartFile convertByteToMultipartFile(byte[] imageBytes,String fileName) {
    if (Objects.isNull(imageBytes)) {
        log.error("获取微信小程序码图片信息失败，接口返回为空");
        throw new CustomException("由于输入byte数组为空，导致转换为MultipartFile失败");
    }
    String contentType = "image/jpeg";

    FileItem item;
    try {
        FileItemFactory factory = new DiskFileItemFactory();
        item = factory.createItem("file", contentType, false, fileName);

        try (ByteArrayOutputStream bos = new ByteArrayOutputStream(imageBytes.length);
             OutputStream os = item.getOutputStream()) {

            bos.write(imageBytes);
            os.write(bos.toByteArray());
        }
        return new CommonsMultipartFile(item);
    } catch (IOException e) {
        log.error("转换微信小程序码图片信息为MultipartFile时发生错误", e);
        throw new CustomException("转换过程中发生错误", e);
    }
}

byte[]转File

byte[]转File的实现方式更多一些，很多第三方高质量的轮子提供了均对应的方法，在开发过程中，无需花费时间自行实现，调用开源的API即可，下文将以HuTool与Apache Commons lang3提供的API举例。

前置条件-获取文件byte[]

以下代码从本地读取文件并转为byte[]用于模拟业务逻辑中获取到的文件数据。

    /**
     * 将文件内容读取到字节数组中。
     *
     * @param filePath 文件路径
     * @return 字节数组，如果文件不存在或读取过程中发生错误，则返回null
     */
    public static byte[] getFileBytes(String filePath) {
        File file = new File(filePath);
        // 检查文件是否存在
        if (!file.exists()) {
            System.out.println("文件不存在");
            return null;
        }

        try (// 使用try-with-resources语句自动管理资源
             FileChannel fileChannel = new RandomAccessFile(file, "r").getChannel()) {
            // 分配一个ByteBuffer，大小为文件的大小
            ByteBuffer byteBuffer = ByteBuffer.allocate((int) fileChannel.size());
            // 从文件通道读取数据到ByteBuffer
            fileChannel.read(byteBuffer);
            // 反转ByteBuffer的limit和position，使得可以通过array()方法获取数据
            byteBuffer.flip();
            // 返回包含文件数据的字节数组
            return byteBuffer.array();
        } catch (IOException e) {
            // 如果发生IO异常，记录错误日志并返回null
            e.printStackTrace(); // 这里假设e.printStackTrace()是日志记录的一种形式
            return null;
        }
    }
}

以Hutool的方式

引入Hutool

以maven坐标的方式引入hutool：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.26</version>
</dependency>

以Gradle的方式引入hutool：

implementation 'cn.hutool:hutool-all:5.8.26'

具体请参考官方文档，官方文档中有更详尽的使用说明：

Hutool快速入门

hutool提供的byte[]转File文件的示例：

byte[] data = getFileBytes("src/main/resources/banner.txt");
// 指定要创建的文件路径
String filePath = "/path/to/your/output/file";
// 使用HuTool将byte数组写入到文件
File file = FileUtil.writeBytes(data, filePath);

以Apache Commons IO的方式

引入Apache Commons IO

以maven坐标的形式引入Apache Commons IO：

<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
  <groupId>commons-io</groupId>
  <artifactId>commons-io</artifactId>
  <version>2.16.1</version>
</dependency>

以Gradle的形式引入Apache Commons IO：

implementation 'commons-io:commons-io:2.16.1'

使用Apache Commons IO提供的API实现byte[]转File文件：

public static void main(String[] args) {
  try {
    //业务逻辑中获取到的byte[]
    byte[] fileBytes = getFileBytes("src/main/resources/banner.txt");
    //目标文件
    String outputFilePath = "src/main/resources/banner22.txt";
    File outputFile = writeBytesToFile(outputFilePath, fileBytes);
    log.error("文件写入成功，输出文件路径: {}", outputFile.getAbsolutePath());
  } catch (IOException e) {
    log.error("转换错误", e);
  }
}


public static File writeBytesToFile(String filePath, byte[] fileBytes) throws IOException {
  File outputFile = new File(filePath);
  FileUtils.writeByteArrayToFile(outputFile, fileBytes);
  // 返回File对象
  return outputFile;
}

MultipartFile与File互转

字节数组可以转换为File，同样也可以转换为MultipartFile，那么MultipartFile与File之间的互转可以利用byte[]作为中间桥梁。File文件转MultipartFile可以先将File转为byte[]，再由byte[]转为MultipartFile即可实现。

MultipartFile转File

MultipartFile接口提供了getInputStream()方法，你可以使用这个方法来读取文件内容，并将它们写入到一个新的File对象中。

public class MultipartFileToFileConverter {

    public static File convert(MultipartFile multipartFile, String filePath) throws IOException {
        // 检查MultipartFile是否为空
        if (multipartFile == null || multipartFile.isEmpty()) {
            throw new IOException("文件为空");
        }

        // 创建File对象
        File file = new File(filePath);

        // 使用try-with-resources语句自动关闭资源
        try (InputStream inputStream = multipartFile.getInputStream();
             FileOutputStream outputStream = new FileOutputStream(file)) {

            // 将输入流中的数据写入到输出流（即文件）中
            byte[] buffer = new byte[4096];
            int bytesRead;
            while ((bytesRead = inputStream.read(buffer)) != -1) {
                outputStream.write(buffer, 0, bytesRead);
            }
        }

        // 返回创建的File对象
        return file;
    }
}

File转MultipartFile

File转MultipartFile同样需要依赖于CommonsMultipartFile。

public class FileToMultipartFileConverter {

    public static MultipartFile convert(File file) throws IOException, FileUploadException {
        // 创建FileItemFactory实例
        FileItemFactory factory = new DiskFileItemFactory();

        // 创建一个FileItem来包装File对象
        org.apache.commons.fileupload.FileItem fileItem = factory.createItem(
                "file", // 表单字段名，可以自定义
                "application/octet-stream", // 内容类型
                true, // 是否使用临时文件存储上传的数据
                file.getName() // 文件名
        );

        // 将File对象的内容写入到FileItem中
        fileItem.write(new File(fileItem.getName()));

        // 使用CommonsMultipartFile来包装FileItem
        return new DiskFileItem(fileItem).getStoreLocation();
    }
}

A representation of an uploaded file received in a multipart request.
The file contents are either stored in memory or temporarily on disk. 
In either case, the user is responsible for copying file contents to a session-level or persistent store as and if desired. 
The temporary storage will be cleared at the end of request processing.

星空不问赶路人，岁月不负有心人。

原文链接: https://juejin.cn/post/7382386471272202275

文章标签

后端开发程序员