tsing

README

Tsing

原dxvgef/httpdispatcher项目已更名为Tsing

使用Go语言开发，基于高性能的julienschmidt/httprouter路由包实现的HTTP调度器，与net/http标准包配合使用。

没有对httprouter包做任何修改，仅轻量封装实现了更多功能，同时保留net/http标准包的API访问，高度可定制性，非常适合自行整合第三方包进行二次开发扩展功能。

• 基本示例
• 路由和路由组 tsing.Router
• 路由处理器 tsing.Handler
• 中间件处理器 tsing.MiddlewareHandler
• 事件处理器 tsing.EventHandler
• 会话上下文 tsing.Context
• 整合dxvgef/filter实现请求参数验证
• 客户端输出 String/JSON
• 整合CloudyKit/jet实现HTML模板渲染
• CORS跨域资源共享控制
• 整合dxvgef/session实现Session
• 整合dxvgef/token实现JWT(JSON Web Token)
• 整合uber-go/zap记录事件日志
• 优雅关闭(Graceful Shutdown)

dxvgef/tsing-demo是一个基于Tsing 整合常见功能的完整示例，可以做为项目初始化使用

Documentation

Index

• type App
  • func New() *App
  • func (app *App) ServeHTTP(resp http.ResponseWriter, req *http.Request)
• type AppConfig
• type Context
  • func (ctx *Context) GetValue(key string) interface{}
  • func (ctx *Context) Next()
  • func (ctx *Context) Param(key string) (string, bool)
  • func (ctx *Context) ParamValue(key string) string
  • func (ctx *Context) Post(key string) (string, bool)
  • func (ctx *Context) PostValue(key string) string
  • func (ctx *Context) Posts() url.Values
  • func (ctx *Context) Query(key string) (string, bool)
  • func (ctx *Context) QueryValue(key string) string
  • func (ctx *Context) Querys() url.Values
  • func (ctx *Context) Redirect(code int, url string) error
  • func (ctx *Context) RemoteIP() string
  • func (ctx *Context) RouteValues() []httprouter.Param
  • func (ctx *Context) SetValue(key string, value interface{})
• type Event
• type EventHandler
• type Handler
• type RouterGroup
  • func (r *RouterGroup) DELETE(path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) FILE(url string, local string)
  • func (r *RouterGroup) GET(path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) GROUP(path string, handlers ...Handler) *RouterGroup
  • func (r *RouterGroup) HEAD(path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) Handle(method string, path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) OPTIONS(path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) PATCH(path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) PATH(url string, local string, list bool)
  • func (r *RouterGroup) POST(path string, handler Handler, middlewareHandlers ...Handler)
  • func (r *RouterGroup) PUT(path string, handler Handler, middlewareHandlers ...Handler)

Types

type App

type App struct {
	Config AppConfig    // 配置
	Router *RouterGroup // 路由器
	// contains filtered or unexported fields
}

框架实例

func New

func New() *App

返回一个基本配置的框架实例

func (*App) ServeHTTP

func (app *App) ServeHTTP(resp http.ResponseWriter, req *http.Request)

实现http.Handler接口

type AppConfig

type AppConfig struct {
	// Recovery              bool         // 启用自动恢复
	RedirectTrailingSlash bool         // 自动重定向到结尾带有或不带有斜杠的URL
	FixPath               bool         // 清理URL中的不规范路径分隔符，例如//和../
	HandleOPTIONS         bool         // 自定响应OPTIONS请求
	EventHandler          EventHandler // 事件处理器，如果未传值则认为不记录事件
	EventTrigger          bool         // 记录事件的触发信息(影响性能)
	EventTrace            bool         // 启用事件的跟踪信息(影响性能)
	EventShortPath        bool         // 使用事件触发信息的短文件名
}

框架配置

type Context

type Context struct {
	Request *http.Request
	// responseWriter customResponseWriter  // 自定义response
	// ResponseWriter _CustomResponseWriter // 用自定义resp替代http.resp
	ResponseWriter http.ResponseWriter
	// contains filtered or unexported fields
}

连接上下文

func (*Context) GetValue

func (ctx *Context) GetValue(key string) interface{}

获取ctx里的值，取出后根据写入的类型自行断言

func (*Context) Next

func (ctx *Context) Next()

继续执行下一个中间件或处理器

func (*Context) Param

func (ctx *Context) Param(key string) (string, bool)

获取路由参数值

func (*Context) ParamValue

func (ctx *Context) ParamValue(key string) string

获取某个路由参数值的string类型

func (*Context) Post

func (ctx *Context) Post(key string) (string, bool)

获取某个POST参数值

func (*Context) PostValue

func (ctx *Context) PostValue(key string) string

获取某个POST参数值的string类型

func (*Context) Posts

func (ctx *Context) Posts() url.Values

获取所有POST参数值

func (*Context) Query

func (ctx *Context) Query(key string) (string, bool)

获取某个GET参数值

func (*Context) QueryValue

func (ctx *Context) QueryValue(key string) string

获取某个GET参数值的string类型

func (*Context) Querys

func (ctx *Context) Querys() url.Values

获取所有GET参数值

func (*Context) Redirect

func (ctx *Context) Redirect(code int, url string) error

向客户端发送重定向响应

func (*Context) RemoteIP

func (ctx *Context) RemoteIP() string

透过nginx反向代理获得客户端真实IP

func (*Context) RouteValues

func (ctx *Context) RouteValues() []httprouter.Param

获取所有路由参数值

func (*Context) SetValue

func (ctx *Context) SetValue(key string, value interface{})

在ctx里存储值，如果key存在则替换值

type Event

type Event struct {
	Status         int      // HTTP状态码
	Message        error    // 消息文本
	Trigger        _Trigger // 触发信息
	Trace          []string // 跟踪信息
	ResponseWriter http.ResponseWriter
	Request        *http.Request
}

事件结构

type EventHandler

type EventHandler func(*Event)

事件处理器类型

type Handler

type Handler func(*Context) error

路由处理器

type RouterGroup

type RouterGroup struct {
	// contains filtered or unexported fields
}

路由组

func (*RouterGroup) DELETE

func (r *RouterGroup) DELETE(path string, handler Handler, middlewareHandlers ...Handler)

DELETE 路由

func (*RouterGroup) FILE

func (r *RouterGroup) FILE(url string, local string)

FILE 定义路由到文件，不支持路由组和中间件

func (*RouterGroup) GET

func (r *RouterGroup) GET(path string, handler Handler, middlewareHandlers ...Handler)

GET 路由

func (*RouterGroup) GROUP

func (r *RouterGroup) GROUP(path string, handlers ...Handler) *RouterGroup

GROUP 路由组

func (*RouterGroup) HEAD

func (r *RouterGroup) HEAD(path string, handler Handler, middlewareHandlers ...Handler)

HEAD 路由

func (*RouterGroup) Handle

func (r *RouterGroup) Handle(method string, path string, handler Handler, middlewareHandlers ...Handler)

Handle 路由

func (*RouterGroup) OPTIONS

func (r *RouterGroup) OPTIONS(path string, handler Handler, middlewareHandlers ...Handler)

OPTIONS 路由

func (*RouterGroup) PATCH

func (r *RouterGroup) PATCH(path string, handler Handler, middlewareHandlers ...Handler)

PATCH 路由

func (*RouterGroup) PATH

func (r *RouterGroup) PATH(url string, local string, list bool)

PATH 定义路由到目录，不支持路由组和中间件

func (*RouterGroup) POST

func (r *RouterGroup) POST(path string, handler Handler, middlewareHandlers ...Handler)

POST 路由

func (*RouterGroup) PUT

func (r *RouterGroup) PUT(path string, handler Handler, middlewareHandlers ...Handler)

PUT 路由