首页 > 软件编程 > java > SpringBoot下载JSON

详解如何使用SpringBoot实现下载JSON文件

2025-02-12 10:37:22 作者：小信丶

在 Spring Boot 中实现文件下载功能,可以通过将 JSON 字符串作为文件内容返回给客户端从而实现JSON文件下载效果,下面我们就来看看具体操作吧

概述

在 Spring Boot 中实现文件下载功能，可以通过将 JSON 字符串作为文件内容返回给客户端。以下是实现步骤和代码示例：

实现步骤

定义接口：创建一个 REST 控制器，用于处理文件下载请求。

设置响应头：通过 HttpServletResponse 设置响应头，指定文件类型和下载文件名。

返回文件内容：将 JSON 字符串写入响应输出流。

代码实现

1. 创建 Spring Boot 控制器

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
 
@RestController
@RequestMapping("/api")
public class FileDownloadController {
 
    @GetMapping("/download-json")
    public void downloadJsonFile(HttpServletResponse response) throws IOException {
        // 1. 准备 JSON 字符串
        String jsonContent = "{\"name\":\"John\", \"age\":30, \"city\":\"New York\"}";
 
        // 2. 设置响应头
        response.setContentType("application/json"); // 文件类型为 JSON
        response.setHeader("Content-Disposition", "attachment; filename=\"data.json\""); // 设置下载文件名
 
        // 3. 将 JSON 字符串写入响应输出流
        response.getOutputStream().write(jsonContent.getBytes(StandardCharsets.UTF_8));
        response.getOutputStream().flush();
    }
}

2. 运行并测试

启动 Spring Boot 应用。

在浏览器中访问接口地址，例如：http://localhost:8080/api/download-json。

浏览器会自动下载一个名为 data.json 的文件，文件内容为：

{"name":"John", "age":30, "city":"New York"}

关键点说明

1.HttpServletResponse：

用于设置响应头和输出流。
setContentType("application/json")：指定文件类型为 JSON。
setHeader("Content-Disposition", "attachment; filename=\"data.json\"")：指定文件名为 data.json，并告诉浏览器以附件形式下载。

2.文件内容写入：

使用 response.getOutputStream().write() 将 JSON 字符串写入响应输出流。
确保使用 StandardCharsets.UTF_8 指定字符编码，避免乱码问题。

3.文件名：

可以根据需要动态生成文件名，例如：

String fileName = "data_" + System.currentTimeMillis() + ".json";
response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");

扩展功能

动态生成 JSON 内容：可以从数据库或其他服务中获取数据，动态生成 JSON 字符串。

压缩文件下载：如果需要下载压缩文件（如 .zip），可以使用 ZipOutputStream 将多个文件打包后返回。

大文件下载：对于大文件，可以使用分块传输（Transfer-Encoding: chunked）来优化性能。

示例：动态生成 JSON 内容

@GetMapping("/download-dynamic-json")
public void downloadDynamicJsonFile(HttpServletResponse response) throws IOException {
    // 动态生成 JSON 数据
    Map<String, Object> data = new HashMap<>();
    data.put("timestamp", System.currentTimeMillis());
    data.put("message", "Hello, this is a dynamic JSON file!");
 
    // 将 Map 转换为 JSON 字符串
    String jsonContent = new ObjectMapper().writeValueAsString(data);
 
    // 设置响应头
    response.setContentType("application/json");
    response.setHeader("Content-Disposition", "attachment; filename=\"dynamic_data.json\"");
 
    // 写入响应输出流
    response.getOutputStream().write(jsonContent.getBytes(StandardCharsets.UTF_8));
    response.getOutputStream().flush();
}

访问 http://localhost:8080/api/download-dynamic-json，会下载一个包含动态生成内容的 JSON 文件。

到此这篇关于详解如何使用SpringBoot实现下载JSON文件的文章就介绍到这了,更多相关SpringBoot下载JSON内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！