springboot下载文件_如何在SpringBoot项目中实现文件下载功能?阿里大牛带你轻松实现...

defe6ca2d954653dfae92b6ea6ef15a5.png

(一)需求

在您的 springboot 项目中,可能会存在让用户下载文档的需求,比如让用户下载 readme 文档来更好地了解该项目的概况或使用方法。

所以,您需要为用户提供可以下载文件的 API ,将用户希望获取的文件作为下载资源返回给前端。

1d6bc6226b0c0209a425414ae90546ce.png

(二)代码

maven 依赖

请您创建好一个 springboot 项目,一定要引入 web 依赖:

<

建议引入 thymeleaf 作为前端模板:

<

配置 application

在您的 application.yml 中,进行如下属性配置:

file:
 doc-dir: doc/

该路径就是待下载文件存放在服务器上的目录,为相对路径,表示与当前项目(jar包)的相对位置。

81433ee44c269d2c8b0dac611800a7b6.png

将属性与 pojo 类自动绑定

springboot 中的注解 @ConfigurationProperties可以将 application 中定义的属性与 pojo 类自动绑定。所以,我们需要定义一个 pojo 类来做 application 中 file.doc-dir=doc/的配置绑定:

@ConfigurationProperties

注解@ConfigurationProperties(prefix = "file")在 springboot 应用启动时将 file 为前缀的属性与 pojo 类绑定,也就是将 application.yml 中的 file.doc-dir与FileProperties中的字段 docDir 做了绑定。

激活配置属性

在启动类或其他配置类(@Configuration注解标记)上加入 @EnableConfigurationProperties即可让 ConfigurationProperties 特性生效。

@SpringBootApplication

2591ae65ded97e259b09d33e20147021.png

控制层

在控制层我们将以 spring 框架的 ResponseEntity 类作为返回值传给前端,其中泛型为 spring io 包的 Resource 类,这意味着返回内容为 io 流资源;并在返回体头部添加附件,以便于前端页面下载文件。

@RestController

服务层

服务层的主要工作是把文件作为 IO 资源加载。注意,在 Service 实现类的构造方法中要使用 @Autowired 注入前面定义好的属性绑定类 FileProperties.

@Service

45eb8309ca813580c4eab09430245591.png

自定义异常

在服务层,我们抛出自定义的文件异常 FileException.

public 

前端

在前端 html 页面,可以使用 a 标签来下载文件,注意在 a 标签中定义 download 属性来规定这是一个下载文件。

<

------本文完结-------

感谢你的阅读,如果喜欢的话**评论、转发**一下再走吧!!!

以后会有更多精彩内容呈现欢迎**关注**!!!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值