如何在Gin中编写GET端点实现文件+JSON元数据单次下载

已实现支持上传文件+JSON格式元数据的端点并完成存储，但编写允许用户单次调用即可下载文件与JSON元数据的GET端点时遇到问题。当前代码会将JSON元数据附加在文件内容开头，而非作为独立对象返回：

jsonData, err := json.Marshal(metadata)
// Set the response headers
c.Header("Content-Disposition", "attachment; filename=file.md")
c.Header("Content-Type", "application/octet-stream")

// Write the file contents and JSON data to the response body
c.Writer.Write(jsonData)
c.Writer.Write(file)

直接将JSON和文件内容拼接成二进制流返回，必然导致两者混在一起。以下是几种可行的解决思路：

1. 打包为ZIP文件返回 #

这是最通用的方案，将元数据保存为独立的JSON文件，和目标文件一起打包成ZIP返回，用户下载后可分别获取两个文件：

import (
    "bytes"
    "archive/zip"
    "net/http"
)

// 创建内存ZIP缓冲区
buf := new(bytes.Buffer)
zipWriter := zip.NewWriter(buf)
defer zipWriter.Close()

// 添加元数据文件
metaFile, err := zipWriter.Create("metadata.json")
if err != nil {
    c.AbortWithError(http.StatusInternalServerError, err)
    return
}
if _, err := metaFile.Write(jsonData); err != nil {
    c.AbortWithError(http.StatusInternalServerError, err)
    return
}

// 添加目标文件
targetFile, err := zipWriter.Create("file.md")
if err != nil {
    c.AbortWithError(http.StatusInternalServerError, err)
    return
}
if _, err := targetFile.Write(file); err != nil {
    c.AbortWithError(http.StatusInternalServerError, err)
    return
}

// 设置响应头并返回ZIP内容
c.Header("Content-Disposition", "attachment; filename=file_with_metadata.zip")
c.Header("Content-Type", "application/zip")
c.Writer.Write(buf.Bytes())

2. 使用多部分响应（适合程序调用场景） #

通过multipart/form-data格式返回两个独立的内容块，分别对应元数据和文件。这种方式需要客户端支持解析多部分响应：

import (
    "net/http"
    "github.com/google/uuid" // 需要引入UUID库生成边界符
)

// 生成唯一的多部分边界符
boundary := "file-meta-boundary-" + uuid.NewString()
c.Header("Content-Type", "multipart/form-data; boundary="+boundary)

// 写入元数据部分
c.Writer.WriteString("--" + boundary + "\r\n")
c.Writer.WriteString("Content-Disposition: form-data; name=\"metadata\"\r\n")
c.Writer.WriteString("Content-Type: application/json\r\n\r\n")
c.Writer.Write(jsonData)
c.Writer.WriteString("\r\n")

// 写入文件部分
c.Writer.WriteString("--" + boundary + "\r\n")
c.Writer.WriteString("Content-Disposition: form-data; name=\"file\"; filename=\"file.md\"\r\n")
c.Writer.WriteString("Content-Type: text/markdown\r\n\r\n")
c.Writer.Write(file)
c.Writer.WriteString("\r\n--" + boundary + "--\r\n")

注意：普通浏览器下载多部分响应会得到无法直接打开的文件，该方案更适合后端服务或客户端程序调用。

3. 将元数据放入自定义响应头（适合小体积元数据） #

如果元数据内容较小，可将其转义后放入自定义响应头，文件内容正常返回：

import (
    "net/http"
    "net/url"
)

// 转义元数据字符串，避免特殊字符破坏响应头格式
escapedMeta := url.QueryEscape(string(jsonData))
c.Header("X-File-Metadata", escapedMeta)

// 设置文件响应头并返回文件内容
c.Header("Content-Disposition", "attachment; filename=file.md")
c.Header("Content-Type", "text/markdown") // 根据实际文件类型调整
c.Writer.Write(file)

客户端可读取X-File-Metadata响应头，通过url.QueryUnescape解码得到原始JSON元数据。

内容的提问来源于stack exchange，提问作者AVarf