gin中文文档示例

例

该节列出了 api 的用法。

AsciiJSON

使用 AsciiJSON 生成具有转义的非 ASCII 字符的 ASCII-only JSON。

func main() {
    r :=gin.Default()

    r.GET("/someJSON", func(c *gin.Context) {
        data :=map[string]interface{}{
            "lang": "GO语言",
            "tag":  "<br>",
        }

        // 输出 : {"lang":"GO\u8bed\u8a00","tag":"\u003cbr\u003e"}
        c.AsciiJSON(http.StatusOK, data)
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

HTML 渲染

使用 LoadHTMLGlob() 或者 LoadHTMLFiles()

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")
}

templates/index.tmpl

<html>
    <h1>
        {{ .title }}
    </h1>
</html>

使用不同目录下名称相同的模板

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")
}

templates/posts/index.tmpl

{{ define "posts/index.tmpl" }}
<html><h1>
    {{ .title }}
</h1>
<p>Using posts/index.tmpl</p>
</html>
{{ end }}

templates/users/index.tmpl

{{ define "users/index.tmpl" }}
<html><h1>
    {{ .title }}
</h1>
<p>Using users/index.tmpl</p>
</html>
{{ end }}

自定义模板渲染器

你可以使用自定义的 html 模板渲染

import "html/template"

func main() {
    router :=gin.Default()
    html :=template.Must(template.ParseFiles("file1", "file2"))
    router.SetHTMLTemplate(html)
    router.Run(":8080")
}

自定义分隔符

你可以使用自定义分隔

    r :=gin.Default()
    r.Delims("{[{", "}]}")
    r.LoadHTMLGlob("/path/to/templates")

自定义模板功能

查看详细示例代码。

main.go

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", map[string]interface{}{
            "now": time.Date(2017, 07, 01, 0, 0, 0, 0, time.UTC),
        })
    })

    router.Run(":8080")
}

raw.tmpl

Date: {[{.now | formatAsDate}]}

结果：

Date: 2017/07/01

HTTP2 server 推送

http.Pusher 仅支持 go1.8+。更多信息，请查阅 golang blog。

package main

import (
    "html/template"
    "log"

    "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 {
            // 使用 pusher.Push() 做服务器推送
            if err :=pusher.Push("/assets/app.js", nil); err !=nil {
                log.Printf("Failed to push: %v", err)
            }
        }
        c.HTML(200, "https", gin.H{
            "status": "success",
        })
    })

    // 监听并在 https://127.0.0.1:8080 上启动服务
    r.RunTLS(":8080", "./testdata/server.pem", "./testdata/server.key")
}

JSONP

使用 JSONP 向不同域的服务器请求数据。如果查询参数存在回调，则将回调添加到响应体中。

func main() {
    r :=gin.Default()

    r.GET("/JSONP", func(c *gin.Context) {
        data :=map[string]interface{}{
            "foo": "bar",
        }
        
        // /JSONP?callback=x
        // 将输出：x({\"foo\":\"bar\"})
        c.JSONP(http.StatusOK, data)
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

Multipart/Urlencoded 绑定

package main

import (
    "github.com/gin-gonic/gin"
)

type LoginForm struct {
    User     string `form:"user" binding:"required"`
    Password string `form:"password" binding:"required"`
}

func main() {
    router :=gin.Default()
    router.POST("/login", func(c *gin.Context) {
        // 你可以使用显式绑定声明绑定 multipart form：
        // c.ShouldBindWith(&form, binding.Form)
        // 或者简单地使用 ShouldBind 方法自动绑定：
        var form LoginForm
        // 在这种情况下，将自动选择合适的绑定
        if c.ShouldBind(&form)==nil {
            if form.User=="user" && form.Password=="password" {
                c.JSON(200, gin.H{"status": "you are logged in"})
            } else {
                c.JSON(401, gin.H{"status": "unauthorized"})
            }
        }
    })
    router.Run(":8080")
}

测试：

$ curl -v --form user=user --form password=password http://localhost:8080/login

Multipart/Urlencoded 表单

func main() {
    router :=gin.Default()

    router.POST("/form_post", func(c *gin.Context) {
        message :=c.PostForm("message")
        nick :=c.DefaultPostForm("nick", "anonymous")

        c.JSON(200, gin.H{
            "status":  "posted",
            "message": message,
            "nick":    nick,
        })
    })
    router.Run(":8080")
}

PureJSON

通常，JSON 使用 unicode 替换特殊 HTML 字符，例如 < 变为 \ u003c。如果要按字面对这些字符进行编码，则可以使用 PureJSON。Go 1.6 及更低版本无法使用此功能。

func main() {
    r :=gin.Default()
    
    // 提供 unicode 实体
    r.GET("/json", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "html": "<b>Hello, world!</b>",
        })
    })
    
    // 提供字面字符
    r.GET("/purejson", func(c *gin.Context) {
        c.PureJSON(200, gin.H{
            "html": "<b>Hello, world!</b>",
        })
    })
    
    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

Query 和 post form

POST /post?id=1234&page=1 HTTP/1.1
Content-Type: application/x-www-form-urlencoded

name=manu&message=this_is_great
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")
}
id: 1234; page: 1; name: manu; message: this_is_great

SecureJSON

使用 SecureJSON 防止 json 劫持。如果给定的结构是数组值，则默认预置 "while(1)," 到响应体。

func main() {
    r :=gin.Default()

    // 你也可以使用自己的 SecureJSON 前缀
    // r.SecureJsonPrefix(")]}',\n")

    r.GET("/someJSON", func(c *gin.Context) {
        names :=[]string{"lena", "austin", "foo"}

        // 将输出：while(1);["lena","austin","foo"]
        c.SecureJSON(http.StatusOK, names)
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

XML/JSON/YAML/ProtoBuf 渲染

func main() {
    r :=gin.Default()

    // gin.H 是 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) {
        // 你也可以使用一个结构体
        var msg struct {
            Name    string `json:"user"`
            Message string
            Number  int
        }
        msg.Name="Lena"
        msg.Message="hey"
        msg.Number=123
        // 注意 msg.Name 在 JSON 中变成了 "user"
        // 将输出：{"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("/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)
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

上传文件

本节列出了上传图片的 api 用法。

单文件

参考 issue #774 和详细示例代码.

func main() {
    router :=gin.Default()
    // 为 multipart forms 设置较低的内存限制 (默认是 32 MiB)
    router.MaxMultipartMemory=8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // 单文件
        file, _ :=c.FormFile("file")
        log.Println(file.Filename)

        // 上传文件至指定目录
        c.SaveUploadedFile(file, dst)

        c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
    })
    router.Run(":8080")
}

如何使用 curl：

curl -X POST http://localhost:8080/upload \
  -F "file=@/Users/appleboy/test.zip" \
  -H "Content-Type: multipart/form-data"

多文件

查看详细示例代码.

func main() {
    router :=gin.Default()
    // 为 multipart forms 设置较低的内存限制 (默认是 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)

            // 上传文件至指定目录
            c.SaveUploadedFile(file, dst)
        }
        c.String(http.StatusOK, fmt.Sprintf("%d files uploaded!", len(files)))
    })
    router.Run(":8080")
}

如何使用 curl:

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"

不使用默认的中间件

使用

r :=gin.New()

代替

// Default 使用 Logger 和 Recovery 中间件
r :=gin.Default()

从 reader 读取数据

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
        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")
}

优雅地重启或停止

你想优雅地重启或停止 web 服务器吗？有一些方法可以做到这一点。

我们可以使用 fvbock/endless 来替换默认的 ListenAndServe。更多详细信息，请参阅 issue #296。

router :=gin.Default()
router.GET("/", handler)
// [...]
endless.ListenAndServe(":4242", router)

替代方案:

manners：可以优雅关机的 Go Http 服务器。
graceful：Graceful 是一个 Go 扩展包，可以优雅地关闭 http.Handler 服务器。
grace：Go 服务器平滑重启和零停机时间部署。

如果你使用的是 Go 1.8，可以不需要这些库！考虑使用 http.Server 内置的 Shutdown() 方法优雅地关机. 请参阅 gin 完整的 graceful-shutdown 示例。

// +build go1.8

package main

import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "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,
    }

    go func() {
        // 服务连接
        if err :=srv.ListenAndServe(); err !=nil && err !=http.ErrServerClosed {
            log.Fatalf("listen: %s\n", err)
        }
    }()

    // 等待中断信号以优雅地关闭服务器（设置 5 秒的超时时间）
    quit :=make(chan os.Signal)
    signal.Notify(quit, os.Interrupt)
    <-quit
    log.Println("Shutdown Server ...")

    ctx, cancel :=context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()
    if err :=srv.Shutdown(ctx); err !=nil {
        log.Fatal("Server Shutdown:", err)
    }
    log.Println("Server exiting")
}

使用 BasicAuth 中间件

// 模拟一些私人数据
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()

    // 路由组使用 gin.BasicAuth() 中间件
    // gin.Accounts 是 map[string]string 的一种快捷方式
    authorized :=r.Group("/admin", gin.BasicAuth(gin.Accounts{
        "foo":    "bar",
        "austin": "1234",
        "lena":   "hello2",
        "manu":   "4321",
    }))

    // /admin/secrets 端点
    // 触发 "localhost:8080/admin/secrets
    authorized.GET("/secrets", func(c *gin.Context) {
        // 获取用户，它是由 BasicAuth 中间件设置的
        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 :("})
        }
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

使用 HTTP 方法

func main() {
    // 禁用控制台颜色
    // gin.DisableConsoleColor()

    // 使用默认中间件（logger 和 recovery 中间件）创建 gin 路由
    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)

    // 默认在 8080 端口启动服务，除非定义了一个 PORT 的环境变量。
    router.Run()
    // router.Run(":3000") hardcode 端口号
}

使用中间件

func main() {
    // 新建一个没有任何默认中间件的路由
    r :=gin.New()

    // 全局中间件
    // Logger 中间件将日志写入 gin.DefaultWriter，即使你将 GIN_MODE 设置为 release。
    // By default gin.DefaultWriter=os.Stdout
    r.Use(gin.Logger())

    // Recovery 中间件会 recover 任何 panic。如果有 panic 的话，会写入 500。
    r.Use(gin.Recovery())

    // 你可以为每个路由添加任意数量的中间件。
    r.GET("/benchmark", MyBenchLogger(), benchEndpoint)

    // 认证路由组
    // authorized :=r.Group("/", AuthRequired())
    // 和使用以下两行代码的效果完全一样:
    authorized :=r.Group("/")
    // 路由组中间件! 在此例中，我们在 "authorized" 路由组中使用自定义创建的 
    // AuthRequired() 中间件
    authorized.Use(AuthRequired())
    {
        authorized.POST("/login", loginEndpoint)
        authorized.POST("/submit", submitEndpoint)
        authorized.POST("/read", readEndpoint)

        // 嵌套路由组
        testing :=authorized.Group("testing")
        testing.GET("/analytics", analyticsEndpoint)
    }

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

只绑定 url 查询字符串

ShouldBindQuery 函数只绑定 url 查询参数而忽略 post 数据。参阅详细信息.

package main

import (
    "log"

    "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(200, "Success")
}

在中间件中使用 Goroutine

当在中间件或 handler 中启动新的 Goroutine 时，不能使用原始的上下文，必须使用只读副本。

func main() {
    r :=gin.Default()

    r.GET("/long_async", func(c *gin.Context) {
        // 创建在 goroutine 中使用的副本
        cCp :=c.Copy()
        go func() {
            // 用 time.Sleep() 模拟一个长任务。
            time.Sleep(5 * time.Second)

            // 请注意您使用的是复制的上下文 "cCp"，这一点很重要
            log.Println("Done! in path " + cCp.Request.URL.Path)
        }()
    })

    r.GET("/long_sync", func(c *gin.Context) {
        // 用 time.Sleep() 模拟一个长任务。
        time.Sleep(5 * time.Second)

        // 因为没有使用 goroutine，不需要拷贝上下文
        log.Println("Done! in path " + c.Request.URL.Path)
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

多模板

Gin 默认允许只使用一个 html 模板。查看多模板渲染以使用 go 1.6 block template 等功能。

如何记录日志

func main() {
    // 禁用控制台颜色，将日志写入文件时不需要控制台颜色。
    gin.DisableConsoleColor()

    // 记录到文件。
    f, _ :=os.Create("gin.log")
    gin.DefaultWriter=io.MultiWriter(f)

    // 如果需要同时将日志写入文件和控制台，请使用以下代码。
    // gin.DefaultWriter=io.MultiWriter(f, os.Stdout)

    router :=gin.Default()
    router.GET("/ping", func(c *gin.Context) {
        c.String(200, "pong")
    })

    router.Run(":8080")
}

定义路由日志的格式

默认的路由日志格式：

[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，key values 或其他格式）记录信息，则可以使用 gin.DebugPrintRouteFunc 指定格式。在下面的示例中，我们使用标准日志包记录所有路由，但你可以使用其他满足你需求的日志工具。

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")
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run()
}

将 request body 绑定到不同的结构体中

一般通过调用 c.Request.Body 方法绑定数据，但不能多次调用这个方法。

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{}
  // c.ShouldBind 使用了 c.Request.Body，不可重用。
  if errA :=c.ShouldBind(&objA); errA==nil {
    c.String(http.StatusOK, `the body should be formA`)
  // 因为现在 c.Request.Body 是 EOF，所以这里会报错。
  } else if errB :=c.ShouldBind(&objB); errB==nil {
    c.String(http.StatusOK, `the body should be formB`)
  } else {
    ...
  }
}

要想多次绑定，可以使用 c.ShouldBindBodyWith.

func SomeHandler(c *gin.Context) {
  objA :=formA{}
  objB :=formB{}
  // 读取 c.Request.Body 并将结果存入上下文。
  if errA :=c.ShouldBindBodyWith(&objA, binding.JSON); errA==nil {
    c.String(http.StatusOK, `the body should be formA`)
  // 这时, 复用存储在上下文中的 body。
  } else if errB :=c.ShouldBindBodyWith(&objB, binding.JSON); errB==nil {
    c.String(http.StatusOK, `the body should be formB JSON`)
  // 可以接受其他格式
  } else if errB2 :=c.ShouldBindBodyWith(&objB, binding.XML); errB2==nil {
    c.String(http.StatusOK, `the body should be formB XML`)
  } else {
    ...
  }
}

c.ShouldBindBodyWith 会在绑定之前将 body 存储到上下文中。这会对性能造成轻微影响，如果调用一次就能完成绑定的话，那就不要用这个方法。
只有某些格式需要此功能，如 JSON, XML, MsgPack, ProtoBuf。对于其他格式, 如 Query, Form, FormPost, FormMultipart 可以多次调用 c.ShouldBind() 而不会造成任任何性能损失 (详见 #1341)。

控制日志输出颜色

根据检测到的 TTY，控制台的日志输出默认是有颜色的。

禁止日志颜色化:

func main() {
    // 禁止日志的颜色
    gin.DisableConsoleColor()

    // 用默认中间件创建一个 gin 路由:
    // 日志和恢复（无崩溃）中间件
    router :=gin.Default()

    router.GET("/ping", func(c *gin.Context) {
        c.String(200, "pong")
    })

    router.Run(":8080")
}

日志颜色化:

func main() {
    // 强制日志颜色化
    gin.ForceConsoleColor()

    // 用默认中间件创建一个 gin 路由:
    // 日志和恢复（无崩溃）中间件
    router :=gin.Default()

    router.GET("/ping", func(c *gin.Context) {
        c.String(200, "pong")
    })

    router.Run(":8080")
}

支持 Let's Encrypt

一行代码支持 LetsEncrypt HTTPS servers 示例。

package main

import (
    "log"

    "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(200, "pong")
    })

    log.Fatal(autotls.Run(r, "example1.com", "example2.com"))
}

自定义 autocert manager 示例。

package main

import (
    "log"

    "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(200, "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))
}

映射查询字符串或表单参数

POST /post?ids[a]=1234&ids[b]=hello HTTP/1.1
Content-Type: application/x-www-form-urlencoded

names[first]=thinkerou&names[second]=tianou
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")
}
ids: map[b:hello a:1234], names: map[second:tianou first:thinkerou]

查询字符串参数

func main() {
    router :=gin.Default()

    // 使用现有的基础请求对象解析查询字符串参数。
    // 示例 URL： /welcome?firstname=Jane&lastname=Doe
    router.GET("/welcome", func(c *gin.Context) {
        firstname :=c.DefaultQuery("firstname", "Guest")
        lastname :=c.Query("lastname") // c.Request.URL.Query().Get("lastname") 的一种快捷方式

        c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
    })
    router.Run(":8080")
}

模型绑定和验证

要将请求体绑定到结构体中，使用模型绑定。 Gin目前支持JSON、XML、YAML和标准表单值的绑定（foo=bar＆boo=baz）。

Gin使用 go-playground/validator.v8 进行验证。查看标签用法的全部文档.

使用时，需要在要绑定的所有字段上，设置相应的tag。例如，使用 JSON 绑定时，设置字段标签为 json:"fieldname"。

Gin提供了两类绑定方法：

Type

- Must bind

Methods - Bind, BindJSON, BindXML, BindQuery, BindYAML
Behavior - 这些方法属于 MustBindWith 的具体调用。如果发生绑定错误，则请求终止，并触发 c.AbortWithError(400, err).SetType(ErrorTypeBind)。响应状态码被设置为 400 并且 Content-Type 被设置为 text/plain; charset=utf-8。如果您在此之后尝试设置响应状态码，Gin会输出日志 [GIN-debug] [WARNING] Headers were already written. Wanted to override status code 400 with 422。如果您希望更好地控制绑定，考虑使用 ShouldBind 等效方法。
Type

- Should bind

Methods - ShouldBind, ShouldBindJSON, ShouldBindXML, ShouldBindQuery, ShouldBindYAML
Behavior - 这些方法属于 ShouldBindWith 的具体调用。如果发生绑定错误，Gin 会返回错误并由开发者处理错误和请求。

使用 Bind 方法时，Gin 会尝试根据 Content-Type 推断如何绑定。如果你明确知道要绑定什么，可以使用 MustBindWith 或 ShouldBindWith。

你也可以指定必须绑定的字段。如果一个字段的 tag 加上了 binding:"required"，但绑定时是空值, Gin 会报错。

// 绑定 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()

    // 绑定 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"})
    })

    // 绑定 XML (
    //  <?xml version="1.0" encoding="UTF-8"?>
    //  <root>
    //      <user>user</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"})
    })

    // 绑定 HTML 表单 (user=manu&password=123)
    router.POST("/loginForm", func(c *gin.Context) {
        var form Login
        // 根据 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"})
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    router.Run(":8080")
}

示例请求

$ 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 命令运行上面的示例时会返回错误。因为示例中 Password 使用了 binding:"required"。如果 Password 使用 binding:"-"，再次运行上面的示例就不会返回错误。

绑定 HTML 复选框

参见详细信息

main.go

...

type myForm struct {
    Colors []string `form:"colors[]"`
}

...

func formHandler(c *gin.Context) {
    var fakeForm myForm
    c.ShouldBind(&fakeForm)
    c.JSON(200, gin.H{"color": fakeForm.Colors})
}

...

form.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>

结果:

{"color":["red","green","blue"]}

绑定 Uri

查看详细信息.

package main

import "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(400, gin.H{"msg": err})
            return
        }
        c.JSON(200, gin.H{"name": person.Name, "uuid": person.ID})
    })
    route.Run(":8088")
}

测试:

$ curl -v localhost:8088/thinkerou/987fbc97-4bed-5078-9f07-9141ba07c9f3
$ curl -v localhost:8088/thinkerou/not-uuid

绑定查询字符串或表单数据

查看详细信息。

package main

import (
    "log"
    "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"`
}

func main() {
    route :=gin.Default()
    route.GET("/testing", startPage)
    route.Run(":8085")
}

func startPage(c *gin.Context) {
    var person Person
    // 如果是 `GET` 请求，只使用 `Form` 绑定引擎（`query`）。
    // 如果是 `POST` 请求，首先检查 `content-type` 是否为 `JSON` 或 `XML`，然后再使用 `Form`（`form-data`）。
    // 查看更多：https://github.com/gin-gonic/gin/blob/master/binding/binding.go#L48
    if c.ShouldBind(&person)==nil {
        log.Println(person.Name)
        log.Println(person.Address)
        log.Println(person.Birthday)
    }

    c.String(200, "Success")
}

测试：

$ curl -X GET "localhost:8085/testing?name=appleboy&address=xyz&birthday=1992-03-15"

绑定表单数据至自定义结构体

以下示例使用自定义结构体：

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(200, gin.H{
        "a": b.NestedStruct,
        "b": b.FieldB,
    })
}

func GetDataC(c *gin.Context) {
    var b StructC
    c.Bind(&b)
    c.JSON(200, gin.H{
        "a": b.NestedStructPointer,
        "c": b.FieldC,
    })
}

func GetDataD(c *gin.Context) {
    var b StructD
    c.Bind(&b)
    c.JSON(200, 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 命令结果：

$ 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"}}

注意：不支持以下格式结构体：

type StructX struct {
    X struct {} `form:"name_x"` // 有 form
}

type StructY struct {
    Y StructX `form:"name_y"` // 有 form
}

type StructZ struct {
    Z *StructZ `form:"name_z"` // 有 form
}

总之, 目前仅支持没有 form 的嵌套结构体。

自定义 HTTP 配置

直接使用 http.ListenAndServe()，如下所示：

func main() {
    router :=gin.Default()
    http.ListenAndServe(":8080", router)
}

或

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()
}

自定义中间件

func Logger() gin.HandlerFunc {
    return func(c *gin.Context) {
        t :=time.Now()

        // 设置 example 变量
        c.Set("example", "12345")

        // 请求前

        c.Next()

        // 请求后
        latency :=time.Since(t)
        log.Print(latency)

        // 获取发送的 status
        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)

        // 打印："12345"
        log.Println(example)
    })

    // 监听并在 0.0.0.0:8080 上启动服务
    r.Run(":8080")
}

自定义验证器

注册自定义验证器，查看示例代码.

package main

import (
    "net/http"
    "reflect"
    "time"

    "github.com/gin-gonic/gin"
    "github.com/gin-gonic/gin/binding"
    "github.com/go-playground/validator/v10"
)

// Booking 包含绑定和验证的数据。
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,bookabledate" 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=2018-04-16&check_out=2018-04-17"
{"message":"Booking dates are valid!"}

$ curl "localhost:8085/bookable?check_in=2018-03-08&check_out=2018-03-09"
{"error":"Key: 'Booking.CheckIn' Error:Field validation for 'CheckIn' failed on the 'bookabledate' tag"}

结构体级别的验证器也可以通过其他的方式注册。更多信息请参阅 struct-lvl-validation 示例。

设置和获取 Cookie

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()
}

路由参数

func main() {
    router :=gin.Default()

    // 此 handler 将匹配 /user/john 但不会匹配 /user/ 或者 /user
    router.GET("/user/:name", func(c *gin.Context) {
        name :=c.Param("name")
        c.String(http.StatusOK, "Hello %s", name)
    })

    // 此 handler 将匹配 /user/john/ 和 /user/john/send
    // 如果没有其他路由匹配 /user/john，它将重定向到 /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)
    })

    router.Run(":8080")
}

路由组

func main() {
    router :=gin.Default()

    // 简单的路由组: v1
    v1 :=router.Group("/v1")
    {
        v1.POST("/login", loginEndpoint)
        v1.POST("/submit", submitEndpoint)
        v1.POST("/read", readEndpoint)
    }

    // 简单的路由组: v2
    v2 :=router.Group("/v2")
    {
        v2.POST("/login", loginEndpoint)
        v2.POST("/submit", submitEndpoint)
        v2.POST("/read", readEndpoint)
    }

    router.Run(":8080")
}

运行多个服务

请参阅 issues 并尝试以下示例：

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 {
        return server01.ListenAndServe()
    })

    g.Go(func() error {
        return server02.ListenAndServe()
    })

    if err :=g.Wait(); err !=nil {
        log.Fatal(err)
    }
}

重定向

HTTP 重定向很容易。内部、外部重定向均支持。

r.GET("/test", func(c *gin.Context) {
    c.Redirect(http.StatusMovedPermanently, "http://www.google.com/")
})

通过 POST 方法进行 HTTP 重定向。请参考 issue：#444

r.POST("/test", func(c *gin.Context) {
    c.Redirect(http.StatusFound, "/foo")
})

路由重定向，使用 HandleContext：

r.GET("/test", func(c *gin.Context) {
    c.Request.URL.Path="/test2"
    r.HandleContext(c)
})
r.GET("/test2", func(c *gin.Context) {
    c.JSON(200, gin.H{"hello": "world"})
})

静态文件服务

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")

    // 监听并在 0.0.0.0:8080 上启动服务
    router.Run(":8080")
}

静态资源嵌入

你可以使用 go-assets 将静态资源打包到可执行文件中。

func main() {
    r :=gin.New()

    t, err :=loadTemplate()
    if err !=nil {
        panic(err)
    }
    r.SetHTMLTemplate(t)

    r.GET("/", func(c *gin.Context) {
        c.HTML(http.StatusOK, "/html/index.tmpl", nil)
    })
    r.Run(":8080")
}

// loadTemplate 加载由 go-assets-builder 嵌入的模板
func loadTemplate() (*template.Template, error) {
    t :=template.New("")
    for name, file :=range Assets.Files {
        if file.IsDir() || !strings.HasSuffix(name, ".tmpl") {
            continue
        }
        h, err :=ioutil.ReadAll(file)
        if err !=nil {
            return nil, err
        }
        t, err=t.New(name).Parse(string(h))
        if err !=nil {
            return nil, err
        }
    }
    return t, nil
}

请参阅 examples/assets-in-binary 目录中的完整示例。

用Golang流行的web框架Gin渲染HTML模板页面的简单例子

Gin是Golang最流行的web框架之一。我之前已经写过如何使用Golang基础模板包渲染HTML页面。使用Gin渲染HTML模板更加简单。

为了使工作流更加顺畅，尝试新的想法并进行调试，我还决定使用Codegangsta的自动重载工具Gin。

安装Gin

安装Gin HTTP web框架就像安装大多数（如果不是所有）Golang包一样简单：

go get -u github.com/gin-gonic/gin

Gin 代码

package main

import (
    "html/template"
    "net/http"
    "strings"

    "github.com/gin-gonic/gin"
)

func main() {
    router :=gin.Default()
    router.SetFuncMap(template.FuncMap{
        "upper": strings.ToUpper,
    })
    router.Static("/assets", "./assets")
    router.LoadHTMLGlob("templates/*.html")

    router.GET("/", func(c *gin.Context) {
        c.HTML(http.StatusOK, "index.html", gin.H{
            "content": "This is an index page...",
        })
    })

    router.GET("/about", func(c *gin.Context) {
        c.HTML(http.StatusOK, "about.html", gin.H{
            "content": "This is an about page...",
        })
    })
    router.Run("localhost:8080")
}

引入的包

在第4到7行，我们引入了一些包：

? Gin HTTP web框架的包。
? Golang的html/template基础包，用于引入FuncMap()函数。在模板中使用函数时需要此函数。
? 与Gin一起使用的Golang net/http基础包。
? strings基础包，用于FuncMap中的upper函数。

main()函数

在第11行，我们创建了一个名为router的默认Gin路由。默认的Gin路由使用日志和恢复中间件，以及基本功能。

在第12到14行，使用SetFuncMap()创建一个供模板使用的函数映射。这里我们添加了一个简单的模板函数upper，它使用strings.ToUpper()函数将字符串中的所有字符设置为大写。

在第15行，我们让Gin路由知道我们在./assets目录中保存了一些静态资产。Gin可以以这种方式访问任何静态资源。

在这个例子中，我在那个目录中放了一个Bulma CSS库的最小版本。通过使用Static()函数，现在HTML模板可以访问这个库。

在第16行，所有满足template/*.html模式的模板都由LoadHTMLGlob()函数加载。这个模式意味着模板文件应该有.html的扩展名，并且位于/template目录中。

在第18到22行，我们告诉Gin路由接受URL路径/上的HTTP GET方法请求。当收到请求时，Gin发送一个HTTP OK状态消息，并用gin.H{}括号内提供的数据渲染index.html模板。在这种情况下，数据只包括一个键/值对，键名为content。

在第24到28行，与上面类似，我们告诉Gin路由接受/about路径上的HTTP GET方法请求。这次渲染的是about.html模板。

在第29行，我们让Gin在localhost端口8080上运行web服务器。

模板和目录结构

下面你可以找到本例中使用的四个模板。这些模板每个都需要在自己的文件中。每段代码之前都有文件名。

模板的语法与html/template基础包中的相同。你可以我之前的文章中阅读更多关于模板语法的内容。

// header.html
{{define "header.html"}}
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link rel="stylesheet" type="text/css" href="/assets/bulma.min.css">
    <title></title>
</head>
<body>
<div class="container">
<br><br>
{{end}}
  

// footer.html
{{define "footer.html"}}
</div>
</body>
</html>
{{end}}


// index.html
{{template "header.html"}}
<h1 class="title">
    INDEX PAGE
</h1>
<p>{{ .content }}</p>
{{template "footer.html"}}


// about.html
{{template "header.html"}}
<h1 class="title">
    ABOUT PAGE
</h1>
<p>{{ .content | upper}}</p>
{{template "footer.html"}}

自动重载Gin

如前所述，我在开发时使用codegangsta/gin工具来自动重载gin。这使得在浏览器中检查我们代码的结果变得更加容易。当我们改变了代码，无需停止当前的可执行文件，重新构建和运行它，就可以做到这一点。

以下是Github页面上对这个工具的描述：

gin是一个简单的命令行工具，用于实时重新加载Go web应用程序。只需在你的应用程序目录下运行gin，你的web应用就会以gin作为代理来服务。gin会在检测到更改时自动重新编译你的代码。下次它接收到HTTP请求时，你的应用将会重启。

安装codegangsta/gin

go get github.com/codegangsta/gin

运行codegangsta/gin

gin -i --appPort 8080 --port 3000 run main.go

上述代码需要在命令行中运行。它假设你正在localhost的8080端口上运行你的Go web应用，并且你将使用3000端口作为Gin自动重载代理。

关于运行代码的注意事项

在从命令行运行代码之前，你可能需要运行以下命令：

go mod init
go mod tidy

在网页浏览器中检查结果

在浏览器的URL字段中输入以下内容以检查代码的结果：

localhost:3000/

…对于索引页面，和…

localhost:3000/about

对于关于页面。

列表清单

请记住，始终保持学习的态度，并享受编码的乐趣！祝您编码愉快！

如果你喜欢我的文章，点赞，关注，转发！

绍

Gin 是一个 Golang 写的 web 框架，具有高性能的优点，基于 httprouter，它提供了类似martini但更好性能(路由性能约快40倍)的API服务。官方地址：https://github.com/gin-gonic/gin。

使用

在项目中使用Gin也极其简单

下载gin: go get -u -v github.com/gin-gonic/gin
import中引入"github.com/gin-gonic/gin"
核心代码r :=gin.Default()r.GET("/ping", ping) r.Run(":8080")
go run 后，浏览器输入http://localhost:9090/ping即可使用
可以使用热加载调试工具：go get -v -u github.com/pilu/fresh - 执行fresh即可，代码有变动会自动编译程序

下面为整体演示代码：

package main
import (
  "net/http"
  ginSwagger "github.com/swaggo/gin-swagger"
  "github.com/swaggo/gin-swagger/swaggerFiles"
  _ "asap/docs"
  "github.com/gin-gonic/gin"
)
// @Summary 接口探活
// @Produce  json
// @Param lang query string false "en"
// @Success 200 {string} string "ok"
// @Router /ping [get]
func ping(c *gin.Context) {
  c.String(http.StatusOK, "ok")
}
func main() {
  r :=gin.Default()
  r.GET("/ping", ping)
  r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
  v1 :=r.Group("/v1")
{
    v1.GET("/group", ping)
}
  // Listen and Server in 0.0.0.0:8080
  r.Run(":9090")
}

源码剖析

Gin代码量很少，使用 find . -name "*.go" | xargs cat | wc -l 查看后，在14K左右。我会从5个方面来进行解析

结构简介：Gin使用的结构进行简单说明
前期准备：Gin是如何将路由等信息组合起来的
监听请求：Gin是如何开启服务，监听请求的
请求处理：当请求到达时，Gin如何处理这些请求
返回数据：处理完请求后，如何将数据返回给请求方

本文只是做简单的剖析，方便大家能够快速地理解和学习这个框架。

结构简介

本节主要给大家介绍一下Gin使用的核心数据结构或者接口，其中有些图画得不太准确，不过不影响理解。

Engine：Engine里有三个非常重要的数据
RouterGroup：使用Handlers存放中间件，另外提供设置路由的功能
pool：主要用于从池中获取或者存放Context，减少GC
trees：主要用于存放路由信息和该路由对应的处理函数列表，每个HTTP方法（GET POST等）都有单独的tree

Context：主要接收server传递过来的http.Request和http.Response，并对这两个数据进行处理

四个流程

红色为前期准备，绿色为监听请求，紫色为请求处理，粉色为返回数据。如果图片不清晰，可查看 https://www.processon.com/view/link/5e36f9efe4b0d27af1852f3b

说明

学习完Gin框架，我们自己也可以制作简单的go-web框架。go在语言层面帮我们解决了很多重复性的工作，实在是一门有理想有追求的语言。
本文章只是简单的讲解，最好的剖析还是源码本身。

参考资料

使用

https://geektutu.com/post/quick-go-gin.html Go Gin 简明教程
https://github.com/gin-gonic/gin 源码
https://gin-gonic.com/zh-cn/docs/ 中文文档
https://www.kancloud.cn/shuangdeyu/gin_book/949436 gin中文文档

源码

https://www.jianshu.com/p/35addb4de300
https://www.cnblogs.com/yjf512/p/9670990.html
https://www.cnblogs.com/sunsky303/p/9706210.html sync.Pool详解

在线咨询

上一篇：优秀武汉疫情武汉加油中国加油AE模板推荐-凌晨两点素
下一篇：「推荐」IntelliJ IDEA 使用系列教程（1

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。

整合营销服务商