使用Gin快速搭建Web站点及提供RESTful接口

在PHP和JAVA中,有众多的WEB MVC框架可以使用,快速完成动态站点的搭建,当然Go语言也不缺乏相关的优秀框架。

但使用这些框架过程都需要学习成本,而由于其本身的开源,在生产环境中,还需要对其可能爆出的漏洞保持安全敏感。而另外使用框架后,反倒对代码实现的本质原理有了距离。所以,能少用的时候我们不要多用。

Go自身的net/http足够简单,性能也非常不错,可以借助他完成很多web开发任务。但还有一定局限性,需要扩展才能较好满足更多的场景。

Gin是一个golang的微框架,使用起来非常简单,很容易就可以快速搭建WEB站点以及提供RESTful接口 。下面我使用它初步搭建了静态资源站,动态站点以及对外提供服务的API。

下面是主程序代码,我在里面采用注释的方式来说说怎么使用:

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

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)

}

到这里已经搭建了一个WEB动态站点,静态资源放在了/public/下面,可在动态模板里面尽情引用。本例的模板中已经实现了多图片上传,以及相关form表单的处理,详情请见对应handler。


golang的net/http设计的一大特点就是特别容易构建中间件。

// gin也提供了类似的中间件。需要注意的是中间件只对注册过的路由函数起作用。

// 对于分组路由,嵌套使用中间件,可以限定中间件的作用范围。大致分为全局中间件,单个路由中间件和群组中间件。

// 使用全局CORS中间件。

// router.Use(Cors())

// 即使是全局中间件,在use前的代码不受影响

// 也可在handler中局部使用,见api.GetUser

//rate-limit 限流中间件,下面设定1qps,超过则报“服务繁忙,请稍后再试...”

//更多有关rate-limit就不在此细说,这里只是简单引入这个中间件,来做流量控制。

//如果加入一些条件,我们就可以把限流做得更完善些。

lmt := tollbooth.NewLimiter(1, nil)

lmt.SetMessage("服务繁忙,请稍后再试...")


RestFull  API 分组实现

// 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

/*

// 对应的handler中增加处理

func OptionsUser(c *gin.Context) {

    c.Writer.Header().Set("Access-Control-Allow-Methods", "DELETE,POST,PUT")

    c.Writer.Header().Set("Access-Control-Allow-Headers", "Content-Type")

    c.Next()

...

}

*/

}

可以方便输出json,string,xml等数据,对应handler实现了对Redis以及MySQL数据查询并返回数据的样例。

// router.Run(":80")本来这样写就可以了。


优雅Shutdown

//但是:下面所有代码(go1.8+)是为了优雅处理重启等动作。可根据实际情况选择。

srv := &http.Server{

Addr:        ":80",

Handler:      router,

ReadTimeout:  30 * time.Second,

WriteTimeout: 30 * time.Second,

}

go func() {

// service connections

if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {

log.Fatalf("listen: %s\n", 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")

}


基本上这样很快就搭建了一个WEB站点,还能提供API接口,实际使用中,我们可能会把web服务和api服务分开部署,但只要稍微修改下上面代码,我们就能很快投入开发,不用在环境搭建和配置上耗费太多的精力。

里面更多细节可以github上面找到说明。欢迎进一步沟通~~

内容在github上同步地址:https://github.com/ffhelicopter/tmm

本文主要内容在《Go语言四十二章经》有详细阐述:  https://www.jianshu.com/nb/29056963

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容