Golang开发使用gin快速搭建WEB站点及提供RestFul
在PHP和JAVA中,有众多的WEB MVC框架可以使用,快速完成动态站点的搭建,当然Go语言也不缺乏相关的优秀框架。
但使用这些框架过程都需要学习成本,而由于其本身的开源,在生产环境中,还需要对其可能爆出的漏洞保持安全敏感。而另外使用框架后,反倒对代码实现的本质原理有了距离。所以,能少用的时候我们不要多用。
Go自身的net/http足够简单,性能也非常不错,可以借助他完成很多web开发任务。但还有一定局限性,需要扩展才能较好满足更多的场景。
Gin是一个golang的微框架,使用起来非常简单,很容易就可以快速搭建WEB站点以及提供RestFull接口 。下面我使用它初步搭建了静态资源站,动态站点以及对外提供服务的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)
}
log.Println("Server exiting")
}
基本上这样很快就搭建了一个WEB站点,还能提供API接口,实际使用中,我们可能会把web服务和api服务分开部署,但只要稍微修改下上面代码,我们就能很快投入开发,不用在环境搭建和配置上耗费太多的精力。
里面更多细节可以github上面找到说明。欢迎进一步沟通~~