Go 语言编写的一个轻量、高性能的 HTTP Router

CleverGo

CleverGo is an enhanced version of julienschmidt/httprouter which providesextra useful features.

Contents

Motivation

CleverGo isn’t an another web framework , it aims to be a lightweight , feature-rich and high performance HTTP router which can be intergrates with any third-party packages(such as HTTP middlewares) easily.

Features

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. The only heap allocations that are made are building the slice of the key-value pairs for path parameters, and building new context and request objects (the latter only in the standard Handler / HandlerFunc API). In the 3-argument API, if the request path contains no parameters not a single heap allocation is necessary.

High Performance

Perfect for APIs:The router design encourages to build sensible, hierarchical RESTful APIs. Moreover it has built-in native support for OPTIONS requests and 405 Method Not Allowed replies.

Of course you can also set custom NotFound and MethodNotAllowed handlers and serve static files .

Extra Features

• Named Routes: allow the reverse route generation of URLs.
• Save Matched Route: allow to retrieve matched route in handler, it is useful to generate URLs of the current route.
• Nestable Route Groups: as known as subrouter.
• Middleware: just a function func(http.Handler) http.Handler , it can not only integrates third-party middleware easily, but also can be used in three scopes: root router, subrouter and route.

Usage

All usage and examples can be found at GoDoc :

• Application
• Routes group / subrouter
• Named routes / reverse route generation
• Serve static files

Middleware

There are a lot of third-party middlewares can be used out of box, such as:

• clevergo/middleware : a collection of HTTP middleware, adapter for gorilla handlers(compress and logging).
• gorilla/handlers : a collection of useful middleware for Go HTTP services & web applications.
• goji/httpauth : basic auth middleware.
• List other middlewares here by PR.

Chaining

Chain allow to attach any middlewares on a http.Handler .

Differences

You can skip this section if you have not use httprouter before.

The usage of this package is very similar to httprouter, but there are serveral important differences you should pay attention for.

• There is no Handle type anymore, you can registers http.Handler and http.HandlerFunc by Router.Handle and Router.HandleFunc respectively. And GetParams is the only way to retrieve Params in handler.
• Params.ByName was renamed to Params.Get , and added some useful functions for converting value type:
  • Params.Int
  • Params.Int64
  • Params.Uint64
  • Params.Float64
  • Params.Bool
• ParamsFromContext was removed, use GetParams instead.
• Router.PanicHandler was removed, it is more reasonable to use RecoveryMiddleware in the top level instead.
• Router methods GET , POST , PUT , DELETE , PATCH , HEAD , OPTIONS were renamed to Get , Post , Put , Delete , Patch , Head , Options respectively.

Contribute

• Give it a

  :star:️
  and spread the package.

• File an issue for features or bugs.
• Fork and make a pull request.

FAQ

Why not contribute to the original repository?

There are multiple reasons:

• Slow maintenance, such as the PR of subrouter is still unaccepted.
• Breaking compatibility for introducing features, seeabove.

Anyway, httprouter is definitely an awesome package.