Springboot文件上传

最新推荐文章于 2024-06-11 09:27:09 发布

不识愁滋味.

最新推荐文章于 2024-06-11 09:27:09 发布

阅读量521

点赞数 3

文章标签： java spring

本文链接：https://blog.csdn.net/m0_62375467/article/details/121992175

版权

要实现文件上传，我们应该先明确几个知识点。

文件是如何建立的？建立好文件以后，又该如何对该文件进行读写操作呢？在构建好符合我们预期与要求的目标文件后，最后又要如何实现文件上传呢？

让我们一步一步来。

Step1：File类

Java文件类以抽象的方式代表文件名和目录路径名，该类主要用于文件和目录的创建、文件的查找和文件的删除等。File对象代表磁盘中实际存在的文件和目录。

创建一个新的File实例主要有以下几种方法，其目的都是为了创建一个文件对象（或是文件夹/目录）：

//1.通过给定的父抽象路径名和子路径名字符串创建一个新的File实例。
File(File parent, String child);

//2.通过将给定路径名字符串转换成抽象路径名来创建一个新 File 实例。
File(String pathname);

//3.根据 parent 路径名字符串和 child 路径名字符串创建一个新 File 实例。
File(String parent, String child); 

//4.通过将给定的 file: URI 转换成一个抽象路径名来创建一个新的 File 实例。
File(URI uri);

其中第二种方法是最常用的，我们给出一个实例：

//通过将给定路径名字符串转换成抽象路径名来创建一个新 File 实例。
// "/"最好用 File.separator 替代，这样可以适配不同的操作系统。如Linux和Windows。
File f = new File("D:/MyFile/File");

//在创建了文件实例f以后，就可以对它进行一些操作，例如：
//exists()测试该抽象路径名表示的文件或目录是否存在
boolean isExists = f.exists(); 
//list()返回由此抽象路径名所表示的目录中，文件和目录的名称所组成字符串数组
String[] fileList = f.list();
//mkdir()创建此抽象路径名指定的目录
boolean makeDir = f.mkdir();
//mkdirs()创建此抽象路径名指定的目录，包括创建必需但不存在的父目录
boolean makeDirs= f.mkdirs()

Step2：Stream类（流）

“流”是一个数据序列，输入流（InputStream）用于从其中读取数据，输出流（OutputStream）用于向目标写入数据。

在这里有一个有趣的小问题，明明Input是输入，应该对应写入数据；Output是输出，应该对应读取数据，为什么反过来了呢？其实是一个视角问题，流的Input、Output应该是基于内存视角的。对于内存来说，Input是输入我内存的东西，在内存中就能被我们读取到，就是读取的过程；Output则是从我内存中输出的，也就相当于是更改了目标。

再来看看这张关于IO流的结构图，里面包括了各种输入流和输出流的层级结构。其中有我们之前提到过的序列化（ObjectOutputStream）与反序列化（ObjectInputStream）,在这里就不赘述了，我们主要关注FileInputStream（文件输入流） FileOutputStream（文件输出流）。

想要读取文件，我们需要先创建一个File类实例，来代表我们要操作的文件，然后再利用FileInputStream输入流来读取它：

//直接用字符串文件名来创建一个输入流对象，然后读取
InputStream f = new FileInputStream("E:/Myfile/file");

//或者使用File对象来创建一个文件对象，再读取
File f = new File("E:/Myfile/file");
InputStream in = new FileInputStream(f);

然后再调用其他的方法操作该文件，例如以下几个：

//这个方法从输入流读取r.length长度的字节，返回读取的字节数，如果是文件结尾则返回-1
public int read(byte[] r) throws IOException{};

//关闭此文件输入流并释放与此流有关的所有系统资源，抛出IOException异常
public void close() throws IOException{};

//这个方法清除与该文件的连接，确保在不再引用文件输入流时调用其 close 方法，抛出IOException异常
protected void finalize()throws IOException {};

//返回下一次对此输入流调用的方法中，可以不受阻塞地从此输入流读取的字节数,返回一个整数值
public int available() throws IOException{};

其中需要注意的是，read()方法只能读取一个字符，如果已经读取到结尾，返回值会是“-1”。如果我们想要一次读取多位字符，可以使用这种方法：

//通过文件字节长度来遍历，挨个输出
//用available()方法来获取字节数，再将读取字节转为char格式输出
int size = in.available();
for (int i = 0; i < size; i++) {
    System.out.print((char) in.read() + "  ");
}

说完了读取，自然轮到了写入，写入则运用了FileOutputStream文件写入流。也是要先操作一个File类的实例对象，和Input流完全相同：

//直接用字符串文件名来创建一个输出流对象，然后写入
OutputStream f = new FileOutputStream("E:/Myfile/file");

//或者使用File对象来创建一个文件对象，再写入
File f = new File("E:/Myfile/file");
OutputStream in = new FileOutputStream(f);

然后再调用方法来写入文件：

//将byte数组中的数据写入文件输出流
public void write(byte[] b);

//关闭此文件输出流并释放与此流有关的所有系统资源，抛出IOException异常
public void close() throws IOException{};

这就是完整的通过输入流和输出流实现文件读取、写入的方法，接下来我们演示一下文件读写的完整过程：

import java.io.*;
 
public class fileTest {
    public static void main(String[] args) {

        //先创建一个文件实例对象，再进行后续操作
        File f = new File("E:/Myfile/file");

        try{
            //指定要写入文件的数据
            String fileStr = "你这接口保通吗";
            byte[] fileBytes = fileStr.getBytes();
            //开始写入文件
            OutputStream outputFile = new FileOutputStream(f);
            outputFile.write(fileBytes);
            outputFile.close();
        } catch (IOException e){
            System.out.print("Exception");
        }

        try{
            //开始读取文件
            InputStream inputFile = new FileInputStream(f);
            int size = inputFile.available();
            for (int i = 0; i < size; i++) {
                System.out.print((char) inputFile.read() + "  ");
            }
            inputFile.close();
        } catch (IOException e){
            System.out.print("Exception");
        }
    }
}

Step3：MultipartFile类

终于来到了最后一步——文件上传。在Spring框架中，文件上传主要应用了MultipartFile类，是一种用于前端上传、在后端保存的文件类型。一般我们运用transferTo()方法来将文件传输到指定目标，再返回一个Map来存放文件的各种信息——例如文件名、文件类型、大小、保存路径等，这些都可以根据你的业务需求来决定。

既然是要存放文件，我们必须要用File来构造一个存放文件载体，也就是路径。而路径需要考虑的问题包含了：保存文件的路径具体在哪里，怎样每次都生成一个不重复的文件名。问题很好解决，只需要生成UUID，再在末尾加上文件的后缀（扩展名），再在文件前面拼接上保存文件夹的绝对路径。

最后我们来实现整个上传的过程，再返回一个保存文件的相对路径：

@Override
public Map<String, String> uploadQuestion(MultipartFile multipartFile) {
    //创建一个map用于返回文件信息
    Map<String, String> map = new HashMap<>();
    //创建需要保存的文件类
    File saveFile = null;
    //文件后缀名
    String suffixName = null;
    //文件名
    String fileName = null;

    try {

        // 创建保存该上传文件的文件夹，这里的uploadPath是一个在dbConstant中指定的静态变量，代表了文件存储的路径名
        File file = new File(uploadPath + File.separator);

        // 创建文件上传目录
        if (!file.exists()) {
            file.mkdirs();
        }

        //获取文件后缀名，先用getOriginalFilename()方法获取完整的文件名，再通过substring()方法，获取文件名中"."以及它之后的内容。获取的内容就是该文件的后缀名（扩展名）。
        suffixName = multipartFile.getOriginalFilename().substring(multipartFile.getOriginalFilename().lastIndexOf("."));

        //用UUID给文件保存一个随机的名字
        fileName = UUID.randomUUID().toString().replace("-", "") + suffixName;

        //获取需要保存的文件完整路径（例如E:\\myFile\\file\\123456.png）
        saveFile = new File(file.getAbsolutePath() + File.separator + fileName);

        //文件保存
        multipartFile.transferTo(saveFile);
    } catch (IOException e) {
        log.error(e.getMessage(), e);
        throw new BootException("文件解析失败！", e);
    }

    //文件在本地存储的相对路径（例如question\\123456.png）
    String staticImgUrl = "question" + File.separator + fileName;

    //由于最终要显示的结果是这样的"question/123456.png"，则需要将"\\"转换为"/"
    staticImgUrl = staticImgUrl.replace("\\", "/");
    
    //给map中加入文件保存路径
    map.put("filePath", staticImgUrl);
    return map;
}

这其中要注意的是"File.separator"，它代表了路径分隔符——通俗说就是"/"与"\"。利用它是为了同时兼容多种操作系统，因为在Linux下，文件路径是类似这样的"/myFile/file/123.png"；而在Windows中又是这样的"E:\Myfile\file\123.png"。考虑到跨平台问题，我们还是使用通用的"File.separator"。

经过这三步走，大伙应该也对文件操作与上传有一个系统的认知了。以后再见到方法一定要知其一也知其二，这样才能深刻的认识到并解决问题。