flow

README

flow

golang web frame as like koajs（洋葱圈模型）

安装

• go get -u github.com/funswe/flow

示例1

func main() {
	flow.ALL("/hello", func(ctx *flow.Context) {
		ctx.Body("hello,world")
	})
	fmt.Println("启动...")
	log.Fatal(flow.Run())
}

启动程序，在浏览器里访问http://localhost:9505/hello，可以看到浏览器返回hello,world

示例2

func main() {
	flow.GET("/test/:name", func(ctx *flow.Context) {
		fmt.Println("name===", ctx.GetParam("name"))
		ctx.Json(map[string]interface{}{
			"name": ctx.GetParam("name"),
		})
	})
	flow.Use(func(ctx *flow.Context, next flow.Next) {
		fmt.Println("mid1->start,time==", time.Now().UnixNano())
		next()
		fmt.Println("mid1->end,time===", time.Now().UnixNano())
	})
	fmt.Println("启动...")
	log.Fatal(flow.Run())
}

启动程序，在浏览器里访问http://localhost:9505/test/hello，可以看到浏览器返回{"name":"hello"}，终端打印

mid1->start,time== 1550045289462400763
name=== hello
mid1->end,time=== 1550045289462472332

示例3

type request struct {
	Age  int    `json:"age,string"`
	Name string `json:"name"`
}

func main() {
	flow.GET("/test/:name", func(ctx *flow.Context) {
       	req := &request{}
       	ctx.Parse(req)
       	ctx.Json(map[string]interface{}{
       		"name": req.Name,
       		"age":  req.Age,
       	})
    })
	fmt.Println("启动...")
	log.Fatal(flow.Run())
}

启动程序，在浏览器里访问http://localhost:9505/test/hello?age=30，可以看到浏览器返回{"age":30,"name":"hello"}

更多例子

模板

使用的HTML模板pongo2

Documentation

Index

• Constants
• func ALL(path string, handler Handler)
• func DELETE(path string, handler Handler)
• func GET(path string, handler Handler)
• func HEAD(path string, handler Handler)
• func OPTIONS(path string, handler Handler)
• func PATCH(path string, handler Handler)
• func POST(path string, handler Handler)
• func PUT(path string, handler Handler)
• func Run() error
• func SetLoggerConfig(loggerConfig *LoggerConfig)
• func SetNotFoundHandle(nfh NotFoundHandle)
• func SetOrmConfig(ormConfig *OrmConfig)
• func SetPanicHandler(ph PanicHandler)
• func SetServerConfig(serverConfig *ServerConfig)
• func Use(m Middleware)
• type Application
• type Context
  • func (c *Context) Body(body string)
  • func (c *Context) Download(filePath string)
  • func (c *Context) GetApp() *Application
  • func (c *Context) GetHeader(key string) string
  • func (c *Context) GetHeaders() map[string][]string
  • func (c *Context) GetHost() string
  • func (c *Context) GetHostname() string
  • func (c *Context) GetHref() string
  • func (c *Context) GetLength() int
  • func (c *Context) GetMethod() string
  • func (c *Context) GetOrigin() string
  • func (c *Context) GetParam(key string) (value string)
  • func (c *Context) GetParamDefault(key, defaultValue string) (value string)
  • func (c *Context) GetProtocol() string
  • func (c *Context) GetQuery() url.Values
  • func (c *Context) GetQuerystring() string
  • func (c *Context) GetStatusCode() int
  • func (c *Context) GetUri() string
  • func (c *Context) GetUserAgent() string
  • func (c *Context) IsSecure() bool
  • func (c *Context) Json(data map[string]interface{})
  • func (c *Context) Parse(object interface{}) error
  • func (c *Context) Redirect(url string, code int)
  • func (c *Context) Render(tmpFile string, data map[string]interface{})
  • func (c *Context) SetHeader(key, value string) *Context
  • func (c *Context) SetLength(length int) *Context
  • func (c *Context) SetStatus(code int) *Context
• type Handler
• type LoggerConfig
• type Middleware
• type Next
• type NotFoundHandle
  • func (f NotFoundHandle) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Orm
  • func (orm *Orm) Count(count *int64, fromTable *OrmFromTable, conditions map[string]interface{}) error
  • func (orm *Orm) DB() *gorm.DB
  • func (orm *Orm) Query(dest interface{}, fields []*OrmColumn, fromTable *OrmFromTable, ...) error
• type OrmColumn
• type OrmConfig
• type OrmFromTable
• type OrmGroupBy
• type OrmJoin
• type OrmLimit
• type OrmOp
• type OrmOrderBy
• type OrmPool
• type OrmWhere
• type PanicHandler
• type ServerConfig

Constants

const (
	HttpMethodGet     = "GET"
	HttpMethodHead    = "HEAD"
	HttpMethodOptions = "OPTIONS"
	HttpMethodPost    = "POST"
	HttpMethodPut     = "PUT"
	HttpMethodPatch   = "PATCH"
	HttpMethodDelete  = "DELETE"
)

const (
	HttpHeaderContentType             = "Content-Type"
	HttpHeaderContentLength           = "Content-Length"
	HttpHeaderTransferEncoding        = "Transfer-Encoding"
	HttpHeaderContentDisposition      = "Content-Disposition"
	HttpHeaderContentTransferEncoding = "Content-Transfer-Encoding"
	HttpHeaderExpires                 = "Expires"
	HttpHeaderCacheControl            = "Cache-Control"
	HttpHeaderEtag                    = "Etag"
	HttpHeaderXForwardedHost          = "X-Forwarded-Host"
	HttpHeaderXForwardedProto         = "X-Forwarded-Proto"
	HttpHeaderIfModifiedSince         = "If-Modified-Since"
	HttpHeaderIfNoneMatch             = "If-None-Match"
	HttpHeaderLastModified            = "Last-Modified"
	HttpHeaderXContentTypeOptions     = "X-Content-Type-Options"
	HttpHeaderXPoweredBy              = "X-Powered-By"
)

Functions

func ALL

func ALL(path string, handler Handler)

func DELETE

func DELETE(path string, handler Handler)

func GET

func GET(path string, handler Handler)

func HEAD

func HEAD(path string, handler Handler)

func OPTIONS

func OPTIONS(path string, handler Handler)

func PATCH

func PATCH(path string, handler Handler)

func POST

func POST(path string, handler Handler)

func PUT

func PUT(path string, handler Handler)

func Run

func Run() error

func SetLoggerConfig

func SetLoggerConfig(loggerConfig *LoggerConfig)

func SetNotFoundHandle

func SetNotFoundHandle(nfh NotFoundHandle)

func SetOrmConfig

func SetOrmConfig(ormConfig *OrmConfig)

func SetPanicHandler

func SetPanicHandler(ph PanicHandler)

func SetServerConfig

func SetServerConfig(serverConfig *ServerConfig)

func Use

func Use(m Middleware)

Types

type Application

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

type Context

type Context struct {
	Logger *log.Logger

	Orm *Orm
	// contains filtered or unexported fields
}

func (*Context) Body

func (c *Context) Body(body string)

func (*Context) Download

func (c *Context) Download(filePath string)

func (*Context) GetApp

func (c *Context) GetApp() *Application

func (*Context) GetHeader

func (c *Context) GetHeader(key string) string

func (*Context) GetHeaders

func (c *Context) GetHeaders() map[string][]string

func (*Context) GetHost

func (c *Context) GetHost() string

func (*Context) GetHostname

func (c *Context) GetHostname() string

func (*Context) GetHref

func (c *Context) GetHref() string

func (*Context) GetLength

func (c *Context) GetLength() int

func (*Context) GetMethod

func (c *Context) GetMethod() string

func (*Context) GetOrigin

func (c *Context) GetOrigin() string

func (*Context) GetParam

func (c *Context) GetParam(key string) (value string)

func (*Context) GetParamDefault

func (c *Context) GetParamDefault(key, defaultValue string) (value string)

func (*Context) GetProtocol

func (c *Context) GetProtocol() string

func (*Context) GetQuery

func (c *Context) GetQuery() url.Values

func (*Context) GetQuerystring

func (c *Context) GetQuerystring() string

func (*Context) GetStatusCode

func (c *Context) GetStatusCode() int

func (*Context) GetUri

func (c *Context) GetUri() string

func (*Context) GetUserAgent

func (c *Context) GetUserAgent() string

func (*Context) IsSecure

func (c *Context) IsSecure() bool

func (*Context) Json

func (c *Context) Json(data map[string]interface{})

func (*Context) Parse

func (c *Context) Parse(object interface{}) error

func (*Context) Redirect

func (c *Context) Redirect(url string, code int)

func (*Context) Render

func (c *Context) Render(tmpFile string, data map[string]interface{})

func (*Context) SetHeader

func (c *Context) SetHeader(key, value string) *Context

func (*Context) SetLength

func (c *Context) SetLength(length int) *Context

func (*Context) SetStatus

func (c *Context) SetStatus(code int) *Context

type Handler

type Handler func(ctx *Context)

type LoggerConfig

type LoggerConfig struct {
	LoggerLevel string
	LoggerPath  string
}

type Middleware

type Middleware func(ctx *Context, next Next)

type Next

type Next func()

type NotFoundHandle

type NotFoundHandle func(w http.ResponseWriter, r *http.Request)

func (NotFoundHandle) ServeHTTP

func (f NotFoundHandle) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Orm

type Orm struct {
	Op *OrmOp
	// contains filtered or unexported fields
}

func (*Orm) Count

func (orm *Orm) Count(count *int64, fromTable *OrmFromTable, conditions map[string]interface{}) error

func (*Orm) DB

func (orm *Orm) DB() *gorm.DB

func (*Orm) Query

func (orm *Orm) Query(dest interface{}, fields []*OrmColumn, fromTable *OrmFromTable, conditions map[string]interface{}, orderBy []*OrmOrderBy, limit *OrmLimit, groupBy *OrmGroupBy) error

type OrmColumn

type OrmColumn struct {
	Table  string
	Column string
	Alias  string
}

type OrmConfig

type OrmConfig struct {
	Enable   bool
	UserName string
	Password string
	DbName   string
	Host     string
	Port     int
	Pool     *OrmPool
}

type OrmFromTable

type OrmFromTable struct {
	Table string
	Alias string
	Joins []*OrmJoin
}

type OrmGroupBy

type OrmGroupBy struct {
	Columns []*OrmColumn
	Having  []*OrmWhere
}

type OrmJoin

type OrmJoin struct {
	Type  string
	Table string
	Alias string
	ON    []*OrmWhere
}

type OrmLimit

type OrmLimit struct {
	Limit  int
	Offset int
}

type OrmOp

type OrmOp struct {
	Eq   string
	Gt   string
	Gte  string
	Lt   string
	Lte  string
	IN   string
	Like string
	Or   string
}

type OrmOrderBy

type OrmOrderBy struct {
	Column *OrmColumn
	Desc   bool
}

type OrmPool

type OrmPool struct {
	MaxIdle         int
	MaxOpen         int
	ConnMaxLifeTime int64
	ConnMaxIdleTime int64
}

type OrmWhere

type OrmWhere struct {
	Column *OrmColumn
	Opt    string
	// contains filtered or unexported fields
}

type PanicHandler

type PanicHandler func(http.ResponseWriter, *http.Request, interface{})

type ServerConfig

type ServerConfig struct {
	AppName    string
	Proxy      bool
	Host       string
	Port       int
	ViewPath   string
	StaticPath string
}