Documentation ¶
Overview ¶
Package zweb provides web service
package main import ( "github.com/sohaha/zlsgo/znet" ) func main(){ r := znet.New() r.SetMode(znet.DebugMode) r.GET("/", func(c znet.Context) { c.String(200, "hello world") }) znet.Run() }
Index ¶
- Constants
- Variables
- func ClientIP(r *http.Request) (ip string)
- func ClientPublicIP(r *http.Request) string
- func HasLocalIP(ip net.IP) bool
- func HasLocalIPddr(ip string) bool
- func IP2Long(ip net.IP) (i uint, err error)
- func IPString2Long(ip string) (i uint, err error)
- func Long2IP(i uint) (ip net.IP, err error)
- func Long2IPString(i uint) (IP string, err error)
- func RemoteIP(r *http.Request) string
- func Run()
- type Context
- func (c *Context) Abort(code ...int)
- func (c *Context) ClientIP() (IP string)
- func (c *Context) CompletionLink(link string) string
- func (c *Context) DefaultPostForm(key, def string) string
- func (c *Context) DefaultQuery(key string, def string) string
- func (c *Context) File(filepath string)
- func (c *Context) FormFile(name string) (*multipart.FileHeader, error)
- func (c *Context) GetAllParam() ParamsMapType
- func (c *Context) GetAllQueryst() url.Values
- func (c *Context) GetCookie(name string) string
- func (c *Context) GetDataRaw() (result string, err error)
- func (c *Context) GetHeader(key string) string
- func (c *Context) GetParam(key string) string
- func (c *Context) GetPostForm(key string) (string, bool)
- func (c *Context) GetPostFormArray(key string) ([]string, bool)
- func (c *Context) GetPostFormMap(key string) (map[string]string, bool)
- func (c *Context) GetQuery(key string) (string, bool)
- func (c *Context) GetQueryArray(key string) ([]string, bool)
- func (c *Context) HTML(code int, html string)
- func (c *Context) Host() string
- func (c *Context) IsWebsocket() bool
- func (c *Context) JSON(code int, values interface{})
- func (c *Context) MultipartForm() (*multipart.Form, error)
- func (c *Context) Next() (next HandlerFunc)
- func (c *Context) PostFormMap(key string) map[string]string
- func (c *Context) Redirect(link string, statusCode ...int)
- func (c *Context) RedirectNext(path string) (not bool)
- func (c *Context) Referer() string
- func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dist string) error
- func (c *Context) SetCookie(name, value string)
- func (c *Context) SetHeader(key, value string)
- func (c *Context) StatusCode(code int)
- func (c *Context) String(code int, format string, values ...interface{})
- func (c *Context) Template(code int, name string, data ...interface{})
- func (c *Context) UserAgent() string
- type Engine
- func (e *Engine) Any(path string, handle HandlerFunc)
- func (e *Engine) DELETE(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) DELETEAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) FindHandle(rw *Context, req *http.Request, requestURL string, applyMiddleware bool) (not bool)
- func (e *Engine) GET(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) GETAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) GenerateURL(method string, routeName string, params map[string]string) (string, error)
- func (e *Engine) GetMiddleware() []HandlerFunc
- func (e *Engine) GetTrees() map[string]*Tree
- func (e *Engine) Group(prefix string, groupHandle ...func(e *Engine)) (engine *Engine)
- func (e *Engine) HEAD(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) HEADAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) Handle(method string, path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) HandleNotFound(c *Context, middleware []HandlerFunc)
- func (e *Engine) IsDebug() bool
- func (e *Engine) Match(requestURL string, path string) bool
- func (e *Engine) NotFoundFunc(handler HandlerFunc)
- func (e *Engine) OPTIONS(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) OPTIONSAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) PATCH(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) PATCHAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) POST(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) POSTAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) PUT(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
- func (e *Engine) PUTAndName(path string, handle HandlerFunc, routeName string)
- func (e *Engine) PanicHandler(handler PanicFunc)
- func (e *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)
- func (e *Engine) SetAddr(addr ...string)
- func (e *Engine) SetCustomMethodField(field string)
- func (e *Engine) SetMode(value string)
- func (e *Engine) SetTimeLocation(location string)
- func (e *Engine) SetTimeout(Timeout time.Duration, WriteTimeout ...time.Duration)
- func (e *Engine) Static(relativePath, root string)
- func (e *Engine) StaticFS(relativePath string, fs http.FileSystem)
- func (e *Engine) StaticFile(relativePath, filepath string)
- func (e *Engine) Use(middleware ...HandlerFunc)
- type H
- type HandlerFunc
- type J
- type MiddlewareFunc
- type MiddlewareType
- type Node
- type PanicFunc
- type Parameters
- type ParamsMapType
- type Tree
Constants ¶
View Source
const ( // DebugMode debug DebugMode = "debug" // ReleaseMode release ReleaseMode = "release" // TestMode test TestMode = "test" )
Variables ¶
View Source
var ( // ErrGenerateParameters is returned when generating a route withRequestLog wrong parameters. ErrGenerateParameters = errors.New("params contains wrong parameters") // ErrNotFoundRoute is returned when generating a route that can not find route in tree. ErrNotFoundRoute = errors.New("cannot find route in tree") // ErrNotFoundMethod is returned when generating a route that can not find method in tree. ErrNotFoundMethod = errors.New("cannot find method in tree") // ErrPatternGrammar is returned when generating a route that pattern grammar error. ErrPatternGrammar = errors.New("pattern grammar error") )
View Source
var ( // Log Log Log = zlog.New(zlog.ColorTextWrap(zlog.ColorGreen, "[Z] ")) )
Functions ¶
func ClientPublicIP ¶
func HasLocalIP ¶
func HasLocalIPddr ¶
func IPString2Long ¶
func Long2IPString ¶
Types ¶
type Context ¶
type Context struct { Writer http.ResponseWriter Request *http.Request Engine *Engine Info *info Log *zlog.Logger // contains filtered or unexported fields }
Context context
func (*Context) CompletionLink ¶
CompletionLink Complete the link and add the current domain name if it is not linked
func (*Context) DefaultPostForm ¶
func (*Context) GetAllParam ¶
func (c *Context) GetAllParam() ParamsMapType
GetAllParam Get the value of all param in the route
func (*Context) GetAllQueryst ¶
func (*Context) GetDataRaw ¶ added in v0.0.19
func (*Context) GetPostFormMap ¶
func (*Context) Next ¶
func (c *Context) Next() (next HandlerFunc)
Next Execute the next Handler Func
func (*Context) RedirectNext ¶ added in v0.0.19
RedirectNext redirect rext
func (*Context) SaveUploadedFile ¶
func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dist string) error
type Engine ¶
type Engine struct { // Log Log Log *zlog.Logger ShowFavicon bool MaxMultipartMemory int64 // contains filtered or unexported fields }
Engine is a simple HTTP route multiplexer that parses a request path
func (*Engine) Any ¶
func (e *Engine) Any(path string, handle HandlerFunc)
func (*Engine) DELETE ¶
func (e *Engine) DELETE(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) DELETEAndName ¶
func (e *Engine) DELETEAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) FindHandle ¶ added in v0.0.19
func (*Engine) GET ¶
func (e *Engine) GET(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) GETAndName ¶
func (e *Engine) GETAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) GenerateURL ¶
func (*Engine) GetMiddleware ¶
func (e *Engine) GetMiddleware() []HandlerFunc
GetMiddleware GetMiddleware
func (*Engine) HEAD ¶
func (e *Engine) HEAD(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) HEADAndName ¶
func (e *Engine) HEADAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) Handle ¶
func (e *Engine) Handle(method string, path string, handle HandlerFunc, moreHandler ...HandlerFunc)
Handle registers new request handler
func (*Engine) HandleNotFound ¶
func (e *Engine) HandleNotFound(c *Context, middleware []HandlerFunc)
func (*Engine) NotFoundFunc ¶
func (e *Engine) NotFoundFunc(handler HandlerFunc)
func (*Engine) OPTIONS ¶
func (e *Engine) OPTIONS(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) OPTIONSAndName ¶
func (e *Engine) OPTIONSAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) PATCH ¶
func (e *Engine) PATCH(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) PATCHAndName ¶
func (e *Engine) PATCHAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) POST ¶
func (e *Engine) POST(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) POSTAndName ¶
func (e *Engine) POSTAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) PUT ¶
func (e *Engine) PUT(path string, handle HandlerFunc, moreHandler ...HandlerFunc)
func (*Engine) PUTAndName ¶
func (e *Engine) PUTAndName(path string, handle HandlerFunc, routeName string)
func (*Engine) PanicHandler ¶
func (*Engine) SetCustomMethodField ¶
SetCustomMethodField SetCustomMethodField
func (*Engine) SetTimeLocation ¶
SetTimeLocation timezone
func (*Engine) SetTimeout ¶
SetTimeout setTimeout
func (*Engine) StaticFile ¶
func (*Engine) Use ¶
func (e *Engine) Use(middleware ...HandlerFunc)
type MiddlewareType ¶
type MiddlewareType HandlerFunc
MiddlewareType is a public type that is used for middleware
type Node ¶
type Node struct {
// contains filtered or unexported fields
}
Node records any URL params, and executes an end handler.
type Parameters ¶
type Parameters struct {
// contains filtered or unexported fields
}
Parameters records some parameters
type Tree ¶
type Tree struct {
// contains filtered or unexported fields
}
Tree records node
func (*Tree) Add ¶
func (t *Tree) Add(pattern string, handle HandlerFunc, middleware ...HandlerFunc)
Source Files ¶
Click to show internal directories.
Click to hide internal directories.