Golang轻量级高性能HTTP路由插件库GoLobby/Router的使用

GoLobby Router简介

GoLobby Router是一个轻量级但功能强大的Go语言HTTP路由器。它基于Go HTTP包构建，并使用基数树提供以下特性：

• 基于HTTP方法和URI的路由
• 路由参数和参数模式
• 路由通配符
• 中间件
• HTTP响应（如JSON、XML、文本、空、文件和重定向）
• 静态文件服务
• 无额外开销！
• 零依赖！

安装

要安装此包，请在项目目录中运行以下命令：

go get github.com/golobby/router

快速入门

以下示例展示了如何使用router包：

package main

import (
    "github.com/golobby/router"
    "log"
    "net/http"
)

func main() {
    r := router.New()
    
    r.GET("/", func(c router.Context) error {
        // c.Request()是原始的http.Request
        // c.Response()是原始的http.ResponseWriter
        return c.Text(http.StatusOK, "Hello from GoLobby Router!")
    })
    
    r.PUT("/products/:id", func(c router.Context) error {
        return c.Text(http.StatusOK, "Update product with ID: "+c.Parameter("id"))
    })
    
    log.Fatalln(r.Start(":8000"))
}

HTTP方法

您可以使用Map()方法声明路由。它接受HTTP方法和路径（URI）。对于最常用的HTTP方法，还提供了一些便捷方法，包括GET、POST、PUT、PATCH、DELETE、HEAD和OPTIONS。Any()方法定义处理任何HTTP方法的路由。

package main

import (
    "github.com/golobby/router"
    "log"
    "net/http"
)

func Handler(c router.Context) error {
    return c.Text(http.StatusOK, "Hello from GoLobby Router!")
}

func main() {
    r := router.New()
    
    r.GET("/", Handler)
    r.POST("/", Handler)
    r.PUT("/", Handler)
    r.PATCH("/", Handler)
    r.DELETE("/", Handler)
    r.HEAD("/", Handler)
    r.OPTIONS("/", Handler)
    
    r.Any("/page", Handler)
    
    r.Map("GET", "/", Handler)
    r.Map("CUSTOM", "/", Handler)
        
    log.Fatalln(r.Start(":8000"))
}

路由参数

要指定路由参数，请在参数前加冒号，如:id。默认情况下，参数可以是任何内容，但您可以使用Define()方法确定正则表达式模式。当然，正则表达式模式会减慢您的应用程序，如果可能的话建议不要使用它们。

package main

import (
    "github.com/golobby/router"
    "log"
    "net/http"
)

func main() {
    r := router.New()
    
    // "id"参数必须是数字
    r.Define("id", "[0-9]+")
   
    // 带一个参数的路由
    r.GET("/posts/:id", func(c router.Context) error {
        return c.Text(http.StatusOK, c.Parameter("id"))
    })
    
    // 带多个参数的路由
    r.GET("/posts/:id/comments/:cid", func(c router.Context) error {
        return c.JSON(http.StatusOK, c.Parameters())
    })
    
    log.Fatalln(r.Start(":8000"))
}

路由组

您可以将具有相似属性的路由放在组中。目前支持前缀和中间件属性。

按前缀分组

package main

import (
    "github.com/golobby/router"
    "log"
    "net/http"
)

func main() {
    r := router.New()
    
    r.WithPrefix("/blog", func() {
        r.GET("/posts", PostsHandler)    // "/blog/posts"
        r.GET("/posts/:id", PostHandler) // "/blog/posts/:id"
        r.WithPrefix("/pages", func() {
            r.GET("/about", AboutHandler)     // "/blog/pages/about"
            r.GET("/contact", ContactHandler) // "/blog/pages/contact"
        })
    })
    
    log.Fatalln(r.Start(":8000"))
}

按中间件分组

package main

import (
    "github.com/golobby/router"
    "log"
    "net/http"
)

func AdminMiddleware(next router.Handler) router.Handler {
    return func(c router.Context) error {
        // 检查用户角色...
        return next(c)
    }
}

func main() {
    r := router.New()
    
    r.WithMiddleware(AdminMiddleware, func() {
        r.GET("/admin/users", UsersHandler)
        r.GET("/admin/products", ProductsHandler)
    })
    
    log.Fatalln(r.Start(":8000"))
}

响应

路由器内置了Empty、Redirect、Text、HTML、JSON、PrettyJSON、XML、PrettyXML和Bytes响应。

package main

import (
    "github.com/golobby/router"
    "github.com/golobby/router/pkg/response"
    "log"
    "net/http"
)

func main() {
    r := router.New()

    r.GET("/empty", func(c router.Context) error {
        return c.Empty(204)
    })

    r.GET("/redirect", func(c router.Context) error {
        return c.Redirect(301, "https://github.com/golobby/router")
    })

    r.GET("/text", func(c router.Context) error {
        return c.Text(200, "A text response")
    })

    r.GET("/html", func(c router.Context) error {
        return c.HTML(200, "<p>A HTML response</p>")
    })

    r.GET("/json", func(c router.Context) error {
        return c.JSON(200, User{"id": 13})
    })

    r.GET("/json-pretty", func(c router.Context) error {
        return c.PrettyJSON(200, response.M{"message": "A pretty JSON response!"})
    })

    r.GET("/xml", func(c router.Context) error {
        return c.XML(200, User{"id": 13})
    })

    r.GET("/xml-pretty", func(c router.Context) error {
        return c.PrettyXML(200, User{"id": 13})
    })

    r.GET("/bytes", func(c router.Context) error {
        return c.Bytes(200, []byte("Some bytes!"))
    })

    log.Fatalln(r.Start(":8000"))
}

错误处理

您的处理程序在处理HTTP请求时可能会返回错误。这个错误可能是由您的应用程序逻辑或HTTP响应失败产生的。默认情况下，路由器使用Golang的内置记录器将其记录到标准输出，并返回以下HTTP 500响应。

{"message": "Internal error."}

最佳实践是添加一个全局中间件来捕获所有这些错误，记录并以您需要的方式处理它们。

package main

import (
    "github.com/golobby/router"
    "log"
    "net/http"
)

func main() {
    r := router.New()
    
    // 错误处理中间件
    r.AddMiddleware(func (next router.Handler) router.Handler {
        return func(c router.Context) error {
            if err := next(c); err != nil {
                myLogger.log(err)
                return c.HTML(500, "<p>Something went wrong</p>")
            }
            
            // 没有错误会传递给路由器基础处理程序
            return nil
        }
    })

    r.GET("/", Handler)
    
    log.Fatalln(r.Start(":8000"))
}