mux

package module
v4.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 12, 2021 License: MIT Imports: 10 Imported by: 1

README

mux

Go Go version Go Report Card license codecov PkgGoDev

mux 功能完备的 Go 路由器:

  1. 路由参数;
  2. 支持正则表达式作为路由项匹配方式;
  3. 丰富的 OPTIONS 请求处理方式;
  4. 自动生成 HEAD 请求内容;
  5. 根据路由反向生成地址;
  6. 任意风格的路由,比如 discuz 这种不以 / 作为分隔符的;
  7. 分组路由,比如按域名,或是版本号等;
  8. 支持中间件;
import "github.com/issue9/middleware/v4/header"

h := header.New(map[string]string{
	"Access-Control-Allow-Origin": "*"
})

m := mux.New(false, false, false, nil, nil)
m.AddMiddleware(h.Middleware) // 中间件,输出跨域的报头。

router, ok := m.New("example.com", group.NewHosts("example.com"))
router.Get("/users/1", h).
    Post("/login", h).
    Get("/pages/{id:\\d+}.html", h). // 匹配 /pages/123.html 等格式,path = 123
    Get("/posts/{path}.html", h).    // 匹配 /posts/2020/11/11/title.html 等格式,path = 2020/11/11/title
    Options("/users/1", "GET").     // OPTIONS /user/1 手动指定该路由项的 OPTIONS 请求方法返回内容

// 统一前缀路径的路由
p := m.Prefix("/api")
p.Get("/logout", h) // 相当于 m.Get("/api/logout", h)
p.Post("/login", h) // 相当于 m.Get("/api/login", h)

// 对同一资源的不同操作
res := p.Resource("/users/{id:\\d+}")
res.Get(h)   // 相当于 m.Get("/api/users/{id:\\d+}", h)
res.Post(h)  // 相当于 m.Post("/api/users/{id:\\d+}", h)
res.URL(map[string]string{"id": "5"}) // 构建一条基于此路由项的路径:/users/5

http.ListenAndServe(":8080", m)

语法

正则表达式

路由中支持以正则表达式的方式进行匹配,表达式以大括号包含,内部以冒号分隔, 前半部分为变量的名称,后半部分为变量可匹配类型的正则表达式。比如:

/posts/{id:\\d+} // 将被转换成 /posts/(?P<id>\\d+)
/posts/{:\\d+}   // 将被转换成 /posts/\\d+
命名参数

若路由字符串中,所有的正则表达式冒号之后的内容是特定的内容,或是无内容, 则会被转换成命名参数,因为有专门的验证方法,性能会比较正则稍微好上一些。

 /posts/{id}.html                  // 匹配 /posts/1.html
 /posts-{id}-{page}.html           // 匹配 /posts-1-10.html
 /posts/{id:digit}.html            // 匹配 /posts/1.html
 /posts/{path}.html                // 匹配 /posts/2020/11/11/title.html

目前支持以下作为命名参数的内容约束:

  • digit 限定为数字字符,相当于正则的 [0-9]
  • word 相当于正则的 [a-zA-Z0-9]
  • any 表示匹配任意非空内容;
  • "" 为空表示任意内容,包括非内容;

用户也可以自行添加新的约束符。具体可参考 https://pkg.go.dev/github.com/issue9/mux/v4/interceptor

在路由字符串中若是以命名参数结尾的,则表示可以匹配之后的任意字符。

/blog/assets/{path}       // 可以匹配 /blog/assets/2020/11/11/file.ext 等格式
/blog/{tags:\\w+}/{path}
/blog/assets{path}
路径匹配规则

可能会出现多条记录与同一请求都匹配的情况,这种情况下, 系统会找到一条认为最匹配的路由来处理,判断规则如下:

  1. 普通路由优先于正则路由;
  2. 正则路由优先于命名路由;

比如:

/posts/{id}.html              // 1
/posts/{id:\\d+}.html         // 2
/posts/1.html                 // 3

/posts/1.html      // 匹配 3
/posts/11.html     // 匹配 2
/posts/index.html  // 匹配 1
路由参数

通过正则表达式匹配的路由,其中带命名的参数可通过 Params() 获取:

params := Params(r)

id, err := params.Int("id")
 // 或是
id := params.MustInt("id", 0) // 0 表示在无法获取 id 参数的默认值

高级用法

分组路由

可以通过匹配 group.Matcher 接口,定义了一组特定要求的路由项。

// server.go

m := mux.Default()

def, ok := m.NewRouter("default", group.NewPathVersion("v1"))
def.Get("/path", h1)

host, ok := m.NewRouter("host", group.NewHosts("*.example.com"))
host.Get("/path", h2)

http.ListenAndServe(":8080", m)

// client.go

// 访问 h2 的内容
r := http.NewRequest(http.MethodGet, "https://abc.example.com/path", nil)
r.Do()

// 访问 h1 的内容
r := http.NewRequest(http.MethodGet, "https://other_domain.com/v1/path", nil)
r.Do()
interceptor

正常情况下,/posts/{id:\d+} 或是 /posts/{id:[0-9]+} 会被当作正则表达式处理, 但是正则表达式的性能并不是很好,这个时候我们可以通完 interceptor 包进行拦截, 采用自己的特定方法进行处理:

import "github.com/issue9/mux/v4/interceptor"

func digit(path string) bool {
    for _, c := range path {
        if c < '0' || c > '9' {
            return false
        }
    }
    return len(path) > 0
}

// 路由中的 \d+ 和 [0-9]+ 均采用 digit 函数进行处理,不再是正则表达式。
interceptor.Register(digit, "\\d+", "[0-9]+")
OPTIONS

默认情况下,用户无须显示地实现它,系统会自动实现。 当然用户也可以使用 *.Options() 函数指定特定的数据; 或是直接使用 *.Handle() 指定一个自定义的实现方式。

如果不需要的话,也可以在 New() 中将 disableOptions 设置为 true。 显示设定 OPTIONS,不受 disableOptions 的影响。

m := mux.Default()
r, ok := m.NewRouter("default", group.Any)

r.Get("/posts/{id}", nil)     // 默认情况下, OPTIONS 的报头为 GET, OPTIONS
r.Options("/posts/{id}", "*") // 强制改成 *
r.Delete("/posts/{id}", nil)  // OPTIONS 依然为 *

r.Remove("/posts/{id}", http.MethodOptions)    // 在当前路由上禁用 OPTIONS
r.Handle("/posts/{id}", h, http.MethodOptions) // 显示指定一个处理函数 h
HEAD

默认情况下,用户无须显示地实现 HEAD 请求, 系统会为每一个 GET 请求自动实现一个对应的 HEAD 请求, 当然也与 OPTIONS 一样,你也可以自通过 mux.Handle() 自己实现 HEAD 请求。

中间件

mux 本身就是一个实现了 http.Handler 接口的中间件, 所有实现官方接口 http.Handler 的都可以附加到 mux 上作为中间件使用。

mux 本身也提供了对中间件的管理功能,同时 middleware 提供了常用的中间件功能。

import "github.com/issue9/middleware/header"
import "github.com/issue9/middleware/compress"

h := header.New(map[string]string{
    "Access-Control-Allow-Origin": "*"
}

c := compress.New(log.Default(), "*")

m := Default()

// 添加中间件
m.AddMiddleware(h.Middleware).
	AddMiddleware(c.Middleware)

r, ok := m.NewRouter("def", group.NewHost("example.com"))

性能

https://caixw.github.io/go-http-routers-testing/ 提供了与其它几个框架的对比情况。

版权

本项目采用 MIT 开源授权许可证,完整的授权说明可在 LICENSE 文件中找到。

Documentation

Overview

Package mux 功能完备的路由中间件

语法

路由支持以 {} 的形式包含参数,比如:/posts/{id}.html,id 在解析时会解析任意字符。 也可以在 {} 中约束参数的范围,比如 /posts/{id:\\d+}.html,表示 id 只能匹配数字。 路由地址可以是 ascii 字符,但是参数名称如果是非 ascii,在正则表达式中无法使用。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ApplyMiddlewares

func ApplyMiddlewares(h http.Handler, f ...MiddlewareFunc) http.Handler

ApplyMiddlewares 按顺序将所有的中间件应用于 h

func ApplyMiddlewaresFunc

func ApplyMiddlewaresFunc(h func(w http.ResponseWriter, r *http.Request), f ...MiddlewareFunc) http.Handler

ApplyMiddlewaresFunc 按顺序将所有的中间件应用于 h

func IsWell

func IsWell(pattern string) error

IsWell 语法格式是否正确

如果出错,则会返回具体的错误信息。

func Methods

func Methods() []string

Methods 返回所有支持的请求方法

func Params

func Params(r *http.Request) params.Params

Params 获取路由的参数集合

Types

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

MiddlewareFunc 将一个 http.Handler 封装成另一个 http.Handler

type Middlewares added in v4.2.0

type Middlewares struct {
	http.Handler
	// contains filtered or unexported fields
}

Middlewares 中间件管理

func NewMiddlewares added in v4.2.0

func NewMiddlewares(next http.Handler) *Middlewares

NewMiddlewares 声明新的 Middlewares 实例

func (*Middlewares) Append added in v4.2.0

func (ms *Middlewares) Append(f MiddlewareFunc) *Middlewares

Append 添加中间件到尾部

尾部的中间件将最后被调用,多次添加,则最后一次的在最末尾。

func (*Middlewares) Prepend added in v4.2.0

func (ms *Middlewares) Prepend(m MiddlewareFunc) *Middlewares

Prepend 添加中间件到顶部

顶部的中间件在运行过程中将最早被调用,多次添加,则最后一次的在顶部。

func (*Middlewares) Reset added in v4.2.0

func (ms *Middlewares) Reset() *Middlewares

Reset 清除中间件

type Mux

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

Mux 提供了强大的路由匹配功能

可以对路径按正则或是请求方法进行匹配。用法如下:

m := mux.Default()
router, ok := m.NewRouter("default", group.Any)
router.Get("/abc/h1", h1).
    Post("/abc/h2", h2).
    Handle("/api/{version:\\d+}",h3, http.MethodGet, http.MethodPost) // 只匹配 GET 和 POST
http.ListenAndServe(m)

func Default

func Default() *Mux

Default New 的默认参数版本

func New

func New(disableOptions, disableHead, skipCleanPath bool, notFound, methodNotAllowed http.HandlerFunc) *Mux

New 声明一个新的 Mux

disableOptions 是否禁用自动生成 OPTIONS 功能; disableHead 是否禁用根据 Get 请求自动生成 HEAD 请求; skipCleanPath 是否不对访问路径作处理,比如 "//api" ==> "/api"; notFound 404 页面的处理方式,为 nil 时会调用默认的方式进行处理; methodNotAllowed 405 页面的处理方式,为 nil 时会调用默认的方式进行处理;

func (*Mux) AppendMiddleware added in v4.2.0

func (mux *Mux) AppendMiddleware(f MiddlewareFunc) *Mux

AppendMiddleware 添加中间件到尾部

func (*Mux) CleanMiddlewares added in v4.2.0

func (mux *Mux) CleanMiddlewares()

func (*Mux) NewRouter

func (mux *Mux) NewRouter(name string, matcher group.Matcher) (r *Router, ok bool)

NewRouter 添加子路由

该路由只有符合 group.Matcher 的要求才会进入,其它与 Router 功能相同。 当 group.Matcher 与其它路由组的判断有重复时,第一条返回 true 的路由组获胜, 即使该路由组最终返回 404,也不会再在其它路由组里查找相应的路由。 所以在有多条子路由的情况下,第一条子路由不应该永远返回 true, 这样会造成其它子路由永远无法到达。

name 表示该路由组的名称,需要唯一,否则返回 false; matcher 路由的准入条件,如果为空,则此条路由匹配时会被排在最后, 只有一个路由的 matcher 为空,否则会 panic。

func (*Mux) PrependMiddleware added in v4.2.0

func (mux *Mux) PrependMiddleware(f MiddlewareFunc) *Mux

PrependMiddleware 添加中间件到顶部

func (*Mux) RemoveRouter

func (mux *Mux) RemoveRouter(name string)

RemoveRouter 删除子路由

func (*Mux) Routers

func (mux *Mux) Routers() []*Router

Routers 返回当前路由所属的子路由组列表

func (*Mux) ServeHTTP

func (mux *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Prefix

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

Prefix 可以将具有统一前缀的路由项集中在一起操作

example:

p := srv.Prefix("/api")
p.Get("/users")  // 相当于 srv.Get("/api/users")
p.Get("/user/1") // 相当于 srv.Get("/api/user/1")

func (*Prefix) Any

func (p *Prefix) Any(pattern string, h http.Handler) *Prefix

Any 相当于 Router.Any(prefix+pattern, h) 的简易写法

func (*Prefix) AnyFunc

func (p *Prefix) AnyFunc(pattern string, f http.HandlerFunc) *Prefix

AnyFunc 相当于 Router.AnyFunc(prefix+pattern, func) 的简易写法

func (*Prefix) Clean

func (p *Prefix) Clean() *Prefix

Clean 清除所有以 Prefix.prefix 开头的路由项

当指定多个相同的 Prefix 时,调用其中的一个 Clean 也将会清除其它的:

p1 := mux.Prefix("prefix")
p2 := mux.Prefix("prefix")
p2.Clean() 将同时清除 p1 的内容,因为有相同的前缀。

func (*Prefix) Delete

func (p *Prefix) Delete(pattern string, h http.Handler) *Prefix

Delete 相当于 Router.Delete(prefix+pattern, h)的简易写法

func (*Prefix) DeleteFunc

func (p *Prefix) DeleteFunc(pattern string, f http.HandlerFunc) *Prefix

DeleteFunc 相当于 Router.DeleteFunc(prefix+pattern, func) 的简易写法

func (*Prefix) Get

func (p *Prefix) Get(pattern string, h http.Handler) *Prefix

Get 相当于 Router.Get(prefix+pattern, h) 的简易写法

func (*Prefix) GetFunc

func (p *Prefix) GetFunc(pattern string, f http.HandlerFunc) *Prefix

GetFunc 相当于 Router.GetFunc(prefix+pattern, func) 的简易写法

func (*Prefix) Handle

func (p *Prefix) Handle(pattern string, h http.Handler, methods ...string) error

Handle 相当于 Router.Handle(prefix+pattern, h, methods...) 的简易写法

func (*Prefix) HandleFunc

func (p *Prefix) HandleFunc(pattern string, f http.HandlerFunc, methods ...string) error

HandleFunc 功能同 Router.HandleFunc(prefix+pattern, fun, ...)

func (*Prefix) Options

func (p *Prefix) Options(pattern string, allow string) *Prefix

Options 手动指定 OPTIONS 请求方法的值

func (*Prefix) Patch

func (p *Prefix) Patch(pattern string, h http.Handler) *Prefix

Patch 相当于 Router.Patch(prefix+pattern, h) 的简易写法

func (*Prefix) PatchFunc

func (p *Prefix) PatchFunc(pattern string, f http.HandlerFunc) *Prefix

PatchFunc 相当于 Router.PatchFunc(prefix+pattern, func) 的简易写法

func (*Prefix) Post

func (p *Prefix) Post(pattern string, h http.Handler) *Prefix

Post 相当于 Router.Post(prefix+pattern, h) 的简易写法

func (*Prefix) PostFunc

func (p *Prefix) PostFunc(pattern string, f http.HandlerFunc) *Prefix

PostFunc 相当 于Mux.PostFunc(prefix+pattern, func) 的简易写法

func (*Prefix) Prefix

func (p *Prefix) Prefix(prefix string) *Prefix

Prefix 在现有 Prefix 的基础上声明一个新的 Prefix 实例

example:

p := mux.Prefix("/api")
v := p.Prefix("/v2")
v.Get("/users")   // 相当于 g.Get("/api/v2/users")
v.Get("/users/1") // 相当于 g.Get("/api/v2/users/1")
v.Get("example.com/users/1") // 相当于 g.Get("/api/v2/example.com/users/1")

func (*Prefix) Put

func (p *Prefix) Put(pattern string, h http.Handler) *Prefix

Put 相当于 Router.Put(prefix+pattern, h) 的简易写法

func (*Prefix) PutFunc

func (p *Prefix) PutFunc(pattern string, f http.HandlerFunc) *Prefix

PutFunc 相当于 Router.PutFunc(prefix+pattern, func) 的简易写法

func (*Prefix) Remove

func (p *Prefix) Remove(pattern string, methods ...string) *Prefix

Remove 删除指定匹配模式的路由项

func (*Prefix) Resource

func (p *Prefix) Resource(pattern string) *Resource

Resource 创建一个资源路由项

func (*Prefix) Router

func (p *Prefix) Router() *Router

Router 返回与当前关联的 *Router 实例

func (*Prefix) SetAllow

func (p *Prefix) SetAllow(pattern string, allow string) error

SetAllow 手动指定 OPTIONS 请求方法的值

func (*Prefix) URL

func (p *Prefix) URL(pattern string, params map[string]string) (string, error)

URL 根据参数生成地址

name 为路由的名称,或是直接为路由项的定义内容, 若 name 作为路由项定义,会加上 Prefix.prefix 作为前缀; params 为路由项中的参数,键名为参数名,键值为参数值。

type Resource

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

Resource 以资源地址为对象的路由配置

r, _ := srv.Resource("/api/users/{id}")
r.Get(h)  // 相当于 srv.Get("/api/users/{id}")
r.Post(h) // 相当于 srv.Post("/api/users/{id}")
url := r.URL(map[string]string{"id":5}) // 获得 /api/users/5

func (*Resource) Any

func (r *Resource) Any(h http.Handler) *Resource

Any 相当于 Router.Any(pattern, h) 的简易写法

func (*Resource) AnyFunc

func (r *Resource) AnyFunc(f http.HandlerFunc) *Resource

AnyFunc 相当于 Router.AnyFunc(pattern, func) 的简易写法

func (*Resource) Clean

func (r *Resource) Clean() *Resource

Clean 清除当前资源的所有路由项

func (*Resource) Delete

func (r *Resource) Delete(h http.Handler) *Resource

Delete 相当于 Router.Delete(pattern, h) 的简易写法

func (*Resource) DeleteFunc

func (r *Resource) DeleteFunc(f http.HandlerFunc) *Resource

DeleteFunc 相当于 Router.DeleteFunc(pattern, func) 的简易写法

func (*Resource) Get

func (r *Resource) Get(h http.Handler) *Resource

Get 相当于 Router.Get(pattern, h) 的简易写法

func (*Resource) GetFunc

func (r *Resource) GetFunc(f http.HandlerFunc) *Resource

GetFunc 相当于 Router.GetFunc(pattern, func) 的简易写法

func (*Resource) Handle

func (r *Resource) Handle(h http.Handler, methods ...string) error

Handle 相当于 Router.Handle(pattern, h, methods...) 的简易写法

func (*Resource) HandleFunc

func (r *Resource) HandleFunc(f http.HandlerFunc, methods ...string) error

HandleFunc 功能同 Router.HandleFunc(pattern, fun, ...)

func (*Resource) Options

func (r *Resource) Options(allow string) *Resource

Options 手动指定 OPTIONS 请求方法的值

具体说明可参考 Router.Options 方法。

func (*Resource) Patch

func (r *Resource) Patch(h http.Handler) *Resource

Patch 相当于 Router.Patch(pattern, h) 的简易写法

func (*Resource) PatchFunc

func (r *Resource) PatchFunc(f http.HandlerFunc) *Resource

PatchFunc 相当于 Router.PatchFunc(pattern, func) 的简易写法

func (*Resource) Post

func (r *Resource) Post(h http.Handler) *Resource

Post 相当于 Router.Post(pattern, h) 的简易写法

func (*Resource) PostFunc

func (r *Resource) PostFunc(f http.HandlerFunc) *Resource

PostFunc 相当于 Router.PostFunc(pattern, func) 的简易写法

func (*Resource) Put

func (r *Resource) Put(h http.Handler) *Resource

Put 相当于 Router.Put(pattern, h) 的简易写法

func (*Resource) PutFunc

func (r *Resource) PutFunc(f http.HandlerFunc) *Resource

PutFunc 相当于 Router.PutFunc(pattern, func) 的简易写法

func (*Resource) Remove

func (r *Resource) Remove(methods ...string) *Resource

Remove 删除指定匹配模式的路由项

func (*Resource) Router

func (r *Resource) Router() *Router

Router 返回与当前资源关联的 *Router 实例

func (*Resource) SetAllow

func (r *Resource) SetAllow(allow string) error

SetAllow 手动指定 OPTIONS 请求方法的值

具体说明可参考 Router.Options 方法。

func (*Resource) URL

func (r *Resource) URL(params map[string]string) (string, error)

URL 根据参数构建一条 URL

params 匹配路由参数中的同名参数,或是不存在路由参数,比如普通的字符串路由项, 该参数不启作用;

res, := m.Resource("/posts/{id}")
res.URL(map[string]string{"id": "1"}, "") // /posts/1

res, := m.Resource("/posts/{id}/{path}")
res.URL(map[string]string{"id": "1","path":"author/profile"}) // /posts/1/author/profile

type Router

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

Router 提供了基本的路由项添加和删除等功能

func (*Router) Any

func (r *Router) Any(pattern string, h http.Handler) *Router

Any 相当于 Router.Handle(pattern, h) 的简易写法

func (*Router) AnyFunc

func (r *Router) AnyFunc(pattern string, f http.HandlerFunc) *Router

AnyFunc 相当于 Router.HandleFunc(pattern, func) 的简易写法

func (*Router) AppendMiddleware added in v4.2.0

func (r *Router) AppendMiddleware(f MiddlewareFunc) *Router

AppendMiddleware 添加中间件到尾部

func (*Router) Clean

func (r *Router) Clean() *Router

Clean 清除当前路由组的所有路由项

func (*Router) CleanMiddlewares added in v4.2.0

func (r *Router) CleanMiddlewares()

func (*Router) Delete

func (r *Router) Delete(pattern string, h http.Handler) *Router

Delete 相当于 Router.Handle(pattern, h, http.MethodDelete) 的简易写法

func (*Router) DeleteFunc

func (r *Router) DeleteFunc(pattern string, f http.HandlerFunc) *Router

DeleteFunc 相当于 Router.HandleFunc(pattern, func, http.MethodDelete) 的简易写法

func (*Router) Get

func (r *Router) Get(pattern string, h http.Handler) *Router

Get 相当于 Router.Handle(pattern, h, http.MethodGet) 的简易写法

func (*Router) GetFunc

func (r *Router) GetFunc(pattern string, f http.HandlerFunc) *Router

GetFunc 相当于 Router.HandleFunc(pattern, func, http.MethodGet) 的简易写法

func (*Router) Handle

func (r *Router) Handle(pattern string, h http.Handler, methods ...string) error

Handle 添加一条路由数据

pattern 为路由匹配模式,可以是正则匹配也可以是字符串匹配, 若语法不正确,则直接 panic,可以通过 IsWell 检测语法的有效性,其它接口也相同; methods 该路由项对应的请求方法,如果未指定值,则表示所有支持的请求方法, 但不包含 OPTIONS 和 HEAD。

func (*Router) HandleFunc

func (r *Router) HandleFunc(pattern string, f http.HandlerFunc, methods ...string) error

HandleFunc 功能同 Router.Handle(),但是将第二个参数从 http.Handler 换成了 http.HandlerFunc

func (*Router) Name

func (r *Router) Name() string

Name 当前路由组的名称

func (*Router) Options

func (r *Router) Options(pattern string, allow string) *Router

Options 将 OPTIONS 请求方法的报头 allow 值固定为指定的值

若无特殊需求,不用调用此方法,系统会自动计算符合当前路由的请求方法列表。 如果想实现对处理方法的自定义,可以显示地调用 Handle 方法:

Router.Handle("/api/1", handle, http.MethodOptions)

Options 与 SetAllow 功能上完全相同,只是对错误处理上有所有区别。 Options 在出错时 panic,而 SetAllow 会返回错误信息。

func (*Router) Patch

func (r *Router) Patch(pattern string, h http.Handler) *Router

Patch 相当于 Router.Handle(pattern, h, http.MethodPatch) 的简易写法

func (*Router) PatchFunc

func (r *Router) PatchFunc(pattern string, f http.HandlerFunc) *Router

PatchFunc 相当于 Router.HandleFunc(pattern, func, http.MethodPatch) 的简易写法

func (*Router) Post

func (r *Router) Post(pattern string, h http.Handler) *Router

Post 相当于 Router.Handle(pattern, h, http.MethodPost) 的简易写法

func (*Router) PostFunc

func (r *Router) PostFunc(pattern string, f http.HandlerFunc) *Router

PostFunc 相当于 Router.HandleFunc(pattern, func, "POST") 的简易写法

func (*Router) Prefix

func (r *Router) Prefix(prefix string) *Prefix

Prefix 声明一个 Prefix 实例

func (*Router) PrependMiddleware added in v4.2.0

func (r *Router) PrependMiddleware(f MiddlewareFunc) *Router

PrependMiddleware 添加中间件到顶部

func (*Router) Put

func (r *Router) Put(pattern string, h http.Handler) *Router

Put 相当于 Router.Handle(pattern, h, http.MethodPut) 的简易写法

func (*Router) PutFunc

func (r *Router) PutFunc(pattern string, f http.HandlerFunc) *Router

PutFunc 相当于 Router.HandleFunc(pattern, func, http.MethodPut) 的简易写法

func (*Router) Remove

func (r *Router) Remove(pattern string, methods ...string) *Router

Remove 移除指定的路由项

当未指定 methods 时,将删除所有 method 匹配的项。 指定错误的 methods 值,将自动忽略该值。

func (*Router) Resource

func (r *Router) Resource(pattern string) *Resource

Resource 创建一个资源路由项

func (*Router) Routes

func (r *Router) Routes(ignoreHead, ignoreOptions bool) map[string][]string

Routes 返回当前路由组的路由项

ignoreHead 是否忽略自动生成的 HEAD 请求; ignoreOptions 是否忽略自动生成的 OPTIONS 请求;

func (*Router) SetAllow

func (r *Router) SetAllow(pattern string, allow string) error

SetAllow 将 OPTIONS 请求方法的报头 allow 值固定为指定的值

若无特殊需求,不用调用此方法,系统会自动计算符合当前路由的请求方法列表。 如果想实现对处理方法的自定义,可以显示地调用 Handle 方法:

Router.Handle("/api/1", handle, http.MethodOptions)

Options 与 SetAllow 功能上完全相同,只是对错误处理上有所有区别。 Options 在出错时 panic,而 SetAllow 会返回错误信息。

func (*Router) URL

func (r *Router) URL(pattern string, params map[string]string) (string, error)

URL 根据参数生成地址

pattern 为路由项的定义内容; params 为路由项中的参数,键名为参数名,键值为参数值。

Directories

Path Synopsis
Package group 提供了按条件进行分组路由的功能
Package group 提供了按条件进行分组路由的功能
Package interceptor 针对带参数类型路由的拦截处理 在解析诸如 /authors/{id:\\d+} 带参数的路由项时, 用户可以通过拦截并自定义对参数部分 {id:\\d+} 的解析, 从而不需要走正则表达式的那一套解析流程,可以在一定程度上增强性能。
Package interceptor 针对带参数类型路由的拦截处理 在解析诸如 /authors/{id:\\d+} 带参数的路由项时, 用户可以通过拦截并自定义对参数部分 {id:\\d+} 的解析, 从而不需要走正则表达式的那一套解析流程,可以在一定程度上增强性能。
internal
handlers
Package handlers 用于处理节点下与处理函数相关的逻辑
Package handlers 用于处理节点下与处理函数相关的逻辑
syntax
Package syntax 负责处理路由语法
Package syntax 负责处理路由语法
tree
Package tree 提供了以树形结构保存路由项的相关操作。
Package tree 提供了以树形结构保存路由项的相关操作。
Package params 获取和转换路由中的参数信息
Package params 获取和转换路由中的参数信息

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL