Golang高性能HTTP路由器插件库Violetear的使用

Violetear是一个Go语言的高性能HTTP路由器库，具有以下设计目标：

• 保持简单小巧，避免不必要的复杂性（遵循KISS原则）
• 支持静态和动态路由
• 兼容中间件，满足http.Handler接口
• 中间件之间共享上下文
• 每个请求的Trace Request-ID
• 原生支持HTTP/2
• 基于Accept头application/vnd.*的版本控制

基本使用

安装

import "github.com/nbari/violetear"

示例代码

package main

import (
    "github.com/nbari/violetear"
    "log"
    "net/http"
    "time"
)

// 捕获所有路由的处理函数
func catchAll(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("I'm catching all\n"))
}

// GET请求处理函数
func handleGET(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("I handle GET requests\n"))
}

// POST请求处理函数
func handlePOST(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("I handle POST requests\n"))
}

// UUID路由处理函数
func handleUUID(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("I handle dynamic requests\n"))
}

func main() {
    router := violetear.New()
    router.LogRequests = true  // 启用请求日志
    router.RequestID = "Request-ID"  // 设置请求ID头名称

    // 添加UUID正则表达式
    router.AddRegex(":uuid", `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`)

    // 注册路由
    router.HandleFunc("*", catchAll)  // 捕获所有路由
    router.HandleFunc("/method", handleGET, "GET")  // 只处理GET请求
    router.HandleFunc("/method", handlePOST, "POST")  // 只处理POST请求
    router.HandleFunc("/:uuid", handleUUID, "GET,HEAD")  // 处理UUID格式的GET和HEAD请求

    // 配置HTTP服务器
    srv := &http.Server{
        Address:     ":8080",
        Handler:     router,
        ReadTimeout: 5 * time.Second,
        WriteTimeout: 7 * time.Second,
        MaxHeaderBytes: 1 << 20,
    }
    
    // 启动服务器
    log.Fatal(srv.ListenAndServe())
}

路由类型

静态路由

router.HandleFunc("/static/path", handler, "GET")

动态路由

// 先定义正则表达式
router.AddRegex(":ip", `^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$`)

// 使用动态参数
router.HandleFunc("/command/ping/:ip", ip_handler, "GET")

通配路由

router.HandleFunc("/command/ping/*", any_handler, "GET, HEAD")

自定义处理

404处理

func my404() http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        http.Error(w, "Not found", 404)
    })
}

router := violetear.New()
router.NotFoundHandler = my404()

405处理

router.NotAllowedHandler = customHandler

异常处理

router.PanicHandler = panicHandler

中间件支持

Violetear使用Alice来处理中间件链：

package main

import (
    "context"
    "log"
    "net/http"
    
    "github.com/nbari/violetear"
    "github.com/nbari/violetear/middleware"
)

// 通用头中间件
func commonHeaders(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("X-App-Version", "1.0")
        next.ServeHTTP(w, r)
    })
}

// 中间件1
func middlewareOne(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        log.Println("Executing middlewareOne")
        ctx := context.WithValue(r.Context(), "key", "value")
        next.ServeHTTP(w, r.WithContext(ctx))
        log.Println("Executing middlewareOne again")
    })
}

func catchAll(w http.ResponseWriter, r *http.Request) {
    log.Printf("Executing finalHandler\nkey:%s\n", 
        r.Context().Value("key"))
    w.Write([]byte("I catch all"))
}

func main() {
    router := violetear.New()
    
    // 创建中间件链
    stdChain := middleware.New(commonHeaders, middlewareOne)
    
    // 应用中间件链
    router.Handle("/", stdChain.ThenFunc(catchAll), "GET,HEAD")
    
    log.Fatal(http.ListenAndServe(":8080", router))
}

上下文和命名参数

Violetear使用net/context在处理器和中间件之间传递数据：

func handleUUID(w http.ResponseWriter, r *http.Request) {
    // 获取路由参数
    params := r.Context().Value(violetear.ParamsKey).(violetear.Params)
    
    // 使用GetParam获取单个参数
    uuid := violetear.GetParam("uuid", r)
    
    // 添加上下文值
    ctx := context.WithValue(r.Context(), "key", "my-value")
    
    // 输出参数
    fmt.Fprintf(w, "Named parameter: %q, uuid: %q, key: %s",
        params[":uuid"],
        uuid,
        ctx.Value("key"),
    )
}

对于重复的命名参数（如/test/:uuid/:uuid/），可以使用：

params := r.Context().Value(violetear.ParamsKey).(violetear.Params)
uuid := params[":uuid"].([]string)
// 或
uuid := violetear.GetParams("uuid")
fmt.Println(uuid[0], uuid[1])

Violetear是一个功能强大且灵活的路由器库，特别适合需要高性能和中间件支持的HTTP服务开发。