core

package

v0.0.0-...-40ef913 Latest Latest Go to latest Published: May 5, 2021 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitee.com/kzquu/wego

Documentation ¶

Index ¶

Variables
func AddController(ctrlName string, a interface{}, route ...string) (err error)
func AddController2(ctrlName string, a interface{}, ...) (err error)
func AddRouter(pattern string)
func Fserve(ctx *Context, err error) error
func NSregister(ns *Namespace) error
func Run()
func StopRun()
type Context
type Controller
- func (c *Controller) Finish()
- func (c *Controller) GetScheme() string
- func (c *Controller) GetURL() string
- func (c *Controller) Prepare()
- func (c *Controller) SetClientCache(second ...int)
- func (c *Controller) SetCookie(name, value string, maxAge int, domain ...string)
- func (c *Controller) WriteData(v ...interface{}) (n int, err error)
- func (c *Controller) WriteJSON(v interface{}) (n int, err error)
- func (c *Controller) WriteString(v string) (n int, err error)
type Handler
type Namespace
- func NewNameSpace(name string, params ...interface{}) *Namespace
type NsController
- func NSaddController(name string, c interface{}) *NsController
- func (nc *NsController) SetStaticSpace(cf, ff SetStaticSpaceFunc) *NsController
type Router
type SetStaticSpaceFunc
type URLinfo

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// FserveList 文件服务,可以有多个
	FserveList = make([]fserve, 0, 2)

	// Start 请求进来时执行的方法
	Start = func(ctx *Context) {}

	// End 请求完成时执行的方法
	End = func(ctx *Context, panicErr interface{}) {
		code := 200
		if panicErr != nil {
			if panicErr == Errs.ErrControllerNotFound || panicErr == Errs.ErrFuncNotFound {
				panicErr = Fserve(ctx, panicErr.(error))
				if panicErr != nil {
					code = 404
					http.Error(ctx.W, (panicErr.(error)).Error(), code)
				}
			} else {
				code = 500
				err := fmt.Sprint(panicErr)
				http.Error(ctx.W, err, code)
				fmt.Println(err)
				fmt.Println(util.BytesString(debug.Stack()))
			}
		}

		if AppConf.Debug {
			fmt.Printf("[%s] [%d] [%s] %s | %v\r\n",
				ctx.R.Method, code, ctx.R.RemoteAddr, ctx.R.URL.Path, time.Since(ctx.Now))
		}
	}
)

View Source

var AppConf = new(struct {
	Debug      bool   // 调试
	FuncPrefix string // 方法前缀
})

AppConf app参数

View Source

var Conf *config.Conf

Conf 参数配置

View Source

var Errs = struct {
	ErrStopRun            error // 主动停止运行产生的错误
	ErrControllerNotFound error // 未找到控制器
	ErrFuncNotFound       error // 未找到方法
}{
	errors.New("user stop run"),
	errors.New("controller not found"),
	errors.New("function not found"),
}

Errs 预定义错误

View Source

var RouterList map[string]*Router

RouterList 路由列表 map[path]路由

Functions ¶

func AddController ¶

func AddController(ctrlName string, a interface{}, route ...string) (err error)

AddController 添加控制器控制器名,控制器结构指针,路由(默认基础路由为 "/")

func AddController2 ¶

func AddController2(ctrlName string, a interface{},
	ctrlStaticSpace, funcStaticSpace SetStaticSpaceFunc, route ...string) (err error)

AddController2 添加控制器

func AddRouter ¶

func AddRouter(pattern string)

AddRouter 添加路由

func Fserve ¶

func Fserve(ctx *Context, err error) error

Fserve 把请求交给文件服务处理

func NSregister ¶

func NSregister(ns *Namespace) error

NSregister 注册命名空间

func Run ¶

func Run()

Run 开启服务器

func StopRun ¶

func StopRun()

StopRun 抛出Errs.ErrStopRun错误，立即返回

Types ¶

type Context ¶

type Context struct {
	W http.ResponseWriter
	R *http.Request

	// 由系统自动获取的请求进来的时间
	Now time.Time
}

Context 上下文

type Controller ¶

type Controller struct {
	Ctx *Context

	U *URLinfo

	CtrlStaticSpace,
	FuncStaticSpace interface{} // 业务方法静态内存空间
}

Controller 基础控制器

func (*Controller) Finish ¶

func (c *Controller) Finish()

Finish 执行业务方法后执行

func (*Controller) GetScheme ¶

func (c *Controller) GetScheme() string

GetScheme 获取请求Scheme

func (*Controller) GetURL ¶

func (c *Controller) GetURL() string

GetURL 获取请求完整URL

func (*Controller) Prepare ¶

func (c *Controller) Prepare()

Prepare 执行业务方法前执行

func (*Controller) SetClientCache ¶

func (c *Controller) SetClientCache(second ...int)

SetClientCache 设置客户端缓存 second默认很长时间

func (*Controller) SetCookie ¶

func (c *Controller) SetCookie(name, value string, maxAge int, domain ...string)

SetCookie 设置cookie

func (*Controller) WriteData ¶

func (c *Controller) WriteData(v ...interface{}) (n int, err error)

WriteData 应答

func (*Controller) WriteJSON ¶

func (c *Controller) WriteJSON(v interface{}) (n int, err error)

WriteJSON 以json格式数据应答

func (*Controller) WriteString ¶

func (c *Controller) WriteString(v string) (n int, err error)

WriteString 以字符串数据应答

type Handler ¶

type Handler interface {
	http.Handler
	HandleFunc(string, func(http.ResponseWriter, *http.Request))
}

Handler 路由处理器

var DefaultHandler Handler = http.DefaultServeMux

DefaultHandler 路由处理器目前使用的是标准库的DefaultServeMux 可以修改这个变量自定义路由处理器

type Namespace ¶

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

Namespace Namespace

func NewNameSpace ¶

func NewNameSpace(name string, params ...interface{}) *Namespace

NewNameSpace 创建命名空间

type NsController ¶

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

NsController NsController

func NSaddController ¶

func NSaddController(name string, c interface{}) *NsController

NSaddController 添加控制器

func (*NsController) SetStaticSpace ¶

func (nc *NsController) SetStaticSpace(cf, ff SetStaticSpaceFunc) *NsController

SetStaticSpace 设置用于设置控制器静态内存空间和业务方法静态内存空间的函数

type Router ¶

type Router struct {
	C map[string]*controllerType // map[控制器名]*controllerType

	UNC *controllerType // unnamed controller，可以为空

}

Router 路由

type SetStaticSpaceFunc ¶

type SetStaticSpaceFunc func(ctrlName, funcName string) interface{}

SetStaticSpaceFunc 用于设置静态内存空间的函数类型

type URLinfo ¶

type URLinfo struct {
	// 访问的路由
	Route string
	// 访问的控制器名
	CtrlName string
	// 访问的函数名
	FuncName string
	// url中FuncName以后并且除了文件后缀的部分按 / Split后的[]string
	PathParts []string
	// 访问的文件后缀 .*
	Suffix string
}

URLinfo URL信息

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL