Skip to content

Commit

Permalink
Merge pull request #6 from go-zoox/feat/support-router-wildcard-with-…
Browse files Browse the repository at this point in the history
…brackets

feat: support router wildcard with brackets
  • Loading branch information
whatwewant committed Aug 7, 2023
2 parents 57720c6 + 1b9c42c commit 3b67c15
Show file tree
Hide file tree
Showing 5 changed files with 128 additions and 21 deletions.
45 changes: 42 additions & 3 deletions components/router/trie.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
package router

import "strings"
import (
"strings"

"github.com/go-zoox/core-utils/safe"
)

// Node ...
type Node struct {
Path string
part string
children []*Node
isWild bool
//
paramsKeyIndexMap *safe.Map
}

// MatchChild ...
Expand Down Expand Up @@ -40,12 +46,37 @@ func (n *Node) Insert(pattern string, parts []string, height int) {
return
}

paramsKeyIndexMap := safe.NewMap()
for i, part := range parts {
if part[0] == ':' {
// pattern: /user/:name
paramsKeyIndexMap.Set(part[1:], i)
} else if part[0] == '{' && part[len(part)-1] == '}' {
// pattern: /user/{name}
paramsKeyIndexMap.Set(part[1:len(part)-1], i)
} else if part[0] == '*' && len(part) > 1 {
// pattern: /file/*
paramsKeyIndexMap.Set(part[1:], i)
break
}
}

part := parts[height]
child := n.MatchChild(part)
if child == nil {
isWild := false
if part[0] == ':' {
isWild = true
} else if part[0] == '{' && part[len(part)-1] == '}' {
isWild = true
} else if part[0] == '*' {
isWild = true
}

child = &Node{
part: part,
isWild: part[0] == ':' || part[0] == '*',
part: part,
isWild: isWild,
paramsKeyIndexMap: paramsKeyIndexMap,
}
n.children = append(n.children, child)
}
Expand Down Expand Up @@ -75,3 +106,11 @@ func (n *Node) Search(parts []string, height int) *Node {

return nil
}

func (n *Node) IsWild() bool {
return n.isWild
}

func (n *Node) ParamsMap() *safe.Map {
return n.paramsKeyIndexMap
}
14 changes: 7 additions & 7 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ go 1.18
require (
github.com/go-zoox/cache v1.0.3
github.com/go-zoox/cookie v1.2.0
github.com/go-zoox/core-utils v1.2.11
github.com/go-zoox/core-utils v1.2.13
github.com/go-zoox/counter v1.2.0
github.com/go-zoox/cron v1.1.2
github.com/go-zoox/datetime v1.1.1
github.com/go-zoox/debug v1.0.1
github.com/go-zoox/fetch v1.7.7
github.com/go-zoox/fetch v1.7.12
github.com/go-zoox/gzip v1.0.0
github.com/go-zoox/headers v1.0.8
github.com/go-zoox/jobqueue v1.0.0
Expand Down Expand Up @@ -46,11 +46,11 @@ require (
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/robfig/cron/v3 v3.0.1 // indirect
github.com/spf13/cast v1.5.1 // indirect
github.com/tidwall/gjson v1.14.4 // indirect
github.com/tidwall/gjson v1.15.0 // indirect
github.com/tidwall/match v1.1.1 // indirect
github.com/tidwall/pretty v1.2.1 // indirect
golang.org/x/crypto v0.11.0 // indirect
golang.org/x/net v0.12.0 // indirect
golang.org/x/sys v0.10.0 // indirect
golang.org/x/text v0.11.0 // indirect
golang.org/x/crypto v0.12.0 // indirect
golang.org/x/net v0.14.0 // indirect
golang.org/x/sys v0.11.0 // indirect
golang.org/x/text v0.12.0 // indirect
)
18 changes: 16 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ github.com/go-zoox/core-utils v1.0.12/go.mod h1:EknM3KLL6/kagL95wZbWE7mRRcYCG/fH
github.com/go-zoox/core-utils v1.0.13/go.mod h1:EknM3KLL6/kagL95wZbWE7mRRcYCG/fHqiJ/EH0ihAs=
github.com/go-zoox/core-utils v1.2.11 h1:3h8P4d+P1XTEzi6M68CywUfy4p8WEZOFuWME8uIYJJ4=
github.com/go-zoox/core-utils v1.2.11/go.mod h1:Y6izFcxuELrkOen5mTQccCJxJqqPJaZV5dQtUMBdkBM=
github.com/go-zoox/core-utils v1.2.13 h1:rcTDGrf7FECVOCgVDXCNRUyu1Nny4h6pCTq1t+i4LPM=
github.com/go-zoox/core-utils v1.2.13/go.mod h1:raOOwr2l2sJQyjR0Dg33sg0ry4U1/L2eNTuLFRpUXWs=
github.com/go-zoox/counter v1.0.1/go.mod h1:PICilZTrnO4dFstDPlXpjc6sdWYBG7hm/XDmjAcHaX0=
github.com/go-zoox/counter v1.2.0 h1:a1sMgYmnOza4UgjDD/fLs+HqTPG2Kh54v2IH41uIi7Q=
github.com/go-zoox/counter v1.2.0/go.mod h1:dCAErDaaxnnqQrfPNkJYklqSQrZ9SKzH3iiciJa3BH4=
Expand All @@ -68,6 +70,8 @@ github.com/go-zoox/fetch v1.3.5/go.mod h1:AkS6v/DlotjmUs+7qJsoFGFkpROr9LVtiKYb00
github.com/go-zoox/fetch v1.4.4/go.mod h1:WExVnds3HZ1A6jJu9KuqtICfkJpvUdR4uONUnw9TG+0=
github.com/go-zoox/fetch v1.7.7 h1:Uw4ldGYxzfZ+eXZDpxVEmLpoJsXEen1g58XLV70euTM=
github.com/go-zoox/fetch v1.7.7/go.mod h1:zaDVj8s8gPFzEeFFsD2oWc5D1z8uKKQwwnilmPdSQOk=
github.com/go-zoox/fetch v1.7.12 h1:q3x9ol6ylas4HL0YLMDkUZeCFHT+AbB9LT6SxciD/h0=
github.com/go-zoox/fetch v1.7.12/go.mod h1:zaDVj8s8gPFzEeFFsD2oWc5D1z8uKKQwwnilmPdSQOk=
github.com/go-zoox/fs v1.2.4/go.mod h1:aywpClMqf6YO8+QnuwC3p3EvFWe88h0tWH65rpxtY00=
github.com/go-zoox/fs v1.2.5/go.mod h1:aywpClMqf6YO8+QnuwC3p3EvFWe88h0tWH65rpxtY00=
github.com/go-zoox/fs v1.3.13 h1:fe0uvtXCM+9s51z/CnQ5kxB4hBYaK55tkrE9gq0385U=
Expand Down Expand Up @@ -106,8 +110,8 @@ github.com/go-zoox/tag v1.0.2/go.mod h1:TNFY+IN6FgsD0KGV6mrnuVXONUq7zpH01k53BcNs
github.com/go-zoox/tag v1.0.6/go.mod h1:jrbJgC1dZAN5+vZlmrUKu1/UpbOo0xVyCC1MfLpGGqk=
github.com/go-zoox/tag v1.0.9/go.mod h1:jrbJgC1dZAN5+vZlmrUKu1/UpbOo0xVyCC1MfLpGGqk=
github.com/go-zoox/tag v1.1.0/go.mod h1:yMB7bMseqbOshUW9O9Dqfq0C7Mmy9OkccV/meEJHICs=
github.com/go-zoox/tag v1.2.2 h1:MLtfFEEBVwV3HVhgNHXGDl0Xv4h9hj1+6Hx9GaRHvFc=
github.com/go-zoox/tag v1.2.2/go.mod h1:z9z4iZb/XPE4HwTXJgPIdwgH90c2NysGxIMq9tW+GuU=
github.com/go-zoox/tag v1.2.3 h1:HDQpRu8rA1xSJt6c+v0O7TfzTjPq5aDtyzW/15aTh94=
github.com/go-zoox/tag v1.2.3/go.mod h1:z9z4iZb/XPE4HwTXJgPIdwgH90c2NysGxIMq9tW+GuU=
github.com/go-zoox/testify v1.0.0 h1:zXuj+JMcudM/dWk8HgMfCKpGYDcyHbTUBGxH35SGubU=
github.com/go-zoox/uuid v0.0.1 h1:txqmDavRTq68gzzqWfJQLorFyUp9a7M2lmq2KcwPGPA=
github.com/go-zoox/uuid v0.0.1/go.mod h1:0/F4LdfLqFdyqOf7aXoiYXRkXHU324JQ5DZEytXYBPM=
Expand Down Expand Up @@ -196,6 +200,8 @@ github.com/tidwall/gjson v1.14.1/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vl
github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/gjson v1.14.4 h1:uo0p8EbA09J7RQaflQ1aBRffTR7xedD2bcIVSYxLnkM=
github.com/tidwall/gjson v1.14.4/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/gjson v1.15.0 h1:5n/pM+v3r5ujuNl4YLZLsQ+UE5jlkLVm7jMzT5Mpolw=
github.com/tidwall/gjson v1.15.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
Expand All @@ -211,6 +217,8 @@ golang.org/x/crypto v0.0.0-20220313003712-b769efc7c000/go.mod h1:IxCIyHEi3zRg3s0
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA=
golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio=
golang.org/x/crypto v0.12.0 h1:tFM/ta59kqch6LlvYnPa0yx5a83cL2nHflFhYKvv9Yk=
golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw=
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
Expand All @@ -225,6 +233,8 @@ golang.org/x/net v0.0.0-20220802222814-0bcc04d9c69b/go.mod h1:YDH+HFinaLZZlnHAfS
golang.org/x/net v0.0.0-20220812174116-3211cb980234/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50=
golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
golang.org/x/net v0.14.0 h1:BONx9s002vGdD9umnlX1Po8vOZmrgH34qlHcD1MfK14=
golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI=
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
Expand Down Expand Up @@ -254,6 +264,8 @@ golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBc
golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
Expand All @@ -263,6 +275,8 @@ golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4=
golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
golang.org/x/text v0.12.0 h1:k+n5B8goJNdU7hSvEtMUz3d1Q6D/XW4COJSJR6fN0mc=
golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
Expand Down
30 changes: 21 additions & 9 deletions router.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,21 +55,33 @@ func (r *router) addRoute(method string, path string, handler ...HandlerFunc) {

func (r *router) getRoute(method string, path string) (*route.Node, map[string]string) {
searchParts := parsePath(path)
params := make(map[string]string)
if ok := r.roots.Has(method); !ok {
return nil, nil
}

root := r.roots.Get(method).(*route.Node)
if n := root.Search(searchParts, 0); n != nil {
parts := parsePath(n.Path)
for i, part := range parts {
if part[0] == ':' {
params[part[1:]] = searchParts[i]
} else if part[0] == '*' && len(part) > 1 {
params[part[1:]] = strings.Join(searchParts[i:], "/")
break
}
params := make(map[string]string)
// parts := parsePath(n.Path)
// for i, part := range parts {
// if part[0] == ':' {
// // pattern: /user/:name
// params[part[1:]] = searchParts[i]
// } else if part[0] == '{' && part[len(part)-1] == '}' {
// // pattern: /user/{name}
// params[part[1:len(part)-1]] = searchParts[i]
// } else if part[0] == '*' && len(part) > 1 {
// // pattern: /file/*
// params[part[1:]] = strings.Join(searchParts[i:], "/")
// break
// }
// }

pmap := n.ParamsMap()
keys := pmap.Keys()
for _, k := range keys {
i := pmap.Get(k).(int)
params[k] = searchParts[i]
}

return n, params
Expand Down
42 changes: 42 additions & 0 deletions router_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ func newTestRouter() *router {
r.addRoute("GET", "/hello/:name", nil)
r.addRoute("GET", "/hello/b/c", nil)
r.addRoute("GET", "/hi/:name", nil)
r.addRoute("GET", "/usersx/:nid", nil)
r.addRoute("GET", "/users/{id}", nil)
r.addRoute("GET", "/users/:id/profile", nil)
r.addRoute("GET", "/users/:id/logs/:lid", nil)
r.addRoute("GET", "/assets/*filepath", nil)
return r
}
Expand Down Expand Up @@ -45,3 +49,41 @@ func TestGetRoute(t *testing.T) {
t.Errorf("Expected zoox, got %s", ps["name"])
}
}

func TestGetRouteMultiParams(t *testing.T) {
r := newTestRouter()
n, ps := r.getRoute("GET", "/users/1/logs/6")

if n == nil {
t.Fatal("Expected node, got nil")
}

if n.Path != "/users/:id/logs/:lid" {
t.Errorf("Expected /users/:id/logs/:lid, got %s", n.Path)
}

if ps["id"] != "1" {
t.Errorf("Expected 1, got %s", ps["id"])
}

if ps["lid"] != "6" {
t.Errorf("Expected 6, got %s", ps["lid"])
}
}

func TestGetRouteWithBrackets(t *testing.T) {
r := newTestRouter()
n, ps := r.getRoute("GET", "/users/1")

if n == nil {
t.Fatal("Expected node, got nil")
}

if n.Path != "/users/{id}" {
t.Errorf("Expected /users/{id}, got %s", n.Path)
}

if ps["id"] != "1" {
t.Errorf("Expected 1, got %v", ps["id"])
}
}

0 comments on commit 3b67c15

Please sign in to comment.