Spring Boot | Spring Boot中进行 “文件上传” 和 “文件下载”

最新推荐文章于 2024-09-23 16:43:15 发布
置顶 最新推荐文章于 2024-09-23 16:43:15 发布
阅读量4.4k 收藏 49
点赞数 24
分类专栏： Spring Boot框架 文章标签： spring boot 后端 java 文件上传 文件下载 SpringBoot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_70720417/article/details/137742958
版权

目录:

在这里插入图片描述

作者简介 ：一只大皮卡丘，计算机专业学生，正在努力学习、努力敲代码中! 让我们一起继续努力学习！

该文章参考学习教材为：
《Spring Boot企业级开发教程》 黑马程序员 / 编著
文章以课本知识点 + 代码为主线，结合自己看书学习过程中的理解和感悟 ，最终成就了该文章

文章用于本人学习使用 ， 同时希望能帮助大家。
欢迎大家点赞👍 收藏⭐ 关注💖哦！！！

（侵权可联系我，进行删除，如果雷同，纯属巧合）

一、SpringBoot中进行 " 文件上传" :

  • 开发Wb应用时，文件上传是很常见的一个需求，浏览器 通过 表单形式 将 文件 以 流的形式传递 给 服务器，服务器再对上传的数据解析处理。下面将通过一个案例讲解使用 SpringBoot 实现 文件上传，具体步骤 如下 ：

1.编写 “文件上传” 的 “表单页面”

  • 在项目的 templates模板引擎文件夹下创建一个用来上传文件的upload.html模板页面 :

  • upload.html :

    <!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>动态添加文件上传列表</title>
    <link th:href="@{/login/css/bootstrap.min.css}" rel="stylesheet">
    <script th:src="@{/login/js/jquery-3.7.1.min.js}"></script>
</head>
<body>
<div th:if="${uploadStatus}" style="color: red" th:text="${uploadStatus}">
    上传成功</div>
<form th:action="@{/uploadFile}" method="post" enctype="multipart/form-data">
    上传文件:&nbsp;&nbsp;
    <input type="button" value="添加文件" onclick="add()"/>
    <div id="file" style="margin-top: 10px;" th:value="文件上传区域">  </div>
    <input id="submit" type="submit" value="上传"
           style="display: none;margin-top: 10px;"/>
</form>


<script type="text/javascript">
    function add(){
        var innerdiv = "<div>";
        innerdiv += "<input type='file' name='fileUpload' required='required'>" +
            "<input type='button' value='删除' οnclick='remove(this)'>";
        innerdiv +="</div>";
        $("#file").append(innerdiv);
        $("#submit").css("display","block");
    }

    function remove(obj) {
        $(obj).parent().remove();
        if($("#file div").length ==0){
            $("#submit").css("display","none");
        }
    }
</script>
</body>
</html>

2.在全局配置文件中添加文件上传的相关配置

  • 在 全局配置文件 : application.properties中添加文件上传的相关设置，配置如下 ：

    application.properties :

    spring.application.name=chapter_12

#thymeleaf的页面缓存设置(默认为true),开发中为方便调试应设置为false，上线稳定后应保持默认true
spring.thymeleaf.cache=false

##配置国际化文件基础名
#spring.messages.basename=i18n.login

#单个文件上传大小限制(默认为1MB)
spring.servlet.multipart.max-file-size=10MB
#总文件上传大小限制
spring.servlet.multipart.max-request-size=50MB

    在 application.properties 全局配置文件中，对文件 上传过程中的上传大小进行了设置。

3.进行文件上传处理，实现 “文件上传” 功能

  • FileController.java :

    package com.myh.chapter_12.controller;

import org.springframework.boot.Banner;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;
import java.util.UUID;

/**
 * 文件管理控制类
 */
@Controller //加入到IOC容器中
public class FileController { //关于File的controller类

    @GetMapping("/toUpload")
    public String toUpload(){
        return "upload";
    }

    @PostMapping("/uploadFile")
    public String uploadFile(MultipartFile[] fileUpload, Model model) {
        //默认文件上传成功,并返回状态信息
        model.addAttribute("uploadStatus", "上传成功！");
        for (MultipartFile file : fileUpload) {
            //获取文件名以及后缀名 (获取原始文件名)
            String fileName = file.getOriginalFilename();
            //使用UUID + 原始文件名 来生成一个新的文件名
            fileName = UUID.randomUUID()+"_"+fileName;
            //指定文件上传的本地存储目录，不存在则提前创建
            String dirPath = "S:\\File\\";
            File filePath = new File(dirPath);
            if(!filePath.exists()){filePath.mkdirs();}//创建该目录
            try {
                //执行“文件上传”的方法
                file.transferTo(new File(dirPath+fileName));
            }
            catch (Exception e) {e.printStackTrace();
                //上传失败，返回失败信息
                model.addAttribute("uploadStatus","上传失败： "+e.getMessage());}
        }

        //携带状态信息回调到文件上传页面
        return "upload";
    }
}

4.效果测试

  • 启动项目，在浏览器访问 http://localhost:8080/toUpload ，效果如下图所示 ：

    在这里插入图片描述

    在这里插入图片描述

    在这里插入图片描述

    通过以上图片可以看出，SpringBoot 中进行 “文件上传”成功 。

二、SpringBoot中进行 “文件下载” :

  • 下载文件能够通过IO流实现，所以 多数框架并没有对文件下载进行封装处理。文件下载时涉及不同浏览器的解析处理，可能会出现 中文乱码 的情况。
    接下来将针对 下载英文名文件 和 中文名文件 进行讲解。

“英文名称” 文件下载 :

1.添加文件下载工具依赖

  • 在 pom.xml文件中引入文件下载的一个工具依赖 ：

    <!--  文件下载的工具依赖  --> 
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.6</version>
</dependency>
2.定制文件下载页面

  • download.html :

    <!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>"英文名称"文件下载</title></head><body>
<div style="margin-bottom: 10px">文件下载列表：</div>
<table>

    <tr>
        <td>嘻嘻哈哈123.txt</td>
        <td><a th:href="@{/download(filename='5afa8ee7-6cbf-4632-9965-4df31aad4558_嘻嘻哈哈123456.txt')}">下载该文件</a></td>
    </tr>

    <tr>
        <td>嘻嘻哈哈123456.txt</td>
        <td><a th:href="@{/download(filename='c53a27b1-b42e-41a4-b283-86ac43034203_嘻嘻哈哈123.txt')}">下载该文件</a></td>
    </tr>

</table>
</body>
</html>

    上面代码中通过列表展示了要下载的两个 文件名及其下载链接。需要注意的是，在文件下载之前，需要保证在文件下载目录（本示例中的“S:\File”目录）中存在对应的文件，可以自行存放，只要 保持文件名统一 即可。

3.编写文件下载处理方法

  • FileController.java :

    package com.myh.chapter_12.controller;

import jakarta.servlet.http.HttpServletRequest;
import org.apache.commons.io.FileUtils;
import org.springframework.boot.Banner;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.UUID;

/**
 * 文件管理控制类
 */
@Controller //加入到IOC容器中
public class FileController { //关于File的controller类

    @GetMapping("/toDownload")
    public String toDownload(){
        return "download";
    }

    /**
     *  英文名称文件下载
     */
    @GetMapping("/download")
    public ResponseEntity<byte[]> fileDownload(String filename){
        //指定要下载的文件根路径
        String dirPath = "S:\\File\\";
        //创建该文件对象
        File file = new File(dirPath + File.separator + filename);
        //设置响应头
        HttpHeaders headers = new HttpHeaders();
        //通知浏览器以下载方式打开
        headers.setContentDispositionFormData("attachment",filename);
        //定义以流的形式下载返回文件数据
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        try {return new ResponseEntity<>(FileUtils.readFileToByteArray(file),
                headers, HttpStatus.OK);}
        catch (Exception e) {e.printStackTrace();
            return new ResponseEntity<byte[]>(e.getMessage().getBytes(),
                    HttpStatus.EXPECTATION_FAILED);
        }
    }

}
4.效果测试

  • 启动项目，在浏览器访问 http://localhost:8080/toDownload ，效果如下图所示 ：
    在这里插入图片描述

    在这里插入图片描述

“中文名称” 文件下载 :

1.添加文件下载工具依赖

  • 在 pom.xml文件中引入文件下载的一个工具依赖 ：

    <!--  文件下载的工具依赖  --> 
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.6</version>
</dependency>
2.定制文件下载页面

  • download.html :

    <!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>中文名称文件下载</title></head><body>
<div style="margin-bottom: 10px">文件下载列表:</div>
<table>

    <tr>
        <td>嘻嘻哈哈123456.txt</td>
        <td><a th:href="@{/download(filename='708ebc14-2ca7-4b66-b0bf-3b9c65df6ec1_嘻嘻哈哈123456.txt')}">下载该文件</a></td>
    </tr>

    <tr>
        <td>嘻嘻哈哈123.txt</td>
        <td><a th:href="@{/download(filename='418b0e77-59dc-4697-8a62-6a450d466567_嘻嘻哈哈123.txt')}">下载该文件</a></td>
    </tr>

</table>
</body>
</html>

    上面代码中通过列表展示了要下载的两个 文件名及其下载链接。需要注意的是，在文件下载之前，需要保证在文件下载目录（本示例中的“S:\File”目录）中存在对应的文件，可以自行存放，只要 保持文件名统一 即可。

3.编写文件下载处理方法

  • FileController.java :

    package com.myh.chapter_12.controller;

import jakarta.servlet.http.HttpServletRequest;
import org.apache.commons.io.FileUtils;
import org.springframework.boot.Banner;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.UUID;

/**
 * 文件管理控制类
 */
@Controller //加入到IOC容器中
public class FileController { //关于File的controller类
    
    @GetMapping("/toDownload")
    public String toDownload(){
        return "download";
    }

    /**
     *  "中文名称"文件下载
     */
    @GetMapping("/download")
    public ResponseEntity<byte[]> fileDownload(HttpServletRequest request,String filename) throws Exception{
        //指定下载的文件根路径
        String dirPath = "S:\\File\\";
        //创建该文件对象
        File file = new File(dirPath + File.separator + filename);
        //设置响应头
        HttpHeaders headers = new HttpHeaders();
        //通知浏览器以下载方式打开(下载前对文件名进行转码)
        filename=getFilename(request,filename);
        headers.setContentDispositionFormData("attachment",filename);
        //定义以流的形式下载返回文件数据
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        try {return new ResponseEntity<>(FileUtils.readFileToByteArray(file),
                headers, HttpStatus.OK);} catch (Exception e) {e.printStackTrace();
            return new ResponseEntity<byte[]>(e.getMessage().getBytes(),
                    HttpStatus.EXPECTATION_FAILED);
        }
    }

   //根据浏览器的不同进行编码设置，返回编码后的文件名
    private String getFilename(HttpServletRequest request,String filename)
            throws Exception {
        //IE不同版本User-Agent中出现的关键词
        String[] IEBrowserKeyWords = {"MSIE", "Trident", "Edge"};
        //获取请求头代理信息
        String userAgent = request.getHeader("User-Agent");
        for (String keyWord : IEBrowserKeyWords) {
            if (userAgent.contains(keyWord)) {
                //IE内核浏览器，统一为UTF-8编码显示，并对转换的+进行更正
                return URLEncoder.encode(filename, "UTF-8").replace("+"," ");
            }}
        //火狐等其他浏览器统一为ISO-8859-1编码显示
        return new String(filename.getBytes("UTF-8"), "ISO-8859-1");
    }


}
4.效果测试

  • 启动项目，在浏览器访问 http://localhost:8080/toDownload ，效果如下图所示 ：

    在这里插入图片描述

    在这里插入图片描述

一只大皮卡丘
关注
专栏目录
基于springboot实现的文件下载上传
05-08
利用springboot实现用户注册登录，完善个人资料，文件上传和文件下载，查看自己上传的文件，还有后台管理功能。数据库文件在压缩包中。
Java Spring Boot应用程序中实现文件上传和下载功能
03-27
1、配置文件上传和下载的相关依赖：在pom.xml文件中添加以下依赖： 2、创建文件上传和下载的Controller：创建一个Controller类，用于处理文件上传和下载的请求。可以使用@RestController注解标记该类，并使用@PostMapping和@GetMapping注解分别处理文件上传和下载的请求。 3、实现文件上传功能：在文件上传的方法中，可以使用MultipartFile类型的参数接收上传的文件。通过transferTo()方法将文件保存到指定的路径。 4、实现文件下载功能：在文件下载的方法中，可以使用ResponseEntity作为返回类型，并设置响应头信息，将文件以流的形式写入响应体中。
SPRINGBOOT实现文件上传的多种方式
最新发布
weixin_52041354的博客
09-23 1844
前端：vue2,vue3,vue-cli,webuploader,html5 后端：SpringBoot 数据库：MySQL,Oracle,SQL Server,达梦,人大金仓,国产化数据库 协议：HTTP WebServer：Tomcat,Resin 服务器：Linux,国产化系统 功能：大文件上传，断点续传，秒传，加密传输，加密存储，文件夹上传，文件夹层级结构 技术：支持第三方软件集成， 该说不说，最近这块好像挻火的，今天早上又有网友加我微信，也是想了解一下这块的技术和方案，也不知道这位老哥是从哪里找到
【SpringBoot】SpringBoot：实现文件上传和下载功能
Easonmax的博客
06-15 1712
在现代应用中，用户需要上传各种类型的文件，如图片、文档、视频等，或者下载生成的报告和数据文件。SpringBoot通过其强大的生态系统和简化的配置，能够高效地实现文件上传和下载功能。在完成文件上传和下载功能的开发后，应该进行充分的测试，确保所有功能都能正常工作。通过这种方式，可以确保应用的各个部分在开发过程中得到充分的测试，减少上线后的问题。通过本文的介绍，我们了解了如何使用SpringBoot实现文件上传和下载。为了方便管理上传的文件，我们需要在项目中配置文件存储的位置。这将文件上传目录设置为。
基于SpringBoot实现文件上传和下载(详细讲解And附完整代码)
热门推荐
a910247的博客
03-22 2万+
在Spring Boot中实现文件上传和下载通常涉及到使用Spring MVC的MultipartFile类来处理文件上传，同时配置一个Controller来处理上传和下载请求。 在Spring Boot中实现文件上传和下载通常遵循以下步骤： 配置文件上传位置和大小限制： 首先，需要在Spring Boot应用的配置文件（如application.properties）中配置文件上传的位置和大小限制。这通常涉及设置spring.servlet.multipart相关属性。
Springboot实现文件的上传于下载
m0_47073109的博客
08-11 250
SpringBoot 实现文件的上传于下载 在这里实现了文件的单行上传,多行上传,以及在浏览器完成对指定文件的下载 首先在controller包下创建FileController类 单个文件上传 这里将文件上传到指定的目录下(d:/uploda/) @RequestMapping(value = "/upload") @ResponseBody public String upload(@RequestParam("file") MultipartFile file) {
SpringBoot文件上传下载
weixin_33717117的博客
04-10 176
项目中经常会有上传和下载的需求，这篇文章简述一下springboot项目中实现简单的上传和下载。 新建springboot项目，前台页面使用的thymeleaf模板，其余的没有特别的配置，pom代码如下： <?xml version="1.0" encoding="UTF-8"?> <pro...
Springboot 文件上传、文件下载
howeres的博客
10-03 2097
【代码】Springboot 文件上传、文件下载。
Spring Boot 文件上传原理解析
08-27
但在Spring Boot中，这些配置已经自动完成，只需在`application.properties`中进行调整以满足实际需求，如设置上传目录、最大文件大小和请求大小： ```properties # multipart config spring....
spring boot上传文件出错问题如何解决
08-25
在 Spring Boot 项目中，上传文件时可能会出现 org.springframework.web.multipart.MultipartException 异常，这是因为 Spring Boot 在上传文件时使用了临时文件，临时文件的存储路径默认在 /tmp 目录下。...
使用Spring Boot上传文件功能
08-28
本文对 Spring Boot 上传文件功能进行了详细的讲解，包括项目配置、启动类设置、前端页面编写和上传文件处理等方面的内容。通过本示例，读者可以快速了解 Spring Boot 上传文件功能的使用方法。
springboot实现文件上传和下载功能
08-30
主要为大家详细介绍了springboot实现文件上传和下载功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Spring boot实现文件上传实例（多文件上传)
08-30
在实际应用中，我们通常需要对上传的文件进行一些限制，比如大小、类型等。可以通过校验`MultipartFile`对象来实现这些限制。 **步骤六：多文件上传** 上述代码已经支持了多文件上传，因为`handleFileUpload`方法的...
Springboot文件上传与下载
weixin_58473601的博客
07-17 1888
Springboot文件上传与下载
SpringBoot实现文件上传和下载实现全过程（值得珍藏）
a342874650的专栏
01-21 3918
在Web应用中，文件上传和下载是常见的需求。Spring Boot框架提供了强大的支持和便利的API，使得开发者可以轻松地实现文件上传和下载功能。本文将详细介绍如何在Spring Boot应用中实现文件上传和下载，包括实现原理和完整的代码示例。
SpringBoot 上传下载文件
一个95后开发者，热爱编程，喜欢玩游戏. 希望可以结识更多的小伙伴...
12-11 1703
Spring Boot实现文件上传和下载
HBLOG
09-04 978
Web项目中，文件的上传和下载服务也是基于HTTP请求的，文件上传由于需要向服务接口提交数据，可以使用POST的请求方式，而文件的下载只是获取数据，因此可以使用GET请求方式。项目中经常会有上传和下载的需求，这篇文章简述一下springboot项目中实现简单的上传和下载。创建好指定的文件存放路径文件夹后，上传逻辑只需要将接收到的文件数据赋值到指定路径后即可。文件的下载逻辑是根据指定的文件名称到文件资源文件夹中获取，如果存在则返回文件。以上只是一些关键代码，所有代码请参见下面代码仓库。
SpringBoot文件上传和下载
程序员小王的博客
11-26 1万+
SpringBoot文件上传和下载 一、SpringBoot文件上传 1、SpringMVC文件上传 1、Client处理 选择文件 （1）form表单 选择文件 method="post" （2）enctype="multipart/form-data" (3) 准备文件框<input type="file" name="upload"> 2、服务端准备存储上传文件的目录 新建文件夹 项目/webapp/upload文件 3、开发文件上传Controller public
SpringBoot的文件上传与下载
reresrse的博客
05-11 325
SpringBoot的文件上传与下载
Springboot文件上传下载
07-16
SpringBoot实现文件上传下载的方法有很多，常见的有以下几种： 1. 使用 Spring 的 `MultipartFile` 接口和 `CommonsMultipartResolver` 组件实现上传。 2. 使用 SpringBoot 自带的文件上传功能，只需要在配置文件中配置好上传文件的路径即可。 3. 使用第三方库实现，如 `Spring-File-Upload` 等。 具体实现方法可以参考SpringBoot官方文档或者网上相关教程。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值