Go語言WEB框架(Gin)詳解

在 Go語言開發的 Web 框架中，有兩款著名 Web 框架分別是 Martini 和 Gin，兩款 Web 框架相比較的話，Gin 自己說它比 Martini 要強很多。

Gin 是 Go語言寫的一個 web 框架，它具有執行速度快，分組的路由器，良好的崩潰捕獲和錯誤處理，非常好的支援中介軟體和 json。總之在 Go語言開發領域是一款值得好好研究的 Web 框架，開源網址：https://github.com/gin-gonic/gin

首先下載安裝 gin 包：

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

一個簡單的例子：

package main

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

func main() {
    //Default返回一個預設的路由引擎
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        //輸出json結果給呼叫方
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.Run() // listen and serve on 0.0.0.0:8080
}

編譯執行程式，開啟瀏覽器，存取http://localhost:8080/ping頁面顯示：

{"message":"pong"}

gin 的功能不只是簡單輸出 Json 資料。它是一個輕量級的 WEB 框架，支援 RestFull 風格 API，支援 GET，POST，PUT，PATCH，DELETE，OPTIONS 等 http 方法，支援檔案上傳，分組路由，Multipart/Urlencoded FORM，以及支援 JsonP，引數處理等等功能，這些都和 WEB 緊密相關，通過提供這些功能，使開發人員更方便地處理 WEB 業務。

Gin 實際應用

接下來使用 Gin 作為框架來搭建一個擁有靜態資源站點，動態 WEB 站點，以及 RESTFull API 介面站點（可專門作為手機 APP 應用提供服務使用）組成的，亦可根據情況分拆這套系統，每種功能獨立出來單獨提供服務。

下面按照一套系統但採用分站點來說明，首先是整個系統的目錄結構，website 目錄下面 static 是資源類檔案，為靜態資源站點專用；photo 目錄是 UGC 上傳圖片目錄，tpl 是動態站點的模板。

當然這個目錄結構是一種約定，可以根據情況來修改。整個專案已經開源，可以存取來詳細了解：https://github.com/ffhelicopter/tmm具體每個站點的功能怎麼實現呢？請看下面有關每個功能的講述：

靜態資源站點

一般網站開發中，我們會考慮把 js，css，以及資源圖片放在一起，作為靜態站點部署在 CDN，提昇響應速度。採用 Gin 實現起來非常簡單，當然也可以使用 net/http 包輕鬆實現，但使用 Gin 會更方便。

不管怎麼樣，使用 Go 開發，我們可以不用花太多時間在 WEB 服務環境搭建上，程式啟動就直接可以提供 WEB 服務了。

package main

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

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

    // 靜態資源載入，本例為css,js以及資源圖片
    router.StaticFS("/public", http.Dir("D:/goproject/src/github.com/ffhelicopter/tmm/website/static"))
    router.StaticFile("/favicon.ico", "./resources/favicon.ico")

    // Listen and serve on 0.0.0.0:80
    router.Run(":80")
}

首先需要是生成一個 Engine，這是 gin 的核心，預設帶有 Logger 和 Recovery 兩個中介軟體。

router := gin.Default()

StaticFile 是載入單個檔案，而 StaticFS 是載入一個完整的目錄資源：

func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoutes
func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoutes

這些目錄下資源是可以隨時更新，而不用重新啟動程式。現在編譯執行程式，靜態站點就可以正常存取了。

存取http://localhost/public/images/logo.jpg圖片載入正常。每次請求響應都會在伺服器端有紀錄檔產生，包括響應時間，載入資源名稱，響應狀態值等等。

動態站點

如果需要動態互動的功能，比如發一段文字+圖片上傳。由於這些功能出來前端頁面外，還需要伺服器端程式一起來實現，而且疊代需要經常需要修改程式碼和模板，所以把這些統一放在一個大目錄下，姑且稱動態站點。

tpl 是動態站點所有模板的根目錄，這些模板可呼叫靜態資源站點的 css，圖片等；photo 是圖片上傳後存放的目錄。

package main

import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "time"

    "github.com/ffhelicopter/tmm/handler"

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

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

    // 靜態資源載入，本例為css,js以及資源圖片
    router.StaticFS("/public", http.Dir("D:/goproject/src/github.com/ffhelicopter/tmm/website/static"))
    router.StaticFile("/favicon.ico", "./resources/favicon.ico")

    // 匯入所有模板，多級目錄結構需要這樣寫
    router.LoadHTMLGlob("website/tpl/*/*")

    // website分組
    v := router.Group("/")
    {

        v.GET("/index.html", handler.IndexHandler)
        v.GET("/add.html", handler.AddHandler)
        v.POST("/postme.html", handler.PostmeHandler)
    }

    // router.Run(":80")
    // 這樣寫就可以了，下面所有程式碼（go1.8+）是為了優雅處理重新啟動等動作。
    srv := &http.Server{
        Addr:         ":80",
        Handler:      router,
        ReadTimeout:  30 * time.Second,
        WriteTimeout: 30 * time.Second,
    }

    go func() {
        // 監聽請求
        if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
            log.Fatalf("listen: %sn", err)
        }
    }()

    // 優雅Shutdown（或重新啟動）服務
    quit := make(chan os.Signal)
    signal.Notify(quit, os.Interrupt) // syscall.SIGKILL
    <-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)
    }
    select {
    case <-ctx.Done():
    }   
    log.Println("Server exiting")
}

在動態站點實現中，引入 WEB 分組以及優雅重新啟動這兩個功能。WEB 分組功能可以通過不同的入口根路徑來區別不同的模組，這裡我們可以存取：http://localhost/index.html。如果新增一個分組，比如：

v := router.Group("/login")

我們可以存取：http://localhost/login/xxxx，xxx 是我們在 v.GET 方法或 v.POST 方法中的路徑。

// 匯入所有模板，多級目錄結構需要這樣寫
router.LoadHTMLGlob("website/tpl/*/*")

// website分組
v := router.Group("/")
{

    v.GET("/index.html", handler.IndexHandler)
    v.GET("/add.html", handler.AddHandler)
    v.POST("/postme.html", handler.PostmeHandler)
}

通過 router.LoadHTMLGlob("website/tpl//") 匯入模板根目錄下所有的檔案。在前面有講過 html/template 包的使用，這裡模板檔案中的語法和前面一致。

router.LoadHTMLGlob("website/tpl/*/*")

比如 v.GET("/index.html", handler.IndexHandler)，通過存取http://localhost/index.html這個 URL，實際由 handler.IndexHandler 來處理。而在 tmm 目錄下的 handler 存放了 package handler 檔案。在包裡定義了 IndexHandler 函數，它使用了 index.html 模板。

func IndexHandler(c *gin.Context) {
    c.HTML(http.StatusOK, "index.html", gin.H{
        "Title": "作品欣賞",
    })
}

index.html 模板：

<!DOCTYPE html>
<html>
<head>
{{template "header" .}}
</head>
<body>

<!--導航-->
<div class="feeds">
    <div class="top-nav">
        <a href="/index.tml" class="active">欣賞</a>
        <a href="/add.html" class="add-btn">
            <svg class="icon" aria-hidden="true">
                <use  xlink:href="#icon-add"></use>
            </svg>
            發布
        </a>
    </div>
    <input type="hidden" id="showmore" value="{$showmore}">
    <input type="hidden" id="page" value="{$page}">
    <!--</div>-->
</div>
<script type="text/javascript">
    var done = true;
    $(window).scroll(function(){
        var scrollTop = $(window).scrollTop();
        var scrollHeight = $(document).height();
        var windowHeight = $(window).height();
        var showmore = $("#showmore").val();
        if(scrollTop + windowHeight + 300 >= scrollHeight && showmore == 1 && done){
            var page = $("#page").val();
            done = false;
            $.get("{:U('Product/listsAjax')}", { page : page }, function(json) {
                if (json.rs != "") {
                    $(".feeds").append(json.rs);
                    $("#showmore").val(json.showmore);
                    $("#page").val(json.page);
                    done = true;
                }
            },'json');
        }
    });
</script>
    <script src="//at.alicdn.com/t/font_ttszo9rnm0wwmi.js"></script>
</body>
</html>

在 index.html 模板中，通過 {{template "header" .}} 語句，巢狀了 header.html 模板。

header.html 模板：

{{ define "header" }}
    <meta charset="UTF-8">   
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no, minimal-ui">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="format-detection" content="telephone=no,email=no">
    <title>{{ .Title }}</title>
    <link rel="stylesheet" href="/public/css/common.css">
    <script src="/public/lib/jquery-3.1.1.min.js"></script>
    <script src="/public/lib/jquery.cookie.js"></script>
    <link href="/public/css/font-awesome.css?v=4.4.0" rel="stylesheet">
{{ end }}

{{ define "header" }} 讓我們在模板巢狀時直接使用 header 名字，而在 index.html 中的 {{template "header" .}} 注意“.”，可以使引數巢狀傳遞，否則不能傳遞，比如這裡的 Title。

現在我們存取http://localhost/index.html，可以看到瀏覽器顯示 Title 是“作品欣賞”，這個 Title 是通過 IndexHandler 來指定的。

接下來點選“發布”按鈕，我們進入發布頁面，上傳圖片，點選“完成”提交，會提示我們成功上傳圖片。可以在 photo 目錄中看到剛才上傳的圖片。

注意：由於在本人在發佈到 github 的程式碼中，在處理圖片上傳的程式碼中，除了伺服器儲存外，還實現了 IPFS 發佈儲存，如果不需要 IPFS，請註釋相關程式碼。

有關 IPFS: IPFS 本質上是一種內容可定址、版本化、對等超媒體的分散式儲存、傳輸協定，目標是補充甚至取代過去 20 年裡使用的超文字媒體傳輸協定（HTTP），希望構建更快、更安全、更自由的網際網路時代。

IPFS 不算嚴格意義上區塊鏈專案，是一個去中心化儲存解決方案，但有些區塊鏈專案通過它來做儲存。

IPFS 專案有在 github 上開源，Go語言實現哦，可以關注並了解。

優雅重新啟動在疊代中有較好的實際意義，每次版本發布，如果直接停服務在部署重新啟動，對業務還是有蠻大的影響，而通過優雅重新啟動，這方面的體驗可以做得更好些。這裡 ctrl + c 後過 5 秒服務停止。

中介軟體的使用，在 API 中可能使用限流，身份驗證等

Go語言中 net/http 設計的一大特點就是特別容易構建中介軟體。gin 也提供了類似的中介軟體。需要注意的是在 gin 裡面中介軟體只對註冊過的路由函數起作用。

而對於分組路由，巢狀使用中介軟體，可以限定中介軟體的作用範圍。大致分為全域性中介軟體，單個路由中介軟體和分組中介軟體。

即使是全域性中介軟體，其使用前的程式碼不受影響。也可在 handler 中區域性使用，具體見 api.GetUser。

在高並行場景中，有時候需要用到限流降速的功能，這裡引入一個限流中介軟體。有關限流方法常見有兩種，具體可自行研究，這裡只講使用。

匯入import "github.com/didip/tollbooth/limiter"包，在上面程式碼基礎上增加如下語句：

//rate-limit 限流中介軟體
lmt := tollbooth.NewLimiter(1, nil)
lmt.SetMessage("服務繁忙，請稍後再試...")

並修改

v.GET("/index.html", LimitHandler(lmt), handler.IndexHandler)

當 F5 重新整理重新整理http://localhost/index.html頁面時，瀏覽器會顯示：服務繁忙，請稍後再試...

限流策略也可以為 IP：

tollbooth.LimitByKeys(lmt, []string{"127.0.0.1", "/"})

更多限流策略的設定，可以進一步github.com/didip/tollbooth/limiter了解。

RestFull API 介面

前面說了在 gin 裡面可以採用分組來組織存取 URL，這裡 RestFull API 需要給出不同的存取 URL 來和動態站點區分，所以新建了一個分組 v1。

在瀏覽器中存取http://localhost/v1/user/1100000/這裡對 v1.GET("/user/:id/*action", LimitHandler(lmt), api.GetUser) 進行了限流控制，所以如果頻繁存取上面地址也將會有限制，這在 API 介面中非常有作用。

通過 api 這個包，來實現所有有關 API 的程式碼。在 GetUser 函數中，通過讀取 mysql 資料庫，查詢到對應 userid 的使用者資訊，並通過 Json 格式返回給 client。

在 api.GetUser 中，設定了一個區域性中介軟體：

//CORS 區域性CORS，可在路由中設定全域性的CORS
c.Writer.Header().Add("Access-Control-Allow-Origin", "*")

gin 關於引數的處理，api 包中 api.go 檔案中有簡單說明，限於篇幅原因，就不在此展開。這個專案的詳細情況，請存取https://github.com/ffhelicopter/tmm了解。有關 gin 的更多資訊，請存取 https://github.com/gin-gonic/gin，該開源專案比較活躍，可以關注。

完整 mian.go 程式碼：

package main

import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "time"

    "github.com/didip/tollbooth"
    "github.com/didip/tollbooth/limiter"
    "github.com/ffhelicopter/tmm/api"
    "github.com/ffhelicopter/tmm/handler"

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

// 定義全域性的CORS中介軟體
func Cors() gin.HandlerFunc {
    return func(c *gin.Context) {
        c.Writer.Header().Add("Access-Control-Allow-Origin", "*")
        c.Next()
    }
}

func LimitHandler(lmt *limiter.Limiter) gin.HandlerFunc {
    return func(c *gin.Context) {
        httpError := tollbooth.LimitByRequest(lmt, c.Writer, c.Request)
        if httpError != nil {
            c.Data(httpError.StatusCode, lmt.GetMessageContentType(), []byte(httpError.Message))
            c.Abort()
        } else {
            c.Next()
        }
    }
}

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

    // 靜態資源載入，本例為css,js以及資源圖片
    router.StaticFS("/public", http.Dir("D:/goproject/src/github.com/ffhelicopter/tmm/website/static"))
    router.StaticFile("/favicon.ico", "./resources/favicon.ico")

    // 匯入所有模板，多級目錄結構需要這樣寫
    router.LoadHTMLGlob("website/tpl/*/*")
    // 也可以根據handler，實時匯入模板。

    // website分組
    v := router.Group("/")
    {
        v.GET("/index.html", handler.IndexHandler)
        v.GET("/add.html", handler.AddHandler)
        v.POST("/postme.html", handler.PostmeHandler)
    }

    // 中介軟體 golang的net/http設計的一大特點就是特別容易構建中介軟體。
    // gin也提供了類似的中介軟體。需要注意的是中介軟體只對註冊過的路由函數起作用。
    // 對於分組路由，巢狀使用中介軟體，可以限定中介軟體的作用範圍。
    // 大致分為全域性中介軟體，單個路由中介軟體和群組中介軟體。

    // 使用全域性CORS中介軟體。
    // router.Use(Cors())
    // 即使是全域性中介軟體，在use前的程式碼不受影響
    // 也可在handler中區域性使用，見api.GetUser

    //rate-limit 中介軟體
    lmt := tollbooth.NewLimiter(1, nil)
    lmt.SetMessage("服務繁忙，請稍後再試...")

    // API分組(RESTFULL)以及版本控制
    v1 := router.Group("/v1")
    {
        // 下面是群組中間的用法
        // v1.Use(Cors())

        // 單個中介軟體的用法
        // v1.GET("/user/:id/*action",Cors(), api.GetUser)

        // rate-limit
        v1.GET("/user/:id/*action", LimitHandler(lmt), api.GetUser)

        //v1.GET("/user/:id/*action", Cors(), api.GetUser)
        // AJAX OPTIONS ，下面是有關OPTIONS用法的範例
        // v1.OPTIONS("/users", OptionsUser)      // POST
        // v1.OPTIONS("/users/:id", OptionsUser)  // PUT, DELETE
    }

    srv := &http.Server{
        Addr:         ":80",
        Handler:      router,
        ReadTimeout:  30 * time.Second,
        WriteTimeout: 30 * time.Second,
    }

    go func() {
        if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
            log.Fatalf("listen: %sn", err)
        }
    }()

    // 優雅Shutdown（或重新啟動）服務
    // 5秒後優雅Shutdown服務
    quit := make(chan os.Signal)
    signal.Notify(quit, os.Interrupt) //syscall.SIGKILL
    <-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)
    }
    select {
    case <-ctx.Done():
    }
    log.Println("Server exiting")
}