gorouter

近来无事,仿httprouter造一轮子gorouter

gorouter 是一个轻便的HTTP API 路由库。

项目创建背景

之前一直使用大名鼎鼎的 httprouter。但由于我写的RESTful API不规范,导致存在一些路由冲突。例如github上讨论的这个问题

r.GET("/teachers/list", func (c *gin.Context){})
r.GET("/teachers/:id/profile", func (c *gin.Context){})

Error:
[GIN-debug] GET /teachers/list --> main.func·001 (3 handlers)
[GIN-debug] GET /teachers/:id/profile --> main.func·002 (3 handlers)
panic: wildcard route ':id' conflicts with existing children in path '/teachers/:id/profile'

当然我们可以把 GET /teachers/list 改成 GET /teachers。或者把 GET /teachers/:id/profile 改成 GET /teacher/:id/profile。 按照restful风格应该采用第一种,但有时候接口太多或者没有严格按照restful风格风格就会导致路由冲突。所以我就偶尔我就会采用第二种,但第二种又会导致我没办法把两个接口归纳在同一个group。gorouter就是为了解决这个问题。

用法


func main()  {

    router := gorouter.New()

    router.GET("/teachers/list", func(resp http.ResponseWriter, req *http.Request, params *gorouter.Param) {
        resp.Write([]byte("/teachers/list"))
    })

    router.GET("/teachers/:id/profiles", func(resp http.ResponseWriter, req *http.Request, params *gorouter.Param) {
        resp.Write([]byte(fmt.Sprintf("%s = %s", "id", params.GetValue("id"))))
    })

    router.GET("/teachers/:id/profiles/:id", func(resp http.ResponseWriter, req *http.Request, params *gorouter.Param) {
        resp.Write([]byte(fmt.Sprintf("id1 = %s; id2 = %s", params.Values[0], params.Values[1])))
    })

    http.ListenAndServe(":3001", router)

}

路由规则

gorouter 借鉴了httprouter的基数树实现方法。但当存在通配符和静态路由都匹配url时,优先匹配静态路由,如果匹配失败则返回再去匹配通配符。

路由:
① GET /users/:id/name   
② GET /users/id/name

请求:
/users/id/name   匹配②
/users/idd/name  匹配①

Benchmark

引用echo的测试用例编写了gorouter-example,跑了下基准测试,感觉性能还不错。因为功能简单可能占些便宜。


goos: darwin
goarch: amd64
Benchmark_Echo_Static-8                30000         42460 ns/op        2413 B/op        157 allocs/op
Benchmark_Echo_GitHubAPI-8             20000         61322 ns/op        2496 B/op        203 allocs/op
Benchmark_Echo_GplusAPI-8             500000          3255 ns/op         173 B/op         13 allocs/op
Benchmark_Echo_ParseAPI-8             300000          5634 ns/op         323 B/op         26 allocs/op

Benchmark_Gorouter_Static-8            50000         29292 ns/op        1007 B/op        157 allocs/op
Benchmark_Gorouter_GitHubAPI-8         30000         58802 ns/op        5666 B/op        275 allocs/op
Benchmark_Gorouter_GplusAPI-8         500000          3164 ns/op         437 B/op         22 allocs/op
Benchmark_Gorouter_ParseAPI-8         300000          4543 ns/op         615 B/op         37 allocs/op

Benchmark_Gin_Static-8                 30000         52282 ns/op        8693 B/op        157 allocs/op
Benchmark_Gin_GitHubAPI-8              20000         79637 ns/op       10616 B/op        203 allocs/op
Benchmark_Gin_GplusAPI-8              300000          4409 ns/op         681 B/op         13 allocs/op
Benchmark_Gin_ParseAPI-8              200000          8040 ns/op        1421 B/op         26 allocs/op

Benchmark_Beego_Static-8               10000        198317 ns/op       76586 B/op       1099 allocs/op
Benchmark_Beego_GitHubAPI-8             5000        269359 ns/op       98868 B/op       1422 allocs/op
Benchmark_Beego_GplusAPI-8            100000         15628 ns/op        6356 B/op         91 allocs/op
Benchmark_Beego_ParseAPI-8             50000         29614 ns/op       12712 B/op        182 allocs/op

Benchmark_Httprouter_Static-8         100000         15696 ns/op        1006 B/op        157 allocs/op
Benchmark_Httprouter_GitHubAPI-8       50000         38157 ns/op       15583 B/op        370 allocs/op
Benchmark_Httprouter_GplusAPI-8      1000000          1874 ns/op         735 B/op         24 allocs/op
Benchmark_Httprouter_ParseAPI-8       500000          2866 ns/op         830 B/op         42 allocs/op
PASS

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

推荐阅读更多精彩内容