![defe6ca2d954653dfae92b6ea6ef15a5.png](https://img-blog.csdnimg.cn/img_convert/defe6ca2d954653dfae92b6ea6ef15a5.png)
(一)需求
在您的 springboot 项目中,可能会存在让用户下载文档的需求,比如让用户下载 readme 文档来更好地了解该项目的概况或使用方法。
所以,您需要为用户提供可以下载文件的 API ,将用户希望获取的文件作为下载资源返回给前端。
![1d6bc6226b0c0209a425414ae90546ce.png](https://img-blog.csdnimg.cn/img_convert/1d6bc6226b0c0209a425414ae90546ce.png)
(二)代码
maven 依赖
请您创建好一个 springboot 项目,一定要引入 web 依赖:
<
建议引入 thymeleaf 作为前端模板:
<
配置 application
在您的 application.yml 中,进行如下属性配置:
file:
doc-dir: doc/
该路径就是待下载文件存放在服务器上的目录,为相对路径,表示与当前项目(jar包)的相对位置。
![81433ee44c269d2c8b0dac611800a7b6.png](https://img-blog.csdnimg.cn/img_convert/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](https://img-blog.csdnimg.cn/img_convert/2591ae65ded97e259b09d33e20147021.png)
控制层
在控制层我们将以 spring 框架的 ResponseEntity 类作为返回值传给前端,其中泛型为 spring io 包的 Resource 类,这意味着返回内容为 io 流资源;并在返回体头部添加附件,以便于前端页面下载文件。
@RestController
服务层
服务层的主要工作是把文件作为 IO 资源加载。注意,在 Service 实现类的构造方法中要使用 @Autowired 注入前面定义好的属性绑定类 FileProperties.
@Service
![45eb8309ca813580c4eab09430245591.png](https://img-blog.csdnimg.cn/img_convert/45eb8309ca813580c4eab09430245591.png)
自定义异常
在服务层,我们抛出自定义的文件异常 FileException.
public
前端
在前端 html 页面,可以使用 a 标签来下载文件,注意在 a 标签中定义 download 属性来规定这是一个下载文件。
<
------本文完结-------
感谢你的阅读,如果喜欢的话**评论、转发**一下再走吧!!!
以后会有更多精彩内容呈现欢迎**关注**!!!