seago

package module
v0.0.0-...-d572f23 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2015 License: Apache-2.0 Imports: 30 Imported by: 3

README

Seago

Seago是一个golang 的 http 框架，代码 fork 自Macaron。

主要特性

  • 支持子路由的强大路由设计
  • 支持灵活多变的路由组合
  • 支持无限路由组的无限嵌套
  • 支持直接集成现有的服务
  • 支持运行时动态设置需要渲染的模板集
  • 支持使用内存文件作为静态资源和模板文件
  • 支持对模块的轻松接入与解除
  • 采用 inject 提供的便利的依赖注入
  • 采用更好的路由层和更少的反射来提升执行速度

帮助文档

特别鸣谢

感谢Matini以及Macaron开发人员

Documentation

Overview

Package Seago is a high productive and modular design web framework in Go.

Index

Constants

View Source 
const (
	HeaderAcceptEncoding  = "Accept-Encoding"
	HeaderContentEncoding = "Content-Encoding"
	HeaderContentLength   = "Content-Length"
	HeaderContentType     = "Content-Type"
	HeaderVary            = "Vary"
)
View Source 
const (
	ContentType   = "Content-Type"
	ContentLength = "Content-Length"
	ContentBinary = "application/octet-stream"
	ContentJSON   = "application/json"
	ContentHTML   = "text/html"
	CONTENT_PLAIN = "text/plain"
	ContentXHTML  = "application/xhtml+xml"
	ContentXML    = "text/xml"
)
View Source 
const (
	DEV  string = "development"
	PROD string = "production"
	TEST string = "test"
)

Variables

View Source 
var (
	// Env is the environment that Macaron is executing in.
	// The SEAGO_ENV is read on initialization to set this variable.
	Env = DEV

	// Path of work directory.
	Root string

	// Flash applies to current request.
	FlashNow bool
)

Functions

func Config 

func Config() *ini.File

Config returns configuration convention object. It returns an empty object if there is no one available.

func GetDefaultListenInfo 

func GetDefaultListenInfo() (string, int)

func GetExt 

func GetExt(s string) string

func NewRouteMap 

func NewRouteMap() *routeMap

NewRouteMap initializes and returns a new routeMap.

func ParseTplSet 

func ParseTplSet(tplSet string) (tplName string, tplDir string)

func PrepareCharset 

func PrepareCharset(charset string) string

func SetConfig 

func SetConfig(source interface{}, others ...interface{}) (_ *ini.File, err error)

SetConfig sets data sources for configuration.

func Version 

func Version() string

Types

type BeforeFunc 

type BeforeFunc func(ResponseWriter)

BeforeFunc is a function that is called before the ResponseWriter has been written to.

type BeforeHandler 

type BeforeHandler func(rw http.ResponseWriter, req *http.Request) bool

BeforeHandler represents a handler executes at beginning of every request. Macaron stops future process when it returns true.

type BufferPool 

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

BufferPool implements a pool of bytes.Buffers in the form of a bounded channel.

func NewBufferPool 

func NewBufferPool(size int) (bp *BufferPool)

NewBufferPool creates a new BufferPool bounded to the given size.

func (*BufferPool) Get 

func (bp *BufferPool) Get() (b *bytes.Buffer)

Get gets a Buffer from the BufferPool, or creates a new one if none are available in the pool.

func (*BufferPool) Put 

func (bp *BufferPool) Put(b *bytes.Buffer)

Put returns the given Buffer to the BufferPool.

type ComboRouter 

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

ComboRouter represents a combo router.

func (*ComboRouter) Delete 

func (cr *ComboRouter) Delete(h ...Handler) *ComboRouter

func (*ComboRouter) Get 

func (cr *ComboRouter) Get(h ...Handler) *ComboRouter

func (*ComboRouter) Head 

func (cr *ComboRouter) Head(h ...Handler) *ComboRouter

func (*ComboRouter) Options 

func (cr *ComboRouter) Options(h ...Handler) *ComboRouter

func (*ComboRouter) Patch 

func (cr *ComboRouter) Patch(h ...Handler) *ComboRouter

func (*ComboRouter) Post 

func (cr *ComboRouter) Post(h ...Handler) *ComboRouter

func (*ComboRouter) Put 

func (cr *ComboRouter) Put(h ...Handler) *ComboRouter

type Context 

type Context struct {
	inject.Injector

	*Router
	Request  Request
	Response ResponseWriter

	File   *multipart.File
	Render // Not nil only if you use macaran.Render middleware.
	Locale
	Data map[string]interface{}
	// contains filtered or unexported fields
}

Context represents the runtime context of current request of Seago instance. It is the integration of most frequently used middlewares and helper methods.

func (*Context) ChangeStaticPath 

func (ctx *Context) ChangeStaticPath(oldPath, newPath string)

ChangeStaticPath changes static path from old to new one.

func (*Context) GetCookie 

func (ctx *Context) GetCookie(name string) string

GetCookie returns given cookie value from request header.

func (*Context) GetFile 

func (ctx *Context) GetFile(name string) (multipart.File, *multipart.FileHeader, error)

GetFile returns information about user upload file by given form field name.

func (*Context) GetFiles 

func (ctx *Context) GetFiles(name string) ([]*multipart.FileHeader, bool)

获取多文件上传的文件信息

func (*Context) GetParam 

func (ctx *Context) GetParam(name string) Value

获取http 请求中 GET POST PUT DELETE等方法的参数以及路由规则中的参数

func (*Context) GetSecureCookie 

func (ctx *Context) GetSecureCookie(key string) (string, bool)

GetSecureCookie returns given cookie value from request header with default secret string.

func (*Context) GetSuperSecureCookie 

func (ctx *Context) GetSuperSecureCookie(Secret, key string) (string, bool)

GetSuperSecureCookie returns given cookie value from request header with secret string.

func (*Context) HTML 

func (ctx *Context) HTML(status int, name string, data ...interface{})

HTML calls Render.HTML but allows less arguments.

func (*Context) HTMLSet 

func (ctx *Context) HTMLSet(status int, setName, tplName string, data ...interface{})

HTML calls Render.HTMLSet but allows less arguments.

func (*Context) HasParam 

func (ctx *Context) HasParam(name string) (Value, bool)

判断http请求中GET POST PUT DELETE 等方法的参数以及路由规则中的参数是否存在

func (*Context) Next 

func (c *Context) Next()

func (*Context) Redirect 

func (ctx *Context) Redirect(location string, status ...int)

URL跳转

func (*Context) RemoteAddr 

func (ctx *Context) RemoteAddr() string

RemoteAddr returns more real IP address.

func (*Context) ServeFile 

func (ctx *Context) ServeFile(file string, names ...string)

ServeFile serves given file to response.

func (*Context) SetCookie 

func (ctx *Context) SetCookie(name string, value string, others ...interface{})

SetCookie sets given cookie value to response header.

func (*Context) SetParam 

func (ctx *Context) SetParam(name, value string)

func (*Context) SetSecureCookie 

func (ctx *Context) SetSecureCookie(name, value string, others ...interface{})

SetSecureCookie sets given cookie value to response header with default secret string.

func (*Context) SetSuperSecureCookie 

func (ctx *Context) SetSuperSecureCookie(Secret, name, value string, others ...interface{})

SetSuperSecureCookie sets given cookie value to response header with secret string.

func (*Context) Written 

func (c *Context) Written() bool

type Delims 

type Delims struct {
	// Left delimiter, defaults to {{
	Left string
	// Right delimiter, defaults to }}
	Right string
}

Delims represents a set of Left and Right delimiters for HTML template rendering

type HTMLOptions 

type HTMLOptions struct {
	// Layout template name. Overrides Options.Layout.
	Layout string
}

HTMLOptions is a struct for overriding some rendering Options for specific HTML call

type Handle 

type Handle func(http.ResponseWriter, *http.Request, Params)

Handle is a function that can be registered to a route to handle HTTP requests. Like http.HandlerFunc, but has a third parameter for the values of wildcards (variables).

type Handler 

type Handler interface{}

Handler can be any callable function. Seago attempts to inject services into the handler's argument list, and panics if an argument could not be fullfilled via dependency injection.

func Gziper 

func Gziper() Handler

Gziper returns a Handler that adds gzip compression to all requests. Make sure to include the Gzip middleware above other middleware that alter the response body (like the render middleware).

func Logger 

func Logger() Handler

Logger returns a middleware handler that logs the request as it goes in and the response as it goes out.

func Recovery 

func Recovery() Handler

Recovery returns a middleware that recovers from any panics and writes a 500 if there was one. While Martini is in development mode, Recovery will also output the panic as HTML.

func Renderer 

func Renderer(options ...RenderOptions) Handler

Renderer is a Middleware that maps a seago.Render service into the Seago handler chain. An single variadic seago.RenderOptions struct can be optionally provided to configure HTML rendering. The default directory for templates is "templates" and the default file extension is ".tmpl" and ".html".

If SEAGO_ENV is set to "" or "development" then templates will be recompiled on every request. For more performance, set the SEAGO_ENV environment variable to "production".

func Renderers 

func Renderers(options RenderOptions, tplSets ...string) Handler

func Static 

func Static(directory string, staticOpt ...StaticOptions) Handler

Static returns a middleware handler that serves static files in the given directory.

type Locale 

type Locale interface {
	Language() string
	Tr(string, ...interface{}) string
}

Locale reprents a localization interface.

type Params 

type Params map[string]string

type Render 

type Render interface {
	http.ResponseWriter
	RW() http.ResponseWriter

	JSON(int, interface{})
	JSONString(interface{}) (string, error)
	RawData(int, []byte)
	RenderData(int, []byte)
	HTML(int, string, interface{}, ...HTMLOptions)
	HTMLSet(int, string, string, interface{}, ...HTMLOptions)
	HTMLSetString(string, string, interface{}, ...HTMLOptions) (string, error)
	HTMLString(string, interface{}, ...HTMLOptions) (string, error)
	HTMLSetBytes(string, string, interface{}, ...HTMLOptions) ([]byte, error)
	HTMLBytes(string, interface{}, ...HTMLOptions) ([]byte, error)
	XML(int, interface{})
	Error(int, ...string)
	Status(int)
	SetTemplatePath(string, string)
	HasTemplateSet(string) bool
}

type RenderOptions 

type RenderOptions struct {
	// Directory to load templates. Default is "templates".
	Directory string
	// Layout template name. Will not render a layout if "". Default is to "".
	Layout string
	// Extensions to parse template files from. Defaults are [".tmpl", ".html"].
	Extensions []string
	// Funcs is a slice of FuncMaps to apply to the template upon compilation. This is useful for helper functions. Default is [].
	Funcs []template.FuncMap
	// Delims sets the action delimiters to the specified strings in the Delims struct.
	Delims Delims
	// Appends the given charset to the Content-Type header. Default is "UTF-8".
	Charset string
	// Outputs human readable JSON.
	IndentJSON bool
	// Outputs human readable XML.
	IndentXML bool
	// Prefixes the JSON output with the given bytes.
	PrefixJSON []byte
	// Prefixes the XML output with the given bytes.
	PrefixXML []byte
	// Allows changing of output to XHTML instead of HTML. Default is "text/html"
	HTMLContentType string
	// TemplateFileSystem is the interface for supporting any implmentation of template file system.
	TemplateFileSystem
}

RenderOptions represents a struct for specifying configuration options for the Render middleware.

type Request 

type Request struct {
	*http.Request
}

A Request represents an HTTP request received by a server or to be sent by a client.

func (*Request) Body 

func (r *Request) Body() *RequestBody

type RequestBody 

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

Body is the request's body.

func (*RequestBody) Bytes 

func (rb *RequestBody) Bytes() ([]byte, error)

func (*RequestBody) ReadCloser 

func (rb *RequestBody) ReadCloser() io.ReadCloser

func (*RequestBody) String 

func (rb *RequestBody) String() (string, error)

type ResponseWriter 

type ResponseWriter interface {
	http.ResponseWriter
	http.Flusher
	// Status returns the status code of the response or 0 if the response has not been written.
	Status() int
	// Written returns whether or not the ResponseWriter has been written.
	Written() bool
	// Size returns the size of the response body.
	Size() int
	// Before allows for a function to be called before the ResponseWriter has been written to. This is
	// useful for setting headers or any other operations that must happen before a response has been written.
	Before(BeforeFunc)
}

ResponseWriter is a wrapper around http.ResponseWriter that provides extra information about the response. It is recommended that middleware handlers use this construct to wrap a responsewriter if the functionality calls for it.

func NewResponseWriter 

func NewResponseWriter(rw http.ResponseWriter) ResponseWriter

NewResponseWriter creates a ResponseWriter that wraps an http.ResponseWriter

type ReturnHandler 

type ReturnHandler func(*Context, []reflect.Value)

ReturnHandler is a service that Martini provides that is called when a route handler returns something. The ReturnHandler is responsible for writing to the ResponseWriter based on the values that are passed into this function.

type Router 

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

Router represents a Seago router layer.

func NewRouter 

func NewRouter() *Router

func (*Router) Any 

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

Any is a shortcut for r.Handle("*", pattern, handlers)

func (*Router) Combo 

func (r *Router) Combo(pattern string) *ComboRouter

Combo returns a combo router.

func (*Router) Delete 

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

Delete is a shortcut for r.Handle("DELETE", pattern, handlers)

func (*Router) Get 

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

Get is a shortcut for r.Handle("GET", pattern, handlers)

func (*Router) Group 

func (r *Router) Group(pattern string, fn func(), h ...Handler)

func (*Router) Handle 

func (r *Router) Handle(method string, pattern string, handlers []Handler)

Handle registers a new request handle with the given pattern, method and handlers.

func (*Router) Head 

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

Head is a shortcut for r.Handle("HEAD", pattern, handlers)

func (*Router) NotFound 

func (r *Router) NotFound(handlers ...Handler)

Configurable http.HandlerFunc which is called when no matching route is found. If it is not set, http.NotFound is used. Be sure to set 404 response code in your handler.

func (*Router) Options 

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

Options is a shortcut for r.Handle("OPTIONS", pattern, handlers)

func (*Router) Patch 

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

Patch is a shortcut for r.Handle("PATCH", pattern, handlers)

func (*Router) Post 

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

Post is a shortcut for r.Handle("POST", pattern, handlers)

func (*Router) Put 

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

Put is a shortcut for r.Handle("PUT", pattern, handlers)

func (*Router) Route 

func (r *Router) Route(pattern, methods string, h ...Handler)

Route is a shortcut for same handlers but different HTTP methods.

Example: 

m.Route("/", "GET,POST", h)

func (*Router) ServeHTTP 

func (r *Router) ServeHTTP(rw http.ResponseWriter, req *http.Request)

type Seago 

type Seago struct {
	inject.Injector

	*Router
	// contains filtered or unexported fields
}

Seago represents the top level web application. inject.Injector methods can be invoked to map services on a global level.

func Classic 

func Classic() *Seago

Classic creates a classic Macaron with some basic default middleware: Web.Logger, Web.Recovery and Web.Static.

func New 

func New() *Seago

New creates a bare bones Seago instance. Use this method if you want to have full control over the middleware that is used.

func NewWithLogger 

func NewWithLogger(out io.Writer) *Seago

NewWithLogger creates a bare bones Seago instance. Use this method if you want to have full control over the middleware that is used. You can specify logger output writer with this function.

func (*Seago) Action 

func (m *Seago) Action(handler Handler)

Action sets the handler that will be called after all the middleware has been invoked. This is set to macaron.Router in a macaron.Classic().

func (*Seago) Before 

func (m *Seago) Before(handler BeforeHandler)

func (*Seago) Handlers 

func (m *Seago) Handlers(handlers ...Handler)

Handlers sets the entire middleware stack with the given Handlers. This will clear any current middleware handlers, and panics if any of the handlers is not a callable function

func (*Seago) Run 

func (m *Seago) Run(args ...interface{})

Run the http server. Listening on os.GetEnv("PORT") or 4000 by default.

func (*Seago) ServeHTTP 

func (m *Seago) ServeHTTP(rw http.ResponseWriter, req *http.Request)

ServeHTTP is the HTTP Entry point for a Macaron instance. Useful if you want to control your own HTTP server. Be aware that none of middleware will run without registering any router.

func (*Seago) SetDefaultCookieSecret 

func (s *Seago) SetDefaultCookieSecret(secret string)

SetDefaultCookieSecret sets global default secure cookie secret.

func (*Seago) SetURLPrefix 

func (m *Seago) SetURLPrefix(prefix string)

SetURLPrefix sets URL prefix of router layer, so that it support suburl.

func (*Seago) Use 

func (m *Seago) Use(handler Handler)

Use adds a middleware Handler to the stack, and panics if the handler is not a callable func. Middleware Handlers are invoked in the order that they are added.

type StaticOptions 

type StaticOptions struct {
	// Prefix is the optional prefix used to serve the static directory content
	Prefix string
	// SkipLogging will disable [Static] log messages when a static file is served.
	SkipLogging bool
	// IndexFile defines which file to serve as index if it exists.
	IndexFile string
	// Expires defines which user-defined function to use for producing a HTTP Expires Header
	// https://developers.google.com/speed/docs/insights/LeverageBrowserCaching
	Expires func() string
}

StaticOptions is a struct for specifying configuration options for the macaron.Static middleware.

type TemplateFile 

type TemplateFile interface {
	Name() string
	Data() []byte
	Ext() string
}

TemplateFile represents a interface of template file that has name and can be read.

type TemplateFileSystem 

type TemplateFileSystem interface {
	ListFiles() []TemplateFile
}

TemplateFileSystem represents a interface of template file system that able to list all files.

type TplFile 

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

TplFile implements TemplateFile interface.

func NewTplFile 

func NewTplFile(name string, data []byte, ext string) *TplFile

NewTplFile cerates new template file with given name and data.

func (*TplFile) Data 

func (f *TplFile) Data() []byte

func (*TplFile) Ext 

func (f *TplFile) Ext() string

func (*TplFile) Name 

func (f *TplFile) Name() string

type TplFileSystem 

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

TplFileSystem implements TemplateFileSystem interface.

func NewTemplateFileSystem 

func NewTemplateFileSystem(opt RenderOptions, omitData bool) TplFileSystem

NewTemplateFileSystem creates new template file system with given options.

func (TplFileSystem) ListFiles 

func (fs TplFileSystem) ListFiles() []TemplateFile

type TplRender 

type TplRender struct {
	http.ResponseWriter

	Opt             *RenderOptions
	CompiledCharset string
	// contains filtered or unexported fields
}

func (*TplRender) Error 

func (r *TplRender) Error(status int, message ...string)

Error writes the given HTTP status to the current ResponseWriter

func (TplRender) Get 

func (ts TplRender) Get(name string) *template.Template

func (TplRender) GetDir 

func (ts TplRender) GetDir(name string) string

func (*TplRender) HTML 

func (r *TplRender) HTML(status int, name string, data interface{}, htmlOpt ...HTMLOptions)

func (*TplRender) HTMLBytes 

func (r *TplRender) HTMLBytes(name string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)

func (*TplRender) HTMLSet 

func (r *TplRender) HTMLSet(status int, setName, tplName string, data interface{}, htmlOpt ...HTMLOptions)

func (*TplRender) HTMLSetBytes 

func (r *TplRender) HTMLSetBytes(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)

func (*TplRender) HTMLSetString 

func (r *TplRender) HTMLSetString(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) (string, error)

func (*TplRender) HTMLString 

func (r *TplRender) HTMLString(name string, data interface{}, htmlOpt ...HTMLOptions) (string, error)

func (*TplRender) HasTemplateSet 

func (r *TplRender) HasTemplateSet(name string) bool

func (*TplRender) JSON 

func (r *TplRender) JSON(status int, v interface{})

func (*TplRender) JSONString 

func (r *TplRender) JSONString(v interface{}) (string, error)

func (*TplRender) RW 

func (r *TplRender) RW() http.ResponseWriter

func (*TplRender) RawData 

func (r *TplRender) RawData(status int, v []byte)

func (*TplRender) RenderData 

func (r *TplRender) RenderData(status int, v []byte)

func (TplRender) Set 

func (ts TplRender) Set(name string, opt *RenderOptions) *template.Template

func (*TplRender) SetTemplatePath 

func (r *TplRender) SetTemplatePath(setName, dir string)

func (*TplRender) Status 

func (r *TplRender) Status(status int)

func (*TplRender) XML 

func (r *TplRender) XML(status int, v interface{})

type Tree 

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

Tree represents a router tree for Macaron instance.

func NewTree 

func NewTree() *Tree

NewTree initializes and returns a router tree.

func (*Tree) AddRouter 

func (t *Tree) AddRouter(pattern string, handle Handle)

AddRouter adds a new route to router tree.

func (*Tree) Match 

func (t *Tree) Match(pattern string) (Handle, Params)

Match returns Handle and params if any route is matched.

type Value 

type Value string

func (Value) Bool 

func (v Value) Bool() bool

*

  • 获取bool值

func (Value) Float32 

func (v Value) Float32() float32

*

  • 获取float32值

func (Value) Float64 

func (v Value) Float64() float64

*

  • 获取float64值

func (Value) HtmlEscape 

func (v Value) HtmlEscape() string

*

  • html escape

func (Value) Int 

func (v Value) Int() (i int)

*

  • 获取int值

func (Value) Int32 

func (v Value) Int32() int32

*

  • 获取int32值

func (Value) Int64 

func (v Value) Int64() (i int64)

*

  • 获取int64值

func (Value) JsonDecode 

func (v Value) JsonDecode(iv interface{}) error

*

  • 解析json值

func (Value) String 

func (v Value) String() string

*

  • 获取string值

Source Files

View all Source files

Directories

Path Synopsis
Package inject provides utilities for mapping and injecting dependencies in various ways.
 Package inject provides utilities for mapping and injecting dependencies in various ways.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.