Go 语言脚手架 - 使用 Gin 几分钟搭建具有继承特性的对象

Go 语言有非常的优秀的特性 (比如高并发、原生支持协程、泛型等等), 同时也贡献了非常多项目(可以 https://awesome-go.com/ 一览),在 Web 开发这块也有非常多优秀的框架,如 Gin、Beego、Iris、Echo、Revel 等.
Top Go Web Frameworks

Gin

官方介绍
Gin is a web framework written in Go (Golang). It features a martini-like API with performance that is up to 40 times faster thanks to httprouter. If you need performance and good productivity, you will love Gin.

Skeleton (脚手架)

为了快速使用 Gin, 我提供了 Gin Skeleton 程序。
提供如下功能:

  • ORM 封装 (使用的 GORM, 对 Model Interface 可进行继承设计, 可方便的封装 DAO 层)
  • Tracing (支持链路追踪)
  • Http TimeOut (支持 Http 请求超时中断)
  • 数据库连接池
  • Redis 集群支持

支持部署:

  • Docker
  • Helm

ORM Interface 继承

设计 BaseModel, 在后面的业务 Model 继承这个 BaseModel 即可抽象 DAO interface


// base model
type BaseModel struct {
    ID        uint64 `json:"id,omitempty" gorm:"primarykey"`
    CreatedAt time.Time
    UpdatedAt time.Time
    DeletedAt gorm.DeletedAt `gorm:"index"`
}

// base dao
type BaseDAO interface {
    Create(entity interface{}) error
    Update(entity interface{}, uid uint64) (int64, error)
    Delete(entity interface{}, uid uint64) (int64, error)
    FindAll(entity interface{}, opts ...DAOOption) error
    FindByKeys(entity interface{}, keys map[string]interface{}) error
    FindByPages(entity interface{}, currentPage, pageSize int) error
    FindByPagesWithKeys(entity interface{}, keys map[string]interface{}, currentPage, pageSize int) error
    SearchByPagesWithKeys(entity interface{}, keys, keyOpts map[string]interface{}, currentPage, pageSize int) error
    Count(entity interface{}, count *int64) error
    CountWithKeys(entity interface{}, count *int64, keys, keyOpts map[string]interface{}) error
}

如 UserDAO 继承 BaseDAO, 然后编写 UserDAO 独有的业务 dao 方法


// instance entity
type User struct {
    ID           uint64         `json:"id,omitempty"`
    Name         string         `json:"name,omitempty" gorm:"type:varchar(255)"`
    Password     string         `json:"password,omitempty" gorm:"type:varchar(1000)"`
    Email        string         `json:"email,omitempty" gorm:"type:varchar(255)"`
    Age          int            `json:"age,omitempty"`
    Birthday     time.Time      `json:"birthday,omitempty"`
    MemberNumber sql.NullString `json:"member_number,omitempty" gorm:"type:varchar(255)"`
    Role         string         `json:"Role,omitempty" gorm:"type:varchar(100)"`
    BaseModel
}

// user DAO
type UserDAO interface {
    BaseDAO
    FindAllByCount(count int) ([]User, error)
}

新建的对象都可以继承 BaseModel,这样可以方便扩展通用属性和方法 。

Http Timeout

设计 TimeoutHandler middleware 来处理超时请求

const (
    TIME_DURATION = 10
)

func DefinitionRoute(router *gin.Engine) {
    // set run mode
    gin.SetMode(gin.DebugMode)
    // middleware
    router.Use(middleware.Tracing())
    router.Use(middleware.UseCookieSession())
    router.Use(middleware.TimeoutHandler(time.Second * TIME_DURATION))
    // no route
    router.NoRoute(NoRouteResponse)
    // home
    var userController *controller.UserController
    router.Static("/web/assets", "./web/assets")
    router.StaticFS("/web/upload", http.Dir("/web/upload"))
    router.LoadHTMLGlob("web/*.tmpl")
...

分布式链路 Jaeger

引入 traceandtrace-go 实现 Tracing middleware, 上报链路信息到 jaeger

import (
    "log"

    tracing "github.com/codeandcode0x/traceandtrace-go"
    "github.com/gin-gonic/gin"
)

// Tracing 中间件
func Tracing() gin.HandlerFunc {
    return func(c *gin.Context) {
        log.Println("..... tracing header1 ", c.Request.Header)
        // add tracing
        pctx, cancel := tracing.AddHttpTracing(
            "ticket-manager",
            c.Request.URL.String()+" "+c.Request.Method,
            c.Request.Header,
            map[string]string{
                "component":      "gin-server",
                "httpMethod":     c.Request.Method,
                "httpUrl":        c.Request.URL.String(),
                "proto":          c.Request.Proto,
                "peerService":    c.HandlerName(),
                "httpStatusCode": "200",
                "spanKind":       "server",
            })
        defer cancel()

        // deliver parent context
        c.Set("parentCtx", pctx)
        c.Next()
        return
    }
}

总结

  • gin 在 go web 上使用非常方便, 并且性能非常不错
  • 使用 gin 脚手架可以快速构建开发项目

另外分享一个基于脚手架开发的 gRPC 代理网关

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