如何在 Beego 中正确返回 JSON 响应供前端 AJAX 调用

心靈之曲 2026-01-14 00:00:00 次阅读

本文介绍在 beego 框架中通过 `servejson()` 方法快速、安全地返回结构化 json 数据，适配 jquery ajax 的 success 回调，避免手动序列化和 content-type 设置错误。

在 Beego 中返回 JSON 并非需要手动调用 json.Marshal() 再设置响应头——框架已内置标准化支持。推荐使用控制器（Controller）提供的 ServeJSON() 方法，它会自动完成三件事：
✅ 序列化 Go 结构体或 map 为 JSON 字符串；
✅ 设置正确的 Content-Type: application/json; charset=utf-8 响应头；
✅ 发送 HTTP 状态码 200（可选自定义状态码）。

✅ 正确用法示例

func (c *MainController) GetUserInfo() {
    // 构造响应数据（支持 struct、map、slice 等可序列化类型）
    data := map[string]interface{}{
        "code": 200,
        "msg":  "success",
        "data": map[string]string{
            "name": "Alice",
            "role": "admin",
        },
    }
    c.ServeJSON(data, false) // 第二个参数 false 表示不格式化（压缩输出），true 则美化（仅调试用）
}

? 注意：ServeJSON(data, pretty) 中第二个参数为 bool，默认 false（生产环境推荐），设为 true 时会输出缩进格式化的 JSON，便于调试但增加传输体积。

⚠️ 常见误区与注意事项

❌ 不要手动 json.Marshal() + c.Ctx.WriteString()：易遗漏 Content-Type，且无法统一处理错误或编码问题；
❌ 避免在 ServeJSON() 后继续执行其他响应逻辑（如 c.TplName 或 c.Redirect()），会导致 panic 或响应冲突；
✅ 若需自定义 HTTP 状态码（如 400、500），请先调用 c.Ctx.ResponseWriter.WriteHeader(statusCode)，再调用 ServeJSON()；
✅ Beego v2+ 默认启用 JSONEscapeHTML: true（防止 XSS），若需返回含的原始字符串，可在 app.conf 中配置：
```
JSONEscapeHTML = false
```

? 前端 jQuery 调用示例（验证兼容性）

$.ajax({
    url: "/api/user",
    type: "GET",
    dataType: "json",
    success: function(res) {
        console.log("Code:", res.code);
        console.log("User:", res.data.name);
    },
    error: function(xhr) {
        console.error("Request failed:", xhr.status, xhr.responseText);
    }
});