Golang轻量级高性能零内存分配HTTP路由插件库LARS的使用

LARS简介

LARS是一个基于基数树的快速、零内存分配的Go语言HTTP路由器。它是一个轻量级的高性能路由库，可以作为创建自定义Web框架的基础。

关键特性

• 上下文是一个接口 - 允许传递框架/全局/应用程序特定的变量
• 智能路由逻辑 - 防止添加不一致的路由URL
• 简单统一的中间件和处理器 - 两者定义完全相同
• 自定义处理器 - 可以注册自定义处理器
• 多样化处理器支持 - 支持标准http.Handler、HandlerFunc等
• 快速高效 - 使用httprouter的定制版本

安装

go get -u github.com/go-playground/lars

基本使用示例

package main

import (
	"fmt"
	"net/http"

	"github.com/go-playground/lars"
	mw "github.com/go-playground/lars/_examples/middleware/logging-recovery"
)

func main() {
	l := lars.New()
	// LoggingAndRecovery只是一个示例，可以复制粘贴并根据需要修改
	l.Use(mw.LoggingAndRecovery)

	l.Get("/", HelloWorld)

	http.ListenAndServe(":3007", l.Serve())
}

// HelloWorld 示例处理器
func HelloWorld(c lars.Context) {
	c.Response().Write([]byte("Hello World"))

	// 也可以这样写，Response()符合http.ResponseWriter接口
	fmt.Fprint(c.Response(), "Hello World")
}

URL参数处理

l := l.New()

// 匹配的参数将存储在Context的params中，名为"id"
l.Get("/user/:id", UserHandler)

// 处理静态文件(c.Param(lars.WildcardParam)将返回剩余路径)
l.Get("/static/*", http.StripPrefix("/static/", http.FileServer(http.Dir("static"))))

路由分组

l.Use(LoggingAndRecovery)
...
l.Post("/users/add", ...)

// 创建一个用户分组，继承所有通过l.Use()注册的中间件
user := l.Group("/user/:userid")
user.Get("", ...)
user.Post("", ...)
user.Delete("/delete", ...)

contactInfo := user.Group("/contact-info/:ciid")
contactinfo.Delete("/delete", ...)

// 创建其他分组，并添加OtherHandler中间件
others := l.GroupWithMore("/others", OtherHandler)

// 创建一个不带中间件的admin分组，可以后续通过admin.Use()添加
admin := l.GroupWithNone("/admin")
admin.Use(SomeAdminSecurityMiddleware)

自定义上下文和处理器

// MyContext 是自定义上下文
type MyContext struct {
	*lars.Ctx  // 使用一点鸭子类型...
}

// CustomContextFunction 是应用程序特定的方法
func (mc *MyContext) CustomContextFunction() {
	// 做一些事情
}

// newContext 创建自定义上下文
func newContext(l *lars.LARS) lars.Context {
	return &MyContext{
		Ctx:        lars.NewContext(l),
	}
}

// castCustomContext 处理类型转换
func castCustomContext(c lars.Context, handler lars.Handler) {
	h := handler.(func(*MyContext))
	ctx := c.(*MyContext)
	h(ctx)
}

func main() {
	l := lars.New()
	l.RegisterContext(newContext) // 所有内容都会被缓存到池中
	l.RegisterCustomHandler(func(*MyContext) {}, castCustomContext)
	l.Use(Logger)

	l.Get("/", Home)

	http.ListenAndServe(":3007", l.Serve())
}

// Home 处理器 - 注意接收者是*MyContext
func Home(c *MyContext) {
	c.CustomContextFunction()
	...
}

请求体解码

// 第一个参数表示是否包含URL查询参数
if err := c.Decode(true, maxBytes, &user); err != nil {
	log.Println(err)
}

性能

LARS使用httprouter的定制版本，性能非常高。在MacBook Pro (15-inch, 2017) 3.1 GHz Intel Core i7 16GB DDR3上使用Go 1.9.2的测试结果如下：

BenchmarkLARS_Param        	20000000	        51.6 ns/op	       0 B/op	       0 allocs/op
BenchmarkLARS_Param5       	20000000	        85.7 ns/op	       0 B/op	       0 allocs/op
BenchmarkLARS_Param20      	10000000	       215 ns/op	       0 B/op	       0 allocs/op
BenchmarkLARS_ParamWrite   	20000000	        94.3 ns/op	       0 B/op	       0 allocs/op
BenchmarkLARS_GithubStatic 	20000000	        68.7 ns/op	       0 B/op	       0 allocs/op
BenchmarkLARS_GithubParam  	20000000	       103 ns/op	       0 B/op	       0 allocs/op
BenchmarkLARS_GithubAll    	  100000	     21066 ns/op	       0 B/op	       0 allocs/op

许可证

• MIT License, Copyright © 2015 Dean Karn
• BSD License, Copyright © 2013 Julien Schmidt. All rights reserved.

LARS是一个非常适合需要高性能路由的场景的选择，特别是当你需要构建自己的Web框架时，它提供了足够的灵活性和控制力。