router

Documentation

Index

• func GetHandlerFuncName(h http.HandlerFunc, seps ...rune) string
• type Auther
• type AutherFunc
  • func (f AutherFunc) Auth(h http.Header) (authInfo interface{}, err error)
• type Entry
  • func NewEntry(path, method, resource string) *Entry
  • func (e *Entry) AddLabel(labels ...*Label) EntryDecorator
  • func (e *Entry) DisableAuth() EntryDecorator
  • func (e *Entry) DisablePermission() EntryDecorator
  • func (e *Entry) EnableAuth() EntryDecorator
  • func (e *Entry) EnablePermission() EntryDecorator
  • func (e *Entry) GetLableValue(key string) string
  • func (e *Entry) String() string
• type EntryDecorator
• type EntrySet
  • func NewEntrySet() *EntrySet
  • func (s *EntrySet) AddEntry(es ...Entry)
  • func (s *EntrySet) GetEntry(path, mothod string) *Entry
  • func (s *EntrySet) String() string
• type Label
  • func NewLable(k, v string) *Label
  • func (l *Label) Key() string
  • func (l *Label) Value() string
• type Middleware
• type MiddlewareFunc
  • func (h MiddlewareFunc) Handler(next http.Handler) http.Handler
• type ResourceRouter
• type Router
• type SubRouter

Functions

func GetHandlerFuncName

func GetHandlerFuncName(h http.HandlerFunc, seps ...rune) string

GetHandlerFuncName 通过反射获取函数名称

Types

type Auther

type Auther interface {
	Auth(req *http.Request, entry Entry) (authInfo interface{}, err error)
}

Auther 设置受保护路由使用的认证器 Header 用于鉴定身份 Entry 用于鉴定权限

type AutherFunc

type AutherFunc func(http.Header) (authInfo interface{}, err error)

The AutherFunc type is an adapter to allow the use of ordinary functions as Auther handlers. If f is a function with the appropriate signature, AutherFunc(f) is a Handler that calls f.

func (AutherFunc) Auth

func (f AutherFunc) Auth(h http.Header) (authInfo interface{}, err error)

Auth calls auth.

type Entry

type Entry struct {
	Path             string            `bson:"path" json:"path,omitempty"`
	Method           string            `bson:"method" json:"method,omitempty"`
	FunctionName     string            `bson:"function_name" json:"function_name,omitempty"`
	Resource         string            `bson:"resource" json:"resource,omitempty"`
	AuthEnable       bool              `bson:"auth_enable" json:"auth_enable"`
	PermissionEnable bool              `bson:"permission_enable" json:"permission_enable"`
	Labels           map[string]string `bson:"labels" json:"labels,omitempty"`
}

Entry 路由条目

func NewEntry

func NewEntry(path, method, resource string) *Entry

NewEntry 行健条目

func (*Entry) AddLabel

func (e *Entry) AddLabel(labels ...*Label) EntryDecorator

AddLabel 添加Label

func (*Entry) DisableAuth

func (e *Entry) DisableAuth() EntryDecorator

DisableAuth 不启用身份验证

func (*Entry) DisablePermission

func (e *Entry) DisablePermission() EntryDecorator

DisablePermission 禁用授权验证

func (*Entry) EnableAuth

func (e *Entry) EnableAuth() EntryDecorator

EnableAuth 启动身份验证

func (*Entry) EnablePermission

func (e *Entry) EnablePermission() EntryDecorator

EnablePermission 启用授权验证

func (*Entry) GetLableValue

func (e *Entry) GetLableValue(key string) string

GetLableValue 获取Lable的值

func (*Entry) String

func (e *Entry) String() string

type EntryDecorator

type EntryDecorator interface {
	// SetLabel 设置子路由标签, 作用于Entry上
	AddLabel(...*Label) EntryDecorator
	EnableAuth() EntryDecorator
	DisableAuth() EntryDecorator
	EnablePermission() EntryDecorator
	DisablePermission() EntryDecorator
}

EntryDecorator 装饰

type EntrySet

type EntrySet struct {
	Items []*Entry `json:"items"`
}

EntrySet 路由条目集

func NewEntrySet

func NewEntrySet() *EntrySet

NewEntrySet 实例

func (*EntrySet) AddEntry

func (s *EntrySet) AddEntry(es ...Entry)

AddEntry 添加Entry

func (*EntrySet) GetEntry

func (s *EntrySet) GetEntry(path, mothod string) *Entry

GetEntry 获取条目

func (*EntrySet) String

func (s *EntrySet) String() string

type Label

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

Label 路由标签

func NewLable

func NewLable(k, v string) *Label

NewLable label实例

func (*Label) Key

func (l *Label) Key() string

Key 健

func (*Label) Value

func (l *Label) Value() string

Value 值

type Middleware

type Middleware interface {
	Handler(http.Handler) http.Handler
}

Middleware 中间件的函数签名

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

MiddlewareFunc is an adapter to allow the use of ordinary functions as Negroni handlers. If f is a function with the appropriate signature, HandlerFunc(f) is a Handler object that calls f.

func (MiddlewareFunc) Handler

func (h MiddlewareFunc) Handler(next http.Handler) http.Handler

Handler wrappe for function

type ResourceRouter

type ResourceRouter interface {
	SubRouter
	// BasePath 设置资源路由的基础路径
	BasePath(path string)
}

ResourceRouter 资源路由

type Router

type Router interface {
	// 添加中间件
	Use(m Middleware)

	// 是否启用用户身份验证
	Auth(isEnable bool)

	// 是否启用用户权限验证
	Permission(isEnable bool)

	// 添加受认证保护的路由
	Handle(method, path string, h http.HandlerFunc) EntryDecorator

	// 开始认证时 使用的认证器
	SetAuther(Auther)

	// 实现标准库路由
	ServeHTTP(http.ResponseWriter, *http.Request)

	// 获取当前的路由条目信息
	GetEndpoints() *EntrySet

	// EnableAPIRoot 将服务路由表通过路径/暴露出去
	EnableAPIRoot()

	// 设置路由的Logger, 用于Debug
	SetLogger(logger.Logger)
	// SetLabel 设置路由标签, 作用于Entry上
	SetLabel(...*Label)

	// 子路由
	SubRouter(basePath string) SubRouter
}

Router 路由

type SubRouter

type SubRouter interface {
	// 是否启用用户身份验证
	Auth(isEnable bool)
	// 是否启用用户权限验证
	Permission(isEnable bool)
	// 添加中间件
	Use(m Middleware)
	// SetLabel 设置路由标签, 作用于Entry上
	SetLabel(...*Label)
	// With独立作用于某一个Handler
	With(m ...Middleware) SubRouter
	// 添加受认证保护的路由
	Handle(method, path string, h http.HandlerFunc) EntryDecorator
	// ResourceRouter 资源路由器, 主要用于设置路由标签和资源名称,方便配置灵活的权限策略
	ResourceRouter(resourceName string, labels ...*Label) ResourceRouter
}

SubRouter 子路由或者分组路由