Elton 一个高性能，简单的Go Web框架

Elton的实现参考了koa，统一中间件的形式，方便定制各类中间件，所有中间件的处理方式都非常简单，如果需要交付给下一中间件，则调用Context.Next()。

Go Web框架

访问GitHub主页

共34Star

详细介绍

Elton

Elton的实现参考了koa以及echo，统一中间件的形式，方便定制各类中间件，所有中间件的处理方式都非常简单，如果需要转给下一中间件，则调用Context.Next()，如果当前中间件出错，则返回Error结束调用，如果无需要转至下一中间件，则无需要调用Context.Next()。对于成功返回只需将响应数据赋值Context.Body = 响应数据，由响应中间件将Body转换为相应的响应数据，如JSON等。

Hello, World!

下面我们来演示如何使用elton返回Hello, World!，并且添加了一些常用的中间件。

package main

import (
	"github.com/vicanso/elton"
	"github.com/vicanso/elton/middleware"
)

func main() {
	e := elton.New()

	// panic处理
	e.Use(middleware.NewRecover())

	// 出错处理
	e.Use(middleware.NewDefaultError())

	// 默认的请求数据解析
	e.Use(middleware.NewDefaultBodyParser())

	// not modified 304的处理
	e.Use(middleware.NewDefaultFresh())
	e.Use(middleware.NewDefaultETag())

	// 响应数据转换为json
	e.Use(middleware.NewDefaultResponder())

	e.GET("/", func(c *elton.Context) error {
		c.Body = &struct {
			Message string `json:"message,omitempty"`
		}{
			"Hello, World!",
		}
		return nil
	})

	e.GET("/books/{id}", func(c *elton.Context) error {
		c.Body = &struct {
			ID string `json:"id,omitempty"`
		}{
			c.Param("id"),
		}
		return nil
	})

	e.POST("/login", func(c *elton.Context) error {
		c.SetContentTypeByExt(".json")
		c.Body = c.RequestBody
		return nil
	})

	err := e.ListenAndServe(":3000")
	if err != nil {
		panic(err)
	}
}

go run main.go

之后在浏览器中打开http://localhost:3000/则能看到返回的Hello, World!。

路由

elton每个路由可以添加多个中间件处理函数，根据路由与及HTTP请求方法指定不同的路由处理函数。而全局的中间件则可通过Use方法来添加。

e.Use(...func(*elton.Context) error)
e.Method(path string, ...func(*elton.Context) error)

e 为elton实例化对象
Method 为HTTP的请求方法，如：GET, PUT, POST等等
path 为HTTP路由路径
func(*elton.Context) error 为路由处理函数（中间件），当匹配的路由被请求时，对应的处理函数则会被调用

路由示例

elton的路由使用chi的路由简化而来，下面是两个简单的示例。

// 带参数路由
e.GET("/users/{type}", func(c *elton.Context) error {
	c.BodyBuffer = bytes.NewBufferString(c.Param("type"))
	return nil
})

// 带中间件的路由配置
e.GET("/users/me", func(c *elton.Context) error {
	c.Set("account", "tree.xie")
	return c.Next()
}, func(c *elton.Context) error {
	c.BodyBuffer = bytes.NewBufferString(c.GetString("account"))
	return nil
})

中间件

简单方便的中间件机制，依赖各类定制的中间件，通过各类中间件的组合，方便快捷实现各类HTTP服务，简单介绍数据响应与出错处理的中间件。

responder

HTTP请求响应数据时，需要将数据转换为Buffer返回，而在应用时响应数据一般为各类的struct或map等结构化数据，因此elton提供了Body(interface{})字段来保存这些数据，再使用自定义的中间件将数据转换为对应的字节数据，elton-responder提供了将struct(map)转换为json字节并设置对应的Content-Type，对于string([]byte)则直接输出。

package main

import (
	"github.com/vicanso/elton"
	"github.com/vicanso/elton/middleware"
)

func main() {

	e := elton.New()
	// 对响应数据 c.Body 转换为相应的json响应
	e.Use(middleware.NewDefaultResponder())

	getSession := func(c *elton.Context) error {
		c.Set("account", "tree.xie")
		return c.Next()
	}
	e.GET("/users/me", getSession, func(c *elton.Context) (err error) {
		c.Body = &struct {
			Name string `json:"name"`
			Type string `json:"type"`
		}{
			c.GetString("account"),
			"vip",
		}
		return
	})

	err := e.ListenAndServe(":3000")
	if err != nil {
		panic(err)
	}
}

error

当请求处理失败时，直接返回error则可，elton从error中获取出错信息并输出。默认的出错处理并不适合实际应用场景，建议使用自定义出错类配合中间件，便于统一的错误处理，程序监控，下面是引入错误中间件将出错转换为json形式的响应。

package main

import (
	"github.com/vicanso/elton"
	"github.com/vicanso/elton/middleware"
	"github.com/vicanso/hes"
)

func main() {

	e := elton.New()
	// 指定出错以json的形式返回
	e.Use(middleware.NewError(middleware.ErrorConfig{
		ResponseType: "json",
	}))

	e.GET("/", func(c *elton.Context) (err error) {
		err = &hes.Error{
			StatusCode: 400,
			Category:   "users",
			Message:    "出错啦",
		}
		return
	})

	err := e.ListenAndServe(":3000")
	if err != nil {
		panic(err)
	}
}

更多的中间件可以参考middlewares

bench

BenchmarkRoutes-8                	 5626749	       220 ns/op	     152 B/op	       3 allocs/op
BenchmarkGetFunctionName-8       	121043851	         9.61 ns/op	       0 B/op	       0 allocs/op
BenchmarkContextGet-8            	14413359	        82.3 ns/op	      16 B/op	       1 allocs/op
BenchmarkContextNewMap-8         	182361898	         6.60 ns/op	       0 B/op	       0 allocs/op
BenchmarkConvertServerTiming-8   	 1377422	       878 ns/op	     360 B/op	      11 allocs/op
BenchmarkGetStatus-8             	1000000000	         0.275 ns/op	       0 B/op	       0 allocs/op
BenchmarkStatic-8                	   21412	     55142 ns/op	   25940 B/op	     628 allocs/op
BenchmarkGitHubAPI-8             	   13143	     91191 ns/op	   33816 B/op	     812 allocs/op
BenchmarkGplusAPI-8              	  271857	      4359 ns/op	    2144 B/op	      52 allocs/op
BenchmarkParseAPI-8              	  136795	      8806 ns/op	    4287 B/op	     104 allocs/op
BenchmarkRWMutexSignedKeys-8     	34447268	        33.8 ns/op
BenchmarkAtomicSignedKeys-8      	1000000000	         0.412 ns/op

推荐源码

暂无源码更多源码...