Golang Go语言分享我的第一个开源项目（xujiajun/gorouter），一个简单高性能的router，和julienschmidt/httprouter差不多快，且支持正则

分享我的第一个 GO 开源项目（ xujiajun/gorouter ），一个简单高性能的 router，和著名的 julienschmidt/httprouter 差不多快，且支持正则。很方便写 RESTful APIs 或者组建你自己的 web 框架。

项目由来

一开始学习 golang 的时候，我是从学习 go 写 web 应用，自然而然需要一个 web 框架或者 web 路由器。

找到这个 julienschmidt/httprouter （有几千 star 吧，截止今天 10 月 30 号，有 7900+star ），

使用了下，发现一般功能有了，但是看了他的 import 库，不支持正则，想改他的代码，发现各种 if，嵌套 walk 有种 bad smell 的感觉，还是放弃。我又试用了另一款著名的路由器 gorilla/mux （也有几千 star 吧，截止今天 10 月 30 号，有 7000+star ），测了下功能比 julienschmidt/httprouter 强大，但是性能差太多。具体见我的 benchmarks。

于是我决定自己写一个，一来学习下 go，二来也能解决下这个问题。我给自己的目标:

0、简单
1、测试覆盖率 90%以上，
2、支持基本的路由功能，
3、支持正则
4、性能要高
5、文档要完善
6、原生 go 实现，不要第三方库

项目地址

https://github.com/xujiajun/gorouter

项目原理

用了数据结构压缩 Trie

Features：

Fast - see benchmarks
URL parameters
Regex parameters
Routes groups
Custom NotFoundHandler
Custom PanicHandler
Middleware Chain Support
Serve Static Files
Pattern Rule Familiar
HTTP Method Get、Post、Delete、Put、Patch Support
No external dependencies (just Go stdlib)

项目情况

目前项目已经提交给awesome-go了，已经被收录了，也算给 Go 社区贡献自己小小的力量。希望大家用得上。
代码覆盖率 100%。
examples 里面含有完整例子，方便学习使用，如编写中间件、路由组、路由正则匹配等。
README 用英文写的，已经完成差不多了，中文如有必要，我再补上。我建议大家看英文

最后，最重要的是欢迎大家给我 star ！提 issues ！提交 PR ！和我交流！

谢谢关注！后面还有更多 Go 开源作品分享给大家

更多关于Golang Go语言分享我的第一个开源项目（xujiajun/gorouter），一个简单高性能的router，和julienschmidt/httprouter差不多快，且支持正则的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html

htzhanglong 1楼•2 天前

支持，支持

caililin 2楼•2 天前

谢谢：）

yuanlaile 3楼•2 天前

Cool

sinazl 4楼•2 天前

先 star，有空再看

yuanlaile 5楼•2 天前

谢谢关注

vueper 6楼•2 天前

谢谢支持

zlyuanteng 7楼•2 天前

厉害啊

h691938207 8楼•2 天前

谢谢关注

eggper 9楼•2 天前

为啥我看你跑 benchmark 的时候，mux 使用的正则路由，而你的没有跑正则路由呢。。还是说我看错了。。

vueper 10楼•2 天前

我把 benchmark 里 gorouter 跑 githubapi2，结果 7 分钟还没出结果，改回 githubapi 后，2 分钟跑出来了，是 gorouter 跑正则路由太慢了么，还是什么原因

nodeper 11楼•2 天前

你好，谢谢关注。githubAPI2 是单独给 gorilla/mux 压测用的，他的部分语法如 /user/{user} xujiajun/gorouter 不支持。只用当用到正则的时候，才回有{}，其他都是 :开头的类似 /user/:id 所以你会在我的 benchmark 看到其他待测的几个 router 都是跑 githubAPI，而 gorilla/mux 用的是 githubAPI2。
PS： xujiajun/gorouter 的语法规则借鉴了 julienschmidt/httprouter 和 gorilla/mux，支持快捷方式关键词 :id (就会去匹配 id:[0-9]+) ，具体见： https://github.com/xujiajun/gorouter#pattern-rule

yuanlaile 12楼•2 天前

很棒，支持

yibo5220 13楼•2 天前

我个人认为你这个 benchmark 可能不公平，githubapi2 的压测结果和 githubapi 压测结果就不应该放一起比较。你应该分两组，一组 githubapi，一组 githubapi2 但不包含{keyword}这种 url，第一组所有路由都跑，第二组 gorouter 和 mux 跑。

sinazl 14楼•2 天前

谢谢支持

ionicwang 15楼•2 天前

好的谢谢你的建议。

htzhanglong 16楼•2 天前

你好，你可以压测下，切换到 develop 分支: https://github.com/xujiajun/gorouter/tree/develop ，增加了 xujiajun/gorouter vs gorilla/mux （用的是 githubapi2 ），这是我的笔记本跑出来的结果，仅供大家参考：

 ➜ gorouter git:(develop) ✗ go test -bench=. GithubAPI Routes: 203 GithubAPI2 Routes: 203 HttpRouter: 37464 Bytes trie-mux: 133864 Bytes MuxRouter: 1378528 Bytes GoRouter1: 85744 Bytes GoRouter2: 85376 Bytes goos: darwin goarch: amd64 pkg: <a target="_blank" href="http://github.com/xujiajun/gorouter" rel="nofollow noopener">github.com/xujiajun/gorouter</a> BenchmarkTrieMuxRouterWithGithubAPI-8 10000 624425 ns/op 1086461 B/op 2975 allocs/op BenchmarkHttpRouterWithGithubAPI-8 10000 556136 ns/op 1034357 B/op 2604 allocs/op BenchmarkGoRouter1WithGithubAPI-8 10000 601101 ns/op 1034412 B/op 2843 allocs/op BenchmarkGoRouter2WithGithubAPI2-8 10000 676998 ns/op 1058368 B/op 3177 allocs/op BenchmarkMuxRouterWithGithubAPI2-8 10000 5414811 ns/op 1219148 B/op 4430 allocs/op PASS ok <a target="_blank" href="http://github.com/xujiajun/gorouter" rel="nofollow noopener">github.com/xujiajun/gorouter</a> 78.775s 

可以看出 xujiajun/gorouter 性能比 gorilla/mux 好一个数量级

htzhanglong 17楼•2 天前

#16 赞一个，另外提一个建议，同一个路径，可以限制只能使用这三种:name, {name:regexp}, :name 匹配方式的一种

htzhanglong 18楼•2 天前

你说只能使用这三种 :name 两个一样的？是不是你写错了？欢迎去我的项目里面提 issure 哦。这样方便我统一处理，thanks。https://github.com/xujiajun/gorouter

h691938207 19楼•2 天前

我的意思是你的三种通配符或正则可能会冲突，有些路由是不允许冲突的，有些是有明确优先级的

wuwangju 20楼•2 天前作者

很好的建议。这个问题我有考虑过，目前设计的是先进先出原则. 把权力开放给使用者，所以在设计路由的时候，设计者自己要注意。尽量不要设计成 :name, {name:regexp}这种差不多的路由

h691938207 21楼•2 天前

请问一下，您这个可以直接输出 JSON 吗？我简单看了一下，好像没有相关的。

h691938207 22楼•2 天前

你好，这个是单纯的 router，要直接输出 json，你指的是业务逻辑的数据库的交互吧。这个我这边也开发一个库，是个支持 mysql 的 sqlbuilder，地址： https://github.com/xujiajun/godbal，这个库可以直接操作数据库，你可以看下这个库里面的 examples，支持直接输出 json，配合 xujiajun/gorouter 一起使用。

zlyuanteng 23楼•2 天前

我是想使用框架或者包，直接输出符合 restful 的 json。当然数据来源肯定是从数据库，有个 orm 是最好的。
其实是想写 API 接口。

nodeper 24楼•2 天前

嗯。如果你要用 xujiajun/gorouter，你只要再找一个支持数据的操作库（ ORM 或者 SQL builder 或者你自己封装），你可以试试我这个库，比 orm 简单，可以直接输出 json，是个 sql builder： https://github.com/xujiajun/godbal

gougou168 25楼•2 天前

https://github.com/xujiajun/gorouter/blob/master/router.go#L145
我看见好多不必要的 string 转换,可以直接这样写 if segment[0] == ‘:’ {…}

caililin 26楼•2 天前

https://github.com/xujiajun/gorouter/blob/master/router.go#L149-L155

多余的判断

go if one == nil { return "", errGenerateParameters } if one != nil { segments = append(segments, key) continue } 

go if one != nil { segments = append(segments, key) continue }else{ return "", errGenerateParameters } 

itying888 27楼•2 天前

这位兄弟有心了谢谢帮我在看代码。欢迎提交给我 PR，这样我会第一时间看到。

关于第一个问题，你说道：“不必要的 string 转换,可以直接这样写 if segment[0] == ‘:’ {…}” ，我表示不认同。如果不加 string，会有问题的，因为 segment[0] 和 “:” 类型都不一样

关于第二个问题，其实是个人喜好代码风格不同，我比较倾向于少用 else。但我表示认同写的代码存在冗余，但不是“多余”，我已经改了 https://github.com/xujiajun/gorouter/blob/master/router.go#L149-L155

itying888 28楼•2 天前

不好意思.看的不够仔细,没注意到 segment 是 string

yibo5220 29楼•2 天前

没事谢谢关注

yuanlaile 30楼•2 天前

很高兴看到你分享了你的第一个Golang开源项目——xujiajun/gorouter。在Go语言的生态系统中，高性能的路由库一直是开发者们关注的重点，而你的项目能在性能上与广受欢迎的julienschmidt/httprouter相媲美，这无疑是一个值得称赞的成就。

正则表达式的支持为gorouter增添了不少灵活性，使得它能够处理更复杂的URL匹配需求。然而，在享受正则表达式带来的便利时，也需要注意其可能带来的性能开销。在实际应用中，建议对正则表达式的复杂度和匹配效率进行充分的测试和优化。

此外，对于开源项目来说，良好的文档和示例代码是吸引用户的关键。建议你在项目仓库中添加详尽的使用指南和示例，帮助其他开发者更快地理解和上手gorouter。

最后，开源项目的成功离不开社区的支持和贡献。你可以通过积极参与Go语言相关的社区讨论，分享你的项目和使用心得，吸引更多的关注者和贡献者。同时，也要及时响应社区反馈，不断优化和完善gorouter的功能和性能。

总之，祝贺你成功发布了第一个Golang开源项目，期待xujiajun/gorouter能够在未来得到更多的关注和应用。