Gin 框架 JSON 格式返回結果的使用方式

原創 frank Golang語言開發棧

2024年11月24日 23:00 北京聽全文

大家好，我是 frank。「Golang語言開發棧」公眾號作者。

01

介紹

Gin 框架為 JSON、XML 和 HTML 渲染提供了易用的API。

本文我們主要介紹 JSON 的使用方式。

02

JSON

在 Go 專案開發中，當開發 HTTP API 時，我們通常提供 JSON 格式的返回結果。

Go 框架為 JSON 渲染提供了易用的 API。

普通 JSON

示例程式碼：

func main() {
 r := gin.Default()
 r.GET("/", func(c *gin.Context) {
  c.JSON(200, gin.H{
   "ping": "pong",
  })
 })
 err := r.Run()
 if err != nil {
  return
 }
}

輸出結果：

curl -s -X GET http://127.0.0.1:8080 | jq
{
  "ping": "pong"
}

閱讀上面這段程式碼，我們可以發現，使用 c.JSON() 方法，即可返回 JSON 格式的返回結果。

具有轉義的非 ASCII 字元的 ASCII-only JSON

示例程式碼：

func main() {
 r := gin.Default()
 r.GET("/", func(c *gin.Context) {
  c.AsciiJSON(200, gin.H{
   "ping": "<b>pong</b>",
  })
 })
 err := r.Run()
 if err != nil {
  return
 }
}

輸出結果：

curl -s -X GET http://127.0.0.1:8080     
{"ping":"\u003cb\u003epong\u003c/b\u003e"}

閱讀上面這段程式碼，我們使用 c.AsciiJSON() 方法，生成有轉義的非 ASCII 字元的 ASCII-only JSON。

跨域請求

示例程式碼：

func main() {
 r := gin.Default()
 r.GET("/", func(c *gin.Context) {
  c.JSONP(200, gin.H{
   "ping": "pong",
  })
 })
 err := r.Run()
 if err != nil {
  return
 }
}

輸出結果：

curl -s -X GET http://127.0.0.1:8080\?callback\=x
x({"ping":"pong"});

閱讀上面這段程式碼，我們使用 c.JSONP() 方法，使用 JSONP 向不同域的伺服器請求資料。如果查詢引數存在回撥，則將回撥新增到響應體中。

PureJSON

示例程式碼：

func main() {
 r := gin.Default()
 r.GET("/", func(c *gin.Context) {
  c.PureJSON(200, gin.H{
   "ping": "<b>pong</b>",
  })
 })
 err := r.Run()
 if err != nil {
  return
 }
}

輸出結果：

curl -s -X GET http://127.0.0.1:8080 | jq
{
  "ping": "<b>pong</b>"
}

閱讀上面這段程式碼，我們使用 c.PureJSON() 方法，輸出字面字元。

SecureJSON

示例程式碼：

func main() {
 r := gin.Default()
 r.GET("/", func(c *gin.Context) {
  names := []string{"lena", "austin", "foo"}
  c.SecureJSON(200, names)
 })
 err := r.Run()
 if err != nil {
  return
 }
}

輸出結果：

curl -s -X GET http://127.0.0.1:8080     
while(1);["lena","austin","foo"]

閱讀上面這段程式碼，我們使用 c.SecureJSON() 方法，防止 json 劫持。如果給定的結構是陣列值，則預設預置 "while(1)," 到響應體。

我們也可以使用 r.SecureJsonPrefix(")]}',\n") 自定義 SecureJSON 字首。

03

總結

本文我們介紹 Gin 框架為 JSON 提供的幾種易於使用的 API。

gin.H 是 map[string]interface{} 的一種快捷方式。

返回結果也可以使用一個結構體。

示例程式碼：

func main() {
 r := gin.Default()
 r.GET("/", func(c *gin.Context) {
  var msg struct {
   Name    string `json:"user"`
   Message string
   Number  int
  }
  msg.Name = "Lena"
  msg.Message = "hey"
  msg.Number = 123
  c.JSON(http.StatusOK, msg)
 })
 err := r.Run()
 if err != nil {
  return
 }
}

輸出結果：

curl -s -X GET http://127.0.0.1:8080 | jq
{
  "user": "Lena",
  "Message": "hey",
  "Number": 123
}

閱讀上面這段程式碼，我們使用一個結構體，輸出 JSON 格式的返回結果。

注意 msg.Name 在 JSON 中變成了 "user"，因為我們在結構體中定義的 tag 為 json:"user"。

Gin 框架 JSON 格式返回結果的使用方式

Gin 框架 JSON 格式返回結果的使用方式

推薦閱讀

相關文章