缩写:
func (r *Router) DELETE(path string, handle Handle)
func (r *Router) GET(path string, handle Handle)
func (r *Router) HEAD(path string, handle Handle)
func (r *Router) OPTIONS(path string, handle Handle)
func (r *Router) PATCH(path string, handle Handle)
func (r *Router) POST(path string, handle Handle)
func (r *Router) PUT(path string, handle Handle)
例如,Get()等价于route.Handle("GET", path, handle)。
例如上面的示例中,为两个路径注册了各自的httprouter.Handle函数。
router := httprouter.New()
router.GET("/", Index)
router.GET("/hello/:name", Hello)
Handler()方法是直接为指定http方法和路径注册http.Handler;HandlerFunc()方法则是直接为指定http方法和路径注册http.HandlerFunc。
Param相关
type Param struct {
Key string
Value string
}
Param is a single URL parameter, consisting of a key and a value.
type Params []Param
Params is a Param-slice, as returned by the router. The slice is ordered, the first URL parameter is also the first slice value. It is therefore safe to read values by the index.
func (ps Params) ByName(name string) string
ByName returns the value of the first Param which key matches the given name. If no matching Param is found, an empty string is returned.
Param类型是key/value型的结构,每个分组捕获到的值都会保存为此类型。正如前面的示例中:
router.GET("/hello/:name", Hello)
这里的:name
就是key,当请求的URL路径为/hello/abc
,则key对应的value为abc。也就是说保存了一个Param实例:
Param{
Key: "name",
Value: "abc",
}
更多的匹配用法稍后解释。
Params是Param的slice。也就是说,每个分组捕获到的key/value都存放在这个slice中。
ByName(str)方法可以根据Param的Key检索已经保存在slice中的Param的Value。正如示例中:
func Hello(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
fmt.Fprintf(w, "hello, %s!\n", ps.ByName("name"))
}
router.GET("/hello/:name", Hello)
这里ByName("name")
将检索保存在slice中,Key="name"的Param,且返回这个Param中的Value。
由于Params是slice结构,除了ByName()方法可以检索key/value,通过slice的方法也可以直接检索:
ps[0].Key
ps[0].Value
路径匹配规则
httprouter要为路径注册handler的适合,路径可以进行命名捕获。有两种命名捕获的方式:
Syntax Type
:name named parameter
*name catch-all parameter
其中:name
的捕获方式是匹配内容直到下一个斜线或者路径的结尾。例如要为如下路径注册handler:
Path: /blog/:category/:post
当请求路径为:
/blog/go/request-routers match: category="go", post="request-routers"
/blog/go/request-routers/ no match, but the router would redirect
/blog/go/ no match
/blog/go/request-routers/comments no match
*name
的捕获方式是从指定位置开始(包含前缀"/")匹配到结尾:
Path: /files/*filepath
/files/ match: filepath="/"
/files/LICENSE match: filepath="/LICENSE"
/files/templates/article.html match: filepath="/templates/article.html"
/files no match, but the router would redirect
再解释下什么时候会进行重定向。在Router类型中,第一个字段控制尾随斜线的重定向操作:
type Router struct {
RedirectTrailingSlash bool
...
}
如果请求的URL路径包含或者不包含尾随斜线时,但在注册的路径上包含了或没有包含"/"的目标上定义了handler,但是会进行301重定向。简单地说,不管URL是否带尾随斜线,只要注册路径不存在,但在去掉尾随斜线或加上尾随斜线的路径上定义了handler,就会自动重定向。
例如注册路径为/foo
,请求路径为/foo/
,会重定向。
下面还有几种会重定向的情况:
注册路径:/blog/:category/:post
请求URL路径:/blog/go/request-routers/
注册路径:/blog/:category
请求URL路径:/blog/go
注册路径:/files/*filepath
请求URL路径:/files
Lookup()
func (r *Router) Lookup(method, path string) (Handle, Params, bool)
Lookup根据method+path检索对应的Handle,以及Params,并可以通过第三个返回值判断是否会进行重定向。