SpringBoot项目中实现文件下载功能

springboot 项目中&＃xff0c;可能会存在让用户下载文档的需求&＃xff0c;比如让用户下载 readme、模板等 文档来更好地了解该项目的概况或使用方法。 所以&＃xff0c;您需要为用户提供可以下载文件的 API &＃xff0c;将用户希望获取的文件作为下载资源返回给前端用户。

1.创建好一个 springboot 项目&＃xff0c;一定要引入 web 依赖&＃xff1a;

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>


2.在application.yml 中&＃xff0c;进行如下属性配置&＃xff1a;

file:doc-dir: doc/


该路径就是待下载文件存放在服务器上的目录&＃xff0c;为相对路径&＃xff0c;表示与当前项目&＃xff08;jar包&＃xff09;的相对位置。

3.springboot 中的注解 &＃64;ConfigurationProperties 可以将 application 中定义的属性与 pojo 类自动绑定。所以&＃xff0c;我们需要定义一个 pojo 类来做 application 中 file.doc-dir&＃61;doc/ 的配置绑定&＃xff1a;

&＃64;ConfigurationProperties(prefix &＃61; "file")
&＃64;Data
public class FileProperties {private String docDir;
}


注解 &＃64;ConfigurationProperties(prefix &＃61; “file”) 在 springboot 应用启动时将 file 为前缀的属性与 pojo 类绑定&＃xff0c;也就是将 application.yml 中的 file.doc-dir 与 FileProperties 中的字段 docDir 做了绑定。

4.在启动类或其他配置类&＃xff08;&＃64;Configuration注解标记&＃xff09;上加入 &＃64;EnableConfigurationProperties 即可让 ConfigurationProperties 特性生效。

&＃64;SpringBootApplication
&＃64;EnableConfigurationProperties({FileProperties.class})
public class AutoTestApplication {public static void main(String[] args) {SpringApplication.run(AutoTestApplication.class, args);}}


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

&＃64;RestController
&＃64;RequestMapping("file")
public class FileController {private static final Logger logger &＃61; LoggerFactory.getLogger(FileController.class);&＃64;Autowiredprivate FileService fileService;&＃64;GetMapping("download/{fileName}")public ResponseEntity<Resource> downloadFile(&＃64;PathVariable String fileName,HttpServletRequest request) {Resource resource &＃61; fileService.loadFileAsResource(fileName);String contentType &＃61; null;try {contentType &＃61; request.getServletContext().getMimeType(resource.getFile().getAbsolutePath());} catch (IOException e) {logger.error("无法获取文件类型", e);}if (contentType &＃61;&＃61; null) {contentType &＃61; "application/octet-stream";}return ResponseEntity.ok().contentType(MediaType.parseMediaType(contentType)).header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename&＃61;\"" &＃43; resource.getFilename() &＃43; "\"").body(resource);}
}


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

&＃64;Service
public class FileServiceImpl implements FileService {private final Path filePath;&＃64;Autowiredpublic FileServiceImpl(FileProperties fileProperties) {filePath &＃61; Paths.get(fileProperties.getDocDir()).toAbsolutePath().normalize();}&＃64;Overridepublic Resource loadFileAsResource(String fileName) {Path path &＃61; filePath.resolve(fileName).normalize();try {UrlResource resource &＃61; new UrlResource(path.toUri());if (resource.exists()) {return resource;}throw new FileException("file " &＃43; fileName &＃43; " not found");} catch (MalformedURLException e) {throw new FileException("file " &＃43; fileName &＃43; " not found", e);}}
}


7.自定义异常
在服务层&＃xff0c;我们抛出自定义的文件异常 FileException.

public class FileException extends RuntimeException {public FileException(String message) {super(message);}public FileException(String message, Throwable cause) {super(message, cause);}
}


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

<a href&＃61;"/file/download/readme.pdf" download>下载使用手册</a>


如果对你有帮助&＃xff0c;请一定要帮忙点赞好评&＃xff0c;给予创作的动力…