golang怎么返回json

Go语言如何优雅地返回JSON数据

在Go语言开发中，处理HTTP响应并返回JSON数据是一项非常常见的任务，Go标准库提供了强大的encoding/json包来处理JSON数据的编码和解码，结合net/http包，可以轻松实现JSON数据的返回,本文将详细介绍在Go中返回JSON数据的各种方法和最佳实践。

基本JSON返回方法

使用json.Marshal和http.ResponseWriter

最基本的方法是使用json.Marshal将结构体或数据转换为JSON字节切片，然后通过http.ResponseWriter写入响应。

package main
import (
    "encoding/json"
    "net/http"
)
type User struct {
    ID       int    `json:"id"`
    Username string `json:"username"`
    Email    string `json:"email"`
}
func main() {
    http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
        user := User{
            ID:       1,
            Username: "john_doe",
            Email:    "john@example.com",
        }
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(http.StatusOK)
        json.NewEncoder(w).Encode(user)
    })
    http.ListenAndServe(":8080", nil)
}

使用json.MarshalIndent美化输出

如果需要格式化的JSON输出（便于调试），可以使用json.MarshalIndent：

func main() {
    http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
        user := User{
            ID:       1,
            Username: "john_doe",
            Email:    "john@example.com",
        }
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(http.StatusOK)
        prettyJSON, _ := json.MarshalIndent(user, "", "    ")
        w.Write(prettyJSON)
    })
    http.ListenAndServe(":8080", nil)
}

更优雅的实现方式

使用结构体标签控制JSON字段

Go的结构体标签可以灵活控制JSON字段的名称、是否忽略等：

type User struct {
    ID       int    `json:"id"`
    Username string `json:"username"`
    Email    string `json:"email"`
    Password string `json:"-"` // 忽略此字段
}

处理JSON编码错误

在实际应用中,应该处理JSON编码过程中可能出现的错误：

func main() {
    http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
        user := User{
            ID:       1,
            Username: "john_doe",
            Email:    "john@example.com",
        }
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(http.StatusOK)
        if err := json.NewEncoder(w).Encode(user); err != nil {
            http.Error(w, "Failed to encode JSON", http.StatusInternalServerError)
        }
    })
    http.ListenAndServe(":8080", nil)
}

使用中间件统一处理JSON响应

在大型应用中,可以创建中间件来统一处理JSON响应：

func JSONMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")
        next.ServeHTTP(w, r)
    })
}
func main() {
    mux := http.NewServeMux()
    mux.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
        user := User{
            ID:       1,
            Username: "john_doe",
            Email:    "john@example.com",
        }
        if err := json.NewEncoder(w).Encode(user); err != nil {
            http.Error(w, "Failed to encode JSON", http.StatusInternalServerError)
        }
    })
    http.ListenAndServe(":8080", JSONMiddleware(mux))
}

高级技巧

使用接口实现灵活的JSON响应

定义一个JSONResponse接口,可以让不同类型的响应数据统一处理：

type JSONResponse interface {
    JSON() ([]byte, error)
}
type User struct {
    ID       int    `json:"id"`
    Username string `json:"username"`
    Email    string `json:"email"`
}
func (u User) JSON() ([]byte, error) {
    return json.Marshal(u)
}
func main() {
    http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
        user := User{
            ID:       1,
            Username: "john_doe",
            Email:    "john@example.com",
        }
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(http.StatusOK)
        if jsonData, err := user.JSON(); err == nil {
            w.Write(jsonData)
        } else {
            http.Error(w, "Failed to encode JSON", http.StatusInternalServerError)
        }
    })
    http.ListenAndServe(":8080", nil)
}

处理JSONP请求

对于需要支持JSONP的旧系统,可以这样处理：

func main() {
    http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
        user := User{
            ID:       1,
            Username: "john_doe",
            Email:    "john@example.com",
        }
        callback := r.URL.Query().Get("callback")
        w.Header().Set("Content-Type", "application/javascript")
        jsonData, _ := json.Marshal(user)
        if callback != "" {
            w.Write([]byte(callback + "("))
            w.Write(jsonData)
            w.Write([]byte(");"))
        } else {
            w.Write(jsonData)
        }
    })
    http.ListenAndServe(":8080", nil)
}