CleverGo Router-轻量、高性能的 Go HTTP Router

CleverGo Router - 轻量、高性能的 Go HTTP Router

路由器/防火墙

授权协议: BSD

操作系统: 跨平台

开发语言: Google Go

软件简介

CleverGo 是一个轻量级、功能丰富和高性能的 HTTP 路由。

基准测试

日期: 2020/02/11

越小性能越好

功能特性

高性能： 参见基准测试。
反向路由生成: 可以通过 命名路由 和 匹配路由 生成 URL。
路由组: 亦称子路由, 参看路由组。
对 APIs 友好: 很容易设计 RESTful APIs 和通过路由组进行 APIs 版本化。
中间件: 可以在路由组或特定路由插入中间件，也可以使用全局中间件, 请参看中间件例子。
错误处理器 可以自定义错误响应，比如显示一个错误页面。

安装

GO111MODULE=on go get github.com/clevergo/clevergo

或者安装特定版本:

GO111MODULE=on go get github.com/clevergo/clevergo@version

替换 version 为具体版本即可。

举个栗子

package main

import (
    "fmt"
    "net/http"

    "github.com/clevergo/clevergo"
)

func home(ctx *clevergo.Context) error {
    ctx.WriteString("hello world")
    return nil
}

func hello(ctx *clevergo.Context) error {
    ctx.WriteString(fmt.Sprintf("hello %s", ctx.Params.String("name")))
    return nil
}

func main() {
    router := clevergo.NewRouter()
    router.Get("/", home)
    router.Get("/hello/:name", hello)
    http.ListenAndServe(":8080", router)
}

参数

可以通过多种方式获取各种类型的参数值。

func (ctx *clevergo.Context) error {
    name := ctx.Params.String("name")
    page, err := ctx.Params.Int("page")
    num, err := ctx.Params.Int64("num")
    amount, err := ctx.Params.Uint64("amount")
    enable, err := ctx.Params.Bool("enable")
    price, err := ctx.Params.Float64("price")
    return err
}

静态文件

router.ServeFiles("/static/*filepath", http.Dir("/path/to/static"))

// 有时候，将 http.FileServer 作为 NotFound 处理器很有用处。
// 比如 "/favicon.ico"。
router.NotFound = http.FileServer(http.Dir("public"))

反向路由生成

queryPost := func (ctx *clevergo.Context) error {
    // 通过匹配路由生成 URL
    url, _ := ctx.Route.URL("year", "2020", "month", "02", "slug", "hello world")
    return nil
}

router.Get("/posts/:year/:month/:slug", queryPost, router.RouteName("post"))

// 通过命名路由生成 URL
url, _ := router.URL("post", "year", "2020", "month", "02", "slug", "hello world")

错误处理器

错误处理器可以自定义错误响应。

type MyErrorHandler struct {
    Tmpl *template.Template
}

func (meh MyErrorHandler) Handle(ctx *clevergo.Context, err error) {
    // 显示一个错误页面。
    if err := meh.Tmpl.Execute(ctx.Response, err); err != nil {
        ctx.Error(err.Error(), http.StatusInternalServerError)
    }
}

router.ErrorHandler = MyErrorHandler{
    Tmpl: template.Must(template.New("error").Parse(`<html><body><h1>{{ .Error }}</h1></body></html>`)),
}

中间件

中间件是一个 Handle 函数。

authenticator := func(ctx *clevergo.Context) error {
    // authenticate 返回一个 user 和一个布尔值表示提供的凭证是否有效。
    if user, ok := authenticate(ctx); !ok {
        // 返回一个错误，以终止后续的中间件和 Handle。
        return clevergo.StatusError{http.StatusUnauthorized, http.StatusText(http.StatusUnauthorized)}
    }

    // 在中间件之间共享数据。
    ctx.WithValue("user", user)
    return nil
}

auth := func(ctx *clevergo.Context) error {
    ctx.WriteString(fmt.Sprintf("hello %v", ctx.Value("user")))
    return nil
}

router.Get("/auth", auth, RouteMiddleware(
    // 中间件，只在当前路由生效。
    authenticator,
))

// 全局路由，以 gorilla compress 中间件为例。
http.ListenAndServe(":8080", handlers.CompressHandler(router))

中间件也可以在路由组中使用。

路由组

router := clevergo.NewRouter()

api := router.Group("/api", clevergo.RouteGroupMiddleware(
    // APIs 的中间件，如：CORS、身份验证、授权验证等。
))

apiV1 := api.Group("/v1", clevergo.RouteGroupMiddleware(
    // middlewares for v1's APIs
))

apiV2 := api.Group("v2", clevergo.RouteGroupMiddleware(
    // middlewares for v2's APIs
))

RESTful APIs

router.Get("/users", queryUsers)
router.Post("/users", createUser)
router.Get("/users/:id", queryUser)
router.Put("/users/:id", updateUser)
router.Delete("/users/:id", deleteUser)

可以通过路由组对你的 APIs 进行版本化。

软件首页