Golang高性能支持HTTP/2的多路复用路由插件库xmux的使用

简介

Xmux是一个基于xhandler的轻量级高性能HTTP请求多路复用器。Xmux从httprouter的分支中获得其速度优势，路由参数存储在context中而不是作为额外参数传递。

特性

• 精确匹配：每个请求只能精确匹配一个路由或完全不匹配，避免了意外匹配
• 自动处理尾部斜杠：自动重定向缺少或多余的尾部斜杠
• 路径自动校正：可以修正大小写错误并移除多余的路径元素
• 路由参数：直接在路由模式中定义参数，无需手动解析URL
• 路由组：创建路由组而不会产生每次请求的开销
• 零垃圾：匹配和分发过程不产生垃圾数据
• 恐慌恢复：可以设置恐慌处理程序来处理HTTP请求处理期间的恐慌
• 自定义NotFound和MethodNotAllowed处理程序

基本用法

package main

import (
	"fmt"
	"log"
	"net/http"
	"context"

	"github.com/rs/xhandler"
	"github.com/rs/xmux"
)

// 定义处理函数
func Index(ctx context.Context, w http.ResponseWriter, r *http.Request) {
	fmt.Fprint(w, "Welcome!\n")
}

func Hello(ctx context.Context, w http.ResponseWriter, r *http.Request) {
	// 从context中获取路由参数
	fmt.Fprintf(w, "hello, %s!\n", xmux.Param(ctx, "name"))
}

func main() {
	// 创建新的mux实例
	mux := xmux.New()
	
	// 注册路由和处理函数
	mux.GET("/", xhandler.HandlerFuncC(Index))
	mux.GET("/hello/:name", xhandler.HandlerFuncC(Hello))

	// 启动HTTP服务器
	log.Fatal(http.ListenAndServe(":8080", xhandler.New(context.Background(), mux)))
}

中间件链

package main

import (
	"context"
	"fmt"
	"log"
	"net/http"
	"time"

	"github.com/rs/xhandler"
	"github.com/rs/xmux"
)

func main() {
	// 创建中间件链
	c := xhandler.Chain{}

	// 添加上下文感知的中间件
	c.UseC(xhandler.CloseHandler)
	c.UseC(xhandler.TimeoutHandler(2 * time.Second))

	// 创建mux实例
	mux := xmux.New()

	// 使用中间件链处理路由
	mux.GET("/welcome/:name", xhandler.HandlerFuncC(func(ctx context.Context, w http.ResponseWriter, req *http.Request) {
		fmt.Fprintf(w, "Welcome %s!", xmux.Param(ctx, "name"))
	}))

	// 启动服务器
	if err := http.ListenAndServe(":8080", c.Handler(mux)); err != nil {
		log.Fatal(err)
	}
}

路由参数

Xmux支持两种类型的参数：

1. 命名参数：格式为:name，只匹配单个路径段

   user := xmux.Param(ctx, "user")
   

2. 通配参数：格式为*name，匹配所有内容，必须放在路径末尾

   Pattern: /src/*filepath
    /src/                     match
    /src/somefile.go          match
    /src/subdir/somefile.go   match
   

多域名/子域名支持

// 定义HostSwitch类型实现xhandler.HandlerC接口
type HostSwitch map[string]xhandler.HandlerC

func (hs HostSwitch) ServeHTTPC(ctx context.Context, w http.ResponseWriter, r *http.Request) {
	if handler := hs[r.Host]; handler != nil {
		handler.ServeHTTPC(ctx, w, r)
	} else {
		http.Error(w, "Forbidden", 403)
	}
}

func main() {
	c := xhandler.Chain{}
	mux := xmux.New()
	mux.GET("/", Index)
	mux.GET("/hello/:name", Hello)

	// 为不同域名配置不同路由
	hs := make(HostSwitch)
	hs["example.com:12345"] = mux

	if err := http.ListenAndServe(":12345", c.Handler(hs)); err != nil {
		log.Fatal(err)
	}
}

基准测试

Xmux性能接近httprouter，虽然由于使用context存储参数略有开销，但仍然优于其他路由器：

BenchmarkXhandler_APIStatic-8     50000000    39.6 ns/op    0 B/op    0 allocs/op
BenchmarkChi_APIStatic-8           3000000   439 ns/op    144 B/op    5 allocs/op
BenchmarkHTTPRouter_APIStatic-8   50000000    37.3 ns/op    0 B/op    0 allocs/op

工作原理

Xmux使用压缩的动态trie（基数树）结构进行高效匹配，每个请求方法管理单独的树，子节点按优先级排序（基于注册的处理程序数量）。

基本认证示例

func BasicAuth(user, pass []byte, next xhandler.HandlerC) xhandler.HandlerC {
	return xhandler.HandlerFuncC(func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		const basicAuthPrefix string = "Basic "
		
		auth := r.Header.Get("Authorization")
		if strings.HasPrefix(auth, basicAuthPrefix) {
			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) {
					next.ServeHTTPC(ctx, w, r)
					return
				}
			}
		}

		w.Header().Set("WWW-Authenticate", "Basic realm=Restricted")
		http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
	})
}

func main() {
	user := []byte("gordon")
	pass := []byte("secret!")

	c := xhandler.Chain{}
	mux := xmux.New()
	mux.GET("/", xhandler.HandlerFuncC(Index))
	mux.GET("/protected/", BasicAuth(user, pass, xhandler.HandlerFuncC(Protected)))

	log.Fatal(http.ListenAndServe(":8080", c.Handler(mux)))
}

Xmux是一个高效、功能丰富的路由库，特别适合需要高性能和HTTP/2支持的Golang web应用。