README
¶
bingo-router
基于httprouter的路由模块
简介
这个包是为了自己的go web项目 Bingo 所开发的模块之一，负责核心路由功能，这里将其抽出来作为单独包， 可以轻松的在其他项目中使用，而无需依赖 Bingo 框架
特性:
-
路由快速查找
-
动态路由传参
-
子路由支持(路由组)
-
中间件支持
bingo-router 基于 httprouter , 性能强劲， httprouter 拥有的特性，bingo-router也有，并且参考 Laravel 的 Pipeline 功能，为 bingo-router 添加中间件支持，可以快速实现拦截器等常见功能
后续准备加入的功能
-
会话管理
-
路由跳转
-
服务的平滑重启和关闭
-
工具方法补充(e.g.封装json返回等方法)
-
测试代码补充
安装
go get -u github.com/silsuer/bingo-router
bingo-router 使用 glide 管理依赖，如果遇到无法 go install 问题，请先安装
glide后，去$PATH/src/github.com/silsuer/bingo-router目录下执行glide install命令安装依赖
使用
bingo-router 已内置在 [Bingo](https://github.com/silsuer/bingo) 框架中，开箱即用，对于第三方项目:
- 初始化路由器对象
router:
// 创建一个路由器
router := bingo_router.New()
路由器 Router 上挂载路由 Route，一个服务只能存在一个 Router，可存在多个Route，不要弄混
- 创建路由
route := bingo_router.NewRoute().Get("/").Target(func(c *bingo_router.Context) {
fmt.Fprint(c.Writer,"hello! bingo-router!")
})
目前上下文对象context只是对 httprouter 中对象的一个简单封装,用法与 httprouter 完全一致:
type Context struct {
Writer http.ResponseWriter // 响应
Request *http.Request // 请求
Params Params //参数
}
NewRoute 方法将会返回一个路由指针，可以调用:
-
Get()方法，设定为Get方法 -
Post()方法，设定为Get方法 -
Patch()方法，设定为Get方法 -
Put()方法，设定为Get方法 -
Delete()方法，设定为Get方法 -
Handle()方法，设定为Get方法 -
Target()方法，指定该路由所对应的方法 -
Middleware()方法，设定一个将在其中设置的中间件 -
MiddlewareGroup()方法，批量设置中间件 -
Prefix()方法，设置路由前缀，该前缀将对该路由的所有子路由有效，对当前路由无效 -
Mount()方法，设置子路由
- 将路由挂载到路由器中
router.Mount(route)
路由器 Router 的
- 开启服务器
http.ListenAndServe(":8080", r)
- 在浏览器中访问
http://localhost:8080, 可以看到输出hello, bingo-router!
进阶
1. 使用中间件
使用 NewRoute() 方法之后将会获得一个 Route 对象指针，采用责任链模式，随意进行链式操作:
r2 := bingo_router.NewRoute().Get("/test").Middleware(func(c *bingo_router.Context, next func(c *bingo_router.Context)) {
fmt.Fprint(c.Writer,"middleware")
next(c)
}).Target(func(c *bingo_router.Context) {
fmt.Fprintln(c.Writer,"target")
})
中间件是一种 MiddlewareHandle 类型的方法 func(c *Context, next func(c *Context))
Middleware 方法传入一个回调函数，该函数接受两个参数，第一个参数context 是上下文，是封装的http.ResponseWriter,*http.Request和httprouter.Params
第二个参数是 next 方法，用来指定何时跳入下一个中间件，主要是用来实现前置中间件和后置中间件功能，当执行 next 方法后，将会跳入下一个中间件，直到所有中间件运行完毕后，才会继续执行下面的代码
例如，上面的r2的效果是输出:
middleware
target
如果将中间件中的next() 方法向上提一行的话:
r2 := bingo_router.NewRoute().Get("/test").Middleware(func(c *bingo_router.Context, next func(c *bingo_router.Context)) {
next(c)
fmt.Fprint(c.Writer,"middleware")
}).Target(func(c *bingo_router.Context) {
fmt.Fprintln(c.Writer,"target")
})
这样将会输出:
target
middleware
这样就可以实现后置中间件的效果了，可以做一些访问完控制器方法之后的后续工作
当然，如果不在中间件中调用 next() 方法，请求就将在这个中间件中终止。
2. 使用中间件组
Route 对象的 MiddlewareGroup() 方法可以实现批量注册中间件的功能，传入一个 MiddlwareHandle 的数组即可，不再赘述
3. 使用子路由和路由前缀
在 Laravel 中，我们经常会用到路由组的概念，可以方便的进行整体控制，在 bingo-router 中，我也实现了这样的功能，但是bingo-router中没有路由组的概念，可以使用子路由实现类似效果,
调用 Route 对象的 Mount 方法添加子路由:
bingo_router.NewRoute().Prefix("/api").Middleware(MiddlewareFunction).Mount(func(b *bingo_router.Builder) {
b.NewRoute().Get("/mount").Target(func(c *bingo_router.Context) {
fmt.Fprint(c.Writer, "hello mount")
})
b.NewRoute().Get("/mount2").Target(func(c *bingo_router.Context) {
fmt.Fprint(c.Writer, "hello mount2")
})
})
Prefix 方法，传入一个字符串，这个字符串将作用在所有子路由路径前，例如上面的代码，我们最终的访问路径就是 /api/mount和/api/mount2
Mount 方法传入一个 Builder 指针，我们可以调用 Builder对象的 NewRoute() 方法为当前路由添加子路由,例如上面的代码，我们在访问 /api/mount和/api/mount2时都会经过我们指定的MiddlewareFunction 中间件
这个包还没有完全开发完成，后续会继续补充，也会在这两天内内置到 Bingo 框架中
请大家多多关注主框架 Bingo , 欢迎 STAR 、 PR
Documentation
¶
Overview ¶
// +build go1.7
Index ¶
- Constants
- func CleanPath(p string) string
- type Builder
- type Context
- func (c *Context) File(key string) (multipart.File, *multipart.FileHeader, error)
- func (c *Context) Get(key string) string
- func (c *Context) GetWithDefault(key, def string) string
- func (c *Context) Post(key string) string
- func (c *Context) PostWithDefault(key, def string) string
- func (c *Context) Redirect(path string)
- func (c *Context) ResponseJson(data interface{})
- func (c *Context) String(data string)
- type Controller
- type Handle
- type IController
- type MiddlewareHandle
- type Output
- type Param
- type Params
- type Pipeline
- type Route
- func (r *Route) Delete(path string) *Route
- func (r *Route) Get(path string) *Route
- func (r *Route) Middleware(h MiddlewareHandle) *Route
- func (r *Route) MiddlewareGroup(hg []MiddlewareHandle) *Route
- func (r *Route) Mount(rr func(b *Builder)) *Route
- func (r *Route) Name(name string) *Route
- func (r *Route) Patch(path string) *Route
- func (r *Route) Post(path string) *Route
- func (r *Route) Prefix(prefix string) *Route
- func (r *Route) Put(path string) *Route
- func (r *Route) Request(method string, path string, target TargetHandle) *Route
- func (r *Route) Resource(path string, controller IController) *Route
- func (r *Route) Target(target TargetHandle) *Route
- type Router
- func (r *Router) DELETE(path string, route *Route)
- func (r *Router) GET(path string, route *Route)
- func (r *Router) HEAD(path string, route *Route)
- func (r *Router) Handle(method, path string, route *Route)
- func (r *Router) Handler(method, path string, handler http.Handler)
- func (r *Router) HandlerFunc(method, path string, handler http.HandlerFunc)
- func (r *Router) Lookup(method, path string) (Route, Params, bool)
- func (r *Router) Mount(routes ...*Route)
- func (r *Router) MountRoute(route *Route)
- func (r *Router) OPTIONS(path string, route *Route)
- func (r *Router) PATCH(path string, route *Route)
- func (r *Router) POST(path string, route *Route)
- func (r *Router) PUT(path string, route *Route)
- func (r *Router) PrintRoutes()
- func (r *Router) ServeFiles(path string, root http.FileSystem)
- func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
- type TargetHandle
Constants ¶
const DELETE = "DELETE"
const GET = "GET"
const PATCH = "PATCH"
const POST = "POST"
const PUT = "PUT"
Variables ¶
This section is empty.
Functions ¶
func CleanPath ¶
CleanPath is the URL version of path.Clean, it returns a canonical URL path for p, eliminating . and .. elements.
The following rules are applied iteratively until no further processing can be done:
- Replace multiple slashes with a single slash.
- Eliminate each . path name element (the current directory).
- Eliminate each inner .. path name element (the parent directory) along with the non-.. element that precedes it.
- Eliminate .. elements that begin a rooted path: that is, replace "/.." by "/" at the beginning of a path.
If the result of this process is an empty string, "/" is returned
Types ¶
type Context ¶
type Context struct {
Writer http.ResponseWriter // 响应
Request *http.Request // 请求
Params Params //参数
}
上下文结构体
func (*Context) GetWithDefault ¶
func (*Context) PostWithDefault ¶
type Controller ¶
type Controller struct {
}
默认基本控制器
func (*Controller) Create ¶
func (cc *Controller) Create(c *Context)
func (*Controller) Destroy ¶
func (cc *Controller) Destroy(c *Context)
func (*Controller) Edit ¶
func (cc *Controller) Edit(c *Context)
func (*Controller) Index ¶
func (cc *Controller) Index(c *Context)
func (*Controller) Show ¶
func (cc *Controller) Show(c *Context)
func (*Controller) Store ¶
func (cc *Controller) Store(c *Context)
func (*Controller) Update ¶
func (cc *Controller) Update(c *Context)
type IController ¶
type IController interface {
Index(c *Context) // 对应 get : path方法
Create(c *Context) // 对应 get : path/create 方法
Store(c *Context) // 对应 post : path 方法
Update(c *Context) // 对应put/patch : path/:id 方法
Edit(c *Context) // 对应get : path/:id/edit
Show(c *Context) // 对应 get: route/:id
Destroy(c *Context) // 对应 delete: route/:id
}
控制器接口
type MiddlewareHandle ¶
type Pipeline ¶
type Pipeline struct {
// contains filtered or unexported fields
}
func (*Pipeline) Through ¶
func (p *Pipeline) Through(middlewares []MiddlewareHandle) *Pipeline
type Route ¶
type Route struct {
// contains filtered or unexported fields
}
路由
func (*Route) Middleware ¶
func (r *Route) Middleware(h MiddlewareHandle) *Route
func (*Route) MiddlewareGroup ¶
func (r *Route) MiddlewareGroup(hg []MiddlewareHandle) *Route
func (*Route) Request ¶
func (r *Route) Request(method string, path string, target TargetHandle) *Route
type Router ¶
type Router struct {
RedirectTrailingSlash bool
RedirectFixedPath bool
HandleMethodNotAllowed bool
HandleOPTIONS bool
NotFound http.HandlerFunc
MethodNotAllowed http.Handler
PanicHandler func(http.ResponseWriter, *http.Request, interface{})
// contains filtered or unexported fields
}
func (*Router) Handle ¶
Handle registers a new request handle with the given path and method.
For GET, POST, PUT, PATCH and DELETE requests the respective shortcut functions can be used.
This function is intended for bulk loading and to allow the usage of less frequently used, non-standardized or custom methods (e.g. for internal communication with a proxy).
func (*Router) HandlerFunc ¶
func (r *Router) HandlerFunc(method, path string, handler http.HandlerFunc)
HandlerFunc is an adapter which allows the usage of an http.HandlerFunc as a request handle.
func (*Router) Lookup ¶
Lookup allows the manual lookup of a method + path combo. This is e.g. useful to build a framework around this router. If the path was found, it returns the handle function and the path parameter values. Otherwise the third return value indicates whether a redirection to the same path with an extra / without the trailing slash should be performed.
func (*Router) ServeFiles ¶
func (r *Router) ServeFiles(path string, root http.FileSystem)
ServeFiles serves files from the given file system root. The path must end with "/*filepath", files are then served from the local path /defined/root/dir/*filepath. For example if root is "/etc" and *filepath is "passwd", the local file "/etc/passwd" would be served. Internally a http.FileServer is used, therefore http.NotFound is used instead of the Router's NotFound handler. To use the operating system's file system implementation, use http.Dir:
router.ServeFiles("/src/*filepath", http.Dir("/var/www"))
type TargetHandle ¶
type TargetHandle func(c *Context)
Source Files
Directories