简介

本文接着上文(Golang GinWeb框架5-绑定请求字符串/URI/请求头/复选框/表单类型)继续探索GinWeb框架。

XML,JSON,YAML,ProtoBuf等渲染

  1. package main 
  2.  
  3. import ( 
  4.   "github.com/gin-gonic/gin" 
  5.   "github.com/gin-gonic/gin/testdata/protoexample" 
  6.   "net/http" 
  7. ) 
  8.  
  9. func main() { 
  10.   r := gin.Default() 
  11.  
  12.   // gin.H is a shortcut for map[string]interface{} 
  13.   // gin.H对象是一个map映射,键名为字符串类型, 键值是接口,所以可以传递所有的类型 
  14.   r.GET("/someJSON", func(c *gin.Context) { 
  15.     c.JSON(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) 
  16.   }) 
  17.  
  18.   r.GET("/moreJSON", func(c *gin.Context) { 
  19.     // You also can use a struct 
  20.     var msg struct { 
  21.       Name    string `json:"user"` 
  22.       Message string 
  23.       Number  int 
  24.     } 
  25.     msg.Name = "Lena" 
  26.     msg.Message = "hey" 
  27.     msg.Number = 123 
  28.     // Note that msg.Name becomes "user" in the JSON 
  29.     // Will output  :   {"user": "Lena", "Message": "hey", "Number": 123} 
  30.  
  31.     //JSON serializes the given struct as JSON into the response body. It also sets the Content-Type as "application/json". 
  32.     //JSON方法将给定的结构序列化为JSON到响应体, 并设置内容类型Content-Type为:"application/json" 
  33.     c.JSON(http.StatusOK, msg) 
  34.   }) 
  35.  
  36.   r.GET("/someXML", func(c *gin.Context) { 
  37.     c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) 
  38.   }) 
  39.  
  40.   r.GET("/someYAML", func(c *gin.Context) { 
  41.     c.YAML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) 
  42.   }) 
  43.  
  44.   //Protocol buffers are a language-neutral, platform-neutral extensible mechanism for serializing structured data. 
  45.   //Protocol buffers(简称ProtoBuf)是来自Google的一个跨语言,跨平台,用于将结构化数据序列化的可扩展机制, 
  46.   //详见:https://developers.google.com/protocol-buffers 
  47.   r.GET("/someProtoBuf", func(c *gin.Context) { 
  48.     reps := []int64{int64(1), int64(2)} 
  49.     label := "test" 
  50.     // The specific definition of protobuf is written in the testdata/protoexample file. 
  51.     // 使用protoexample.Test这个特别的protobuf结构来定义测试数据 
  52.     data := &protoexample.Test{ 
  53.       Label: &label, 
  54.       Reps:  reps, 
  55.     } 
  56.     // Note that data becomes binary data in the response  //将data序列化为二进制的响应数据 
  57.     // Will output protoexample.Test protobuf serialized data 
  58.     // ProtoBuf serializes the given struct as ProtoBuf into the response body. 
  59.     // ProtoBuf方法将给定的结构序列化为ProtoBuf响应体 
  60.     c.ProtoBuf(http.StatusOK, data) 
  61.   }) 
  62.  
  63.   // Listen and serve on 0.0.0.0:8080 
  64.   r.Run(":8080") 
  65. } 
  66.  
  67. /* 
  68. 模拟测试 
  69. curl http://localhost:8080/someJSON 
  70. {"message":"hey","status":200} 
  71.  
  72. curl http://localhost:8080/moreJSON 
  73. {"user":"Lena","Message":"hey","Number":123} 
  74.  
  75. curl http://localhost:8080/someXML 
  76. <map><message>hey</message><status>200</status></map> 
  77.  
  78. curl http://localhost:8080/someYAML 
  79. message: hey 
  80. status: 200 
  81.  
  82. curl http://localhost:8080/someProtoBuf 
  83. test 
  84. */ 

安全的JSOn

使用SecureJSON方法保护Json不被劫持, 如果响应体是一个数组, 该方法会默认添加`while(1)`前缀到响应头, 这样的死循环可以防止后面的代码被恶意执行, 也可以自定义安全JSON的前缀.

  1. package main 
  2.  
  3. import ( 
  4.   "github.com/gin-gonic/gin" 
  5.   "net/http" 
  6. ) 
  7.  
  8. func main() { 
  9.   r := gin.Default() 
  10.  
  11.   // You can also use your own secure json prefix 
  12.   // 你也可以自定义安全Json的前缀 
  13.   r.SecureJsonPrefix(")]}',\n") 
  14.  
  15.   //使用SecureJSON方法保护Json不被劫持, 如果响应体是一个数组, 该方法会默认添加`while(1)`前缀到响应头,  这样的死循环可以防止后面的代码被恶意执行, 也可以自定义安全JSON的前缀. 
  16.   r.GET("/someJSON", func(c *gin.Context) { 
  17.     names := []string{"lena", "austin", "foo"} 
  18.  
  19.     //names := map[string]string{ 
  20.     //  "hello": "world", 
  21.     //} 
  22.  
  23.     // Will output  :   while(1);["lena","austin","foo"] 
  24.     c.SecureJSON(http.StatusOK, names) 
  25.   }) 
  26.  
  27.   // Listen and serve on 0.0.0.0:8080 
  28.   r.Run(":8080") 
  29. } 
  30.  
  31. /* 
  32. 模拟请求:curl http://localhost:8080/someJSON 
  33. )]}', 
  34. ["lena","austin","foo"]% 
  35. */ 

JSONP

使用JSONP可以实现跨域请求数据, 如果请求中有查询字符串参数callback, 则将返回数据作为参数传递给callback值(前端函数名),整体作为一个响应体,返回给前端.

JSONP是服务器与客户端跨源通信的常用方法. 最大特点就是简单适用, 老式浏览器全部支持, 服务器改造非常小, 它的基本思想是: 网页通过添加一个<script>元素, 向服务器请求JSON数据, 这种做法不受同源政策限制, 服务器收到请求后, 将数据放在一个指定名字的回调函数里传回来, 这样, 前端可以完成一次前端函数的调用, 而参数是后端返回的数据.

注意: 这种方式存在被劫持的风险

  1. package main 
  2.  
  3. import ( 
  4.   "github.com/gin-gonic/gin" 
  5.   "net/http" 
  6. ) 
  7.  
  8. func main() { 
  9.   r := gin.Default() 
  10.  
  11.   r.GET("/JSONP", func(c *gin.Context) { 
  12.     data := gin.H{ 
  13.       "foo": "bar", 
  14.     } 
  15.  
  16.     //callback is x 
  17.     // Will output  :   x({\"foo\":\"bar\"}) 
  18.     // 使用JSONP可以实现跨域请求数据, 如果请求中有查询字符串参数callback, 则将返回数据作为参数传递给callback值(前端函数名),整体作为一个响应体,返回给前端 
  19.     //JSONP是服务器与客户端跨源通信的常用方法。最大特点就是简单适用，老式浏览器全部支持，服务器改造非常小。 
  20.     //它的基本思想是，网页通过添加一个<script>元素，向服务器请求JSON数据，这种做法不受同源政策限制；服务器收到请求后，将数据放在一个指定名字的回调函数里传回来 
  21.     c.JSONP(http.StatusOK, data) 
  22.   }) 
  23.  
  24.   // Listen and serve on 0.0.0.0:8080 
  25.   r.Run(":8080") 
  26.  
  27.   // 模拟客户端,请求参数中有callback参数,值为x(前端函数名),最后响应内容为x("foo":"bar") 
  28.   // curl http://127.0.0.1:8080/JSONP?callback=x 
  29. } 

AsciiJSON

使用ASCII编码, 将非ASCII的字符进行转义和编码, 生成纯ASCII编码的JSON

  1. package main 
  2.  
  3. import ( 
  4.   "github.com/gin-gonic/gin" 
  5.   "net/http" 
  6. ) 
  7.  
  8. func main() { 
  9.   r := gin.Default() 
  10.  
  11.   r.GET("/someJSON", func(c *gin.Context) { 
  12.     data := gin.H{ 
  13.       "lang": "GO语言", 
  14.       "tag":  "<br>", 
  15.     } 
  16.  
  17.     // 输出结果 : {"lang":"GO\u8bed\u8a00","tag":"\u003cbr\u003e"} 
  18.     // AsciiJSON方法返回带有Unicode编码和转义组成的纯ASCII字符串 
  19.     c.AsciiJSON(http.StatusOK, data) 
  20.   }) 
  21.  
  22.   // Listen and serve on 0.0.0.0:8080 
  23.   r.Run(":8080") 
  24. } 
  25.  
  26. /* 
  27. 模拟请求:curl http://localhost:8080/someJSON 
  28.  */ 

不带转义的原始JSON

通常, JSON会将特殊的HTML字符转化为他们的unicode编码, 如标签`<`转为`\u003c` 使用PureJSON方法可以得到原始不做转义的字符串.

注意: 该方法至少需要Go版本1.6以上

  1. package main 
  2.  
  3. import "github.com/gin-gonic/gin" 
  4.  
  5. func main() { 
  6.   r := gin.Default() 
  7.  
  8.   // Serves unicode entities 
  9.   r.GET("/json", func(c *gin.Context) { 
  10.     c.JSON(200, gin.H{ 
  11.       "html": "<b>Hello, world!</b>", 
  12.     }) 
  13.   }) 
  14.  
  15.   // Serves literal characters 
  16.   r.GET("/purejson", func(c *gin.Context) { 
  17.     c.PureJSON(200, gin.H{ 
  18.       "html": "<b>Hello, world!</b>", 
  19.     }) 
  20.   }) 
  21.  
  22.   // listen and serve on 0.0.0.0:8080 
  23.   r.Run(":8080") 
  24. } 
  25. /* 
  26. 模拟请求,得到将HTML标签转义后的JSON字符串 
  27. curl http://localhost:8080/json 
  28. {"html":"\u003cb\u003eHello, world!\u003c/b\u003e"}                                                                                                                                                                            
  29. 得到原始JSON字符串 
  30. curl http://localhost:8080/purejson 
  31. {"html":"<b>Hello, world!</b>"} 
  32. */ 

参考文档

Gin官方仓库:https://github.com/gin-gonic/gin