SpringBoot功能模块之实现单文件、多文件上传和下载

最新推荐文章于 2024-08-21 17:18:09 发布
最新推荐文章于 2024-08-21 17:18:09 发布
阅读量2.7k 收藏 20
点赞数 22
分类专栏： Spring全家桶 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_62377885/article/details/136663168
版权

一、单文件上传

1.1MultipartFile

MultipartFile 是 Spring 框架中的一个接口，主要用于处理 HTTP 请求中的文件上传。它提供了一些方法来获取上传文件的信息和内容。  以下是 MultipartFile 的一些主要方法：  

  • getOriginalFilename()：返回上传文件的原始文件名。
  • getName()：返回表单中文件组件的名字。
  • getContentType()：返回文件的 MIME 类型。
  • isEmpty()：返回文件是否为空。
  • getSize()：返回文件的大小，单位为字节。
  • getBytes()：返回文件的内容，作为字节数组。
  • getInputStream()：返回一个 InputStream，用于读取文件的内容。
  • transferTo(File dest)：将上传的文件保存到目标文件中。
@PostMapping("/upload") // 定义一个处理文件上传的POST请求映射
public String handleFileUpload(@RequestParam("file") MultipartFile file) { // 接收名为"file"的文件参数
    String name = file.getOriginalFilename(); // 获取原始文件名
    try {
        file.transferTo(new File("/path/to/destination/" + name)); // 将文件保存到指定路径
        return "File uploaded successfully"; // 返回文件上传成功的提示信息
    } catch (IOException e) {
        e.printStackTrace(); // 打印异常堆栈信息
        return "Failed to upload file"; // 返回文件上传失败的提示信息
    }
}

File.separator 是系统相关的默认名称分隔符。在 UNIX 系统中，这个字段的值为 '/'；在 Microsoft Windows 系统中，它为 '\'。 

private static final String ROOT_PATH = System.getProperty("user.dir") + File.separator + "files";

 System.getProperty("user.dir") 是 Java 系统属性，用于获取用户的当前工作目录。这通常是运行 JVM 的路径。 

1.2MIME 类型

MIME 类型是一种标准，用于表示文档、文件或字节流的性质和格式。 以下是一些常见的 MIME 类型：

  • text/plain：纯文本文件
  • text/html：HTML 文件
  • text/css：CSS 文件
  • text/javascript：JavaScript 文件
  • image/jpeg：JPEG 图像文件
  • image/png：PNG 图像文件
  • image/gif：GIF 图像文件
  • application/pdf：PDF 文件
  • application/msword：Microsoft Word 文件
  • application/vnd.ms-excel：Microsoft Excel 文件
  • application/vnd.ms-powerpoint：Microsoft PowerPoint 文件
  • application/json：JSON 数据
  • application/xml：XML 数据
  • application/zip：ZIP 压缩文件

这些只是一些常见的 MIME 类型，实际上 MIME 类型的数量非常多，可以表示各种各样的文件和数据格式。

 1.3Hutool插件

概述

Hutool是一个功能丰富的Java工具类库，它旨在简化Java开发中的常见任务。

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

Hutool提供了一系列的工具类和组件，具体如下：

  1. 文件操作：对文件的读写、复制、删除等进行封装，简化了文件处理流程。
  2. 流操作：对输入输出流的包装，使得流的处理更加便捷。
  3. 加密解密：提供多种加密解密算法的实现，如MD5、SHA等。
  4. 转码：支持字符串与字节数组之间的转换，以及不同编码格式之间的转换。
  5. 正则表达式：简化了正则表达式的使用，提供匹配和替换等功能。
  6. 线程操作：包括线程池管理、线程控制等。
  7. XML处理：简化了XML文档的解析、生成和查询。
  8. 缓存：提供简单的缓存机制，帮助提升程序性能。
  9. 定时任务：支持类似Crontab表达式的定时任务调度。
  10. 数据库操作：基于JDBC的封装，简化了数据库操作。
  11. 布隆过滤器：实现布隆过滤算法，用于高效判断一个元素是否属于某个集合。
  12. 切面编程：即使在非IOC环境下，也支持AOP编程。
  13. 多关键字查找：基于DFA模型的多关键字搜索实现。

Hutool的设计哲学是“小而全”，通过静态方法封装常用的功能，降低API的学习成本，提高开发效率，使Java代码更加优雅。它是Java项目中“util”包的良好替代品，可以节省开发人员在公用类和工具方法上的时间，让开发者更专注于业务逻辑。

  FileUtil 类

FileUtil 是 Hutool 工具包中的一个类，主要用于文件和目录的操作。它提供了一系列的静态方法，可以方便地进行文件的创建、复制、删除、移动、读取和写入等操作。

String originalFilename = file.getOriginalFilename();  // 文件的原始名称
String mainName = FileUtil.mainName(originalFilename);  // 获取文件主名称
String extName = FileUtil.extName(originalFilename); // 获取文件扩展名

在 FileController 类的 upload 方法中，上述使用了 FileUtil 的 mainName 和 extName 方法来获取上传文件的主名称和扩展名：

以下是 FileUtil 的一些主要方法：  

  • file(String path)：根据文件路径创建 File 对象。
  • mkdir(String path)：创建目录，如果父目录不存在，会一并创建。
  • copy(File src, File dest, boolean isOverride)：复制文件或目录，通过第三个参数控制如果目标文件存在时是否覆盖。
  • move(File src, File dest, boolean isOverride)：移动文件或目录，通过第三个参数控制如果目标文件存在时是否覆盖。
  • del(File file)：删除文件或目录。
  • readUtf8String(File file)：读取文件内容，返回 UTF-8 编码的字符串。
  • writeUtf8String(String content, File file)：将字符串写入文件，编码为 UTF-8。
  • getAbsolutePath(File file)：获取文件的绝对路径。
  • getName(File file)：获取文件名或目录名。
  • getExtension(File file)：获取文件的扩展名。
  • getSize(File file)：获取文件或目录的大小。

这些只是 FileUtil 类的一部分方法，实际上它还提供了更多的方法，可以满足各种复杂的文件操作需求。 

1.4实现

 @Value("${ip:localhost}")
    String ip;

    @Value("${server.port:8083}")
    String port;

    private static final String ROOT_PATH =  System.getProperty("user.dir") + File.separator + "files";

    @PostMapping("/upload")
    public Result upload(@RequestParam("file") MultipartFile file) {
        if (file.isEmpty()) {

            return Result.error("上传文件不能为空");
        }
        String originalFilename = file.getOriginalFilename();  // 文件的原始名称
        // aaa.png
        String mainName = FileUtil.mainName(originalFilename);  // 获取文件主名称aaa
        String extName = FileUtil.extName(originalFilename); // 获取文件扩展名png
        System.out.println("文件的原始名称：" + originalFilename);
        System.out.println("文件的主名称：" + mainName);
        try {
            if (!FileUtil.exist(ROOT_PATH)) {
                FileUtil.mkdir(ROOT_PATH);  // 如果当前文件的父级目录不存在，就创建
            }
            if (FileUtil.exist(ROOT_PATH + File.separator + originalFilename)) {  // 如果当前上传的文件已经存在了，那么这个时候我就要重名一个文件名称
                originalFilename = System.currentTimeMillis() + "_" + mainName + "." + extName;
            }
            File saveFile = new File(ROOT_PATH + File.separator + originalFilename);
            System.out.println("文件的保存路径：" + saveFile.getAbsolutePath());
            file.transferTo(saveFile);  // 存储文件到本地的磁盘里面去
            String url = "http://" + ip + ":" + port + "/file/download/" + originalFilename;
            return Result.success(url);  //返回文件的链接，这个链接就是文件的下载地址，这个下载地址就是我的后台提供出来的

            //另外一种思路
//            file.transferTo(new File(UPLOAD_DIR + fileName));
//            // 返回文件的下载链接
//            String fileDownloadUri = "/file/download?fileName=" + fileName;
//            return javax.xml.transform.Result.success(fileDownloadUri);
        } catch (IOException e) {
            e.printStackTrace();
            return Result.error("上传文件失败");
        }
    }

测试

 二、文件下载

2.1URLEncoder

URLEncoder 是 Java 中的一个工具类，用于将字符串转换为 application/x-www-form-urlencoded MIME 格式。这种格式通常用于 HTTP 请求的查询字符串部分。 

以下是 `URLEncoder` 的一些常用方法：

1. `encode(String s, String enc)`: 这个方法用于将指定的字符串按照指定的编码方式进行转码。例如，`URLEncoder.encode("hello world", "UTF-8")` 将返回 "hello+world"。

2. `encode(String s)`: 这个方法已经被废弃，因为它使用平台默认的编码方式进行转码，这可能会导致不可预知的结果。建议使用 `encode(String s, String enc)` 方法。

以下是 `URLEncoder.encode(String s, String enc)` 方法的一个示例：

try {
    String original = "文件名 with spaces";
    String encoded = URLEncoder.encode(original, "UTF-8");
    System.out.println(encoded);  // 输出 "文件名+with+spaces"
} catch (UnsupportedEncodingException e) {
    e.printStackTrace();
}

在这个示例中，空格被转换为 `+`。如果原始字符串中包含非 ASCII 字符或其他需要编码的字符，它们将被转换为 `%` 后跟两个十六进制数字的形式。

2.2实现

 @GetMapping("/download/{fileName}")
    public Result download(@PathVariable("fileName") String fileName, HttpServletResponse response) throws IOException {


       // response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileFullName, "UTF-8"));  // 附件下载
        String filePath = ROOT_PATH  + File.separator + fileName;

        if (!FileUtil.exist(filePath)) {
            return Result.error("文件不存在");
        }
        byte[] bytes = FileUtil.readBytes(filePath);
        ServletOutputStream outputStream = response.getOutputStream();
        outputStream.write(bytes);  // 数组是一个字节数组，也就是文件的字节流数组
        outputStream.flush();
        outputStream.close();
        System.out.println("文件下载成功");
        return Result.success();
    }

2.3配置介绍

在 Spring Boot 中，你可以在 application.properties 或 application.yml 文件中配置文件上传的最大大小。这是通过设置 spring.servlet.multipart.max-file-size 和 spring.servlet.multipart.max-request-size 属性来实现的。

  • spring.servlet.multipart.max-file-size：设置单个文件的最大大小。如果上传的文件超过这个大小，将会抛出异常。
  • spring.servlet.multipart.max-request-size：设置整个请求的最大大小。这包括所有的文件和其他表单数据。如果整个请求的大小超过这个值，将会抛出异常。
  • spring.servlet.multipart.file-size-threshold：这个属性用于设置写入磁盘的文件的大小阈值。如果上传的文件大小超过这个阈值，那么文件将会被写入到磁盘，而不是保存在内存中。这可以防止大文件上传消耗过多的内存。  
  • spring.servlet.multipart.location：这个属性用于设置临时文件的存储位置。当文件大小超过 file-size-threshold 时，文件将会被写入到这个位置。
servlet:
  multipart:
    max-file-size:20MB
    max-request-size:20MB

2.4文件预览

根据文件的类型区分的，一般是图片和 pdf 可以预览

response.addHeader("Content-Disposition", "inline;filename=" + URLEncoder.encode(fileFullName, "UTF-8")); // 预览

Content-Disposition 是 HTTP 响应头部的一个字段，它定义了获取的资源如何处理。这个字段通常用于下载操作，告诉浏览器如何处理响应的内容。  Content-Disposition 主要有两个值：  

  • inline：这意味着资源应该直接在浏览器中显示，如果可能的话。例如，如果资源是一个图像或 PDF 文档，大多数浏览器都能够直接在浏览器窗口中显示这些类型的文件。  
  • attachment：这意味着资源应该被下载和保存到本地，而不是直接在浏览器中显示。  

Content-Disposition 还可以包含一个 filename 参数，这个参数可以指定一个默认的文件名，当用户保存资源时，浏览器会使用这个文件名。  例如，Content-Disposition: attachment; filename="filename.jpg" 这个头部会告诉浏览器下载资源并将其保存为 "filename.jpg"。

 

烟雨平生9527
关注
专栏目录
Springboot单文件、多文件上传下载
小四是个程序猿的博客
04-27 521
一、概述 这篇文章主要是Springboot项目单文件、多文件的上传和下载功能的实现。可以上传任何格式的文件，并且根据文件的地址进行下载。 二、实现 1、首先创建一个Springboot项目。 2、在pom.xml里面导入需要的依赖： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apach...
SpringBoot文件上传
热门推荐
m0_59092234的博客
07-28 2万+
SpringMVC对文件上传做了简化，在SpringBoot中对此做了更进一步的简化，文件上传更为方便。根据这里的配置可以看出，如果开发者没有提供MultipartResolver，那么默认采用的MultipartResolver就是StandardServletMultipartResolver。因此，在SpringBoot中上传文件甚至可以做到零配置。下面来看具体上传过程。...
SpringBoot整合 MultipartFile实现文件上传与下载
最新发布
cnzzs的博客
08-21 452
一、前言文件上传与下载是 Web 系统中最常见的应用功能，比如用户头像的上传、Excel 文件的导入和导出等。我们通过SpringBoot整合MultipartFile可以很方便的实现文件的上传和下载。二、项目实践1.引入相关依赖登录后复制 <dependency> <group...
Java利用阿里云OSS/本地存储实现文件上传功能
逐梦苍穹的博客
02-08 4937
本文介绍Java实现文件存储和回显(阿里云OSS和本地)
springboot文件上传
Starbright.的博客
04-11 2万+
/</</</</其中后端处理文件上传的请求地址为/uploadFile，请求方法为POST。在文件上传时需要设置form表单的enctype属性为“multipart/form-data”。
Spring boot文件上传
weixin_46102505的博客
11-12 4676
本位文描写了spring boot的文件上传，并对其整合成工具类，以便以后使用。 引用了文章：https://blog.csdn.net/qq_43581790/article/details/123811775
springboot多文件上传
weixin_44808225的博客
12-01 1263
Spring Boot 是一个强大的、灵活的、开发效率高的框架，适合开发各种类型的 Web 应用或微服务，是现代化的企业级开发的首选。
SpringBoot+layui实现文件上传功能
08-27
在本文中，我们将探讨如何利用Spring Boot框架与layui前端组件库来实现文件上传功能。Spring Boot简化了基于Spring的应用程序的构建和开发流程，通过自动配置各种组件，使得开发者能够快速搭建项目。而layui则是一个...
SpringBoot 文件上传和下载的实现
08-27
文件上传和下载是 Web 开发中非常常见的功能，下面我们将介绍如何使用 SpringBoot 实现文件上传和下载。 文件上传 文件上传是指将文件从客户端上传到服务端的过程。在 SpringBoot 中，我们可以使用 `MultipartFile...
webuploader + springboot实现大文件的上传下载
10-21
在现代Web应用中，大文件上传和下载是常见的需求，特别是在云存储、文件分享和协作平台等场景。本文将深入探讨如何使用`WebUploader`前端组件与`SpringBoot`后端框架来实现这一功能，同时支持断点续传和秒传。 `...
SpringBoot文件上传下载
09-21
至于压缩包中的"文件上传文件下载.pdf"，这可能是一个教程文档，详细阐述了如何在SpringBoot中实现文件上传和下载功能，包括步骤、代码示例和注意事项。而"rest01(4)"可能是源码或示例项目的部分，这部分内容可能...
springboot文件上传(支持单个和多个)
01-02
使用springboot实现文件的单个和多个上传,并解决系统兼容性及虚拟路径映射等多个问题
基于springboot实现的文件下载上传
05-08
利用springboot实现用户注册登录，完善个人资料，文件上传和文件下载，查看自己上传的文件，还有后台管理功能。数据库文件在压缩包中。
在 Spring Boot 项目中实现文件下载功能
08-25
主要介绍了在 Spring Boot 项目中实现文件下载功能,本文给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
springboot整合plupload，实现文件批量上传、断点续传、秒传 源码
02-28
通过合理地利用MD5校验、分块上传和异步处理，实现了批量、断点续传和秒传功能，大大提升了文件上传的效率和用户体验。在实际开发中，可以根据具体需求进行调整和优化，例如增加权限控制、错误处理和日志记录等。
springBoot+vue文件上传功能模块的详细代码
03-27
由于涉及到前后端交互，这里提供一个完整的Spring Boot和Vue.js的文件上传功能模块的代码示例。 1. 后端代码 在Spring Boot中，我们可以使用MultipartFile类处理文件上传。我们可以定义一个Controller来处理上传请求，并在该Controller中使用MultipartFile类来处理上传文件。以下是一个简单的文件上传Controller示例： ```java @RestController public class FileUploadController { @PostMapping("/upload") public ResponseEntity<?> uploadFile(@RequestParam("file") MultipartFile file) { try { // 处理文件上传逻辑 return ResponseEntity.ok().build(); } catch (Exception e) { // 处理异常情况 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build(); } } } ``` 2. 前端代码 在Vue.js中，我们可以使用Vue.js的Axios库来处理文件上传。Axios是一个基于Promise的HTTP客户端，可以在浏览器和Node.js中使用。以下是一个简单的文件上传Vue组件示例： ```vue <template> <div> <input type="file" @change="selectFile" /> <button @click="uploadFile">Upload</button> </div> </template> <script> import axios from "axios"; export default { data() { return { selectedFile: null, }; }, methods: { selectFile(event) { this.selectedFile = event.target.files[0]; }, uploadFile() { let formData = new FormData(); formData.append("file", this.selectedFile); axios .post("/upload", formData, { headers: { "Content-Type": "multipart/form-data", }, }) .then((response) => { console.log(response.data); }) .catch((error) => { console.log(error); }); }, }, }; </script> ``` 在这个组件中，我们使用了一个input元素来让用户选择要上传的文件，并使用了一个button元素来触发文件上传操作。在selectFile方法中，我们使用了HTML5的File API来获取用户选择的文件，并将其保存到selectedFile变量中。在uploadFile方法中，我们创建了一个FormData对象，并将selectedFile添加到其中，然后使用Axios库的post方法发送文件上传请求。在请求头中，我们指定了Content-Type为multipart/form-data。 以上就是一个完整的Spring Boot和Vue.js的文件上传功能模块的代码示例。需要注意的是，由于涉及到文件上传，需要特别注意文件大小、文件类型、文件重名等问题，以确保系统的安全性和可靠性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

烟雨平生9527

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值