Middleware in Golang

有时候我们需要统计web service接口的数据,比如记录日志、统计API调用时间、或者对HandleFunc进行错误处理,

这个时候,middleware就很有帮助。

最初版本

我们目前有个程序,监听8080端口,提供两个接口,

1. compute:进行计算,耗时在500ms-1000ms之间
2. version:得到版本号,耗时在10ms-60ms之间
package main

import (
    "log"
    "math/rand"
    "net/http"
    "time"
)

// Compute is compute process for doing task
func Compute(w http.ResponseWriter, r *http.Request) {
    time.Sleep(time.Duration((500 + rand.Intn(500))) * time.Millisecond)
}


// Version is getting version task
func Version(w http.ResponseWriter, r *http.Request) {
    time.Sleep(time.Duration((10 + rand.Intn(50))) * time.Millisecond)
    w.Write([]byte("version"))
}

func main() {
    http.HandleFunc("/compute", Compute)
    http.HandleFunc("/version", Version)

    log.Panic(http.ListenAndServe(":8080", nil))
}

调用结果如下,

# curl http://localhost:8080/compute
finish

增加日志

需要记录每次调用接口的名字。

有两种方式记录日志,

1. 在每一个HandleFunc第一行输出URI
2. 增加中间件封装HandleFunc

对于第一种情况,修改Compute()函数为,

// Compute is compute process for doing task
func Compute(w http.ResponseWriter, r *http.Request) {
    log.Printf(r.RequestURI)

    time.Sleep(time.Duration((500 + rand.Intn(500))) * time.Millisecond)
    w.Write([]byte("finish"))
}

运行得到结果为,

2017/12/11 23:07:24 /compute

对于API少的情况,还比较适用。但是对于API接口比较多的情况,修改每一个函数就不太合适。并且当我们不光想统计URI信息时,还需要统计每一个调用接口的其他信息时,就需要修改每一处HandleFunc。

所以我们可以使用Middleware形式来完成。

我们希望使用middlware以后,对于main()函数变为,

func main() {
    http.HandleFunc("/compute", middleware(Compute))
    http.HandleFunc("/version", middleware(Version))

    log.Panic(http.ListenAndServe(":8080", nil))
}

使用middlware对每一个http handle func进行封装,在middleware中进行相应的需求处理,比如日志记录、错误处理、用时统计等。

func middleware(fn func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request) {
    return func(w http.ResponseWriter, r *http.Request) {
        begin := time.Now()
        defer func() {
            log.Printf("[%s] %s, time_used: %v", r.Method, r.URL.String(), time.Now().Sub(begin))
        }()

        fn(w, r)
    }
}

middlware入参和返回值都为func(w http.ResponseWriter, r *http.Request)类型。

middleware中,进行了调用接口URI的统计和用时统计。

完整的代码如下,

package main

import (
    "log"
    "math/rand"
    "net/http"
    "time"
)

// Compute is compute process for doing task
func Compute(w http.ResponseWriter, r *http.Request) {
    time.Sleep(time.Duration((500 + rand.Intn(500))) * time.Millisecond)
    w.Write([]byte("finish"))
}

// Version is getting version task
func Version(w http.ResponseWriter, r *http.Request) {
    time.Sleep(time.Duration((10 + rand.Intn(50))) * time.Millisecond)
    w.Write([]byte("version"))
}

func middleware(fn func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request) {
    return func(w http.ResponseWriter, r *http.Request) {
        begin := time.Now()
        defer func() {
            log.Printf("[%s] %s, time_used: %v", r.Method, r.URL.String(), time.Now().Sub(begin))
        }()

        fn(w, r)
    }
}

func main() {
    http.HandleFunc("/compute", middleware(Compute))
    http.HandleFunc("/version", middleware(Version))

    log.Panic(http.ListenAndServe(":8080", nil))
}

测试

curl http://localhost:8080/compute
# 2017/12/13 16:57:15 [GET] /compute, time_used: 583.357048ms

curl http://localhost:8080/version
# 2017/12/13 16:57:24 [GET] /version, time_used: 47.09209ms

Source code in github.com

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

推荐阅读更多精彩内容