flygo

package module
v0.2.7-beta5 Latest Latest
Warning

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

 Go to latest Published: Jun 16, 2020 License: Apache-2.0 Imports: 19 Imported by: 5

README

flygo

Introduction

A simple and lightweight web framework, pure native and no third dependencies.

Features

  • Pure native
  • No third dependencies
  • Support variables route
  • Support env variables for deploymenting
  • Support filter chain (Before & After)
  • Support interceptor chain (Before & After)
  • Static cache
  • View data cache
  • Field preset
  • Field validation
  • Global level cache

New

  • Support Middleware (since v0.2.2-beta)
    • logger : Built in Logger
    • cors : A Cors middleware for flygo
    • redisauth : A simple authentication with redis middleware for flygo
    • redistoken : A simple authorization with redis middleware for flygo

Install

  1. GOPATH
mkdir -p $GOPATH/src/gitee.com/billcoding/flygo

cd $GOPATH/src/gitee.com/billcoding

git clone https://gitee.com/billcoding/flygo.git flygo
  1. Go mod
require gitee.com/billcoding/flygo TAG

Versions

https://gitee.com/billcoding/flygo/releases

Usage

package main

import (
	"gitee.com/billcoding/flygo"
)

func main() {
	app := flygo.NewApp()

	app.Get("/", func(context Context) {
		context.Text("index")
	})

	app.Run()
}

Configuration

Name Key Config Default Description
WebRoot global.webRoot app.SetWebRoot(WEB_ROOT) ./ The app webroot
StaticEnable static.enable app.SetStaticEnable(STATIC_ENABLE) false Static resource enable
StaticPattern static.pattern app.SetStaticPattern(STATIC_PATTERN) /static Static resource request URL
StaticPrefix static.prefix app.SetStaticPrefix(STATIC_PREFIX) static Static resource local file prefix
StaticCache static.cache app.SetStaticCache(STATIC_CACHE) true Static resource enable cache
ViewPrefix view.prefix app.SetViewPrefix(VIEW_PREFIX) templates View local file prefix
ViewSuffix view.suffix app.SetViewSuffix(VIEW_SUFFIX) html View local file suffix
ViewCache view.cache app.SetViewCache(VIEW_CACHE) true View enable cache
ValidateErrCode validate.err.code app.SetValidateErrCode(Validate_ERR_CODE) 1 Route field validate err code

Environment Variables

Name Description
FLYGO_HOST bind address
FLYGO_PORT bind port
FLYGO_WEB_ROOT app webroot
FLYGO_STATIC_CACHE app enable static resource cache
FLYGO_VIEW_CACHE app view cache

Middleware

  • Middleware (based on route)

    Must implements flygo.Middleware interface

app.Use(middlewares ...Middleware)

  • FilterMiddleware (based on filter)

    Must implements flygo.FilterMiddleware interface

app.UseFilter(filtermiddlewares ...FilterMiddleware)

  • InterceptorMiddleware (based on interceptor)

    Must implements flygo.InterceptorMiddleware interface

app.UseInterceptor(interceptorMiddlewares ...InterceptorMiddleware)

Default Handler Config

  • Not found resource
 app.DefaultHandler(HANDLER)
  • Not supported request
app.RequestNotSupportedHandler(HANDLER)
  • Favicon ico handler
app.FaviconIco()

The favicon ico file should be stored at $WEB_ROOT/$STATIC_PREFIX/favicon.ico

Route Types

  • Pattern route
/index/id
  • Variables route
/index/{id}/{name}

Handler Methods

  • All
app.Req(PATTERN, HANDLER, FIELD...)
  • GET
app.Get(PATTERN, HANDLER, FIELD...)
  • POST
app.Post(PATTERN, HANDLER, FIELD...)
  • DELETE
app.Delete(PATTERN, HANDLER, FIELD...)
  • PUT
app.Put(PATTERN, HANDLER, FIELD...)
  • PATCH
app.Patch(PATTERN, HANDLER, FIELD...)

Filter Config

  • Before filter
app.BeforeFilter(PATTERN, HANDLER)
  • After filter
app.AfterFilter(PATTERN, HANDLER)

Interceptor Config

  • Get prev results
context.Response.GetData()
  • Before interceptor
app.BeforeInterceptor(PATTERN, HANDLER)
  • After interceptor
app.AfterInterceptor(PATTERN, HANDLER)

Field Preset

  • First set part enable
field.Preset()
  • Default value
field.DefaultVal(DEFAULT_VAL)
  • Concat multiple values
field.Concat(true)
  • Concat rune
field.ConcatRune(CONCAT_RUNE)
  • Split single value
field.Split(true)
  • Split rune
field.SplitRune(SPLIT_RUNE)

Field Validation

  • First set part enable
field.Validate()
  • Min number value
field.Min(MIN_VALUE)
  • Max number value
field.Max(MAX_VALUE)
  • Min length string
field.MinLength(MIN_LENGTH)
  • Max length string
field.MaxLength(MAX_LENGTH)
  • Optional values
field.Enums(VALUE...)
  • Regex validation
field.Regex(PATTERN)

Global Cache

  • Set data
app.SetCache(KEY,DATA)
  • Get data
app.GetCache(KEY)
  • Remove data
app.RemoveCache(KEY)
  • Clear caches
app.ClearCaches()

Multipart Support

  • First parse the request
context.ParseMultipart(MEMORY_SIZE)
  • Get a multipart file
context.GetMultipartFile(FILE_NAME)
  • Get some multipart files
context.GetMultipartFiles(FILE_NAME)
  • Get multipart file original filename
multipartFile.Filename()
  • Get multipart file size in byte
multipartFile.Size()
  • Get multipart file MIME type
multipartFile.ContentType()
  • Get formdata request header
multipartFile.Header(NAME)
  • Get formdata request all headers
multipartFile.Headers()
  • Copy to local disk
multipartFile.Copy(DISK_PATH)

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Logger = &logger{}

Functions

This section is empty.

Types

type App 

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

Define app struct

func GetApp 

func GetApp() *App

Return app

func NewApp 

func NewApp() *App

Return new App

func (*App) AfterFilter 

func (app *App) AfterFilter(pattern string, filterHandler FilterHandler) *App

Route after filter

func (*App) AfterInterceptor 

func (app *App) AfterInterceptor(pattern string, interceptorHandler InterceptorHandler) *App

Route after interceptor

func (*App) Banner 

func (app *App) Banner(banner bool) *App

Enable banner print

func (*App) BeforeFilter 

func (app *App) BeforeFilter(pattern string, filterHandler FilterHandler) *App

Route before filter

func (*App) BeforeInterceptor 

func (app *App) BeforeInterceptor(pattern string, interceptorHandler InterceptorHandler) *App

Route before interceptor

func (*App) ClearCaches 

func (app *App) ClearCaches()

clear caches

func (*App) DefaultHandler 

func (app *App) DefaultHandler(handler Handler) *App

Config default handler

func (*App) Delete 

func (app *App) Delete(pattern string, handler Handler, fields ...*Field) *App

Route Handler for DELETE method

func (*App) FaviconIco 

func (app *App) FaviconIco() *App

Enable default favicon ico handler

func (*App) Get 

func (app *App) Get(pattern string, handler Handler, fields ...*Field) *App

Route Handler for GET method

func (*App) GetCache 

func (app *App) GetCache(key string) interface{}

Get data from app storage

func (*App) GetContextPath 

func (app *App) GetContextPath() string

Get contextPath

func (*App) GetStaticCache 

func (app *App) GetStaticCache() bool

Get static cache

func (*App) GetStaticEnable 

func (app *App) GetStaticEnable() bool

Get static enable

func (*App) GetStaticPattern 

func (app *App) GetStaticPattern() string

Get static pattern

func (*App) GetStaticPrefix 

func (app *App) GetStaticPrefix() string

Get static prefix

func (*App) GetValidateErrCode 

func (app *App) GetValidateErrCode() int

Get validate err code

func (*App) GetViewCache 

func (app *App) GetViewCache() bool

Get view cache

func (*App) GetViewPrefix 

func (app *App) GetViewPrefix() string

Get view prefix

func (*App) GetViewSuffix 

func (app *App) GetViewSuffix() string

Get view suffix

func (*App) GetWebRoot 

func (app *App) GetWebRoot() string

Get webRoot

func (*App) LogFatal 

func (app *App) LogFatal(message string, args ...interface{})

Log fatal

func (*App) LogInfo 

func (app *App) LogInfo(message string, args ...interface{})

Log info

func (*App) LogWarn 

func (app *App) LogWarn(message string, args ...interface{})

Log warn

func (*App) Patch 

func (app *App) Patch(pattern string, handler Handler, fields ...*Field) *App

Route Handler for PATCH method

func (*App) Post 

func (app *App) Post(pattern string, handler Handler, fields ...*Field) *App

Route Handler for POST method

func (*App) PreflightedHandler 

func (app *App) PreflightedHandler(handler Handler) *App

Config preflighted handler

func (*App) Put 

func (app *App) Put(pattern string, handler Handler, fields ...*Field) *App

Route Handler for PUT method

func (*App) RegisterStaticRes 

func (app *App) RegisterStaticRes(fileExt, contentType string) *App

Register a static res

func (*App) RemoveCache 

func (app *App) RemoveCache(key string)

remove data from app storage

func (*App) Req 

func (app *App) Req(pattern string, handler Handler, fields ...*Field) *App

Route Handler for all method

func (*App) RequestNotSupportedHandler 

func (app *App) RequestNotSupportedHandler(handler Handler) *App

Config request not supported handler

func (*App) Run 

func (app *App) Run()

Run the server

func (*App) RunAs 

func (app *App) RunAs(host string, port int)

Run as the server

func (*App) SetCache 

func (app *App) SetCache(key string, data interface{})

Set data into app storage

func (*App) SetContextPath 

func (app *App) SetContextPath(contextPath string) *App

Set contextPath

func (*App) SetStaticCache 

func (app *App) SetStaticCache(cache bool) *App

Set static cache

func (*App) SetStaticEnable 

func (app *App) SetStaticEnable(enable bool) *App

Set static enable

func (*App) SetStaticPattern 

func (app *App) SetStaticPattern(pattern string) *App

Set static pattern

func (*App) SetStaticPrefix 

func (app *App) SetStaticPrefix(prefix string) *App

Set static prefix

func (*App) SetValidateErrCode 

func (app *App) SetValidateErrCode(code int) *App

Set validate err code

func (*App) SetViewCache 

func (app *App) SetViewCache(cache bool) *App

Set view cache

func (*App) SetViewPrefix 

func (app *App) SetViewPrefix(prefix string) *App

Set view prefix

func (*App) SetViewSuffix 

func (app *App) SetViewSuffix(suffix string) *App

Set view suffix

func (*App) SetWebRoot 

func (app *App) SetWebRoot(webRoot string) *App

Set webRoot

func (*App) TLS 

func (app *App) TLS(certFile, keyFile string)

Enable TLS mode

func (*App) Use 

func (app *App) Use(middlewares ...Middleware) *App

Using middlewares

func (*App) UseFilter 

func (app *App) UseFilter(filterMiddlewares ...FilterMiddleware) *App

Using filter middlewares

func (*App) UseInterceptor 

func (app *App) UseInterceptor(interceptorMiddlewares ...InterceptorMiddleware) *App

Using interceptor middlewares

type Context 

type Context struct {
	Request          *http.Request       //request
	RequestURI       string              //request uri
	ParsedRequestURI string              //parsed request uri
	RequestMethod    string              //request method
	RequestHeader    http.Header         //request header
	ResponseWriter   http.ResponseWriter //Response writer
	ResponseHeader   *http.Header        //Response header
	//K<string>,V<*arraylist.ArrayList<MultipartFile>>
	Multipart *hashmap.HashMap //multipart map
	//K<string>,V<*arraylist.ArrayList<string>>
	Parameters      *hashmap.HashMap //map[string][]string
	MultipartParsed bool             //multipart parsed ?
	Response        *Response        //Response
	// contains filtered or unexported fields
}

Define context struct

func (*Context) AddHeader 

func (context *Context) AddHeader(name, value string) *Context

Add Response header

func (*Context) Binary 

func (context *Context) Binary(buffer []byte)

Response binary to client

func (*Context) BinaryWith 

func (context *Context) BinaryWith(buffer []byte, contentType string)

Response binary to client with ContentType

func (*Context) ClearCaches 

func (context *Context) ClearCaches()

Clear app cache

func (*Context) ClearMiddlewareCtx 

func (context *Context) ClearMiddlewareCtx(name string)

Clear middleware context

func (*Context) GetCache 

func (context *Context) GetCache(key string) interface{}

Get app cache

func (*Context) GetMiddlewareCtx 

func (context *Context) GetMiddlewareCtx(name string) *hashmap.HashMap

Get middleware context

func (*Context) GetMiddlewareData 

func (context *Context) GetMiddlewareData(name, key string) gotypes.V

Get middleware data

func (*Context) GetMultipartFile 

func (context *Context) GetMultipartFile(name string) *MultipartFile

Get multipart file

func (*Context) GetMultipartFiles 

func (context *Context) GetMultipartFiles(name string) []*MultipartFile

Get request parameter

func (*Context) GetParameter 

func (context *Context) GetParameter(name string) string

Get request parameter

func (*Context) GetParameterWithDefault 

func (context *Context) GetParameterWithDefault(name, defaultValue string) string

Get request parameter with default

func (*Context) GetParameters 

func (context *Context) GetParameters(name string) []string

Get request parameters

func (*Context) GetParametersWithDefault 

func (context *Context) GetParametersWithDefault(name string, defaultValue []string) []string

Get request parameters with default

func (*Context) Image 

func (context *Context) Image(buffer []byte)

Response image to client

func (*Context) JSON 

func (context *Context) JSON(data interface{})

Response json to client

func (*Context) ParseMultipart 

func (context *Context) ParseMultipart(maxMemory int64) error

Parse Multipart

func (*Context) RemoveCache 

func (context *Context) RemoveCache(key string)

Remove app cache

func (*Context) RemoveMiddlewareData 

func (context *Context) RemoveMiddlewareData(name, key string)

Remove middleware data

func (*Context) SetCache 

func (context *Context) SetCache(key string, data interface{})

Set app cache

func (*Context) SetDone 

func (context *Context) SetDone(done bool) *Context

Set done

func (*Context) SetHeader 

func (context *Context) SetHeader(name, value string) *Context

Set content type

func (*Context) SetMiddlewareData 

func (context *Context) SetMiddlewareData(name, key string, val gotypes.V)

Set middleware data

func (*Context) Text 

func (context *Context) Text(text string)

Response text to client

func (*Context) View 

func (context *Context) View(name string)

Response view to client

type Field 

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

Define field struct

func NewField 

func NewField(name string) *Field

func (*Field) Concat 

func (field *Field) Concat(concat bool) *Field

concat

func (*Field) ConcatRune 

func (field *Field) ConcatRune(concatRune rune) *Field

concat rune

func (*Field) DefaultVal 

func (field *Field) DefaultVal(defaultVal string) *Field

default val

func (*Field) Enums 

func (field *Field) Enums(enums ...string) *Field

enums

func (*Field) Fixed 

func (field *Field) Fixed(fixed string) *Field

fixed

func (*Field) Length 

func (field *Field) Length(length int) *Field

length

func (*Field) Max 

func (field *Field) Max(max int) *Field

max

func (*Field) MaxLength 

func (field *Field) MaxLength(maxLength int) *Field

maxLength

func (*Field) Min 

func (field *Field) Min(min int) *Field

min

func (*Field) MinLength 

func (field *Field) MinLength(minLength int) *Field

minLength

func (*Field) Name 

func (field *Field) Name(name string) *Field

name

func (*Field) Preset 

func (field *Field) Preset(preset bool) *Field

set

func (*Field) Regex 

func (field *Field) Regex(regex string) *Field

regex

func (*Field) Split 

func (field *Field) Split(split bool) *Field

split

func (*Field) SplitRune 

func (field *Field) SplitRune(splitRune rune) *Field

split rune

func (*Field) Validate 

func (field *Field) Validate(validate bool) *Field

validate

type FilterContext 

type FilterContext struct {
	RequestURI       string
	ParsedRequestURI string
	RequestMethod    string
	RequestHeader    http.Header
	ResponseHeader   *http.Header
	Parameters       *hashmap.HashMap
	// contains filtered or unexported fields
}

Define filter context

func (*FilterContext) ClearCaches 

func (context *FilterContext) ClearCaches()

Clear app cache

func (*FilterContext) ClearMiddlewareCtx 

func (context *FilterContext) ClearMiddlewareCtx(name string)

Clear middleware context

func (*FilterContext) GetCache 

func (context *FilterContext) GetCache(key string) interface{}

Get app cache

func (*FilterContext) GetMiddlewareCtx 

func (context *FilterContext) GetMiddlewareCtx(name string) *hashmap.HashMap

Get middleware context

func (*FilterContext) GetMiddlewareData 

func (context *FilterContext) GetMiddlewareData(name, key string) gotypes.V

Get middleware data

func (*FilterContext) RemoveCache 

func (context *FilterContext) RemoveCache(key string)

Remove app cache

func (*FilterContext) RemoveMiddlewareData 

func (context *FilterContext) RemoveMiddlewareData(name, key string)

Remove middleware data

func (*FilterContext) SetCache 

func (context *FilterContext) SetCache(key string, data interface{})

Set app cache

func (*FilterContext) SetMiddlewareData 

func (context *FilterContext) SetMiddlewareData(name, key string, val gotypes.V)

Set middleware data

type FilterHandler 

type FilterHandler func(FilterContext)

Define filter handler

type FilterMiddleware 

type FilterMiddleware interface {
	//Set FilterMiddleware name
	Name() string
	//Set FilterMiddleware type
	Type() string
	//Set FilterMiddleware pattern
	Pattern() string
	//Process FilterMiddleware
	Process() FilterHandler
}

Define Filter Middleware interface

type Handler 

type Handler func(context Context)

Define handler

type InterceptorHandler 

type InterceptorHandler func(Context)

Define interceptor handler

type InterceptorMiddleware 

type InterceptorMiddleware interface {
	//Set InterceptorMiddleware name
	Name() string
	//Set InterceptorMiddleware type
	Type() string
	//Set InterceptorMiddleware pattern
	Pattern() string
	//Process InterceptorMiddleware
	Process() InterceptorHandler
}

Define Interceptor Middleware interface

type Middleware 

type Middleware interface {
	//Set Middleware name
	Name() string
	//Set Middleware method
	Method() string
	//Set Middleware pattern
	Pattern() string
	//Process Middleware
	Process() Handler
	//Set Middleware fields
	Fields() []*Field
}

Define Middleware interface

type MultipartFile 

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

Define MultipartFile struct

func (*MultipartFile) ContentType 

func (file *MultipartFile) ContentType() string

Get multipart file content type

func (*MultipartFile) Copy 

func (file *MultipartFile) Copy(distName string) error

Copy file to dist name

func (*MultipartFile) Filename 

func (file *MultipartFile) Filename() string

Get multipart file name

func (*MultipartFile) Header 

func (file *MultipartFile) Header(name string) string

Get multipart header

func (*MultipartFile) Headers 

func (file *MultipartFile) Headers() *hashmap.HashMap

Get multipart headers

func (*MultipartFile) Size 

func (file *MultipartFile) Size() int64

Get multipart file size in byte

type Response 

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

Define Response struct

func (*Response) GetContentType 

func (response *Response) GetContentType() string

Get content type

func (*Response) GetData 

func (response *Response) GetData() []byte

Get data

func (*Response) GetHeaders 

func (response *Response) GetHeaders() *hashmap.HashMap

Set done

func (*Response) SetContentType 

func (response *Response) SetContentType(contentType string) *Response

Set content type

func (*Response) SetDone 

func (response *Response) SetDone(done bool) *Response

Set done

func (*Response) SetHeaders 

func (response *Response) SetHeaders(headers *hashmap.HashMap) *Response

Set done

type StaticHandler 

type StaticHandler func(context Context, contentType, resourcePath string)

Define static handler

Source Files

View all Source files

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.