当前位置：首页 > 行业动态 > 正文

beego api json 输出

admin
行业动态
2025-04-09
6

Beego API JSON 输出指南

在Web开发中,API接口通常以JSON格式返回数据，Beego作为一款优秀的Go语言Web框架，提供了简单高效的JSON输出功能，本文将详细介绍如何在Beego中正确输出JSON响应。

基本JSON输出

Beego控制器中输出JSON非常简单：

func (c *MainController) Get() {
    data := map[string]interface{}{
        "code":    200,
        "message": "success",
        "data":    "Hello, Beego!",
    }
    c.Data["json"] = data
    c.ServeJSON()
}

这段代码会输出：

{
    "code": 200,
    "message": "success",
    "data": "Hello, Beego!"
}

自定义JSON格式

Beego允许自定义JSON输出的格式和内容：

func (c *MainController) GetUser() {
    user := models.User{
        ID:   1,
        Name: "张三",
        Age:  28,
    }
    response := struct {
        Status  int         `json:"status"`
        Message string      `json:"message"`
        Data    interface{} `json:"data"`
    }{
        Status:  200,
        Message: "用户信息获取成功",
        Data:    user,
    }
    c.Data["json"] = response
    c.ServeJSON()
}

错误处理与JSON输出

在API开发中,错误处理同样需要返回JSON格式：

func (c *MainController) GetUserByID() {
    id, err := c.GetInt(":id")
    if err != nil {
        c.Data["json"] = map[string]interface{}{
            "code":    400,
            "message": "参数错误",
        }
        c.ServeJSON()
        return
    }
    user, err := models.GetUserByID(id)
    if err != nil {
        c.Data["json"] = map[string]interface{}{
            "code":    404,
            "message": "用户不存在",
        }
        c.ServeJSON()
        return
    }
    c.Data["json"] = map[string]interface{}{
        "code":    200,
        "message": "success",
        "data":    user,
    }
    c.ServeJSON()
}

设置HTTP状态码

在返回JSON时,有时需要设置HTTP状态码：

func (c *MainController) CreateUser() {
    var user models.User
    if err := c.ParseForm(&user); err != nil {
        c.Ctx.Output.SetStatus(400)
        c.Data["json"] = map[string]interface{}{
            "code":    400,
            "message": "参数解析失败",
        }
        c.ServeJSON()
        return
    }
    // 业务处理...
    c.Ctx.Output.SetStatus(201) // 201 Created
    c.Data["json"] = map[string]interface{}{
        "code":    201,
        "message": "用户创建成功",
        "data":    user,
    }
    c.ServeJSON()
}

JSONP支持

Beego也支持JSONP格式输出：

func (c *MainController) GetJSONP() {
    data := map[string]interface{}{
        "code":    200,
        "message": "success",
        "data":    "JSONP response",
    }
    c.Data["json"] = data
    c.ServeJSONP()
}

性能优化

对于大量数据输出,可以使用jsoniter等高性能JSON库替代标准库：

import "github.com/json-iterator/go"
func init() {
    beego.BConfig.WebConfig.EnableXSRF = false
    beego.BConfig.WebConfig.EnableDocs = true
    beego.BConfig.WebConfig.JsonMarshalFunc = jsoniter.Marshal
}