《Go語言四十二章經(jīng)》第四十二章 WEB框架(Gin)
作者:李驍
42.1 有關(guān)于Gin
Gin是Go語言寫的一個web框架,API性能超強,運行速度號稱較httprouter要快40x。開源網(wǎng)址: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() {
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "pong",
})
})
r.Run() // listen and serve on 0.0.0.0:8080
}
編譯運行程序,打開瀏覽器,訪問 http://localhost:8080/ping
頁面顯示:
{"message":"pong"}
以Json格式輸出了數(shù)據(jù)。
gin的功能不只是簡單輸出Json數(shù)據(jù)。它是一個輕量級的WEB框架,支持RESTful風(fēng)格API,支持GET,POST,PUT,PATCH,DELETE,OPTIONS 等http方法,支持文件上傳,分組路由,Multipart/Urlencoded FORM,以及支持JsonP,參數(shù)處理等等功能,這些都和WEB緊密相關(guān),通過提供這些功能,使開發(fā)人員更方便地處理WEB業(yè)務(wù)。
42.2 Gin實際應(yīng)用
接下來使用Gin作為框架來搭建一個擁有靜態(tài)資源站點,動態(tài)WEB站點,以及RESTFull API接口站點(可專門作為手機APP應(yīng)用提供服務(wù)使用)組成的,亦可根據(jù)情況分拆這套系統(tǒng),每種功能獨立出來單獨提供服務(wù)。
下面按照一套系統(tǒng)但采用分站點來說明,首先是整個系統(tǒng)的目錄結(jié)構(gòu),website目錄下面static是資源類文件,為靜態(tài)資源站點專用;photo目錄是UGC上傳圖片目錄,tpl是動態(tài)站點的模板。當(dāng)然這個目錄結(jié)構(gòu)是一種約定,你可以根據(jù)情況來修改。整個項目已經(jīng)開源,你可以訪問來詳細(xì)了解:https://github.com/ffhelicopter/tmm
具體每個站點的功能怎么實現(xiàn)呢?請看下面有關(guān)每個功能的講述:
一:靜態(tài)資源站點
一般網(wǎng)站開發(fā)中,我們會考慮把js,css,以及資源圖片放在一起,作為靜態(tài)站點部署在CDN,提升響應(yīng)速度。采用Gin實現(xiàn)起來非常簡單,當(dāng)然也可以使用net/http包輕松實現(xiàn),但使用Gin會更方便。
不管怎么樣,使用Go開發(fā),我們可以不用花太多時間在WEB服務(wù)環(huán)境搭建上,程序啟動就直接可以提供WEB服務(wù)了。
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
func main() {
router := gin.Default()
// 靜態(tài)資源加載,本例為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的核心,默認(rèn)帶有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
這些目錄下資源是可以隨時更新,而不用重新啟動程序。現(xiàn)在編譯運行程序,靜態(tài)站點就可以正常訪問了。
訪問http://localhost/public/images/logo.jpg 圖片加載正常。每次請求響應(yīng)都會在服務(wù)端有日志產(chǎn)生,包括響應(yīng)時間,加載資源名稱,響應(yīng)狀態(tài)值等等。
二:動態(tài)站點
如果需要動態(tài)交互的功能,比如發(fā)一段文字+圖片上傳。由于這些功能出來前端頁面外,還需要服務(wù)端程序一起來實現(xiàn),而且迭代需要經(jīng)常需要修改代碼和模板,所以把這些統(tǒng)一放在一個大目錄下,姑且稱動態(tài)站點。
tpl是動態(tài)站點所有模板的根目錄,這些模板可調(diào)用靜態(tài)資源站點的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()
// 靜態(tài)資源加載,本例為css,js以及資源圖片
router.StaticFS("/public", http.Dir("D:/goproject/src/github.com/ffhelicopter/tmm/website/static"))
router.StaticFile("/favicon.ico", "./resources/favicon.ico")
// 導(dǎo)入所有模板,多級目錄結(jié)構(gòu)需要這樣寫
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+)是為了優(yōu)雅處理重啟等動作。
srv := &http.Server{
Addr: ":80",
Handler: router,
ReadTimeout: 30 * time.Second,
WriteTimeout: 30 * time.Second,
}
go func() {
// 監(jiān)聽請求
if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Fatalf("listen: %s\n", err)
}
}()
// 優(yōu)雅Shutdown(或重啟)服務(wù)
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")
}
在動態(tài)站點實現(xiàn)中,引入WEB分組以及優(yōu)雅重啟這兩個功能。WEB分組功能可以通過不同的入口根路徑來區(qū)別不同的模塊,這里我們可以訪問:http://localhost/index.html 。如果新增一個分組,比如:
v := router.Group("/login")
我們可以訪問:http://localhost/login/xxxx,xxx是我們在v.GET方法或v.POST方法中的路徑。
// 導(dǎo)入所有模板,多級目錄結(jié)構(gòu)需要這樣寫
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//") 導(dǎo)入模板根目錄下所有的文件。在前面有講過html/template 包的使用,這里模板文件中的語法和前面一致。
router.LoadHTMLGlob("website/tpl/*/*")
比如v.GET("/index.html", handler.IndexHandler) ,通過訪問http://localhost/index.html 這個URL,實際由handler.IndexHandler來處理。而在tmm目錄下的handler存放了package handler 文件。在包里定義了IndexHandler函數(shù),它使用了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>
<!--導(dǎo)航-->
<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>
發(fā)布
</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="http://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" .}} 注意“.”,可以使參數(shù)嵌套傳遞,否則不能傳遞,比如這里的Title。
現(xiàn)在我們訪問 http://localhost/index.html ,可以看到瀏覽器顯示Title 是“作品欣賞”,這個Title是通過IndexHandler來指定的。
接下來點擊“發(fā)布”按鈕,我們進入發(fā)布頁面,上傳圖片,點擊“完成”提交,會提示我們成功上傳圖片。可以在photo目錄中看到剛才上傳的圖片。
注意:
由于在本人在發(fā)布到github的代碼中,在處理圖片上傳的代碼中,除了服務(wù)器存儲外,還實現(xiàn)了IPFS發(fā)布存儲,如果不需要IPFS,請注釋相關(guān)代碼。
有關(guān)IPFS:
IPFS本質(zhì)上是一種內(nèi)容可尋址、版本化、點對點超媒體的分布式存儲、傳輸協(xié)議,目標(biāo)是補充甚至取代過去20年里使用的超文本媒體傳輸協(xié)議(HTTP),希望構(gòu)建更快、更安全、更自由的互聯(lián)網(wǎng)時代。
IPFS 不算嚴(yán)格意義上區(qū)塊鏈項目,是一個去中心化存儲解決方案,但有些區(qū)塊鏈項目通過它來做存儲。
IPFS項目有在github上開源,Go語言實現(xiàn)哦,可以關(guān)注并了解。
優(yōu)雅重啟在迭代中有較好的實際意義,每次版本發(fā)布,如果直接停服務(wù)在部署重啟,對業(yè)務(wù)還是有蠻大的影響,而通過優(yōu)雅重啟,這方面的體驗可以做得更好些。這里ctrl + c 后過5秒服務(wù)停止。
三:中間件的使用,在API中可能使用限流,身份驗證等
Go 語言中net/http設(shè)計的一大特點就是特別容易構(gòu)建中間件。 gin也提供了類似的中間件。需要注意的是在gin里面中間件只對注冊過的路由函數(shù)起作用。
而對于分組路由,嵌套使用中間件,可以限定中間件的作用范圍。大致分為全局中間件,單個路由中間件和分組中間件。
即使是全局中間件,其使用前的代碼不受影響。 也可在handler中局部使用,具體見api.GetUser 。
在高并發(fā)場景中,有時候需要用到限流降速的功能,這里引入一個限流中間件。有關(guān)限流方法常見有兩種,具體可自行研究,這里只講使用。
導(dǎo)入 import "github.com/didip/tollbooth/limiter" 包,在上面代碼基礎(chǔ)上增加如下語句:
//rate-limit 限流中間件
lmt := tollbooth.NewLimiter(1, nil)
lmt.SetMessage("服務(wù)繁忙,請稍后再試...")
并修改
v.GET("/index.html", LimitHandler(lmt), handler.IndexHandler)
當(dāng)F5刷新刷新http://localhost/index.html 頁面時,瀏覽器會顯示:服務(wù)繁忙,請稍后再試...
限流策略也可以為IP:
tollbooth.LimitByKeys(lmt, []string{"127.0.0.1", "/"})
更多限流策略的配置,可以進一步github.com/didip/tollbooth/limiter 了解。
四:RestFull API接口
前面說了在gin里面可以采用分組來組織訪問URL,這里RestFull API需要給出不同的訪問URL來和動態(tài)站點區(qū)分,所以新建了一個分組v1。
在瀏覽器中訪問http://localhost/v1/user/1100000/
這里對v1.GET("/user/:id/*action", LimitHandler(lmt), api.GetUser) 進行了限流控制,所以如果頻繁訪問上面地址也將會有限制,這在API接口中非常有作用。
通過 api這個包,來實現(xiàn)所有有關(guān)API的代碼。在GetUser函數(shù)中,通過讀取mysql數(shù)據(jù)庫,查找到對應(yīng)userid的用戶信息,并通過Json格式返回給client。
在api.GetUser中,設(shè)置了一個局部中間件:
//CORS 局部CORS,可在路由中設(shè)置全局的CORS
c.Writer.Header().Add("Access-Control-Allow-Origin", "*")
gin關(guān)于參數(shù)的處理,api包中api.go文件中有簡單說明,限于篇幅原因,就不在此展開。這個項目的詳細(xì)情況,請訪問 https://github.com/ffhelicopter/tmm 了解。有關(guān)gin的更多信息,請訪問https://github.com/gin-gonic/gin,該開源項目比較活躍,可以關(guān)注。
完整main.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()
// 靜態(tài)資源加載,本例為css,js以及資源圖片
router.StaticFS("/public", http.Dir("D:/goproject/src/github.com/ffhelicopter/tmm/website/static"))
router.StaticFile("/favicon.ico", "./resources/favicon.ico")
// 導(dǎo)入所有模板,多級目錄結(jié)構(gòu)需要這樣寫
router.LoadHTMLGlob("website/tpl/*/*")
// 也可以根據(jù)handler,實時導(dǎo)入模板。
// 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設(shè)計的一大特點就是特別容易構(gòu)建中間件。
// gin也提供了類似的中間件。需要注意的是中間件只對注冊過的路由函數(shù)起作用。
// 對于分組路由,嵌套使用中間件,可以限定中間件的作用范圍。
// 大致分為全局中間件,單個路由中間件和群組中間件。
// 使用全局CORS中間件。
// router.Use(Cors())
// 即使是全局中間件,在use前的代碼不受影響
// 也可在handler中局部使用,見api.GetUser
//rate-limit 中間件
lmt := tollbooth.NewLimiter(1, nil)
lmt.SetMessage("服務(wù)繁忙,請稍后再試...")
// 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 ,下面是有關(guān)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: %s\n", err)
}
}()
// 優(yōu)雅Shutdown(或重啟)服務(wù)
// 5秒后優(yōu)雅Shutdown服務(wù)
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")
}
本書《Go語言四十二章經(jīng)》內(nèi)容在github上同步地址:https://github.com/ffhelicopter/Go42
本書《Go語言四十二章經(jīng)》內(nèi)容在簡書同步地址: http://www.itdecent.cn/nb/29056963雖然本書中例子都經(jīng)過實際運行,但難免出現(xiàn)錯誤和不足之處,煩請您指出;如有建議也歡迎交流。
聯(lián)系郵箱:roteman@163.com