Go Web輕量級框架Gin學習系列：多種資料響應格式

張君鴻發表於2019-04-18
GoWeb框架

原創作者，公眾號【程式設計師讀書】，歡迎關注公眾號，轉載文章請註明出處哦。

我們在《Go Web輕量級框架Gin學習系列：安裝與使用》已經講過如何安裝Gin框架以及如何定義各種處理HTTP請求的方法了，這篇文章就接著講講接收到客戶端請求後，怎麼響應客戶端請求以及有多種響應資料格式。

r.GET("/test",func(c *gin.Context){
    //省略處理請求的程式碼
})
複製程式碼

上面的例子中，我們定義了一個處理HTTP GET請求的方法，回撥用函式的引數為*gin.Context,Gin框架在*gin.Context例項中封裝了所以處理請求並響應客戶端的方法，Gin支援多種響應方法，包括我們常見的String,HTML,JSON,XML,YAML,JSONP,也支援直接響應Reader和[]byte，而且還支援重定向。

下面列表出gin.Context中響應客戶端的方法列表：

func (c *Context) AsciiJSON(code int, obj interface{})
func (c *Context) Data(code int, contentType string, data []byte)
func (c *Context) DataFromReader(code int, contentLength int64, contentType string,
reader io.Reader, extraHeaders map[string]string)
func (c *Context) HTML(code int, name string, obj interface{})
func (c *Context) IndentedJSON(code int, obj interface{})
func (c *Context) JSON(code int, obj interface{})
func (c *Context) JSONP(code int, obj interface{})
func (c *Context) ProtoBuf(code int, obj interface{})
func (c *Context) PureJSON(code int, obj interface{})
func (c *Context) Redirect(code int, location string)
func (c *Context) Render(code int, r render.Render)
func (c *Context) SecureJSON(code int, obj interface{})
func (c *Context) String(code int, format string, values ...interface{})
func (c *Context) XML(code int, obj interface{})
func (c *Context) YAML(code int, obj interface{})
複製程式碼

下面是多種響應資料格式的詳細講：

JSON

json是輕量級資料互動格式，應用很廣泛，尤其是Web API服務方面，因此Gin框架為JSON提供了支援，使用gin.Context中的JSON方法將格式化後的JSON資料返回給客戶端。

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
type User struct {
    Uid      int    `json:"uid" xml:"uid"`
    Username string `json:"username" xml:"username"`
}
func main() {
    r := gin.Default()
    r.GET("test", func(c *gin.Context) {
        data := &User{Uid:1,Username:"測試賬號"}
        c.JSON(http.StatusOK,data)
    })
    r.Run()
}
複製程式碼

XML,YAML,String

響應XML、YAML或String格式的資料，處理方式如同JSON一樣，Gin都提供相應的函式，示例如下：

//xml
r.GET("xml",func(c *gin.Context){
    data := gin.H{"xml":"Hello World"}
    c.XML(200,data)
})
//yaml
r.GET("yaml",func(c *gin.Context){
    data := gin.H{"xml":"Hello World"}
    c.YAML(200,data)
})
//string
r.GET("yaml",func(c *gin.Context){
    c.String(200,"Hello World")
})
複製程式碼

上面的例子中， 我們使用了一個叫gin.H型別，實際gin.H在gin包中的定義如下：

type H map[string]interface{}
複製程式碼

Protobuf

Protobuf是一種與平臺無關和語言無關，且可擴充套件且輕便高效的序列化資料結構的協議，可以用於網路通訊和資料儲存，其實序列化的速度要比JSON和XML快，但其易用性和可閱讀性遠不如JSON和XML，因此並沒有廣泛使用。

不過Gin也為Protobuf資料響應提供了支援，以下例子來自Gin官方文件：

r.GET("/someProtoBuf", func(c *gin.Context) {
    reps := []int64{int64(1), int64(2)}
    label := "test"
    // protobuf 的具體定義寫在 testdata/protoexample 檔案中。
    data := &protoexample.Test{
        Label: &label,
        Reps:  reps,
    }
    // 請注意，資料在響應中變為二進位制資料
    // 將輸出被 protoexample.Test protobuf 序列化了的資料
    c.ProtoBuf(http.StatusOK, data)
})
複製程式碼

HTML渲染

Gin也支援傳統Web程式設計中的HTML模板渲染，直接返回HTML程式碼給客戶端，主要步驟如下：

1. 定義HTML模板

HTML模板檔案：templates/index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
    <body>
    {{.foo}}
    </body>
</html>
複製程式碼

2. 載入模板

定義好模板之後，在渲染之前，要使用gin.Engine中的LoadHTMLFiles()或LoadHTMLGlob()方法載入模板。

LoadHTMLFiles(files ...string)方法可以接收一個或多個引數，用於載入單個或多個模板檔案。

r := gin.Default()
r.LoadHTMLFiles("./templates/index.html")
複製程式碼

LoadHTMLGlob(pattern string)方法則用於載入整個目錄下的模板檔案，如果目錄不存在或目錄下沒有模板檔案會引發panic錯誤。

r := gin.Default()
r.LoadHTMLGlob("./templates/*")
複製程式碼

3. 完整示例

func main() {
    r := gin.Default()
    r.LoadHTMLFiles("./templates/index.html")
    //r.LoadHTMLGlob("./templates/*")
    r.GET("html", func(c *gin.Context) {
        data := map[string]interface{}{
            "foo": "bar",
        }
        c.HTML(http.StatusOK,"index.html",data)
    })
    r.Run()
}
複製程式碼

JSONP

JSONP是一種基於JSON，而用於解決瀏覽器跨域訪問問題的機制，使用gin.Context的JSONP()返回資料時，會將URL中的callback引數按照JSONP的資料格式放在json資料前面,並返回給客戶端。

func main() {
    r := gin.Default()
    r.GET("/JSONP?callback=test", func(c *gin.Context) {
        data := map[string]interface{}{
            "foo": "bar",
        }
        c.JSONP(http.StatusOK,data)
    })
    r.Run()
}
複製程式碼

Reader

使用gin.Context中的DataFromReader()方法，可以直接從Reader讀取資料，下面演示一個下載圖片的HTTP請求：

func main() {
    r := gin.Default()
    r.GET("file", func(c *gin.Context) {
        fileName := "./1.jpg"
        file, _ := os.Open(fileName)
        fileInfo, _ := os.Lstat(fileName)
        extraHeaders := map[string]string{
            "Content-Disposition": `attachment; filename="` + fileName + `"`,
        }
        c.DataFromReader(200, fileInfo.Size(), "image/png", file, extraHeaders)
    })
    r.Run()
}
複製程式碼

位元組陣列

使用gin.Context中的Data()方法，可以返回一個位元組陣列([]byte)給客戶端，下面的例子演示從圖片中讀取二進位制陣列並返回給客戶端。

func main() {
    r := gin.Default()
    r.GET("file", func(c *gin.Context) {
        file, _ := os.Open("./1.jpg")
        b, _ := ioutil.ReadAll(file)
        c.Data(200, "image/png", b)
    })
    r.Run()
}
複製程式碼

重定向

除了返回不同格式的資料給客戶端，Gin框架也支援重定向操作，重定向分為外部和內部重定向。

1. 外部重定向

用於跳轉其他外部的連結。

func main(){
    r := gin.Default()
    r.GET("Redirect",func(c *gin.Context){
        c.Redirect(http.StatusMovedPermanently,"https://juejin.im")  
    })
    r.Run()
}
複製程式碼

2. 內部重定向

用於跳轉內部路由。

func main() {
    r := gin.Default()
    r.GET("test", func(c *gin.Context) {
        c.Request.URL.Path = "/profile"
        r.HandleContext(c)
    })
    r.GET("profile", func(c *gin.Context) {
        username := c.Query("username")
        fmt.Println(username)
        c.JSON(200, gin.H{"user": "profile"})
    })
    r.Run()
}
複製程式碼

小結

從上面的多個例子中可以看到Gin響應Web請求的良好封裝，因此使用Gin進入Web應用程式的開發，會大大提升開發速度與效率的。

你的關注，是我寫作路上最大的鼓勵！

Go Web輕量級框架Gin學習系列：多種資料響應格式

相關文章