web

type BaseContext struct {
	Logger *log.Logger
	// contains filtered or unexported fields
}

type BasicAuthConfig struct {
	Accounts map[string]string
	Realm    string
}

type BindScope int

type BodyBinder func(i interface{}, ctx Context) error

type BufferedResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

type Context interface {

	// NativeContext 返回封装的底层上下文对象
	NativeContext() interface{}

	// Get retrieves data from the context.
	Get(key string) interface{}

	// Set saves data in the context.
	Set(key string, val interface{}) error

	// Request returns `*http.Request`.
	Request() *http.Request

	// Context 返回 Request 绑定的 context.Context 对象
	Context() context.Context

	// SetContext sets context.Context.
	SetContext(ctx context.Context)

	// IsTLS returns true if HTTP connection is TLS otherwise false.
	IsTLS() bool

	// IsWebSocket returns true if HTTP connection is WebSocket otherwise false.
	IsWebSocket() bool

	// Scheme returns the HTTP protocol scheme, `http` or `https`.
	Scheme() string

	// ClientIP implements a best effort algorithm to return the real client IP,
	// it parses X-Real-IP and X-Forwarded-For in order to work properly with
	// reverse-proxies such us: nginx or haproxy. Use X-Forwarded-For before
	// X-Real-Ip as nginx uses X-Real-Ip with the proxy's IP.
	ClientIP() string

	// Path returns the registered path for the handler.
	Path() string

	// Handler returns the matched handler by router.
	Handler() Handler

	// ContentType returns the Content-Type header of the request.
	ContentType() string

	// Header returns value from request headers.
	Header(key string) string

	// Cookies returns the HTTP cookies sent with the request.
	Cookies() []*http.Cookie

	// Cookie returns the named cookie provided in the request.
	Cookie(name string) (*http.Cookie, error)

	// PathParamNames returns path parameter names.
	PathParamNames() []string

	// PathParamValues returns path parameter values.
	PathParamValues() []string

	// PathParam returns path parameter by name.
	PathParam(name string) string

	// QueryString returns the URL query string.
	QueryString() string

	// QueryParams returns the query parameters as `url.Values`.
	QueryParams() url.Values

	// QueryParam returns the query param for the provided name.
	QueryParam(name string) string

	// FormParams returns the form parameters as `url.Values`.
	FormParams() (url.Values, error)

	// FormValue returns the form field value for the provided name.
	FormValue(name string) string

	// MultipartForm returns the multipart form.
	MultipartForm() (*multipart.Form, error)

	// FormFile returns the multipart form file for the provided name.
	FormFile(name string) (*multipart.FileHeader, error)

	// SaveUploadedFile uploads the form file to specific dst.
	SaveUploadedFile(file *multipart.FileHeader, dst string) error

	// RequestBody return stream data.
	RequestBody() ([]byte, error)

	// Bind binds the request body into provided type `i`. The default binder
	// does it based on Content-Type header.
	Bind(i interface{}) error

	// Response returns Response.
	Response() Response

	// SetStatus sets the HTTP response code.
	SetStatus(code int)

	// SetHeader is a intelligent shortcut for c.Writer.Header().Set(key, value).
	// It writes a header in the response.
	// If value == "", this method removes the header `c.Writer.Header().Del(key)`
	SetHeader(key, value string)

	// SetContentType 设置 ResponseWriter 的 ContentType 。
	SetContentType(typ string)

	// SetCookie adds a `Set-Cookie` header in HTTP response.
	SetCookie(cookie *http.Cookie)

	// NoContent sends a response with no body and a status code. Maybe panic.
	NoContent(code int)

	// String writes the given string into the response body. Maybe panic.
	String(format string, values ...interface{})

	// HTML sends an HTTP response. Maybe panic.
	HTML(html string)

	// HTMLBlob sends an HTTP blob response. Maybe panic.
	HTMLBlob(b []byte)

	// JSON sends a JSON response. Maybe panic.
	JSON(i interface{})

	// JSONPretty sends a pretty-print JSON. Maybe panic.
	JSONPretty(i interface{}, indent string)

	// JSONBlob sends a JSON blob response. Maybe panic.
	JSONBlob(b []byte)

	// JSONP sends a JSONP response. It uses `callback`
	// to construct the JSONP payload. Maybe panic.
	JSONP(callback string, i interface{})

	// JSONPBlob sends a JSONP blob response. It uses
	// `callback` to construct the JSONP payload. Maybe panic.
	JSONPBlob(callback string, b []byte)

	// XML sends an XML response. Maybe panic.
	XML(i interface{})

	// XMLPretty sends a pretty-print XML. Maybe panic.
	XMLPretty(i interface{}, indent string)

	// XMLBlob sends an XML blob response. Maybe panic.
	XMLBlob(b []byte)

	// Blob sends a blob response and content type. Maybe panic.
	Blob(contentType string, b []byte)

	// File sends a response with the content of the file. Maybe panic.
	File(file string)

	// Attachment sends a response as attachment, prompting client to
	// save the file. Maybe panic.
	Attachment(file string, name string)

	// Inline sends a response as inline, opening the file in the browser. Maybe panic.
	Inline(file string, name string)

	// Redirect redirects the request to a provided URL with status code. Maybe panic.
	Redirect(code int, url string)

	// SSEvent writes a Server-Sent Event into the body stream. Maybe panic.
	SSEvent(name string, message interface{})
}

type ErrorCode struct {
	Code int32  `json:"code"` // 错误码
	Msg  string `json:"msg"`  // 错误信息
}

type ErrorHandler interface {
	Invoke(ctx Context, err *HttpError)
}

type FileHandler struct {
	Prefix string
	Server http.Handler
}

type Filter interface {
	Invoke(ctx Context, chain FilterChain)
}

type FilterChain interface {
	Next(ctx Context, op NextOperation)
}

type FilterFunc func(ctx Context, chain FilterChain)

type FuncErrorHandler func(ctx Context, err *HttpError)

type GzipFilter struct {
	ExcludedExtensions   []string
	ExcludedPaths        []string
	ExcludedPathsRegexes []*regexp.Regexp
	// contains filtered or unexported fields
}

type Handler interface {

	// Invoke 响应函数
	Invoke(Context)

	// FileLine 获取用户函数的文件名、行号以及函数名称
	FileLine() (file string, line int, fnName string)
}

type HandlerFunc func(Context)

type HttpError struct {
	Code     int         // HTTP 错误码
	Message  string      // 自定义错误消息
	Internal interface{} // 保存的原始异常
}

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

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

type MethodOverrideGetter func(ctx Context) string

type NextOperation int

type Operation interface {

	// Process 完成处理参数绑定等过程
	Process() error
}

type PathStyleEnum int

type Prefilter struct {
	Filter
}

type RedirectConfig struct {
	Code int
}

type RequestIDConfig struct {
	Header    string
	Generator func() string
}

type Response interface {
	http.ResponseWriter
	Get() http.ResponseWriter
	Set(w http.ResponseWriter)
}

type Router interface {

	// Mappers 返回映射器列表
	Mappers() []*Mapper

	// AddMapper 添加一个 Mapper
	AddMapper(m *Mapper)

	// HttpGet 注册 GET 方法处理函数
	HttpGet(path string, h http.HandlerFunc) *Mapper

	// HandleGet 注册 GET 方法处理函数
	HandleGet(path string, h Handler) *Mapper

	// GetMapping 注册 GET 方法处理函数
	GetMapping(path string, fn HandlerFunc) *Mapper

	// GetBinding 注册 GET 方法处理函数
	GetBinding(path string, fn interface{}) *Mapper

	// HttpPost 注册 POST 方法处理函数
	HttpPost(path string, h http.HandlerFunc) *Mapper

	// HandlePost 注册 POST 方法处理函数
	HandlePost(path string, h Handler) *Mapper

	// PostMapping 注册 POST 方法处理函数
	PostMapping(path string, fn HandlerFunc) *Mapper

	// PostBinding 注册 POST 方法处理函数
	PostBinding(path string, fn interface{}) *Mapper

	// HttpPut 注册 PUT 方法处理函数
	HttpPut(path string, h http.HandlerFunc) *Mapper

	// HandlePut 注册 PUT 方法处理函数
	HandlePut(path string, h Handler) *Mapper

	// PutMapping 注册 PUT 方法处理函数
	PutMapping(path string, fn HandlerFunc) *Mapper

	// PutBinding 注册 PUT 方法处理函数
	PutBinding(path string, fn interface{}) *Mapper

	// HttpDelete 注册 DELETE 方法处理函数
	HttpDelete(path string, h http.HandlerFunc) *Mapper

	// HandleDelete 注册 DELETE 方法处理函数
	HandleDelete(path string, h Handler) *Mapper

	// DeleteMapping 注册 DELETE 方法处理函数
	DeleteMapping(path string, fn HandlerFunc) *Mapper

	// DeleteBinding 注册 DELETE 方法处理函数
	DeleteBinding(path string, fn interface{}) *Mapper

	// HandleRequest 注册任意 HTTP 方法处理函数
	HandleRequest(method uint32, path string, h Handler) *Mapper

	// RequestMapping 注册任意 HTTP 方法处理函数
	RequestMapping(method uint32, path string, fn HandlerFunc) *Mapper

	// RequestBinding 注册任意 HTTP 方法处理函数
	RequestBinding(method uint32, path string, fn interface{}) *Mapper

	// File 定义单个文件资源
	File(path string, file string) *Mapper

	// Static 定义一组文件资源
	Static(prefix string, dir string) *Mapper

	// StaticFS 定义一组文件资源
	StaticFS(prefix string, fs http.FileSystem) *Mapper
}

type RpcError ErrorCode

type RpcResult struct {
	ErrorCode

	Err  string      `json:"err,omitempty"`  // 错误源
	Data interface{} `json:"data,omitempty"` // 返回值
}

type RpcSuccess ErrorCode

type Server interface {
	Router

	// Config 获取 web 服务器配置
	Config() ServerConfig

	// Prefilters 返回前置过滤器列表
	Prefilters() []*Prefilter

	// AddPrefilter 添加前置过滤器
	AddPrefilter(filter ...*Prefilter)

	// Filters 返回过滤器列表
	Filters() []Filter

	// AddFilter 添加过滤器
	AddFilter(filter ...Filter)

	// AccessFilter 获取访问记录 Filter
	AccessFilter() Filter

	// SetAccessFilter 设置访问记录 Filter
	SetAccessFilter(filter Filter)

	// ErrorHandler 获取错误处理接口
	ErrorHandler() ErrorHandler

	// SetErrorHandler 设置错误处理接口
	SetErrorHandler(errHandler ErrorHandler)

	// Swagger 设置与服务器绑定的 Swagger 对象
	Swagger(swagger Swagger)

	// Start 启动 web 服务器
	Start() error

	// Stop 停止 web 服务器
	Stop(ctx context.Context) error
}

type ServerConfig struct {
	Prefix       string `value:"${prefix:=}"`          // 用于 WebStarter 选择路由匹配的 Server
	Host         string `value:"${host:=}"`            // 监听 IP
	Port         int    `value:"${port:=8080}"`        // HTTP 端口
	EnableSSL    bool   `value:"${ssl.enable:=false}"` // 是否启用 HTTPS
	KeyFile      string `value:"${ssl.key:=}"`         // SSL 秘钥
	CertFile     string `value:"${ssl.cert:=}"`        // SSL 证书
	BasePath     string `value:"${base-path:=}"`       // 当前 Server 的所有路由都具有这个路径前缀
	ReadTimeout  int    `value:"${read-timeout:=0}"`   // 读取超时，毫秒
	WriteTimeout int    `value:"${write-timeout:=0}"`  // 写入超时，毫秒
}

type ServerHandler interface {
	http.Handler
	Start(s Server) error
	RecoveryFilter(errHandler ErrorHandler) Filter
}

type SimpleResponse struct {
	http.ResponseWriter
}

type Swagger interface {

	// ReadDoc 读取标准格式的描述文档
	ReadDoc() string

	// AddPath 添加与服务器绑定的路由节点
	AddPath(path string, method string, op Operation)
}

type SwaggerHandler func(router Router, doc string)