Loading... > Gin 是一个用 Go (Golang) 编写的 Web 框架。[它具有类似马提尼酒的 API,由于httprouter](https://github.com/julienschmidt/httprouter),性能最高可提高 40 倍。如果您需要性能和良好的生产力,您会喜欢 Gin。 gin也是目前go中最流行的几个web框架之一 其stat高达60多k [传送门](https://github.com/gin-gonic/gin) ## 安装 要安装 Gin 包,您需要先安装 Go 并设置您的 Go 工作区。 1. 您首先需要安装[Go (需要](https://go.dev/) **1.16+ 版本** ),然后您可以使用下面的 Go 命令安装 Gin。 ```shell notranslate position-relative overflow-auto go get -u github.com/gin-gonic/gin ``` 2. 在您的代码中导入它: ```go notranslate position-relative overflow-auto import "github.com/gin-gonic/gin" ``` 3. (可选)导入`net/http`。例如,如果使用诸如`http.StatusOK`. ```go notranslate position-relative overflow-auto import "net/http" ``` ## 快速开始 ```shell notranslate position-relative overflow-auto # assume the following codes in example.go file $ cat example.go ``` ```go notranslate position-relative overflow-auto package main import ( "net/http" "github.com/gin-gonic/gin" ) func main() { r := gin.Default() r.GET("/ping", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{ "message": "pong", }) }) r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080") } ``` ``` # run example.go and visit 0.0.0.0:8080/ping (for windows "localhost:8080/ping") on browser $ go run example.go ``` ## 基准 Gin 使用自定义版本的[HttpRouter](https://github.com/julienschmidt/httprouter) [查看所有基准](https://github.com/gin-gonic/gin/blob/master/BENCHMARKS.md) | 基准名称 | (1) | (2) | (3) | (4) | | -------------------------------- | ----------: | --------------------: | ------------------: | ----------------: | | BenchmarkGin_GithubAll | **43550** | **27364 纳秒/运算** | **0 次/操作** | **0 分配/操作** | | BenchmarkAce_GithubAll | 40543 | 29670 纳秒/运算 | 0 次/操作 | 0 分配/操作 | | BenchmarkAero_GithubAll | 57632 | 20648 纳秒/运算 | 0 次/操作 | 0 分配/操作 | | BenchmarkBear_GithubAll | 9234 | 216179 纳秒/操作 | 86448 B/OP | 943 分配/操作 | | BenchmarkBeego_GithubAll | 7407 | 243496 纳秒/操作 | 71456 B/OP | 609 分配/操作 | | BenchmarkBone_GithubAll | 420 | 2922835 纳秒/操作 | 720160 B/OP | 8620 分配/操作 | | BenchmarkChi_GithubAll | 7620 | 238331 纳秒/操作 | 87696 B/OP | 609 分配/操作 | | BenchmarkDenco_GithubAll | 18355 | 64494 纳秒/运算 | 20224 后备箱 | 167 个分配/操作 | | BenchmarkEcho_GithubAll | 31251 | 38479 纳秒/运算 | 0 次/操作 | 0 分配/操作 | | BenchmarkGocraftWeb_GithubAll | 4117 | 300062 纳秒/操作 | 131656 双胞胎 | 1686 分配/操作 | | BenchmarkGoji_GithubAll | 3274 | 416158 纳秒/操作 | 56112 B/OP | 334 分配/操作 | | BenchmarkGojiv2_GithubAll | 1402 | 870518 纳秒/操作 | 352720 B/OP | 4321 分配/操作 | | BenchmarkGoJsonRest_GithubAll | 2976 | 401507 纳秒/操作 | 134371 B/OP | 2737 分配/操作 | | BenchmarkGoRestful_GithubAll | 410 | 2913158 纳秒/操作 | 910144 B/OP | 2938 分配/操作 | | BenchmarkGorillaMux_GithubAll | 346 | 3384987 纳秒/操作 | 251650 B/OP | 1994 分配/操作 | | BenchmarkGowwwRouter_GithubAll | 10000 | 143025 纳秒/操作 | 72144 B/OP | 501 分配/操作 | | BenchmarkHttpRouter_GithubAll | 55938 | 21360 纳秒/运算 | 0 次/操作 | 0 分配/操作 | | BenchmarkHttpTreeMux_GithubAll | 10000 | 153944 纳秒/操作 | 65856 B/OP | 671 分配/操作 | | BenchmarkKocha_GithubAll | 10000 | 106315 纳秒/操作 | 23304 后备箱 | 843 分配/操作 | | BenchmarkLARS_GithubAll | 47779 | 25084 纳秒/运算 | 0 次/操作 | 0 分配/操作 | | BenchmarkMacaron_GithubAll | 3266 | 371907 纳秒/操作 | 149409 B/OP | 1624 分配/操作 | | BenchmarkMartini_GithubAll | 331 | 3444706 纳秒/操作 | 226551 后备箱 | 2325 分配/操作 | | BenchmarkPat_GithubAll | 273 | 4381818 纳秒/操作 | 1483152 黑/操作员 | 26963 分配/操作 | | BenchmarkPossum_GithubAll | 10000 | 164367 纳秒/操作 | 84448 B/OP | 609 分配/操作 | | BenchmarkR2router_GithubAll | 10000 | 160220 纳秒/操作 | 77328 后备箱 | 979 分配/操作 | | 基准铆钉_GithubAll | 14625 | 82453 纳秒/运算 | 16272 B/OP | 167 个分配/操作 | | BenchmarkTango_GithubAll | 6255 | 279611 纳秒/操作 | 63826 B/操作员 | 1618 分配/操作 | | BenchmarkTigerTonic_GithubAll | 2008年 | 687874 纳秒/操作 | 193856 手办 | 4474 分配/操作 | | BenchmarkTraffic_GithubAll | 355 | 3478508 纳秒/操作 | 820744 B/OP | 14114 分配/操作 | | BenchmarkVulcan_GithubAll | 6885 | 193333 纳秒/操作 | 19894 B/OP | 609 分配/操作 | * (1):在恒定时间内完成的总重复次数,越高表示结果越自信 * (2): Single Repetition Duration (ns/op),越低越好 * (3):堆内存(B/op),越低越好 * (4): Average Allocations per Repetition (allocs/op),越低越好 ## 杜松子酒 v1。稳定的 * [X] 零配置路由器。 * [X] 仍然是最快的 http 路由器和框架。从路由到写入。 * [X] 完整的单元测试套件。 * [X] 战斗测试。 * [X] API 冻结,新版本不会破坏您的代码。 ## 使用 json 替换构建 Gin`encoding/json`用作默认的 json 包,但您可以通过从其他标签构建来更改它。 [jsoniter](https://github.com/json-iterator/go) ```shell notranslate position-relative overflow-auto go build -tags=jsoniter . ``` [go-json](https://github.com/goccy/go-json) ```shell notranslate position-relative overflow-auto go build -tags=go_json . ``` [sonic](https://github.com/bytedance/sonic)(你必须确保你的 cpu 支持 avx 指令。) ```shell notranslate position-relative overflow-auto $ go build -tags="sonic avx" . ``` ## 构建无`MsgPack`渲染功能 Gin`MsgPack`默认启用渲染功能。但是您可以通过指定`nomsgpack`构建标签来禁用此功能。 ```shell notranslate position-relative overflow-auto go build -tags=nomsgpack . ``` 这对于减少可执行文件的二进制大小很有用。查看[详细信息](https://github.com/gin-gonic/gin/pull/1852)。 ## API 范例 [您可以在Gin 示例存储库](https://github.com/gin-gonic/examples)中找到许多现成的示例。 ### 使用 GET、POST、PUT、PATCH、DELETE 和 OPTIONS ```go notranslate position-relative overflow-auto func main() { // Creates a gin router with default middleware: // logger and recovery (crash-free) middleware router := gin.Default() router.GET("/someGet", getting) router.POST("/somePost", posting) router.PUT("/somePut", putting) router.DELETE("/someDelete", deleting) router.PATCH("/somePatch", patching) router.HEAD("/someHead", head) router.OPTIONS("/someOptions", options) // By default it serves on :8080 unless a // PORT environment variable was defined. router.Run() // router.Run(":3000") for a hard coded port } ``` ### 路径中的参数 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() // This handler will match /user/john but will not match /user/ or /user router.GET("/user/:name", func(c *gin.Context) { name := c.Param("name") c.String(http.StatusOK, "Hello %s", name) }) // However, this one will match /user/john/ and also /user/john/send // If no other routers match /user/john, it will redirect to /user/john/ router.GET("/user/:name/*action", func(c *gin.Context) { name := c.Param("name") action := c.Param("action") message := name + " is " + action c.String(http.StatusOK, message) }) // For each matched request Context will hold the route definition router.POST("/user/:name/*action", func(c *gin.Context) { b := c.FullPath() == "/user/:name/*action" // true c.String(http.StatusOK, "%t", b) }) // This handler will add a new router for /user/groups. // Exact routes are resolved before param routes, regardless of the order they were defined. // Routes starting with /user/groups are never interpreted as /user/:name/... routes router.GET("/user/groups", func(c *gin.Context) { c.String(http.StatusOK, "The available groups are [...]") }) router.Run(":8080") } ``` ### 查询字符串参数 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() // Query string parameters are parsed using the existing underlying request object. // The request responds to an url matching: /welcome?firstname=Jane&lastname=Doe router.GET("/welcome", func(c *gin.Context) { firstname := c.DefaultQuery("firstname", "Guest") lastname := c.Query("lastname") // shortcut for c.Request.URL.Query().Get("lastname") c.String(http.StatusOK, "Hello %s %s", firstname, lastname) }) router.Run(":8080") } ``` ### 多部分/URL 编码形式 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.POST("/form_post", func(c *gin.Context) { message := c.PostForm("message") nick := c.DefaultPostForm("nick", "anonymous") c.JSON(http.StatusOK, gin.H{ "status": "posted", "message": message, "nick": nick, }) }) router.Run(":8080") } ``` ### 另一个例子:query + post 表单 ```shell notranslate position-relative overflow-auto POST /post?id=1234&page=1 HTTP/1.1 Content-Type: application/x-www-form-urlencoded name=manu&message=this_is_great ``` ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.POST("/post", func(c *gin.Context) { id := c.Query("id") page := c.DefaultQuery("page", "0") name := c.PostForm("name") message := c.PostForm("message") fmt.Printf("id: %s; page: %s; name: %s; message: %s", id, page, name, message) }) router.Run(":8080") } ``` ```shell notranslate position-relative overflow-auto id: 1234; page: 1; name: manu; message: this_is_great ``` ### 映射为查询字符串或 postform 参数 ```shell notranslate position-relative overflow-auto POST /post?ids[a]=1234&ids[b]=hello HTTP/1.1 Content-Type: application/x-www-form-urlencoded names[first]=thinkerou&names[second]=tianou ``` ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.POST("/post", func(c *gin.Context) { ids := c.QueryMap("ids") names := c.PostFormMap("names") fmt.Printf("ids: %v; names: %v", ids, names) }) router.Run(":8080") } ``` ```shell notranslate position-relative overflow-auto ids: map[b:hello a:1234]; names: map[second:tianou first:thinkerou] ``` ### 上传文件 #### 单个文件 参考问题[#774](https://github.com/gin-gonic/gin/issues/774)和详细[示例代码](https://github.com/gin-gonic/examples/tree/master/upload-file/single)。 `file.Filename` **不应该**被信任。请参阅[`Content-Disposition`MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#Directives)和[#1693](https://github.com/gin-gonic/gin/issues/1693) > 文件名始终是可选的,不能被应用程序盲目使用:应该去除路径信息,并转换为服务器文件系统规则。 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() // Set a lower memory limit for multipart forms (default is 32 MiB) router.MaxMultipartMemory = 8 << 20 // 8 MiB router.POST("/upload", func(c *gin.Context) { // Single file file, _ := c.FormFile("file") log.Println(file.Filename) // Upload the file to specific dst. c.SaveUploadedFile(file, dst) c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename)) }) router.Run(":8080") } ``` 如何`curl`: ```shell notranslate position-relative overflow-auto curl -X POST http://localhost:8080/upload \ -F "file=@/Users/appleboy/test.zip" \ -H "Content-Type: multipart/form-data" ``` #### 多个文件 请参阅详细[示例代码](https://github.com/gin-gonic/examples/tree/master/upload-file/multiple)。 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() // Set a lower memory limit for multipart forms (default is 32 MiB) router.MaxMultipartMemory = 8 << 20 // 8 MiB router.POST("/upload", func(c *gin.Context) { // Multipart form form, _ := c.MultipartForm() files := form.File["upload[]"] for _, file := range files { log.Println(file.Filename) // Upload the file to specific dst. c.SaveUploadedFile(file, dst) } c.String(http.StatusOK, fmt.Sprintf("%d files uploaded!", len(files))) }) router.Run(":8080") } ``` 如何`curl`: ```shell notranslate position-relative overflow-auto curl -X POST http://localhost:8080/upload \ -F "upload[]=@/Users/appleboy/test1.zip" \ -F "upload[]=@/Users/appleboy/test2.zip" \ -H "Content-Type: multipart/form-data" ``` ### 分组路线 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() // Simple group: v1 v1 := router.Group("/v1") { v1.POST("/login", loginEndpoint) v1.POST("/submit", submitEndpoint) v1.POST("/read", readEndpoint) } // Simple group: v2 v2 := router.Group("/v2") { v2.POST("/login", loginEndpoint) v2.POST("/submit", submitEndpoint) v2.POST("/read", readEndpoint) } router.Run(":8080") } ``` ### 默认没有中间件的 Blank Gin 利用 ```go notranslate position-relative overflow-auto r := gin.New() ``` 代替 ```go notranslate position-relative overflow-auto // Default With the Logger and Recovery middleware already attached r := gin.Default() ``` ### 使用中间件 ```go notranslate position-relative overflow-auto func main() { // Creates a router without any middleware by default r := gin.New() // Global middleware // Logger middleware will write the logs to gin.DefaultWriter even if you set with GIN_MODE=release. // By default gin.DefaultWriter = os.Stdout r.Use(gin.Logger()) // Recovery middleware recovers from any panics and writes a 500 if there was one. r.Use(gin.Recovery()) // Per route middleware, you can add as many as you desire. r.GET("/benchmark", MyBenchLogger(), benchEndpoint) // Authorization group // authorized := r.Group("/", AuthRequired()) // exactly the same as: authorized := r.Group("/") // per group middleware! in this case we use the custom created // AuthRequired() middleware just in the "authorized" group. authorized.Use(AuthRequired()) { authorized.POST("/login", loginEndpoint) authorized.POST("/submit", submitEndpoint) authorized.POST("/read", readEndpoint) // nested group testing := authorized.Group("testing") // visit 0.0.0.0:8080/testing/analytics testing.GET("/analytics", analyticsEndpoint) } // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` ### 自定义恢复行为 ```go notranslate position-relative overflow-auto func main() { // Creates a router without any middleware by default r := gin.New() // Global middleware // Logger middleware will write the logs to gin.DefaultWriter even if you set with GIN_MODE=release. // By default gin.DefaultWriter = os.Stdout r.Use(gin.Logger()) // Recovery middleware recovers from any panics and writes a 500 if there was one. r.Use(gin.CustomRecovery(func(c *gin.Context, recovered interface{}) { if err, ok := recovered.(string); ok { c.String(http.StatusInternalServerError, fmt.Sprintf("error: %s", err)) } c.AbortWithStatus(http.StatusInternalServerError) })) r.GET("/panic", func(c *gin.Context) { // panic with a string -- the custom middleware could save this to a database or report it to the user panic("foo") }) r.GET("/", func(c *gin.Context) { c.String(http.StatusOK, "ohai") }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` ### 如何写日志文件 ```go notranslate position-relative overflow-auto func main() { // Disable Console Color, you don't need console color when writing the logs to file. gin.DisableConsoleColor() // Logging to a file. f, _ := os.Create("gin.log") gin.DefaultWriter = io.MultiWriter(f) // Use the following code if you need to write the logs to file and console at the same time. // gin.DefaultWriter = io.MultiWriter(f, os.Stdout) router := gin.Default() router.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) router.Run(":8080") } ``` ### 自定义日志格式 ```go notranslate position-relative overflow-auto func main() { router := gin.New() // LoggerWithFormatter middleware will write the logs to gin.DefaultWriter // By default gin.DefaultWriter = os.Stdout router.Use(gin.LoggerWithFormatter(func(param gin.LogFormatterParams) string { // your custom format return fmt.Sprintf("%s - [%s] \"%s %s %s %d %s \"%s\" %s\"\n", param.ClientIP, param.TimeStamp.Format(time.RFC1123), param.Method, param.Path, param.Request.Proto, param.StatusCode, param.Latency, param.Request.UserAgent(), param.ErrorMessage, ) })) router.Use(gin.Recovery()) router.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) router.Run(":8080") } ``` 示例输出 ```shell notranslate position-relative overflow-auto ::1 - [Fri, 07 Dec 2018 17:04:38 JST] "GET /ping HTTP/1.1 200 122.767µs "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.80 Safari/537.36" " ``` ### 控制日志输出着色 默认情况下,控制台上的日志输出应根据检测到的 TTY 进行着色。 从不着色日志: ```go notranslate position-relative overflow-auto func main() { // Disable log's color gin.DisableConsoleColor() // Creates a gin router with default middleware: // logger and recovery (crash-free) middleware router := gin.Default() router.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) router.Run(":8080") } ``` 始终为日志着色: ```go notranslate position-relative overflow-auto func main() { // Force log's color gin.ForceConsoleColor() // Creates a gin router with default middleware: // logger and recovery (crash-free) middleware router := gin.Default() router.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) router.Run(":8080") } ``` ### 模型绑定和验证 要将请求主体绑定到类型中,请使用模型绑定。我们目前支持绑定 JSON、XML、YAML、TOML 和标准格式值 (foo=bar&boo=baz)。 Gin 使用[**go-playground/validator/v10**](https://github.com/go-playground/validator)进行验证。[在此处](https://pkg.go.dev/github.com/go-playground/validator#hdr-Baked_In_Validators_and_Tags)查看有关标签使用的完整文档。 注意需要在所有要绑定的字段上设置相应的绑定标签。例如,从 JSON 绑定时,设置`json:"fieldname"`. 另外,Gin 提供了两套绑定方法: * **类型** - 必须绑定 * **方法** - `Bind`, `BindJSON`, `BindXML`, `BindQuery`, `BindYAML`, `BindHeader`,`BindTOML` * **行为** - 这些方法`MustBindWith`在幕后使用。如果存在绑定错误,请求将被中止`c.AbortWithError(400, err).SetType(ErrorTypeBind)`。这会将响应状态代码设置为 400,并将`Content-Type`标头设置为`text/plain; charset=utf-8`。请注意,如果您在此之后尝试设置响应代码,则会导致警告`[GIN-debug] [WARNING] Headers were already written. Wanted to override status code 400 with 422`。如果您希望更好地控制行为,请考虑使用`ShouldBind`等效方法。 * **类型** - 应该绑定 * **方法** - `ShouldBind`,,,,,,,,, `ShouldBindJSON`_ `ShouldBindXML`_ `ShouldBindQuery`_ `ShouldBindYAML`_ `ShouldBindHeader`_ `ShouldBindTOML`_ * **行为** - 这些方法`ShouldBindWith`在幕后使用。如果存在绑定错误,则返回错误,开发人员有责任适当地处理请求和错误。 使用绑定方法时,Gin 会尝试根据 Content-Type 标头推断绑定器。如果您确定要绑定什么,可以使用`MustBindWith`or `ShouldBindWith`。 您还可以指定特定字段是必需的。如果一个字段被修饰`binding:"required"`并且在绑定时有一个空值,将会返回一个错误。 ```go notranslate position-relative overflow-auto // Binding from JSON type Login struct { User string `form:"user" json:"user" xml:"user" binding:"required"` Password string `form:"password" json:"password" xml:"password" binding:"required"` } func main() { router := gin.Default() // Example for binding JSON ({"user": "manu", "password": "123"}) router.POST("/loginJSON", func(c *gin.Context) { var json Login if err := c.ShouldBindJSON(&json); err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } if json.User != "manu" || json.Password != "123" { c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"}) return } c.JSON(http.StatusOK, gin.H{"status": "you are logged in"}) }) // Example for binding XML ( // <?xml version="1.0" encoding="UTF-8"?> // <root> // <user>manu</user> // <password>123</password> // </root>) router.POST("/loginXML", func(c *gin.Context) { var xml Login if err := c.ShouldBindXML(&xml); err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } if xml.User != "manu" || xml.Password != "123" { c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"}) return } c.JSON(http.StatusOK, gin.H{"status": "you are logged in"}) }) // Example for binding a HTML form (user=manu&password=123) router.POST("/loginForm", func(c *gin.Context) { var form Login // This will infer what binder to use depending on the content-type header. if err := c.ShouldBind(&form); err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } if form.User != "manu" || form.Password != "123" { c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"}) return } c.JSON(http.StatusOK, gin.H{"status": "you are logged in"}) }) // Listen and serve on 0.0.0.0:8080 router.Run(":8080") } ``` 索取样品 ```shell notranslate position-relative overflow-auto $ curl -v -X POST \ http://localhost:8080/loginJSON \ -H 'content-type: application/json' \ -d '{ "user": "manu" }' > POST /loginJSON HTTP/1.1 > Host: localhost:8080 > User-Agent: curl/7.51.0 > Accept: */* > content-type: application/json > Content-Length: 18 > * upload completely sent off: 18 out of 18 bytes < HTTP/1.1 400 Bad Request < Content-Type: application/json; charset=utf-8 < Date: Fri, 04 Aug 2017 03:51:31 GMT < Content-Length: 100 < {"error":"Key: 'Login.Password' Error:Field validation for 'Password' failed on the 'required' tag"} ``` 跳过验证:当使用上面的`curl`命令运行上面的例子时,它返回错误。因为示例使用`binding:"required"`for `Password`。如果使用`binding:"-"`for `Password`,那么再次运行上面的例子就不会返回错误。 ### 自定义验证器 也可以注册自定义验证器。请参阅[示例代码](https://github.com/gin-gonic/examples/tree/master/custom-validation/server.go)。 ```go notranslate position-relative overflow-auto package main import ( "net/http" "time" "github.com/gin-gonic/gin" "github.com/gin-gonic/gin/binding" "github.com/go-playground/validator/v10" ) // Booking contains binded and validated data. type Booking struct { CheckIn time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"` CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02"` } var bookableDate validator.Func = func(fl validator.FieldLevel) bool { date, ok := fl.Field().Interface().(time.Time) if ok { today := time.Now() if today.After(date) { return false } } return true } func main() { route := gin.Default() if v, ok := binding.Validator.Engine().(*validator.Validate); ok { v.RegisterValidation("bookabledate", bookableDate) } route.GET("/bookable", getBookable) route.Run(":8085") } func getBookable(c *gin.Context) { var b Booking if err := c.ShouldBindWith(&b, binding.Query); err == nil { c.JSON(http.StatusOK, gin.H{"message": "Booking dates are valid!"}) } else { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) } } ``` ``` $ curl "localhost:8085/bookable?check_in=2030-04-16&check_out=2030-04-17" {"message":"Booking dates are valid!"} $ curl "localhost:8085/bookable?check_in=2030-03-10&check_out=2030-03-09" {"error":"Key: 'Booking.CheckOut' Error:Field validation for 'CheckOut' failed on the 'gtfield' tag"} $ curl "localhost:8085/bookable?check_in=2000-03-09&check_out=2000-03-10" {"error":"Key: 'Booking.CheckIn' Error:Field validation for 'CheckIn' failed on the 'bookabledate' tag"}% ``` [结构级别验证](https://github.com/go-playground/validator/releases/tag/v8.7)也可以通过这种方式注册。请参阅[struct-lvl-validation 示例](https://github.com/gin-gonic/examples/tree/master/struct-lvl-validations)以了解更多信息。 ### 仅绑定查询字符串 `ShouldBindQuery`函数只绑定查询参数而不绑定发布数据。查看[详细信息](https://github.com/gin-gonic/gin/issues/742#issuecomment-315953017)。 ```go notranslate position-relative overflow-auto package main import ( "log" "net/http" "github.com/gin-gonic/gin" ) type Person struct { Name string `form:"name"` Address string `form:"address"` } func main() { route := gin.Default() route.Any("/testing", startPage) route.Run(":8085") } func startPage(c *gin.Context) { var person Person if c.ShouldBindQuery(&person) == nil { log.Println("====== Only Bind By Query String ======") log.Println(person.Name) log.Println(person.Address) } c.String(http.StatusOK, "Success") } ``` ### 绑定查询字符串或发布数据 查看[详细信息](https://github.com/gin-gonic/gin/issues/742#issuecomment-264681292)。 ```go notranslate position-relative overflow-auto package main import ( "log" "net/http" "time" "github.com/gin-gonic/gin" ) type Person struct { Name string `form:"name"` Address string `form:"address"` Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc:"1"` CreateTime time.Time `form:"createTime" time_format:"unixNano"` UnixTime time.Time `form:"unixTime" time_format:"unix"` } func main() { route := gin.Default() route.GET("/testing", startPage) route.Run(":8085") } func startPage(c *gin.Context) { var person Person // If `GET`, only `Form` binding engine (`query`) used. // If `POST`, first checks the `content-type` for `JSON` or `XML`, then uses `Form` (`form-data`). // See more at https://github.com/gin-gonic/gin/blob/master/binding/binding.go#L88 if c.ShouldBind(&person) == nil { log.Println(person.Name) log.Println(person.Address) log.Println(person.Birthday) log.Println(person.CreateTime) log.Println(person.UnixTime) } c.String(http.StatusOK, "Success") } ``` 测试它: ```shell notranslate position-relative overflow-auto curl -X GET "localhost:8085/testing?name=appleboy&address=xyz&birthday=1992-03-15&createTime=1562400033000000123&unixTime=1562400033" ``` ### 绑定URI 查看[详细信息](https://github.com/gin-gonic/gin/issues/846)。 ```go notranslate position-relative overflow-auto package main import ( "net/http" "github.com/gin-gonic/gin" ) type Person struct { ID string `uri:"id" binding:"required,uuid"` Name string `uri:"name" binding:"required"` } func main() { route := gin.Default() route.GET("/:name/:id", func(c *gin.Context) { var person Person if err := c.ShouldBindUri(&person); err != nil { c.JSON(http.StatusBadRequest, gin.H{"msg": err.Error()}) return } c.JSON(http.StatusOK, gin.H{"name": person.Name, "uuid": person.ID}) }) route.Run(":8088") } ``` 测试它: ```shell notranslate position-relative overflow-auto curl -v localhost:8088/thinkerou/987fbc97-4bed-5078-9f07-9141ba07c9f3 curl -v localhost:8088/thinkerou/not-uuid ``` ### 绑定标头 ```go notranslate position-relative overflow-auto package main import ( "fmt" "net/http" "github.com/gin-gonic/gin" ) type testHeader struct { Rate int `header:"Rate"` Domain string `header:"Domain"` } func main() { r := gin.Default() r.GET("/", func(c *gin.Context) { h := testHeader{} if err := c.ShouldBindHeader(&h); err != nil { c.JSON(http.StatusOK, err) } fmt.Printf("%#v\n", h) c.JSON(http.StatusOK, gin.H{"Rate": h.Rate, "Domain": h.Domain}) }) r.Run() // client // curl -H "rate:300" -H "domain:music" 127.0.0.1:8080/ // output // {"Domain":"music","Rate":300} } ``` ### 绑定 HTML 复选框 查看[详细信息](https://github.com/gin-gonic/gin/issues/129#issuecomment-124260092) 主程序 ```go notranslate position-relative overflow-auto ... type myForm struct { Colors []string `form:"colors[]"` } ... func formHandler(c *gin.Context) { var fakeForm myForm c.ShouldBind(&fakeForm) c.JSON(http.StatusOK, gin.H{"color": fakeForm.Colors}) } ... ``` 表单.html ```html <form action="/" method="POST"> <p>Check some colors</p> <label for="red">Red</label> <input type="checkbox" name="colors[]" value="red" id="red"> <label for="green">Green</label> <input type="checkbox" name="colors[]" value="green" id="green"> <label for="blue">Blue</label> <input type="checkbox" name="colors[]" value="blue" id="blue"> <input type="submit"> </form> ``` 结果: ```json notranslate position-relative overflow-auto {"color":["red","green","blue"]} ``` ### 多部分/URL 编码绑定 ```go notranslate position-relative overflow-auto type ProfileForm struct { Name string `form:"name" binding:"required"` Avatar *multipart.FileHeader `form:"avatar" binding:"required"` // or for multiple files // Avatars []*multipart.FileHeader `form:"avatar" binding:"required"` } func main() { router := gin.Default() router.POST("/profile", func(c *gin.Context) { // you can bind multipart form with explicit binding declaration: // c.ShouldBindWith(&form, binding.Form) // or you can simply use autobinding with ShouldBind method: var form ProfileForm // in this case proper binding will be automatically selected if err := c.ShouldBind(&form); err != nil { c.String(http.StatusBadRequest, "bad request") return } err := c.SaveUploadedFile(form.Avatar, form.Avatar.Filename) if err != nil { c.String(http.StatusInternalServerError, "unknown error") return } // db.Save(&form) c.String(http.StatusOK, "ok") }) router.Run(":8080") } ``` 测试它: ```shell notranslate position-relative overflow-auto curl -X POST -v --form name=user --form "avatar=@./avatar.png" http://localhost:8080/profile ``` ### XML、JSON、YAML、TOML 和 ProtoBuf 渲染 ```go notranslate position-relative overflow-auto func main() { r := gin.Default() // gin.H is a shortcut for map[string]interface{} r.GET("/someJSON", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) }) r.GET("/moreJSON", func(c *gin.Context) { // You also can use a struct var msg struct { Name string `json:"user"` Message string Number int } msg.Name = "Lena" msg.Message = "hey" msg.Number = 123 // Note that msg.Name becomes "user" in the JSON // Will output : {"user": "Lena", "Message": "hey", "Number": 123} c.JSON(http.StatusOK, msg) }) r.GET("/someXML", func(c *gin.Context) { c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) }) r.GET("/someYAML", func(c *gin.Context) { c.YAML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) }) r.GET("/someTOML", func(c *gin.Context) { c.TOML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK}) }) r.GET("/someProtoBuf", func(c *gin.Context) { reps := []int64{int64(1), int64(2)} label := "test" // The specific definition of protobuf is written in the testdata/protoexample file. data := &protoexample.Test{ Label: &label, Reps: reps, } // Note that data becomes binary data in the response // Will output protoexample.Test protobuf serialized data c.ProtoBuf(http.StatusOK, data) }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` #### 安全JSON 使用 SecureJSON 来防止 json 劫持。如果给定的结构是数组值,则默认`"while(1),"`添加到响应主体。 ```go notranslate position-relative overflow-auto func main() { r := gin.Default() // You can also use your own secure json prefix // r.SecureJsonPrefix(")]}',\n") r.GET("/someJSON", func(c *gin.Context) { names := []string{"lena", "austin", "foo"} // Will output : while(1);["lena","austin","foo"] c.SecureJSON(http.StatusOK, names) }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` #### JSONP 使用 JSONP 从不同域中的服务器请求数据。如果查询参数回调存在,则将回调添加到响应主体。 ```go notranslate position-relative overflow-auto func main() { r := gin.Default() r.GET("/JSONP", func(c *gin.Context) { data := gin.H{ "foo": "bar", } //callback is x // Will output : x({\"foo\":\"bar\"}) c.JSONP(http.StatusOK, data) }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") // client // curl http://127.0.0.1:8080/JSONP?callback=x } ``` #### AsciiJSON 使用 AsciiJSON 生成带有转义非 ASCII 字符的纯 ASCII JSON。 ```go notranslate position-relative overflow-auto func main() { r := gin.Default() r.GET("/someJSON", func(c *gin.Context) { data := gin.H{ "lang": "GO语言", "tag": "<br>", } // will output : {"lang":"GO\u8bed\u8a00","tag":"\u003cbr\u003e"} c.AsciiJSON(http.StatusOK, data) }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` #### 纯JSON 通常,JSON 用它们的 unicode 实体替换特殊的 HTML 字符,例如`<`变成 `\u003c`. 如果您想按字面意思对此类字符进行编码,则可以改用 PureJSON。此功能在 Go 1.6 及更低版本中不可用。 ```go notranslate position-relative overflow-auto func main() { r := gin.Default() // Serves unicode entities r.GET("/json", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{ "html": "<b>Hello, world!</b>", }) }) // Serves literal characters r.GET("/purejson", func(c *gin.Context) { c.PureJSON(http.StatusOK, gin.H{ "html": "<b>Hello, world!</b>", }) }) // listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` ### 提供静态文件 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.Static("/assets", "./assets") router.StaticFS("/more_static", http.Dir("my_file_system")) router.StaticFile("/favicon.ico", "./resources/favicon.ico") router.StaticFileFS("/more_favicon.ico", "more_favicon.ico", http.Dir("my_file_system")) // Listen and serve on 0.0.0.0:8080 router.Run(":8080") } ``` ### 从文件提供数据 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.GET("/local/file", func(c *gin.Context) { c.File("local/file.go") }) var fs http.FileSystem = // ... router.GET("/fs/file", func(c *gin.Context) { c.FileFromFS("fs/file.go", fs) }) } ``` ### 从阅读器提供数据 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.GET("/someDataFromReader", func(c *gin.Context) { response, err := http.Get("https://raw.githubusercontent.com/gin-gonic/logo/master/color.png") if err != nil || response.StatusCode != http.StatusOK { c.Status(http.StatusServiceUnavailable) return } reader := response.Body defer reader.Close() contentLength := response.ContentLength contentType := response.Header.Get("Content-Type") extraHeaders := map[string]string{ "Content-Disposition": `attachment; filename="gopher.png"`, } c.DataFromReader(http.StatusOK, contentLength, contentType, reader, extraHeaders) }) router.Run(":8080") } ``` ### HTML 渲染 使用 LoadHTMLGlob() 或 LoadHTMLFiles() ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.LoadHTMLGlob("templates/*") //router.LoadHTMLFiles("templates/template1.html", "templates/template2.html") router.GET("/index", func(c *gin.Context) { c.HTML(http.StatusOK, "index.tmpl", gin.H{ "title": "Main website", }) }) router.Run(":8080") } ``` 模板/index.tmpl ```html <html> <h1> {{ .title }} </h1> </html> ``` 在不同目录中使用同名模板 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() router.LoadHTMLGlob("templates/**/*") router.GET("/posts/index", func(c *gin.Context) { c.HTML(http.StatusOK, "posts/index.tmpl", gin.H{ "title": "Posts", }) }) router.GET("/users/index", func(c *gin.Context) { c.HTML(http.StatusOK, "users/index.tmpl", gin.H{ "title": "Users", }) }) router.Run(":8080") } ``` 模板/帖子/index.tmpl ```html {{ define "posts/index.tmpl" }} <html><h1> {{ .title }} </h1> <p>Using posts/index.tmpl</p> </html> {{ end }} ``` 模板/用户/index.tmpl ```html {{ define "users/index.tmpl" }} <html><h1> {{ .title }} </h1> <p>Using users/index.tmpl</p> </html> {{ end }} ``` #### 自定义模板渲染器 您也可以使用自己的 html 模板渲染 ```go notranslate position-relative overflow-auto import "html/template" func main() { router := gin.Default() html := template.Must(template.ParseFiles("file1", "file2")) router.SetHTMLTemplate(html) router.Run(":8080") } ``` #### 自定义分隔符 您可以使用自定义 delims ```go notranslate position-relative overflow-auto r := gin.Default() r.Delims("{[{", "}]}") r.LoadHTMLGlob("/path/to/templates") ``` #### 自定义模板函数 请参阅详细[示例代码](https://github.com/gin-gonic/examples/tree/master/template)。 主程序 ```go notranslate position-relative overflow-auto import ( "fmt" "html/template" "net/http" "time" "github.com/gin-gonic/gin" ) func formatAsDate(t time.Time) string { year, month, day := t.Date() return fmt.Sprintf("%d/%02d/%02d", year, month, day) } func main() { router := gin.Default() router.Delims("{[{", "}]}") router.SetFuncMap(template.FuncMap{ "formatAsDate": formatAsDate, }) router.LoadHTMLFiles("./testdata/template/raw.tmpl") router.GET("/raw", func(c *gin.Context) { c.HTML(http.StatusOK, "raw.tmpl", gin.H{ "now": time.Date(2017, 07, 01, 0, 0, 0, 0, time.UTC), }) }) router.Run(":8080") } ``` 原始.tmpl ```html Date: {[{.now | formatAsDate}]} ``` 结果: ```shell notranslate position-relative overflow-auto Date: 2017/07/01 ``` ### 多模板 Gin 默认只允许使用一个 html.Template。检查[多模板渲染](https://github.com/gin-contrib/multitemplate)以使用 go 1.6 等功能`block template`。 ### 重定向 发出 HTTP 重定向很容易。支持内部和外部位置。 ```go notranslate position-relative overflow-auto r.GET("/test", func(c *gin.Context) { c.Redirect(http.StatusMovedPermanently, "http://www.google.com/") }) ``` 从 POST 发出 HTTP 重定向。参考问题:[#444](https://github.com/gin-gonic/gin/issues/444) ```go notranslate position-relative overflow-auto r.POST("/test", func(c *gin.Context) { c.Redirect(http.StatusFound, "/foo") }) ``` 发出路由器重定向,使用`HandleContext`如下。 ```go notranslate position-relative overflow-auto r.GET("/test", func(c *gin.Context) { c.Request.URL.Path = "/test2" r.HandleContext(c) }) r.GET("/test2", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"hello": "world"}) }) ``` ### 自定义中间件 ```go notranslate position-relative overflow-auto func Logger() gin.HandlerFunc { return func(c *gin.Context) { t := time.Now() // Set example variable c.Set("example", "12345") // before request c.Next() // after request latency := time.Since(t) log.Print(latency) // access the status we are sending status := c.Writer.Status() log.Println(status) } } func main() { r := gin.New() r.Use(Logger()) r.GET("/test", func(c *gin.Context) { example := c.MustGet("example").(string) // it would print: "12345" log.Println(example) }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` ### 使用 BasicAuth() 中间件 ```go notranslate position-relative overflow-auto // simulate some private data var secrets = gin.H{ "foo": gin.H{"email": "foo@bar.com", "phone": "123433"}, "austin": gin.H{"email": "austin@example.com", "phone": "666"}, "lena": gin.H{"email": "lena@guapa.com", "phone": "523443"}, } func main() { r := gin.Default() // Group using gin.BasicAuth() middleware // gin.Accounts is a shortcut for map[string]string authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{ "foo": "bar", "austin": "1234", "lena": "hello2", "manu": "4321", })) // /admin/secrets endpoint // hit "localhost:8080/admin/secrets authorized.GET("/secrets", func(c *gin.Context) { // get user, it was set by the BasicAuth middleware user := c.MustGet(gin.AuthUserKey).(string) if secret, ok := secrets[user]; ok { c.JSON(http.StatusOK, gin.H{"user": user, "secret": secret}) } else { c.JSON(http.StatusOK, gin.H{"user": user, "secret": "NO SECRET :("}) } }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` ### 中间件内的协程 在中间件或处理程序中启动新的 Goroutine 时,你**不应该**使用其中的原始上下文,你必须使用只读副本。 ```go notranslate position-relative overflow-auto func main() { r := gin.Default() r.GET("/long_async", func(c *gin.Context) { // create copy to be used inside the goroutine cCp := c.Copy() go func() { // simulate a long task with time.Sleep(). 5 seconds time.Sleep(5 * time.Second) // note that you are using the copied context "cCp", IMPORTANT log.Println("Done! in path " + cCp.Request.URL.Path) }() }) r.GET("/long_sync", func(c *gin.Context) { // simulate a long task with time.Sleep(). 5 seconds time.Sleep(5 * time.Second) // since we are NOT using a goroutine, we do not have to copy the context log.Println("Done! in path " + c.Request.URL.Path) }) // Listen and serve on 0.0.0.0:8080 r.Run(":8080") } ``` ### 自定义 HTTP 配置 直接使用`http.ListenAndServe()`,像这样: ```go notranslate position-relative overflow-auto func main() { router := gin.Default() http.ListenAndServe(":8080", router) } ``` 或者 ```go notranslate position-relative overflow-auto func main() { router := gin.Default() s := &http.Server{ Addr: ":8080", Handler: router, ReadTimeout: 10 * time.Second, WriteTimeout: 10 * time.Second, MaxHeaderBytes: 1 << 20, } s.ListenAndServe() } ``` ### 支持让我们加密 1 行 LetsEncrypt HTTPS 服务器的示例。 ```go notranslate position-relative overflow-auto package main import ( "log" "net/http" "github.com/gin-gonic/autotls" "github.com/gin-gonic/gin" ) func main() { r := gin.Default() // Ping handler r.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) log.Fatal(autotls.Run(r, "example1.com", "example2.com")) } ``` 自定义自动证书管理器的示例。 ```go notranslate position-relative overflow-auto package main import ( "log" "net/http" "github.com/gin-gonic/autotls" "github.com/gin-gonic/gin" "golang.org/x/crypto/acme/autocert" ) func main() { r := gin.Default() // Ping handler r.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) m := autocert.Manager{ Prompt: autocert.AcceptTOS, HostPolicy: autocert.HostWhitelist("example1.com", "example2.com"), Cache: autocert.DirCache("/var/www/.cache"), } log.Fatal(autotls.RunWithManager(r, &m)) } ``` ### 使用 Gin 运行多个服务 查看[问题](https://github.com/gin-gonic/gin/issues/346)并尝试以下示例: ```go notranslate position-relative overflow-auto package main import ( "log" "net/http" "time" "github.com/gin-gonic/gin" "golang.org/x/sync/errgroup" ) var ( g errgroup.Group ) func router01() http.Handler { e := gin.New() e.Use(gin.Recovery()) e.GET("/", func(c *gin.Context) { c.JSON( http.StatusOK, gin.H{ "code": http.StatusOK, "error": "Welcome server 01", }, ) }) return e } func router02() http.Handler { e := gin.New() e.Use(gin.Recovery()) e.GET("/", func(c *gin.Context) { c.JSON( http.StatusOK, gin.H{ "code": http.StatusOK, "error": "Welcome server 02", }, ) }) return e } func main() { server01 := &http.Server{ Addr: ":8080", Handler: router01(), ReadTimeout: 5 * time.Second, WriteTimeout: 10 * time.Second, } server02 := &http.Server{ Addr: ":8081", Handler: router02(), ReadTimeout: 5 * time.Second, WriteTimeout: 10 * time.Second, } g.Go(func() error { err := server01.ListenAndServe() if err != nil && err != http.ErrServerClosed { log.Fatal(err) } return err }) g.Go(func() error { err := server02.ListenAndServe() if err != nil && err != http.ErrServerClosed { log.Fatal(err) } return err }) if err := g.Wait(); err != nil { log.Fatal(err) } } ``` ### 优雅关机或重启 您可以使用几种方法来执行正常关机或重新启动。您可以使用专门为此构建的第三方包,或者您可以手动对内置包中的函数和方法执行相同的操作。 #### 第三方包 我们可以使用[fvbock/endless](https://github.com/fvbock/endless)来替换默认的`ListenAndServe`. 有关详细信息,请参阅问题[#296](https://github.com/gin-gonic/gin/issues/296)。 ```go notranslate position-relative overflow-auto router := gin.Default() router.GET("/", handler) // [...] endless.ListenAndServe(":4242", router) ``` 备择方案: * [grace](https://github.com/facebookgo/grace):Go 服务器的优雅重启和零停机部署。 * [graceful](https://github.com/tylerb/graceful):Graceful 是一个 Go 包,可以优雅地关闭 http.Handler 服务器。 * [manners](https://github.com/braintree/manners):优雅关闭的礼貌 Go HTTP 服务器。 #### 手动 如果您使用的是 Go 1.8 或更高版本,则可能不需要使用这些库。考虑使用`http.Server`的内置[Shutdown()](https://pkg.go.dev/net/http#Server.Shutdown)方法进行正常关机。下面的例子描述了它的用法,我们在[这里](https://github.com/gin-gonic/examples/tree/master/graceful-shutdown)有更多使用 gin 的例子。 ```go notranslate position-relative overflow-auto // +build go1.8 package main import ( "context" "log" "net/http" "os" "os/signal" "syscall" "time" "github.com/gin-gonic/gin" ) func main() { router := gin.Default() router.GET("/", func(c *gin.Context) { time.Sleep(5 * time.Second) c.String(http.StatusOK, "Welcome Gin Server") }) srv := &http.Server{ Addr: ":8080", Handler: router, } // Initializing the server in a goroutine so that // it won't block the graceful shutdown handling below go func() { if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) { log.Printf("listen: %s\n", err) } }() // Wait for interrupt signal to gracefully shutdown the server with // a timeout of 5 seconds. quit := make(chan os.Signal) // kill (no param) default send syscall.SIGTERM // kill -2 is syscall.SIGINT // kill -9 is syscall.SIGKILL but can't be caught, so don't need to add it signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM) <-quit log.Println("Shutting down server...") // The context is used to inform the server it has 5 seconds to finish // the request it is currently handling ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) defer cancel() if err := srv.Shutdown(ctx); err != nil { log.Fatal("Server forced to shutdown:", err) } log.Println("Server exiting") } ``` ### 使用模板构建单个二进制文件 [您可以使用嵌入](https://pkg.go.dev/embed)包将服务器构建到包含模板的单个二进制文件中。 ```go notranslate position-relative overflow-auto package main import ( "embed" "html/template" "net/http" "github.com/gin-gonic/gin" ) //go:embed assets/* templates/* var f embed.FS func main() { router := gin.Default() templ := template.Must(template.New("").ParseFS(f, "templates/*.tmpl", "templates/foo/*.tmpl")) router.SetHTMLTemplate(templ) // example: /public/assets/images/example.png router.StaticFS("/public", http.FS(f)) router.GET("/", func(c *gin.Context) { c.HTML(http.StatusOK, "index.tmpl", gin.H{ "title": "Main website", }) }) router.GET("/foo", func(c *gin.Context) { c.HTML(http.StatusOK, "bar.tmpl", gin.H{ "title": "Foo website", }) }) router.GET("favicon.ico", func(c *gin.Context) { file, _ := f.ReadFile("assets/favicon.ico") c.Data( http.StatusOK, "image/x-icon", file, ) }) router.Run(":8080") } ``` 请参阅目录中的完整示例`https://github.com/gin-gonic/examples/tree/master/assets-in-binary/example02`。 ### 使用自定义结构绑定表单数据请求 以下示例使用自定义结构: ```go notranslate position-relative overflow-auto type StructA struct { FieldA string `form:"field_a"` } type StructB struct { NestedStruct StructA FieldB string `form:"field_b"` } type StructC struct { NestedStructPointer *StructA FieldC string `form:"field_c"` } type StructD struct { NestedAnonyStruct struct { FieldX string `form:"field_x"` } FieldD string `form:"field_d"` } func GetDataB(c *gin.Context) { var b StructB c.Bind(&b) c.JSON(http.StatusOK, gin.H{ "a": b.NestedStruct, "b": b.FieldB, }) } func GetDataC(c *gin.Context) { var b StructC c.Bind(&b) c.JSON(http.StatusOK, gin.H{ "a": b.NestedStructPointer, "c": b.FieldC, }) } func GetDataD(c *gin.Context) { var b StructD c.Bind(&b) c.JSON(http.StatusOK, gin.H{ "x": b.NestedAnonyStruct, "d": b.FieldD, }) } func main() { r := gin.Default() r.GET("/getb", GetDataB) r.GET("/getc", GetDataC) r.GET("/getd", GetDataD) r.Run() } ``` 使用命令`curl`命令结果: ```shell notranslate position-relative overflow-auto $ curl "http://localhost:8080/getb?field_a=hello&field_b=world" {"a":{"FieldA":"hello"},"b":"world"} $ curl "http://localhost:8080/getc?field_a=hello&field_c=world" {"a":{"FieldA":"hello"},"c":"world"} $ curl "http://localhost:8080/getd?field_x=hello&field_d=world" {"d":"world","x":{"FieldX":"hello"}} ``` ### 尝试将 body 绑定到不同的结构中 绑定请求体的普通方法消耗`c.Request.Body`,并且它们不能被多次调用。 ```go notranslate position-relative overflow-auto type formA struct { Foo string `json:"foo" xml:"foo" binding:"required"` } type formB struct { Bar string `json:"bar" xml:"bar" binding:"required"` } func SomeHandler(c *gin.Context) { objA := formA{} objB := formB{} // This c.ShouldBind consumes c.Request.Body and it cannot be reused. if errA := c.ShouldBind(&objA); errA == nil { c.String(http.StatusOK, `the body should be formA`) // Always an error is occurred by this because c.Request.Body is EOF now. } else if errB := c.ShouldBind(&objB); errB == nil { c.String(http.StatusOK, `the body should be formB`) } else { ... } } ``` 为此,您可以使用`c.ShouldBindBodyWith`. ```go notranslate position-relative overflow-auto func SomeHandler(c *gin.Context) { objA := formA{} objB := formB{} // This reads c.Request.Body and stores the result into the context. if errA := c.ShouldBindBodyWith(&objA, binding.Form); errA == nil { c.String(http.StatusOK, `the body should be formA`) // At this time, it reuses body stored in the context. } else if errB := c.ShouldBindBodyWith(&objB, binding.JSON); errB == nil { c.String(http.StatusOK, `the body should be formB JSON`) // And it can accepts other formats } else if errB2 := c.ShouldBindBodyWith(&objB, binding.XML); errB2 == nil { c.String(http.StatusOK, `the body should be formB XML`) } else { ... } } ``` 1. `c.ShouldBindBodyWith`在绑定之前将主体存储到上下文中。这对性能有轻微的影响,所以如果你足够一次调用绑定,你不应该使用这个方法。 2. 只有某些格式需要此功能 - `JSON`, `XML`, `MsgPack`, `ProtoBuf`。对于其他格式,`Query`, `Form`, `FormPost`, `FormMultipart`, 可以被`c.ShouldBind()`多次调用而不会对性能造成任何损害(参见[#1341](https://github.com/gin-gonic/gin/pull/1341))。 ### 使用自定义结构和自定义标签绑定表单数据请求 ```go notranslate position-relative overflow-auto const ( customerTag = "url" defaultMemory = 32 << 20 ) type customerBinding struct {} func (customerBinding) Name() string { return "form" } func (customerBinding) Bind(req *http.Request, obj interface{}) error { if err := req.ParseForm(); err != nil { return err } if err := req.ParseMultipartForm(defaultMemory); err != nil { if err != http.ErrNotMultipart { return err } } if err := binding.MapFormWithTag(obj, req.Form, customerTag); err != nil { return err } return validate(obj) } func validate(obj interface{}) error { if binding.Validator == nil { return nil } return binding.Validator.ValidateStruct(obj) } // Now we can do this!!! // FormA is an external type that we can't modify it's tag type FormA struct { FieldA string `url:"field_a"` } func ListHandler(s *Service) func(ctx *gin.Context) { return func(ctx *gin.Context) { var urlBinding = customerBinding{} var opt FormA err := ctx.MustBindWith(&opt, urlBinding) if err != nil { ... } ... } } ``` ### http2 服务器推送 http.Pusher 仅支持 **go1.8+** 。有关详细信息,请参阅[golang 博客](https://go.dev/blog/h2push)。 ```go notranslate position-relative overflow-auto package main import ( "html/template" "log" "net/http" "github.com/gin-gonic/gin" ) var html = template.Must(template.New("https").Parse(` <html> <head> <title>Https Test</title> <script src="/assets/app.js"></script> </head> <body> <h1 style="color:red;">Welcome, Ginner!</h1> </body> </html> `)) func main() { r := gin.Default() r.Static("/assets", "./assets") r.SetHTMLTemplate(html) r.GET("/", func(c *gin.Context) { if pusher := c.Writer.Pusher(); pusher != nil { // use pusher.Push() to do server push if err := pusher.Push("/assets/app.js", nil); err != nil { log.Printf("Failed to push: %v", err) } } c.HTML(http.StatusOK, "https", gin.H{ "status": "success", }) }) // Listen and Server in https://127.0.0.1:8080 r.RunTLS(":8080", "./testdata/server.pem", "./testdata/server.key") } ``` ### 定义路由日志的格式 路由的默认日志是: ```shell notranslate position-relative overflow-auto [GIN-debug] POST /foo --> main.main.func1 (3 handlers) [GIN-debug] GET /bar --> main.main.func2 (3 handlers) [GIN-debug] GET /status --> main.main.func3 (3 handlers) ``` 如果您想以给定格式(例如 JSON、键值或其他格式)记录此信息,则可以使用`gin.DebugPrintRouteFunc`. 在下面的示例中,我们使用标准日志包记录所有路由,但您可以使用适合您需要的其他日志工具。 ```go notranslate position-relative overflow-auto import ( "log" "net/http" "github.com/gin-gonic/gin" ) func main() { r := gin.Default() gin.DebugPrintRouteFunc = func(httpMethod, absolutePath, handlerName string, nuHandlers int) { log.Printf("endpoint %v %v %v %v\n", httpMethod, absolutePath, handlerName, nuHandlers) } r.POST("/foo", func(c *gin.Context) { c.JSON(http.StatusOK, "foo") }) r.GET("/bar", func(c *gin.Context) { c.JSON(http.StatusOK, "bar") }) r.GET("/status", func(c *gin.Context) { c.JSON(http.StatusOK, "ok") }) // Listen and Server in http://0.0.0.0:8080 r.Run() } ``` ### 设置并获取 cookie ```go notranslate position-relative overflow-auto import ( "fmt" "github.com/gin-gonic/gin" ) func main() { router := gin.Default() router.GET("/cookie", func(c *gin.Context) { cookie, err := c.Cookie("gin_cookie") if err != nil { cookie = "NotSet" c.SetCookie("gin_cookie", "test", 3600, "/", "localhost", false, true) } fmt.Printf("Cookie value: %s \n", cookie) }) router.Run() } ``` ## 不要相信所有代理 Gin 允许您指定哪些标头来保存真实客户端 IP(如果有),以及指定您信任哪些代理(或直接客户端)来指定这些标头之一。 使用`SetTrustedProxies()`您`gin.Engine`的功能指定网络地址或网络 CIDR,从中可以信任与客户端 IP 相关的请求标头的客户端。它们可以是 IPv4 地址、IPv4 CIDR、IPv6 地址或 IPv6 CIDR。 **注意:** 如果您没有使用上述功能指定受信任的代理,则默认情况下 Gin 信任所有代理,**这是不安全**的。同时,如果你不使用任何代理,你可以使用 禁用这个特性`Engine.SetTrustedProxies(nil)`,然后`Context.ClientIP()`会直接返回远程地址,避免一些不必要的计算。 ```go notranslate position-relative overflow-auto import ( "fmt" "github.com/gin-gonic/gin" ) func main() { router := gin.Default() router.SetTrustedProxies([]string{"192.168.1.2"}) router.GET("/", func(c *gin.Context) { // If the client is 192.168.1.2, use the X-Forwarded-For // header to deduce the original client IP from the trust- // worthy parts of that header. // Otherwise, simply return the direct client IP fmt.Printf("ClientIP: %s\n", c.ClientIP()) }) router.Run() } ``` **注意:** 如果您使用的是CDN服务,您可以设置`Engine.TrustedPlatform` 跳过TrustedProxies检查,它的优先级高于TrustedProxies。看下面的例子: ```go notranslate position-relative overflow-auto import ( "fmt" "github.com/gin-gonic/gin" ) func main() { router := gin.Default() // Use predefined header gin.PlatformXXX router.TrustedPlatform = gin.PlatformGoogleAppEngine // Or set your own trusted request header for another trusted proxy service // Don't set it to any suspect request header, it's unsafe router.TrustedPlatform = "X-CDN-IP" router.GET("/", func(c *gin.Context) { // If you set TrustedPlatform, ClientIP() will resolve the // corresponding header and return IP directly fmt.Printf("ClientIP: %s\n", c.ClientIP()) }) router.Run() } ``` ## 测试 该`net/http/httptest`包是 HTTP 测试的首选方式。 ```go notranslate position-relative overflow-auto package main import ( "net/http" "github.com/gin-gonic/gin" ) func setupRouter() *gin.Engine { r := gin.Default() r.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "pong") }) return r } func main() { r := setupRouter() r.Run(":8080") } ``` 测试上面的代码示例: ```go notranslate position-relative overflow-auto package main import ( "net/http" "net/http/httptest" "testing" "github.com/stretchr/testify/assert" ) func TestPingRoute(t *testing.T) { router := setupRouter() w := httptest.NewRecorder() req, _ := http.NewRequest(http.MethodGet, "/ping", nil) router.ServeHTTP(w, req) assert.Equal(t, http.StatusOK, w.Code) assert.Equal(t, "pong", w.Body.String()) } ``` 最后修改:2022 年 11 月 21 日 © 允许规范转载 打赏 赞赏作者 微信 赞 1 如果觉得我的文章对你有用,请随意赞赏