- Uses http.Handler instead of httprouter.Handle for endpoints.
- Built in middleware (func(http.Handler)http.Handler) global and per handler support (using closure) e.g. GET(path,middleware..)(handler)
- Uses map[string]string instead of httprouter.Params.
- Exposes Router.SetHandler middleware method (w http.ResponseWriter, r *http.Request, params map[string]string, next http.Handler) to initialize the middleware pipeline and to associate parameters with the request. The default backing implementation uses a Gorilla Context approach (map[*http.Request]map[string]string)
- Updated base tests
TODO: Add tests for newly added
NOTE: Last named parameter wins i.e. params[name] = value, the current httprouter.Params uses an array and returns the first parameter matching the name when calling params.ByName(name).
HttpRouter is a lightweight high performance HTTP request router (also called multiplexer or just mux for short) for Go.
In contrast to the default mux of Go's net/http package, this router supports variables in the routing pattern and matches against the request method. It also scales better.
The router is optimized for high performance and a small memory footprint. It scales well even with very long paths and a large number of routes. A compressing dynamic trie (radix tree) structure is used for efficient matching.
Only explicit matches: With other routers, like http.ServeMux, a requested URL path could match multiple patterns. Therefore they have some awkward pattern priority rules, like longest match or first registered, first matched. By design of this router, a request can only match exactly one or no route. As a result, there are also no unintended matches, which makes it great for SEO and improves the user experience.
Stop caring about trailing slashes: Choose the URL style you like, the router automatically redirects the client if a trailing slash is missing or if there is one extra. Of course it only does so, if the new path has a handler. If you don't like it, you can turn off this behavior.
Path auto-correction: Besides detecting the missing or additional trailing
slash at no extra cost, the router can also fix wrong cases and remove
superfluous path elements (like ../ or //).
Is CAPTAIN CAPS LOCK one of your users?
HttpRouter can help him by making a case-insensitive look-up and redirecting him
to the correct URL.
Parameters in your routing pattern: Stop parsing the requested URL path, just give the path segment a name and the router delivers the dynamic value to you. Because of the design of the router, path parameters are very cheap.
Zero Garbage: The matching and dispatching process generates zero bytes of garbage. In fact, the only heap allocations that are made, is by building the slice of the key-value pairs for path parameters. If the request path contains no parameters, not a single heap allocation is necessary.
Best Performance: Benchmarks speak for themselves. See below for technical details of the implementation.
No more server crashes: You can set a Panic handler to deal with panics occurring during handling a HTTP request. The router then recovers and lets the PanicHandler log what happened and deliver a nice error page.
Of course you can also set custom NotFound and MethodNotAllowed handlers and serve static files.
This is just a quick introduction, view the GoDoc for details.
Let's start with a trivial example:
package main
import (
"fmt"
"log"
"net/http"
"sync"
"time"
gorillaContext "github.com/gorilla/context"
"github.com/shelakel/httprouter"
netContext "golang.org/x/net/context"
)
//-----------------------------------------------
// Custom initializer example - gorilla/context
//-----------------------------------------------
func GorillaSetParams(r *http.Request, params map[string]string) {
gorillaContext.Set(r, "params", params)
}
var GorillaUnsetParams = gorillaContext.Clear
func GorillaParams(r *http.Request) map[string]string {
// default implementation returns nil when no parameters are associated with the request
// or the request is nil
if r == nil {
return nil
}
var ps interface{}
var ok bool
var params map[string]string
if ps, ok = gorillaContext.GetOk(r, "params"); ok {
if params, ok = ps.(map[string]string); ok {
return params
}
}
return nil
}
//-----------------------------------------------
// Custom initializer example - net/context
//-----------------------------------------------
var netContextLock = new(sync.Mutex)
var netContextMap = make(map[*http.Request]netContext.Context, 0)
func Context(r *http.Request) netContext.Context {
netContextLock.Lock()
if ctx, ok := netContextMap[r]; ok {
netContextLock.Unlock()
return ctx
}
netContextLock.Unlock()
return nil
}
func SetContext(r *http.Request, ctx netContext.Context) {
netContextLock.Lock()
if ctx == nil {
delete(netContextMap, r)
} else {
netContextMap[r] = ctx
}
netContextLock.Unlock()
}
func NetParams(r *http.Request) map[string]string {
ctx := Context(r)
if ps := ctx.Value("params"); ps != nil {
if params, ok := ps.(map[string]string); ok {
return params
}
}
return nil // default implementation returns nil when no parameters are associated with the request
}
func NetContextInitializer(w http.ResponseWriter, r *http.Request, params map[string]string, next http.Handler) {
ctx := netContext.WithValue(netContext.Background(), "params", params)
SetContext(r, ctx)
defer SetContext(r, nil)
next.ServeHTTP(w, r)
}
//-----------------------------------------------
// Middleware example
//-----------------------------------------------
func LogRequest(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
defer func(started time.Time) {
log.Printf("%s: %s (%dus)\n", r.Method, r.RequestURI, time.Since(started).Nanoseconds()/1000.0)
}(time.Now())
next.ServeHTTP(w, r)
})
}
func PerHandlerMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Println("Per Handler Middleware")
next.ServeHTTP(w, r)
})
}
func Index(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Welcome!\n")
}
func Hello(w http.ResponseWriter, r *http.Request) {
ps := httprouter.Params(r) // default implementation
name := ps["name"]
fmt.Fprintf(w, "hello, %s!\n", name)
}
func useGorillaContext(router *httprouter.Router) {
// example: replace the built-in functions with custom store for parameters
httprouter.SetParams = GorillaSetParams
httprouter.UnsetParams = GorillaUnsetParams
httprouter.Params = GorillaParams
}
func useNetContext(router *httprouter.Router) {
// example: use net/Context custom initializer
router.SetInitializer(NetContextInitializer)
// only the default initializer uses SetParams/Params, but can be overridden for convenience
}
func main() {
router := httprouter.New()
router.GET("/", PerHandlerMiddleware)(Index)
router.GET("/hello/:name")(Hello)
router.Use(LogRequest) // router level middleware are only composed when handling the request
// useGorillaContext(router)
// useNetContext(router)
log.Fatal(http.ListenAndServe(":8080", router))
}As you can see, :name is a named parameter.
The values are accessible via httprouter.Params, which is just a slice of httprouter.Params.
You can get the value of a parameter either by its index in the slice, or by using the ByName(name) method:
:name can be retrived by ByName("name").
Named parameters only match a single path segment:
Pattern: /user/:user
/user/gordon match
/user/you match
/user/gordon/profile no match
/user/ no match
Note: Since this router has only explicit matches, you can not register static routes and parameters for the same path segment. For example you can not register the patterns /user/new and /user/:user for the same request method at the same time. The routing of different request methods is independent from each other.
The second type are catch-all parameters and have the form *name.
Like the name suggests, they match everything.
Therefore they must always be at the end of the pattern:
Pattern: /src/*filepath
/src/ match
/src/somefile.go match
/src/subdir/somefile.go match
The router relies on a tree structure which makes heavy use of common prefixes,
it is basically a compact prefix tree
(or just Radix tree).
Nodes with a common prefix also share a common parent. Here is a short example
what the routing tree for the GET request method could look like:
Priority Path Handle
9 \ *<1>
3 ├s nil
2 |├earch\ *<2>
1 |└upport\ *<3>
2 ├blog\ *<4>
1 | └:post nil
1 | └\ *<5>
2 ├about-us\ *<6>
1 | └team\ *<7>
1 └contact\ *<8>
Every *<num> represents the memory address of a handler function (a pointer).
If you follow a path trough the tree from the root to the leaf, you get the
complete route path, e.g \blog\:post\, where :post is just a placeholder
(parameter) for an actual post name. Unlike hash-maps, a
tree structure also allows us to use dynamic parts like the :post parameter,
since we actually match against the routing patterns instead of just comparing
hashes. As benchmarks show,
this works very well and efficient.
Since URL paths have a hierarchical structure and make use only of a limited set of characters (byte values), it is very likely that there are a lot of common prefixes. This allows us to easily reduce the routing into ever smaller problems. Moreover the router manages a separate tree for every request method. For one thing it is more space efficient than holding a method->handle map in every single node, for another thing is also allows us to greatly reduce the routing problem before even starting the look-up in the prefix-tree.
For even better scalability, the child nodes on each tree level are ordered by priority, where the priority is just the number of handles registered in sub nodes (children, grandchildren, and so on..). This helps in two ways:
- Nodes which are part of the most routing paths are evaluated first. This helps to make as much routes as possible to be reachable as fast as possible.
- It is some sort of cost compensation. The longest reachable path (highest cost) can always be evaluated first. The following scheme visualizes the tree structure. Nodes are evaluated from top to bottom and from left to right.
├------------
├---------
├-----
├----
├--
├--
└-
It does! The router itself implements the http.Handler interface. Moreover the router provides convenient adapters for http.Handlers and http.HandlerFuncs which allows them to be used as a httprouter.Handle when registering a route. The only disadvantage is, that no parameter values can be retrieved when a http.Handler or http.HandlerFunc is used, since there is no efficient way to pass the values with the existing function parameters. Therefore httprouter.Handle has a third function parameter.
Just try it out for yourself, the usage of HttpRouter is very straightforward. The package is compact and minimalistic, but also probably one of the easiest routers to set up.
This package just provides a very efficient request router with a few extra features. The router is just a http.Handler, you can chain any http.Handler compatible middleware before the router, for example the Gorilla handlers. Or you could just write your own, it's very easy!
Alternatively, you could try a web framework based on HttpRouter.
Here is a quick example: Does your server serve multiple domains / hosts? You want to use sub-domains? Define a router per host!
// We need an object that implements the http.Handler interface.
// Therefore we need a type for which we implement the ServeHTTP method.
// We just use a map here, in which we map host names (with port) to http.Handlers
type HostSwitch map[string]http.Handler
// Implement the ServerHTTP method on our new type
func (hs HostSwitch) ServeHTTP(w http.ResponseWriter, r *http.Request) {
// Check if a http.Handler is registered for the given host.
// If yes, use it to handle the request.
if handler := hs[r.Host]; handler != nil {
handler.ServeHTTP(w, r)
} else {
// Handle host names for wich no handler is registered
http.Error(w, "Forbidden", 403) // Or Redirect?
}
}
func main() {
// Initialize a router as usual
router := httprouter.New()
router.GET("/")(Index)
router.GET("/hello/:name")(Hello)
// Make a new HostSwitch and insert the router (our http handler)
// for example.com and port 12345
hs := make(HostSwitch)
hs["example.com:12345"] = router
// Use the HostSwitch to listen and serve on port 12345
log.Fatal(http.ListenAndServe(":12345", hs))
}Another quick example: Basic Authentification (RFC 2617) for handles:
package main
import (
"bytes"
"encoding/base64"
"fmt"
"github.com/julienschmidt/httprouter"
"net/http"
"log"
"strings"
)
func BasicAuth(user, pass []byte) func(http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
const basicAuthPrefix string = "Basic "
// Get the Basic Authentication credentials
auth := r.Header.Get("Authorization")
if strings.HasPrefix(auth, basicAuthPrefix) {
// Check credentials
payload, err := base64.StdEncoding.DecodeString(auth[len(basicAuthPrefix):])
if err == nil {
pair := bytes.SplitN(payload, []byte(":"), 2)
if len(pair) == 2 && bytes.Equal(pair[0], user) && bytes.Equal(pair[1], pass) {
// Delegate request to the given handle
next.ServeHTTP(w, r)
return
}
}
}
// Request Basic Authentication otherwise
w.Header().Set("WWW-Authenticate", "Basic realm=Restricted")
http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
})
}
}
func Index(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Not protected!\n")
}
func Protected(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Protected!\n")
}
func main() {
user := []byte("gordon")
pass := []byte("secret!")
router := httprouter.New()
router.GET("/")(Index)
router.GET("/protected/", BasicAuth(user, pass))(Protected)
log.Fatal(http.ListenAndServe(":8080", router))
}NOTE: It might be required to set Router.HandleMethodNotAllowed to false to avoid problems.
You can use another http.HandlerFunc, for example another router, to handle requests which could not be matched by this router by using the Router.NotFound handler. This allows chaining.
The NotFound handler can for example be used to serve static files from the root path / (like an index.html file along with other assets):
// Serve static files from the ./public directory
router.NotFound = http.FileServer(http.Dir("public")).ServeHTTPBut this approach sidesteps the strict core rules of this router to avoid routing problems. A cleaner approach is to use a distinct sub-path for serving files, like /static/*filepath or /files/*filepath.
If the HttpRouter is a bit too minimalistic for you, you might try one of the following more high-level 3rd-party web frameworks building upon the HttpRouter package:
- Ace: Blazing fast Go Web Framework
- api2go: A JSON API Implementation for Go
- Gin: Features a martini-like API with much better performance
- Goat: A minimalistic REST API server in Go
- Hikaru: Supports standalone and Google AppEngine
- Hitch: Hitch ties httprouter, httpcontext, and middleware up in a bow
- kami: A tiny web framework using x/net/context
- Medeina: Inspired by Ruby's Roda and Cuba
- Neko: A lightweight web application framework for Golang