blog
blog copied to clipboard
geektutu
Go语言动手写Web框架 - Gee第三天 路由Router | 极客兔兔
https://geektutu.com/post/gee-day3.html
7天用 Go语言 从零实现Web框架教程(7 days implement golang web framework from scratch tutorial)，用 Go语言/golang 动手写Web框架，从零实现一个Web框架，从零设计一个Web框架。本文介绍了如何用 Trie 前缀树实现路由。支持简单的参数解析和通配符的场景。
@Arbusz @zjfsdnu 为了降低代码量，这一节实现的路由算法很粗糙。因为整个系列的核心还是想介绍一个框架的最基础的构成，所以都只能是浅尝辄止，不过7天就打不住了。
兔兔你好，发现了两个小bug
第一个 bug
在 trie.go 里的
func (n *node) insert(pattern string, parts []string, height int) {
if len(parts) == height {
n.pattern = pattern
return
}
part := parts[height]
child := n.matchChild(part)
if child == nil {
child = &node{part: part, isWild: part[0] == ':' || part[0] == '*'}
n.children = append(n.children, child)
}
child.insert(pattern, parts, height+1)
}
如果第一次插入的pattern为/:age，method 为 GET，handlefunc 为 handleAge()
那么会生成一个这样的 node
nodeAge = node{
pattern: ":age",
part: ":age",
children: nil,
isWild: true,
}
handlers["GET-:age"] = handleAge
第二次插入的 pattern 为 /18 ,method 与第一次相同，仍然为 GET，handlefunc 为 handle18()，此时并不会修改之前的 node，而是修改了之前 nodeAge 的 pattern。
nodeAge = node{
pattern: "18",
part: ":age",
children: nil,
isWild: true,
}
handlers["GET-:age"] = handleAge
handlers["GET-18"] = handle18
接下来看看handle()函数
func (r *router) handle(c *Context) {
n, params := r.getRoute(c.Method, c.Path)
if n != nil {
c.Params = params
key := c.Method + "-" + n.pattern
r.handlers[key](c)
} else {
c.String(http.StatusNotFound, "404 NOT FOUND: %s\n", c.Path)
}
}
当有一个 /19 的请求到来时，将会匹配到 nodeAge，但是由于 nodeAge 的 pattern 变成了 18，因此将会被 handle18() 处理，这不太合适。
GIN的做法是将冲突的路由直接panic了。
第二个bug
router的 handle 方法貌似不是协程安全的
假设此时只有一个/:age的router
nodeAge = node{
pattern: ":age",
part: ":age",
children: nil,
isWild: true,
}
handlers["GET-:age"] = handleAge
此时有两个请求地址分别为 /18 和 /19的请求到达。
handle() 内的 getRoute() 函数得到的 params 分别为 key:age value:18 和 key:age value:19，它们会对同一个 context 进行写入，因此不太安全。
在 http 包内的 server.go 文件中的 Serve 函数内，有这样一段注释
// Serve accepts incoming connections on the Listener l, creating a
// new service goroutine for each. The service goroutines read requests and
// then call srv.Handler to reply to them.
//
// HTTP/2 support is only enabled if the Listener returns *tls.Conn
// connections and they were configured with "h2" in the TLS
// Config.NextProtos.
//
// Serve always returns a non-nil error and closes l.
// After Shutdown or Close, the returned error is ErrServerClosed.
func (srv *Server) Serve(l net.Listener) error
可见，http.ListenAndServe() 是有可能开启多个协程的。
@liweiforeveryoung 非常感谢，指出了非常关键的问题。
第一个bug，存在覆盖的问题，gin 的做法才是对的，应该把问题暴露给用户。
第二个问题，http 请求是并发的，但每一个请求都会调用 ServeHTTP ，这个方法中，context 每次都创建新的，不会对同一个context进行写入。
func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) {
c := newContext(w, req)
engine.router.handle(c)
}
@geektutu @liweiforeveryoung 非常感谢，指出了非常关键的问题。
第一个bug，存在覆盖的问题，gin 的做法才是对的，应该把问题暴露给用户。 第二个问题，http 请求是并发的，但每一个请求都会调用
ServeHTTP，这个方法中，context 每次都创建新的，不会对同一个context进行写入。func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) { c := newContext(w, req) engine.router.handle(c) }
嗯，我刚刚看发现了ServeHTTP每次都创建了一个新的context，刚准备修改评论的，结果看见你回复了。
@geektutu @liweiforeveryoung 非常感谢，指出了非常关键的问题。
第一个bug，存在覆盖的问题，gin 的做法才是对的，应该把问题暴露给用户。 第二个问题，http 请求是并发的，但每一个请求都会调用
ServeHTTP，这个方法中，context 每次都创建新的，不会对同一个context进行写入。func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) { c := newContext(w, req) engine.router.handle(c) }
@geektutu @liweiforeveryoung 非常感谢，指出了非常关键的问题。
第一个bug，存在覆盖的问题，gin 的做法才是对的，应该把问题暴露给用户。 第二个问题，http 请求是并发的，但每一个请求都会调用
ServeHTTP，这个方法中，context 每次都创建新的，不会对同一个context进行写入。func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) { c := newContext(w, req) engine.router.handle(c) }
非常感谢作者的付出！！
建议这一章先把代码写一遍 大概清楚每一个方法是做什么的，然后按照 addRouter -> getRouter -> handle 在看一遍代码 走一遍流程就明了多了, 说白了就是 用前缀树结构存 前缀树结构取, 用GET /a/asd/c || GET a/s/c 匹配到路由(GET-/a/:param/c)对应的HandlerFunc 并把asd || s 存在context的Params里.
感谢楼主
func (n *node) travel(list *([]*node)) {
if n.pattern != "" {
*list = append(*list, n)
}
for _, child := range n.children {
child.travel(list)
}
}
func (n *node) String() string {
return fmt.Sprintf("node{pattern=%s, part=%s, isWild=%t}", n.pattern, n.part, n.isWild)
}
以上两个方法，在文章中没有提到，但是用到了，看了GitHub源码，才知道，建议后期这种不重要的代码可以提一下，要不会以为自己哪里漏了。
@limaoxiaoer @xlban163 感谢二位的建议，这里可能假定了大家是计算机专业，学习过二叉树、B+树等常用的数据结构了。以后的文章细节会多写一些。
@Howard0o0 通配符匹是文中的模糊匹配，精准匹配是指每个字符都一致，而不是用通配符。
写的太好了，十分感谢大佬的付出！
@wushh @wangzukang 感谢支持，笔芯~
谢谢博主，我有小问题， 在Demo例子里 curl "http://localhost:9999/hello/geektutu/a/b", 匹配不了/hello/geektutu，但可以匹配到/hello 所有是否可以修改为：
func (n *node) search(parts []string, height int) *node {
if len(parts) == height || strings.HasPrefix(n.part, "*") {
if n.pattern == "" {
return nil
}
return n
}
part := parts[height]
children := n.matchChildren(part)
for _, child := range children {
result := child.search(parts, height+1)
if result != nil {
return result
}
}
//应该新增， 判断当前节点是否满足其前缀
if n.pattern != nil {
return n
}
return nil
}
很棒的学习资料！
有一个问题 get /a/:b get /a/c
/a/x 也是去到 /a/c
get /a/c get /a/:b 和 get /a/:b get /a/c 顺序不一样， 结果是两个不同的树
