這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)碛嘘P(guān)SpringBoot項(xiàng)目中怎么實(shí)現(xiàn)文件下載功能,文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述,閱讀完這篇文章希望大家可以有所收獲。
成都創(chuàng)新互聯(lián)-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價(jià)比清澗網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式清澗網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們,業(yè)務(wù)覆蓋清澗地區(qū)。費(fèi)用合理售后完善,十年實(shí)體公司更值得信賴。maven 依賴
請(qǐng)您創(chuàng)建好一個(gè) springboot 項(xiàng)目,一定要引入 web 依賴:
建議引入 thymeleaf 作為前端模板:
配置 application
在您的application.yml
中,進(jìn)行如下屬性配置:
file: doc-dir: doc/
該路徑就是待下載文件存放在服務(wù)器上的目錄,為相對(duì)路徑,表示與當(dāng)前項(xiàng)目(jar包)的相對(duì)位置。
將屬性與 pojo 類自動(dòng)綁定
springboot 中的注解@ConfigurationProperties
可以將 application 中定義的屬性與 pojo 類自動(dòng)綁定。所以,我們需要定義一個(gè) pojo 類來做 application 中file.doc-dir=doc/
的配置綁定:
@ConfigurationProperties(prefix = "file")@Datapublic class FileProperties { private String docDir;}
注解@ConfigurationProperties(prefix = "file")
在 springboot 應(yīng)用啟動(dòng)時(shí)將 file 為前綴的屬性與 pojo 類綁定,也就是將application.yml
中的 file.doc-dir
與 FileProperties 中的字段 docDir 做了綁定。
激活配置屬性
在啟動(dòng)類或其他配置類(@Configuration注解標(biāo)記)上加入 @EnableConfigurationProperties 即可讓 ConfigurationProperties 特性生效。
@SpringBootApplication@EnableConfigurationProperties({FileProperties.class})public class AutoTestApplication { public static void main(String[] args) { SpringApplication.run(AutoTestApplication.class, args); }}
控制層
在控制層我們將以 spring 框架的 ResponseEntity 類作為返回值傳給前端,其中泛型為 spring io 包的 Resource 類,這意味著返回內(nèi)容為 io 流資源;并在返回體頭部添加附件,以便于前端頁面下載文件。
@RestController@RequestMapping("file")public class FileController { private static final Logger logger = LoggerFactory.getLogger(FileController.class); @Autowired private FileService fileService; @GetMapping("download/{fileName}") public ResponseEntity
服務(wù)層
服務(wù)層的主要工作是把文件作為 IO 資源加載。注意,在 Service 實(shí)現(xiàn)類的構(gòu)造方法中要使用 @Autowired 注入前面定義好的屬性綁定類 FileProperties.
@Servicepublic class FileServiceImpl implements FileService { private final Path filePath; @Autowired public FileServiceImpl(FileProperties fileProperties) { filePath = Paths.get(fileProperties.getDocDir()).toAbsolutePath().normalize(); } @Override public Resource loadFileAsResource(String fileName) { Path path = filePath.resolve(fileName).normalize(); try { UrlResource resource = new UrlResource(path.toUri()); if (resource.exists()) { return resource; } throw new FileException("file " + fileName + " not found"); } catch (MalformedURLException e) { throw new FileException("file " + fileName + " not found", e); } }}
自定義異常
在服務(wù)層,我們拋出自定義的文件異常 FileException.
public class FileException extends RuntimeException { public FileException(String message) { super(message); } public FileException(String message, Throwable cause) { super(message, cause); }}
前端
在前端 html 頁面,可以使用 a 標(biāo)簽來下載文件,注意在 a 標(biāo)簽中定義 download 屬性來規(guī)定這是一個(gè)下載文件。
上述就是小編為大家分享的SpringBoot項(xiàng)目中怎么實(shí)現(xiàn)文件下載功能了,如果剛好有類似的疑惑,不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。