treemux - fast and flexible HTTP router
- Basic example
- Debug logging
- CORS example
- Error handling
- Rate limiting using Redis
- Gzip compression
- OpenTelemetry integration
- Writing REST API with Go and PostgreSQL
- RealWorld example application
- Reference
High-speed, flexible, tree-based HTTP router for Go. It is as fast as httprouter, but with relaxed routing rules.
Benchmark results
#GithubAPI Routes: 203
GorillaMux: 1319632 Bytes
HttpRouter: 37088 Bytes
VmihailencoTreemux: 55056 Bytes
#GPlusAPI Routes: 13
GorillaMux: 66016 Bytes
HttpRouter: 2760 Bytes
VmihailencoTreemux: 5392 Bytes
#ParseAPI Routes: 26
GorillaMux: 105448 Bytes
HttpRouter: 5024 Bytes
VmihailencoTreemux: 5472 Bytes
#Static Routes: 157
GorillaMux: 582520 Bytes
HttpRouter: 21680 Bytes
VmihailencoTreemux: 46768 Bytes
goos: linux
goarch: amd64
pkg: github.com/julienschmidt/go-http-routing-benchmark
cpu: AMD Ryzen 5 2600 Six-Core Processor
BenchmarkGorillaMux_Param 482310 2466 ns/op 1312 B/op 10 allocs/op
BenchmarkHttpRouter_Param 11034873 98.17 ns/op 32 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_Param 7469511 159.0 ns/op 32 B/op 1 allocs/op
BenchmarkGorillaMux_Param5 315780 3630 ns/op 1376 B/op 10 allocs/op
BenchmarkHttpRouter_Param5 4141971 284.0 ns/op 160 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_Param5 2814357 433.4 ns/op 160 B/op 1 allocs/op
BenchmarkGorillaMux_Param20 153157 7711 ns/op 3483 B/op 12 allocs/op
BenchmarkHttpRouter_Param20 1311662 902.1 ns/op 640 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_Param20 939973 1449 ns/op 640 B/op 1 allocs/op
BenchmarkGorillaMux_ParamWrite 444409 2533 ns/op 1312 B/op 10 allocs/op
BenchmarkHttpRouter_ParamWrite 8234792 145.1 ns/op 32 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_ParamWrite 6130166 191.2 ns/op 32 B/op 1 allocs/op
BenchmarkGorillaMux_GithubStatic 221184 5321 ns/op 1008 B/op 9 allocs/op
BenchmarkHttpRouter_GithubStatic 27660388 43.66 ns/op 0 B/op 0 allocs/op
BenchmarkVmihailencoTreemux_GithubStatic 21185312 56.69 ns/op 0 B/op 0 allocs/op
BenchmarkGorillaMux_GithubParam 148010 8032 ns/op 1328 B/op 10 allocs/op
BenchmarkHttpRouter_GithubParam 4974057 237.6 ns/op 96 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_GithubParam 3405594 351.2 ns/op 64 B/op 1 allocs/op
BenchmarkGorillaMux_GithubAll 319 3641622 ns/op 258152 B/op 1994 allocs/op
BenchmarkHttpRouter_GithubAll 26018 47075 ns/op 13792 B/op 167 allocs/op
BenchmarkVmihailencoTreemux_GithubAll 19554 63180 ns/op 10848 B/op 167 allocs/op
BenchmarkGorillaMux_GPlusStatic 802489 1811 ns/op 1008 B/op 9 allocs/op
BenchmarkHttpRouter_GPlusStatic 38865102 31.89 ns/op 0 B/op 0 allocs/op
BenchmarkVmihailencoTreemux_GPlusStatic 41022703 29.31 ns/op 0 B/op 0 allocs/op
BenchmarkGorillaMux_GPlusParam 356788 3449 ns/op 1312 B/op 10 allocs/op
BenchmarkHttpRouter_GPlusParam 6561582 164.7 ns/op 64 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_GPlusParam 6196903 193.5 ns/op 32 B/op 1 allocs/op
BenchmarkGorillaMux_GPlus2Params 201336 6237 ns/op 1328 B/op 10 allocs/op
BenchmarkHttpRouter_GPlus2Params 5670499 197.0 ns/op 64 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_GPlus2Params 3671635 337.5 ns/op 64 B/op 1 allocs/op
BenchmarkGorillaMux_GPlusAll 24546 50849 ns/op 16528 B/op 128 allocs/op
BenchmarkHttpRouter_GPlusAll 616034 2250 ns/op 640 B/op 11 allocs/op
BenchmarkVmihailencoTreemux_GPlusAll 441236 3026 ns/op 512 B/op 11 allocs/op
BenchmarkGorillaMux_ParseStatic 632019 2185 ns/op 1008 B/op 9 allocs/op
BenchmarkHttpRouter_ParseStatic 44729970 27.70 ns/op 0 B/op 0 allocs/op
BenchmarkVmihailencoTreemux_ParseStatic 22529782 54.80 ns/op 0 B/op 0 allocs/op
BenchmarkGorillaMux_ParseParam 498606 2423 ns/op 1312 B/op 10 allocs/op
BenchmarkHttpRouter_ParseParam 7737769 145.6 ns/op 64 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_ParseParam 7123089 168.0 ns/op 32 B/op 1 allocs/op
BenchmarkGorillaMux_Parse2Params 419157 2924 ns/op 1328 B/op 10 allocs/op
BenchmarkHttpRouter_Parse2Params 7583847 165.6 ns/op 64 B/op 1 allocs/op
BenchmarkVmihailencoTreemux_Parse2Params 4374222 272.1 ns/op 64 B/op 1 allocs/op
BenchmarkGorillaMux_ParseAll 12295 99150 ns/op 31120 B/op 250 allocs/op
BenchmarkHttpRouter_ParseAll 388022 3227 ns/op 640 B/op 16 allocs/op
BenchmarkVmihailencoTreemux_ParseAll 235298 4937 ns/op 608 B/op 16 allocs/op
BenchmarkGorillaMux_StaticAll 1122 967515 ns/op 158261 B/op 1413 allocs/op
BenchmarkHttpRouter_StaticAll 88946 12589 ns/op 0 B/op 0 allocs/op
BenchmarkVmihailencoTreemux_StaticAll 96432 12494 ns/op 0 B/op 0 allocs/op
Installing with Go Modules
When using Go Modules, import this repository with import "github.com/vmihailenco/treemux"
to ensure that you get the right version.
Handler
The handler is a simple function with the prototype func(w http.ResponseWriter, req treemux.Request) error
. A treemux.Request
contains route name and parameters parsed from wildcards and catch-alls in the URL. This type is aliased as treemux.HandlerFunc
.
import "github.com/vmihailenco/treemux"
router := treemux.New()
group := router.NewGroup("/api/v1")
group.GET("/:id", func(w http.ResponseWriter, req treemux.Request) error {
id := req.Param("id")
return treemux.JSON(w, treemux.H{
"url": fmt.Sprintf("GET /api/v1/%s", id),
"route": req.Route(),
})
})
log.Println(http.ListenAndServe(":8080", router))
Why not http.HandlerFunc?
treemux.HandlerFunc
is a thin wrapper over http.HandlerFunc
:
treemux.Request
replaces*http.Request
. You can get the original request viareq.Request
.- Handlers return errors just like other Go functions.
Those 2 tiny changes bring us:
- Shorter and simpler error handling. In your handlers you just return the error and deal with it in a middleware in centralized fashion.
- Easier debugging. Since middlewares have access to errors you can log errors along with other debugging information. OpenTelemetry integration uses that to record the error.
- Route name and params.
*http.Request
was not designed to carry the route name and params. You can store that information in the requestcontext.Context
, but that clones the request and therefore requires an allocation - Effeciency.
treemux.Request
is designed soreq.WithContext(ctx)
does not allocate.
Treemux comes with middlewares that handle gzip compression, CORS, OpenTelemetry integration, and request logging. So with minimal changes you can make treemux work nicely with existing libraries.
Converting http.HandlerFunc to treemux.HandlerFunc
treemux provides helpers to convert existing http.HandlerFunc
and http.Handler
into treemux.HandlerFunc
:
// http.HandlerFunc -> treemux.HandlerFunc
router.GET("/foo", treemux.HTTPHandlerFunc(existingHandlerFunc))
// http.Handler -> treemux.HandlerFunc
router.GET("/bar", treemux.HTTPHandler(existingHandler))
Middlewares
Middleware is a function that wraps a handler with another function:
func corsMiddleware(next treemux.HandlerFunc) treemux.HandlerFunc {
return func(w http.ResponseWriter, req treemux.Request) error {
if origin := req.Header.Get("Origin"); origin != "" {
h := w.Header()
h.Set("Access-Control-Allow-Origin", origin)
h.Set("Access-Control-Allow-Credentials", "true")
}
return next(w, req)
}
}
router := treemux.New(treemux.WithMiddleware(corsMiddleware))
Middlewares are also used for error handling.
Routing Rules
The syntax here is modeled after httprouter. Each variable in a path may match on one segment only, except for an optional catch-all variable at the end of the URL.
Some examples of valid URL patterns are:
/post/all
/post/:postid
/post/:postid/page/:page
/post/:postid/:page
/images/*path
/favicon.ico
/:year/:month/
/:year/:month/:post
/:page
Note that all of the above URL patterns may exist concurrently in the router.
Path elements starting with :
indicate a wildcard in the path. A wildcard will only match on a single path segment. That is, the pattern /post/:postid
will match on /post/1
or /post/1/
, but not /post/1/2
.
A path element starting with *
is a catch-all, whose value will be a string containing all text in the URL matched by the wildcards. For example, with a pattern of /images/*path
and a requested URL images/abc/def
, path would contain abc/def
. A catch-all path will not match an empty string, so in this example a separate route would need to be installed if you also want to match /images/
.
Using : and * in routing patterns
The characters :
and *
can be used at the beginning of a path segment by escaping them with a backslash. A double backslash at the beginning of a segment is interpreted as a single backslash. These escapes are only checked at the very beginning of a path segment; they are not necessary or processed elsewhere in a token.
router.GET("/foo/\\*starToken", handler) // matches /foo/*starToken
router.GET("/foo/star*inTheMiddle", handler) // matches /foo/star*inTheMiddle
router.GET("/foo/starBackslash\\*", handler) // matches /foo/starBackslash\*
router.GET("/foo/\\\\*backslashWithStar") // matches /foo/\*backslashWithStar
Routing Groups
Lets you create a new group of routes with a given path prefix. Makes it easier to create clusters of paths like:
/api/v1/foo
/api/v1/bar
To use this you do:
router = treemux.New()
api := router.NewGroup("/api/v1")
api.GET("/foo", fooHandler) // becomes /api/v1/foo
api.GET("/bar", barHandler) // becomes /api/v1/bar
Or using WithGroup
:
router.WithGroup("/api/v1", func(g *treemux.Group) {
g.GET("/foo", fooHandler) // becomes /api/v1/foo
g.GET("/bar", barHandler) // becomes /api/v1/bar
})
More complex example:
router := treemux.New()
g := router.NewGroup("/api/v1", treemux.WithMiddleware(ipRateLimitMiddleware))
g.NewGroup("/users/:user_id",
treemux.WithMiddleware(authMiddleware),
treemux.WithGroup(func(g *treemux.Group) {
g.GET("", userHandler)
g = g.WithMiddleware(adminMiddleware)
g.PUT("", updateUserHandler)
g.DELETE("", deleteUserHandler)
}))
g.NewGroup("/projects/:project_id/articles/:article_id",
treemux.WithMiddleware(authMiddleware),
treemux.WithMiddleware(projectMiddleware),
treemux.WithGroup(func(g *treemux.Group) {
g.GET("", articleHandler)
g.Use(quotaMiddleware)
g.POST("", createArticleHandler)
g.PUT("", updateArticleHandler)
g.DELETE("", deleteArticleHandler)
}))
Routing Priority
The priority rules in the router are simple.
- Static path segments take the highest priority. If a segment and its subtree are able to match the URL, that match is returned.
- Wildcards take second priority. For a particular wildcard to match, that wildcard and its subtree must match the URL.
- Finally, a catch-all rule will match when the earlier path segments have matched, and none of the static or wildcard conditions have matched. Catch-all rules must be at the end of a pattern.
So with the following patterns adapted from simpleblog, we'll see certain matches:
router = treemux.New()
router.GET("/:page", pageHandler)
router.GET("/:year/:month/:post", postHandler)
router.GET("/:year/:month", archiveHandler)
router.GET("/images/*path", staticHandler)
router.GET("/favicon.ico", staticHandler)
Example scenarios
/abc
will match/:page
/2014/05
will match/:year/:month
/2014/05/really-great-blog-post
will match/:year/:month/:post
/images/CoolImage.gif
will match/images/*path
/images/2014/05/MayImage.jpg
will also match/images/*path
, with all the text after/images
stored in the variable path./favicon.ico
will match/favicon.ico
Special Method Behavior
If TreeMux.HeadCanUseGet is set to true, the router will call the GET handler for a pattern when a HEAD request is processed, if no HEAD handler has been added for that pattern. This behavior is enabled by default.
Go's http.ServeContent and related functions already handle the HEAD method correctly by sending only the header, so in most cases your handlers will not need any special cases for it.
Trailing Slashes
The router has special handling for paths with trailing slashes. If a pattern is added to the router with a trailing slash, any matches on that pattern without a trailing slash will be redirected to the version with the slash. If a pattern does not have a trailing slash, matches on that pattern with a trailing slash will be redirected to the version without.
The trailing slash flag is only stored once for a pattern. That is, if a pattern is added for a method with a trailing slash, all other methods for that pattern will also be considered to have a trailing slash, regardless of whether or not it is specified for those methods too. However this behavior can be turned off by setting TreeMux.RedirectTrailingSlash to false. By default it is set to true.
One exception to this rule is catch-all patterns. By default, trailing slash redirection is disabled on catch-all patterns, since the structure of the entire URL and the desired patterns can not be predicted. If trailing slash removal is desired on catch-all patterns, set TreeMux.RemoveCatchAllTrailingSlash to true.
router = treemux.New()
router.GET("/about", pageHandler)
router.GET("/posts/", postIndexHandler)
router.POST("/posts", postFormHandler)
GET /about will match normally.
GET /about/ will redirect to /about.
GET /posts will redirect to /posts/.
GET /posts/ will match normally.
POST /posts will redirect to /posts/, because the GET method used a trailing slash.
Custom Redirects
RedirectBehavior sets the behavior when the router redirects the request to the canonical version of the requested URL using RedirectTrailingSlash or RedirectClean. The default behavior is to return a 301 status, redirecting the browser to the version of the URL that matches the given pattern.
These are the values accepted for RedirectBehavior. You may also add these values to the RedirectMethodBehavior map to define custom per-method redirect behavior.
- Redirect301 - HTTP 301 Moved Permanently; this is the default.
- Redirect307 - HTTP/1.1 Temporary Redirect
- Redirect308 - RFC7538 Permanent Redirect
- UseHandler - Don't redirect to the canonical path. Just call the handler instead.
Rationale/Usage
On a POST request, most browsers that receive a 301 will submit a GET request to the redirected URL, meaning that any data will likely be lost. If you want to handle and avoid this behavior, you may use Redirect307, which causes most browsers to resubmit the request using the original method and request body.
Since 307 is supposed to be a temporary redirect, the new 308 status code has been proposed, which is treated the same, except it indicates correctly that the redirection is permanent. The big caveat here is that the RFC is relatively recent, and older or non-compliant browsers will not handle it. Therefore its use is not recommended unless you really know what you're doing.
Finally, the UseHandler value will simply call the handler function for the pattern, without redirecting to the canonical version of the URL.
RequestURI vs. URL.Path
Escaped Slashes
Go automatically processes escaped characters in a URL, converting + to a space and %XX to the corresponding character. This can present issues when the URL contains a %2f, which is unescaped to '/'. This isn't an issue for most applications, but it will prevent the router from correctly matching paths and wildcards.
For example, the pattern /post/:post
would not match on /post/abc%2fdef
, which is unescaped to /post/abc/def
. The desired behavior is that it matches, and the post
wildcard is set to abc/def
.
Therefore, this router defaults to using the raw URL, stored in the Request.RequestURI variable. Matching wildcards and catch-alls are then unescaped, to give the desired behavior.
TL;DR: If a requested URL contains a %2f, this router will still do the right thing. Some Go HTTP routers may not due to Go issue 3659.
http Package Utility Functions
Although using RequestURI avoids the issue described above, certain utility functions such as http.StripPrefix
modify URL.Path, and expect that the underlying router is using that field to make its decision. If you are using some of these functions, set the router's PathSource
member to URLPath
. This will give up the proper handling of escaped slashes described above, while allowing the router to work properly with these utility functions.
Error Handlers
NotFoundHandler
TreeMux.NotFoundHandler
can be set to provide custom 404-error handling. The default implementation is Go's http.NotFound
function.
MethodNotAllowedHandler
If a pattern matches, but the pattern does not have an associated handler for the requested method, the router calls the MethodNotAllowedHandler. The default version of this handler just writes the status code http.StatusMethodNotAllowed
.
Unexpected Differences from Other Routers
This router is intentionally light on features in the name of simplicity and performance. When coming from another router that does heavier processing behind the scenes, you may encounter some unexpected behavior. This list is by no means exhaustive, but covers some nonobvious cases that users have encountered.
httprouter and catch-all parameters
When using httprouter
, a route with a catch-all parameter (e.g. /images/*path
) will match on URLs like /images/
where the catch-all parameter is empty. This router does not match on empty catch-all parameters, but the behavior can be duplicated by adding a route without the catch-all (e.g. /images/
).
httptreemux
This is a fork of httptreemux. The original code was written by Daniel Imfeld.
Changes from httptreemux
-
Thin wrapper
treemux.Request
aroundhttp.Request
to expose route viaRequest.Route
and route params viareq.Params
. -
Setting a
context.Context
does not require an allocation. -
More efficient params encoding using a slice instead of a map.
-
Reworked configuration.
-
Group
is immutable to avoid accidental leaking of middlewares into the group.