米葫芦网

Spring Boot 文件上传与下载的示例代码

热度:1℃ 发布时间:2024-07-03 01:02:24

文件的上传及下载功能是开发人员在日常应用及编程开发中经常会遇到的。正好最近开发需要用到此功能,虽然本人是 Android 开发人员,但还是业余客串了一下后台开发。

在本文中,您将学习如何使用 Spring Boot 实现 Web 服务中的文件上传和下载功能。首先会构建一个 REST APIs 实现上传及下载的功能,然后使用 Postman 工具来测试这些接口,最后创建一个 Web 界面使用 JavaScript 调用接口演示完整的功能。最终界面及功能如下:

Spring Boot 文件上传与下载的示例代码Spring Boot 文件上传与下载的示例代码

项目环境

Spring Boot 文件上传与下载的示例代码

项目创建

开发环境为 Intellij IDEA,项目创建很简单,按照下面的步骤创建即可:

File -> New -> Project...

选择 Spring Initializr,点击 Next

填写 Group (项目域名) 和 Artifact (项目别名)

构建类型可以选择 Maven 或 Gradle, 看个人习惯

添加 Web 依赖

输入项目名称及保存路径,完成创建

项目创建完毕之后就可以进行开发,项目的完整结构如下图所示:

Spring Boot 文件上传与下载的示例代码Spring Boot 文件上传与下载的示例代码

参数配置

项目创建完成之后,需要设置一些必要的参数,打开项目resources目录下配置文件application.properties,在其中添加以下参数:

Spring Boot 文件上传与下载的示例代码

其中file.upload-dir=./uploads参数为自定义的参数,创建FileProperties.javaPOJO类,使配置参数可以自动绑定到POJO类。

Spring Boot 文件上传与下载的示例代码

然后在@SpringBootApplication注解的类中添加@EnableConfigurationProperties注解以开启ConfigurationProperties功能。

SpringBootFileApplication.java

Spring Boot 文件上传与下载的示例代码

配置完成,以后若有file前缀开头的参数需要配置,可直接在application.properties配置文件中配置并更新FileProperties.java即可。

另外再创建一个上传文件成功之后的Response响应实体类UploadFileResponse.java及异常类FileException.java来处理异常信息。

UploadFileResponse.java

Spring Boot 文件上传与下载的示例代码

FileException.java

Spring Boot 文件上传与下载的示例代码

创建接口

下面需要创建文件上传下载所需的 REST APIs 接口。创建文件FileController.java。

Spring Boot 文件上传与下载的示例代码

Spring Boot 文件上传与下载的示例代码

FileController类在接收到用户的请求后,使用FileService类提供的storeFile()方法将文件写入到系统中进行存储,其存储目录就是之前在application.properties配置文件中的file.upload-dir参数的值./uploads。

下载接口downloadFile()在接收到用户请求之后,使用FileService类提供的loadFileAsResource()方法获取存储在系统中文件并返回文件供用户下载。

FileService.java

Spring Boot 文件上传与下载的示例代码

Spring Boot 文件上传与下载的示例代码

接口测试

在完成上述的代码之后,打开SpringBootFileApplication.java并运行,运行完成之后就可以使用 Postman 进行测试了。

单个文件上传结果:

Spring Boot 文件上传与下载的示例代码Spring Boot 文件上传与下载的示例代码

多个文件上传结果:

Spring Boot 文件上传与下载的示例代码Spring Boot 文件上传与下载的示例代码

文件下载结果:

Spring Boot 文件上传与下载的示例代码Spring Boot 文件上传与下载的示例代码

Web 前端开发

index.html

Spring Boot 文件上传与下载的示例代码

main.css

Spring Boot 文件上传与下载的示例代码

Spring Boot 文件上传与下载的示例代码

Spring Boot 文件上传与下载的示例代码

main.js


总结

至此,文件的上传及下载功能已完成。在正式环境中可能还需要将上传的文件存储到数据库,此处按照实际需求去处理即可。

网友评论
评论
发 布

更多软件教程
  • 软件教程推荐
更多+
Greenfoot设置中文的方法

Greenfoot设置中文的方法

Greenfoot是一款简单易用的Java开发环境,该软件界面清爽简约,既可以作为一个开发框使用,也能够作为集成开发环境使用,操作起来十分简单。这款软件支持多种语言,但是默认的语言是英文,因此将该软件下载到电脑上的时候,会发现软件的界面语言是英文版本的,这对于英语基础较差的朋友来说,使用这款软件就会...

07-05

Egret UI Editor修改快捷键的方法

Egret UI Editor修改快捷键的方法

Egret UI Editor是一款开源的2D游戏开发代码编辑软件,其主要功能是针对Egret项目中的Exml皮肤文件进行可视化编辑,功能十分强大。我们在使用这款软件的过程中,可以将一些常用操作设置快捷键,这样就可以简化编程,从而提高代码编辑的工作效率。但是这款软件在日常生活中使用得不多,并且专业性...

07-05

KittenCode新建项目的方法

KittenCode新建项目的方法

KittenCode是一款十分专业的编程软件,该软件给用户提供了可视化的操作界面,支持Python语言的编程开发以及第三方库管理,并且提供了很多实用的工具,功能十分强大。我们在使用这款软件进行编程开发的过程中,最基本、最常做的操作就是新建项目,因此我们很有必要掌握新建项目的方法。但是这款软件的专业性...

07-05

Thonny设置中文的方法

Thonny设置中文的方法

Thonny是一款十分专业的Python编辑软件,该软件界面清爽简单,给用户提供了丰富的编程工具,具备代码补全、语法错误显示等功能,非常的适合新手使用。该软件还支持多种语言,所以在下载这款软件的时候,有时候下载到电脑中的软件是英文版本的,这对于英语基础较差的小伙伴来说,使用这款软件就会变得十分困难,...

07-05

最新软件下载