Spring Boot 前端 GET/POST 请求下载文件多种方式解析
在 Spring Boot 应用中，前端 GET/POST 请求下载文件是常见的需求，本文将详细解析多种实现方式，包括代码示例、源码解析以及优缺点分析，帮助你更清晰地理解并掌握文件下载的技巧。
一、GET 请求下载
GET 请求下载文件是 RESTful API 规范中推荐的方式，它简单易用，并且易于调试。
- 编写 RESTful API 接口
@RestController
@RequestMapping("/download")
public class DownloadController {
@GetMapping("/{fileName}")
public ResponseEntity<Resource> downloadFile(@PathVariable String fileName) {
// 获取文件路径
File file = new File("path/to/file/" + fileName);
// 设置响应头信息
HttpHeaders headers = new HttpHeaders();
headers.setContentDisposition(ContentDisposition.attachment().filename(fileName));
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
// 返回文件内容
return ResponseEntity.ok().headers(headers).body(new InputStreamResource(new FileInputStream(file)));
}
}
- 前端代码实现
function downloadFile(fileName) {
// 发送 GET 请求，并处理响应
axios.get('/download/' + fileName, { responseType: 'blob' })
.then(response => {
const url = window.URL.createObjectURL(response.data);
const link = document.createElement('a');
link.href = url;
link.setAttribute('download', fileName);
document.body.appendChild(link);
link.click();
document.body.removeChild(link);
})
.catch(error => {
console.error('下载文件失败：', error);
});
}
二、POST 请求下载
POST 请求下载文件适用于需要传递更多参数或进行更多操作的场景，例如需要进行文件加密或压缩后再下载。
- 编写 RESTful API 接口
@RestController
@RequestMapping("/download")
public class DownloadController {
@PostMapping
public ResponseEntity<Resource> downloadFile(@RequestBody DownloadRequest request) {
// 获取文件路径
File file = new File("path/to/file/" + request.getFileName());
// 设置响应头信息
HttpHeaders headers = new HttpHeaders();
headers.setContentDisposition(ContentDisposition.attachment().filename(request.getFileName()));
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
// 返回文件内容
return ResponseEntity.ok().headers(headers).body(new InputStreamResource(new FileInputStream(file)));
}
}
- 前端代码实现
function downloadFile(data) {
// 发送 POST 请求，并处理响应
axios.post('/download', data, { responseType: 'blob' })
.then(response => {
const url = window.URL.createObjectURL(response.data);
const link = document.createElement('a');
link.href = url;
link.setAttribute('download', data.fileName);
document.body.appendChild(link);
link.click();
document.body.removeChild(link);
})
.catch(error => {
console.error('下载文件失败：', error);
});
}
三、第三方库 - SpringFox Swagger
SpringFox Swagger 是一个强大的工具，可用于为 RESTful API 生成交互式文档和测试工具。
- 配置 Swagger
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.api"))
.paths(PathSelectors.any())
.build();
}
- 使用 Swagger 下载文件
在 Swagger 生成的 UI 中，你可以直接选择要下载的文件并点击下载按钮。
四、总结
这三种方式各有优缺点，选择哪种方式取决于具体的应用场景。
- GET 请求简单易用，适用于大多数场景。
- POST 请求更灵活，适用于需要传递更多参数或进行更多操作的场景。
- SpringFox Swagger 适用于需要生成交互式文档和测试工具的场景。
希望本文能帮助你更好地理解 Spring Boot 前端 GET/POST 请求下载文件，并选择最适合你的方案。
互动与讨论
如果你在 Spring Boot 文件下载方面遇到任何问题，或者有更好的实践经验，欢迎在评论区分享你的见解和讨论，你的参与将帮助更多开发者解决类似问题。