Go Web轻量级框架Gin学习系列:多种数据响应格式

https://juejin.im/post/5cb5d4a36fb9a068a84fdf2d

我们在《Go Web轻量级框架Gin学习系列:安装与使用》已经讲过如何安装Gin框架以及如何定义各种处理HTTP请求的方法了,这篇文章就接着讲讲接收到客户端请求后,怎么响应客户端请求以及有多种响应数据格式。

  1. r.GET("/test",func(c *gin.Context){
  2. //省略处理请求的代码
  3. })

上面的例子中,我们定义了一个处理HTTP GET请求的方法,回调用函数的参数为*gin.Context,Gin框架在*gin.Context实例中封装了所以处理请求并响应客户端的方法,Gin支持多种响应方法,包括我们常见的String,HTML,JSON,XML,YAML,JSONP,也支持直接响应Reader[]byte,而且还支持重定向。

下面列表出gin.Context中响应客户端的方法列表:

  1. func (c *Context) AsciiJSON(code int, obj interface{})
  2. func (c *Context) Data(code int, contentType string, data []byte)
  3. func (c *Context) DataFromReader(code int, contentLength int64, contentType string,
  4. reader io.Reader, extraHeaders map[string]string)
  5. func (c *Context) HTML(code int, name string, obj interface{})
  6. func (c *Context) IndentedJSON(code int, obj interface{})
  7. func (c *Context) JSON(code int, obj interface{})
  8. func (c *Context) JSONP(code int, obj interface{})
  9. func (c *Context) ProtoBuf(code int, obj interface{})
  10. func (c *Context) PureJSON(code int, obj interface{})
  11. func (c *Context) Redirect(code int, location string)
  12. func (c *Context) Render(code int, r render.Render)
  13. func (c *Context) SecureJSON(code int, obj interface{})
  14. func (c *Context) String(code int, format string, values ...interface{})
  15. func (c *Context) XML(code int, obj interface{})
  16. func (c *Context) YAML(code int, obj interface{})

下面是多种响应数据格式的详细讲:

JSON

json是轻量级数据交互格式,应用很广泛,尤其是Web API服务方面,因此Gin框架为JSON提供了支持,使用gin.Context中的JSON方法将格式化后的JSON数据返回给客户端。

  1. package main
  2. import (
  3. "github.com/gin-gonic/gin"
  4. "net/http"
  5. )
  6. type User struct {
  7. Uid int `json:"uid" xml:"uid"`
  8. Username string `json:"username" xml:"username"`
  9. }
  10. func main() {
  11. r := gin.Default()
  12. r.GET("test", func(c *gin.Context) {
  13. data := &User{Uid:1,Username:"测试账号"}
  14. c.JSON(http.StatusOK,data)
  15. })
  16. r.Run()
  17. }

XML,YAML,String

响应XML、YAML或String格式的数据,处理方式如同JSON一样,Gin都提供相应的函数,示例如下:

  1. //xml
  2. r.GET("xml",func(c *gin.Context){
  3. data := gin.H{"xml":"Hello World"}
  4. c.XML(200,data)
  5. })
  6. //yaml
  7. r.GET("yaml",func(c *gin.Context){
  8. data := gin.H{"xml":"Hello World"}
  9. c.YAML(200,data)
  10. })
  11. //string
  12. r.GET("yaml",func(c *gin.Context){
  13. c.String(200,"Hello World")
  14. })

上面的例子中, 我们使用了一个叫gin.H类型,实际gin.H在gin包中的定义如下:

  1. type H map[string]interface{}

Protobuf

Protobuf是一种与平台无关和语言无关,且可扩展且轻便高效的序列化数据结构的协议,可以用于网络通信和数据存储,其实序列化的速度要比JSON和XML快,但其易用性和可阅读性远不如JSON和XML,因此并没有广泛使用。

不过Gin也为Protobuf数据响应提供了支持,以下例子来自Gin官方文档:

  1. r.GET("/someProtoBuf", func(c *gin.Context) {
  2. reps := []int64{int64(1), int64(2)}
  3. label := "test"
  4. // protobuf 的具体定义写在 testdata/protoexample 文件中。
  5. data := &protoexample.Test{
  6. Label: &label,
  7. Reps: reps,
  8. }
  9. // 请注意,数据在响应中变为二进制数据
  10. // 将输出被 protoexample.Test protobuf 序列化了的数据
  11. c.ProtoBuf(http.StatusOK, data)
  12. })

HTML渲染

Gin也支持传统Web编程中的HTML模板渲染,直接返回HTML代码给客户端,主要步骤如下:

1. 定义HTML模板

HTML模板文件:templates/index.html

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Title</title>
  6. </head>
  7. <body>
  8. {{.foo}}
  9. </body>
  10. </html>

2. 加载模板

定义好模板之后,在渲染之前,要使用gin.Engine中的LoadHTMLFiles()或LoadHTMLGlob()方法加载模板。

LoadHTMLFiles(files …string)方法可以接收一个或多个参数,用于加载单个或多个模板文件。

  1. r := gin.Default()
  2. r.LoadHTMLFiles("./templates/index.html")

LoadHTMLGlob(pattern string)方法则用于加载整个目录下的模板文件,如果目录不存在或目录下没有模板文件会引发panic错误。

  1. r := gin.Default()
  2. r.LoadHTMLGlob("./templates/*")

3. 完整示例

  1. func main() {
  2. r := gin.Default()
  3. r.LoadHTMLFiles("./templates/index.html")
  4. //r.LoadHTMLGlob("./templates/*")
  5. r.GET("html", func(c *gin.Context) {
  6. data := map[string]interface{}{
  7. "foo": "bar",
  8. }
  9. c.HTML(http.StatusOK,"index.html",data)
  10. })
  11. r.Run()
  12. }

JSONP

JSONP是一种基于JSON,而用于解决浏览器跨域访问问题的机制,使用gin.Context的JSONP()返回数据时,会将URL中的callback参数按照JSONP的数据格式放在json数据前面,并返回给客户端。

  1. func main() {
  2. r := gin.Default()
  3. r.GET("/JSONP?callback=test", func(c *gin.Context) {
  4. data := map[string]interface{}{
  5. "foo": "bar",
  6. }
  7. c.JSONP(http.StatusOK,data)
  8. })
  9. r.Run()
  10. }

Reader

使用gin.Context中的DataFromReader()方法,可以直接从Reader读取数据,下面演示一个下载图片的HTTP请求:

  1. func main() {
  2. r := gin.Default()
  3. r.GET("file", func(c *gin.Context) {
  4. fileName := "./1.jpg"
  5. file, _ := os.Open(fileName)
  6. fileInfo, _ := os.Lstat(fileName)
  7. extraHeaders := map[string]string{
  8. "Content-Disposition": `attachment; filename="` + fileName + `"`,
  9. }
  10. c.DataFromReader(200, fileInfo.Size(), "image/png", file, extraHeaders)
  11. })
  12. r.Run()
  13. }

字节数组

使用gin.Context中的Data()方法,可以返回一个字节数组([]byte)给客户端,下面的例子演示从图片中读取二进制数组并返回给客户端。

  1. func main() {
  2. r := gin.Default()
  3. r.GET("file", func(c *gin.Context) {
  4. file, _ := os.Open("./1.jpg")
  5. b, _ := ioutil.ReadAll(file)
  6. c.Data(200, "image/png", b)
  7. })
  8. r.Run()
  9. }

重定向

除了返回不同格式的数据给客户端,Gin框架也支持重定向操作,重定向分为外部和内部重定向。

1. 外部重定向

用于跳转其他外部的链接。

  1. func main(){
  2. r := gin.Default()
  3. r.GET("Redirect",func(c *gin.Context){
  4. c.Redirect(http.StatusMovedPermanently,"https://juejin.im")
  5. })
  6. r.Run()
  7. }

2. 内部重定向

用于跳转内部路由。

  1. func main() {
  2. r := gin.Default()
  3. r.GET("test", func(c *gin.Context) {
  4. c.Request.URL.Path = "/profile"
  5. r.HandleContext(c)
  6. })
  7. r.GET("profile", func(c *gin.Context) {
  8. username := c.Query("username")
  9. fmt.Println(username)
  10. c.JSON(200, gin.H{"user": "profile"})
  11. })
  12. r.Run()
  13. }

小结

从上面的多个例子中可以看到Gin响应Web请求的良好封装,因此使用Gin进入Web应用程序的开发,会大大提升开发速度与效率的。

ft_authoradmin  ft_create_time2019-04-26 18:04
 ft_update_time2019-04-26 18:05