flow

package module
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: May 27, 2019 License: MIT Imports: 13 Imported by: 2

README

flow

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

安装

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

示例1

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

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

示例2

func main() {
	app := flow.New()
	app.GET("/test/:name", func(ctx *flow.Context) {
		fmt.Println("name===", ctx.GetParam("name"))
		ctx.Json(map[string]interface{}{
			"name": ctx.GetParam("name"),
		})
	})
	app.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(app.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() {
	app := flow.New()
	app.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(app.Run())
}

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

API

flow.New

创建一个app实例

app.Run

启动服务

app.Use

添加中间件

app.GET

添加GET路由

app.HEAD

添加HEAD路由

app.OPTIONS

添加OPTIONS路由

app.POST

添加POST路由

app.PUT

添加PUT路由

app.PATCH

添加PATCH路由

app.DELETE

添加DELETE路由

app.ALL

添加以上每种方法的路由

app.StaticFiles

设置静态文件路径

ctx.GetParam

获取请求参数，包括通配路由字段，json字段，query字段，form表单字段

ctx.Parse

将请求参数赋值到定义的结构体中，如示例3所示，方便管理请求数据

ctx.GetHeaders

获取请求的所有头信息

ctx.GetHeader

获取给定的头信息

ctx.GetUri

获取请求的uri，如：http://localhost:9505/test/hello，返回/test/hello

ctx.GetHost

获取请求的主机，如：http://localhost:9505/test/hello，返回localhost:12345

ctx.GetProtocol

获取请求的协议类型，http|https

ctx.IsSecure

判断是不是安全的连接，当Protocol是https返回true

ctx.GetOrigin

获取请求的源，如：http://localhost:9505/test/hello，返回http://localhost:12345

ctx.GetHref

获取请求的连接，如：http://localhost:9505/test/hello，返回http://localhost:12345/test/hello

ctx.GetMethod

获取请求的方法

ctx.GetQuery

获取请求的query参数，以map方式返回

ctx.GetQuerystring

获取请求的query参数，以字符串方法返回

ctx.GetHostname

获取请求的主机名，如：http://localhost:9505/test/hello，返回localhost

ctx.GetLength

获取请求体的长度

ctx.SetHeader

设置返回的头信息

ctx.SetStatus

设置http返回码

ctx.SetLength

设置返回体的长度

ctx.Redirect

重定向

ctx.Download

文件下载

ctx.Logger

获取日志对象

ctx.Json

以json方式返回

ctx.Body

以文本方式返回

ctx.Render

渲染html,使用的HTML模板pongo2

Documentation

Index

Constants

View Source 
const (
	HTTP_METHOD_GET     = "GET"
	HTTP_METHOD_HEAD    = "HEAD"
	HTTP_METHOD_OPTIONS = "OPTIONS"
	HTTP_METHOD_POST    = "POST"
	HTTP_METHOD_PUT     = "PUT"
	HTTP_METHOD_PATCH   = "PATCH"
	HTTP_METHOD_DELETE  = "DELETE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Application 

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

func New 

func New() *Application

func (*Application) ALL 

func (app *Application) ALL(path string, handler Handler) *Application

func (*Application) DELETE 

func (app *Application) DELETE(path string, handler Handler) *Application

func (*Application) GET 

func (app *Application) GET(path string, handler Handler) *Application

func (*Application) GetAddress added in v1.0.2 

func (app *Application) GetAddress() string

func (*Application) GetAppName added in v1.0.2 

func (app *Application) GetAppName() string

func (*Application) GetLogPath added in v1.0.2 

func (app *Application) GetLogPath() string

func (*Application) GetProxy 

func (app *Application) GetProxy() bool

func (*Application) GetViewPath added in v1.0.2 

func (app *Application) GetViewPath() string

func (*Application) HEAD 

func (app *Application) HEAD(path string, handler Handler) *Application

func (*Application) OPTIONS 

func (app *Application) OPTIONS(path string, handler Handler) *Application

func (*Application) PATCH 

func (app *Application) PATCH(path string, handler Handler) *Application

func (*Application) POST 

func (app *Application) POST(path string, handler Handler) *Application

func (*Application) PUT 

func (app *Application) PUT(path string, handler Handler) *Application

func (*Application) Run 

func (app *Application) Run() error

func (*Application) SetAddress added in v1.0.2 

func (app *Application) SetAddress(address string) *Application

func (*Application) SetAppName added in v1.0.2 

func (app *Application) SetAppName(appName string) *Application

func (*Application) SetLogPath added in v1.0.2 

func (app *Application) SetLogPath(logPath string) *Application

func (*Application) SetPanicHandler added in v1.0.2 

func (app *Application) SetPanicHandler(panicHandler PanicHandler) *Application

func (*Application) SetProxy added in v1.0.2 

func (app *Application) SetProxy(proxy bool) *Application

func (*Application) SetViewPath added in v1.0.2 

func (app *Application) SetViewPath(viewPath string) *Application

func (*Application) StaticFiles 

func (app *Application) StaticFiles(prefix, path string) *Application

func (*Application) Use 

func (app *Application) Use(m Middleware) *Application

type Context 

type Context struct {
	Logger *log.Logger
	// 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) 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) GetUri 

func (c *Context) GetUri() string

func (*Context) GetUserAgent added in v1.0.2 

func (c *Context) GetUserAgent() string

func (*Context) IsSecure 

func (c *Context) IsSecure() bool

func (*Context) Json added in v1.0.2 

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

func (*Context) Parse added in v1.0.2 

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

func (*Context) Redirect 

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

func (*Context) Render added in v1.0.2 

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 Middleware 

type Middleware func(ctx *Context, next Next)

type Next 

type Next func()

type NotFoundHandle added in v1.0.2 

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

func (NotFoundHandle) ServeHTTP added in v1.0.2 

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

type PanicHandler added in v1.0.2 

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

Source Files

View all Source files

Directories

Path Synopsis
utils
json

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.