golang 原生 http 庫已經(jīng)可以很方便地實(shí)現(xiàn)一個(gè) http server 了，但對(duì)于復(fù)雜的 web 服務(wù)來說，路由解析，請(qǐng)求參數(shù)解析，對(duì)象返回等等，原生 api 就顯得有些不太夠用了，而 gin 是一個(gè)功能完備，性能很高的 web 網(wǎng)絡(luò)框架，特別適合 web api 的開發(fā)
hello world
|
1
2
3
4
5
6
7
8
9
10
11
|
package mainimport "github.com/gin-gonic/gin"func main() { r := gin.New() r.GET("/ping", func(c *gin.Context) { c.String(200, "hello world") }) r.Run() // listen and serve on 0.0.0.0:8080} |
如這個(gè) hello world 程序所示 gin 所有的業(yè)務(wù)邏輯都在 func(c *gin.Context) 函數(shù)中實(shí)現(xiàn)，請(qǐng)求和返回都通過這個(gè) gin.Context 傳遞
請(qǐng)求參數(shù)解析
gin 提供了豐富的請(qǐng)求參數(shù)獲取方式
|
1
2
3
4
5
|
(c *Context) Query(key string) string // 獲取 GET 參數(shù)(c *Context) QueryArray(key string) []string // 獲取 GET 參數(shù)數(shù)組(c *Context) DefaultQuery(key, defaultValue string) // 獲取 GET 參數(shù)，并提供默認(rèn)值(c *Context) Param(key string) string // 獲取 Param 參數(shù)，類似于 "/user/:id"(c *Context) GetRawData() ([]byte, error) // 獲取 body 數(shù)據(jù) |
但這些函數(shù)我都不建議使用，建議用結(jié)構(gòu)體來描述請(qǐng)求，再使用 bind api 直接將獲取請(qǐng)求參數(shù)
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
type HelloWorldReq struct { Token string `json:"token"` ID int `json:"id" uri:"id"` Email string `json:"email" form:"email"` Password string `json:"password" form:"password"`}req := &HelloWorldReq{ Token: c.GetHeader("Authorization"), // 頭部字段無法 bind，可以通過 GetHeader 獲取}// 用請(qǐng)求中的 Param 參數(shù)填充結(jié)構(gòu)體中的 uri 字段if err := c.BindUri(req); err != nil { return nil, nil, http.StatusBadRequest, fmt.Errorf("bind uri failed. err: [%v]", err)}// GET 請(qǐng)求中用 Query 參數(shù)填充 form 字段// 非 GET 請(qǐng)求，將 body 中的 json 或者 xml 反序列化后填充 form 字段if err := c.Bind(req); err != nil { return nil, nil, http.StatusBadRequest, fmt.Errorf("bind failed. err: [%v]", err)} |
http 的客戶端 ip 一般在請(qǐng)求頭的 X-Forwarded-For 和 X-Real-Ip 中，gin 提供了 (c *Context) ClientIP() string 來獲取 ip
返回包體
|
1
2
3
|
(c *Context) String(code int, format string, values ...interface{}) // 返回一個(gè)字符串(c *Context) JSON(code int, obj interface{}) // 返回一個(gè) json(c *Context) Status(code int) // 返回一個(gè)狀態(tài)碼 |
文件上傳和返回
從請(qǐng)求中獲取文件
|
1
2
3
4
5
6
7
8
9
10
|
fh, err := ctx.FormFile("file")if err != nil { return err}src, err := fh.Open()if err != nil { return err}defer src.Close() |
返回文件
|
1
|
(c *Context) File(filepath string) |
cros 跨域
服務(wù)端返回的頭部中有個(gè)字段 "Access-Control-Allow-Origin"，如果該字段和請(qǐng)求的域不同，瀏覽器會(huì)被瀏覽器拒絕，其實(shí)這個(gè)地方我理解應(yīng)該是客戶端沒有權(quán)限訪問，服務(wù)端不該返回結(jié)果，瀏覽器認(rèn)為結(jié)果不可用，所以提示跨域錯(cuò)誤，而這個(gè)頭部字段還只能寫一個(gè)地址，或者寫成 *，對(duì)所有網(wǎng)站都開放，要想對(duì)多個(gè)網(wǎng)站開發(fā)，我們可以根據(jù)請(qǐng)求的 "Origin" 字段，動(dòng)態(tài)地設(shè)置 "Access-Control-Allow-Origin" 字段，滿足權(quán)限得設(shè)置成請(qǐng)求中的 "Origin" 字段，gin 的有個(gè)插件 github.com/gin-contrib/cors 就是專門用來做這個(gè)事情的，可以在 AllowOrigins 中設(shè)置多個(gè)網(wǎng)站，還可以設(shè)置通配符（需設(shè)置 AllowWildcard 為 true）
|
1
2
3
4
5
6
7
8
9
|
import "github.com/gin-contrib/cors"r := gin.New()r.Use(cors.New(cors.Config{ AllowOrigins: []string{"a.example.com", "b.example.com"}, AllowMethods: []string{"PUT", "POST", "GET", "OPTIONS"}, AllowHeaders: []string{"Origin", "Content-Type", "Content-Length", "Accept-Encoding", "X-CSRF-Token", "Authorization", "Accept", "Cache-Control", "X-Requested-With"}, AllowCredentials: true,})) |
cookies
|
1
2
3
4
5
6
|
// maxAge 為過期時(shí)間// domain 是網(wǎng)站的地址，如需跨域共享 cookie，可以設(shè)置成域名，// 比如 a.example.com 和 b.example.com，可以將 domain 設(shè)置成 example.com// secure 為 https 設(shè)為 true，http 設(shè)為 false// httpOnly 設(shè)置為 false，否則 axios 之類的庫訪問不到 cookie(c *Context) SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool) |
另外，axios 需要設(shè)置 withCredentials: true cookie 才能正常返回
鏈接
github 地址: https://github.com/gin-gonic/gin
代碼示例: https://github.com/hpifu/tpl-go-http
以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持服務(wù)器之家。
原文鏈接：https://tech.hatlonely.com/article/55
