hfw

package module
v0.0.0-...-784d6ec Latest Latest
Warning

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

 Go to latest Published: Aug 15, 2019 License: GPL-3.0 Imports: 35 Imported by: 0

README

hfw

go small framework

Documentation

Index

Constants

View Source 
const (
	DEV  = "dev"
	TEST = "test"
	PROD = "prod"
)

Variables

View Source 
var (
	//VERSION 版本
	VERSION string
	//ENVIRONMENT 环境
	ENVIRONMENT string

	PID         = os.Getpid()
	HOSTNAME, _ = os.Hostname()
)
View Source 
var (
	APPPATH = GetAppPath()
	APPNAME = GetAppName()
)
View Source 
var (
	Config configs.AllConfig
)
View Source 
var ErrStopRun = errors.New("user stop run")

ErrStopRun ..

Functions

func AddCron 

func AddCron(spec string, cmd func()) error

func AddErrorMap 

func AddErrorMap(errNo int64, errMsg string)

func DispatchRoute 

func DispatchRoute(httpCtx *HTTPContext)

修改httpCtx.Path后重新寻找执行action

func GetAppName 

func GetAppName() string

func GetAppPath 

func GetAppPath() string

func GetEnv 

func GetEnv() string

func GetErrorMap 

func GetErrorMap(errNo int64) string

func GetHostName 

func GetHostName() string

func GetPid 

func GetPid() int

func GetVersion 

func GetVersion() string

func Handler 

func Handler(pattern string, handler ControllerInterface) (err error)

Handler 暂时只支持2段

func HandlerFunc 

func HandlerFunc(pattern string, h http.HandlerFunc)

HandlerFunc register HandleFunc

func HotDeploy 

func HotDeploy(hotDeployConfig configs.HotDeployConfig)

func IsDevEnv 

func IsDevEnv() bool

func IsProdEnv 

func IsProdEnv() bool

func IsTestEnv 

func IsTestEnv() bool

func Router 

func Router(w http.ResponseWriter, r *http.Request)

Router 写测试用例会调用

func Run 

func Run() (err error)

Run start

func SetErrorMap 

func SetErrorMap(m map[int64]string)

func StaticHandler 

func StaticHandler(pattern string, dir string)

StaticHandler ... 如pattern=css,dir=./static，则css在./static下

func StaticStripHandler 

func StaticStripHandler(pattern string, dir string)

StaticStripHandler ... 如pattern=css,dir=./static/css，则css就是./static/css

func StopCron 

func StopCron()

Types

type Controller 

type Controller struct {
}

Controller ..

func (*Controller) After 

func (ctl *Controller) After(httpCtx *HTTPContext)

After ..

func (*Controller) Before 

func (ctl *Controller) Before(httpCtx *HTTPContext)

Before ..

func (*Controller) Finish 

func (ctl *Controller) Finish(httpCtx *HTTPContext)

Finish 请不要实现Finish方法

func (*Controller) Init 

func (ctl *Controller) Init(httpCtx *HTTPContext)

Init 请不要实现Init方法

func (*Controller) NotFound 

func (ctl *Controller) NotFound(httpCtx *HTTPContext)

NotFound ..

func (*Controller) ServerError 

func (ctl *Controller) ServerError(httpCtx *HTTPContext)

ServerError .. 不要手动调用，用于捕获未知错误，手动请用Throw 该方法不能使用StopRun，也不能panic，因为会被自动调用

type ControllerInterface 

type ControllerInterface interface {
	Init(*HTTPContext)
	Before(*HTTPContext)
	After(*HTTPContext)
	Finish(*HTTPContext)
	NotFound(*HTTPContext)
	ServerError(*HTTPContext)
}

ControllerInterface .. init和finish必定会执行，而且不允许被修改 Before和After之间是业务逻辑，所有Before也是必定会执行 用户手动StopRun()后，中止业务逻辑，跳过After，继续Finish

type HTTPContext 

type HTTPContext struct {
	Ctx    context.Context    `json:"-"`
	Cancel context.CancelFunc `json:"-"`

	ResponseWriter http.ResponseWriter `json:"-"`
	Request        *http.Request       `json:"-"`
	Session        *session.Session    `json:"-"`
	Layout         string              `json:"-"`
	Controller     string              `json:"-"`
	Action         string              `json:"-"`
	Path           string              `json:"-"`

	IsZip bool `json:"-"`
	//404和500页面被自动更改content-type，导致压缩后有问题，暂时不压缩
	IsError bool `json:"-"`

	//html文本
	Template string `json:"-"`
	//模板文件
	TemplateFile string `json:"-"`
	//主要用于模板渲染
	Data    map[string]interface{} `json:"-"`
	FuncMap map[string]interface{} `json:"-"`

	IsJSON bool `json:"-"`
	//返回的json是否包含Header
	HasHeader bool `json:"-"`
	//是否只返回Response.Results里的数据
	IsOnlyResults   bool `json:"-"`
	common.Response `json:"response"`
	Header          interface{} `json:"header"`

	//如果是下载文件，不执行After和Finish
	IsCloseRender bool `json:"-"`
	// contains filtered or unexported fields
}

HTTPContext .. 渲染模板的数据放Data Json里的数据放Response Layout的功能未实现 TODO

func (*HTTPContext) GetCookie 

func (httpCtx *HTTPContext) GetCookie(key string) (s string)

func (*HTTPContext) GetForm 

func (httpCtx *HTTPContext) GetForm(key string) string

GetForm 优先post和put,然后get

func (*HTTPContext) GetFormInt 

func (httpCtx *HTTPContext) GetFormInt(key string) int

GetFormInt 优先post和put,然后get，转为int

func (*HTTPContext) Log 

func (httpCtx *HTTPContext) Log() *logger.Log

func (*HTTPContext) Output 

func (httpCtx *HTTPContext) Output()

Output ..

func (*HTTPContext) Redirect 

func (httpCtx *HTTPContext) Redirect(url string)

Redirect ..

func (*HTTPContext) Render 

func (httpCtx *HTTPContext) Render()

Render ..

func (*HTTPContext) ReturnFileContent 

func (httpCtx *HTTPContext) ReturnFileContent(contentType, filename string, file interface{})

ReturnFileContent 下载文件服务

func (*HTTPContext) ReturnJSON 

func (httpCtx *HTTPContext) ReturnJSON()

ReturnJSON ..

func (*HTTPContext) SetCookie 

func (httpCtx *HTTPContext) SetCookie(key, value string)

func (*HTTPContext) SetDownloadMode 

func (httpCtx *HTTPContext) SetDownloadMode(filename string)

SetDownloadMode ..

func (*HTTPContext) StopRun 

func (httpCtx *HTTPContext) StopRun()

StopRun ..

func (*HTTPContext) ThrowCheck 

func (httpCtx *HTTPContext) ThrowCheck(errNo int64, i interface{})

ThrowCheck

Source Files

View all Source files

Directories

Path Synopsis
db
cache
grpc
auth
client
支持连接https+grpc共享端口的版本，也支持非证书版 Usage: conn, err := client.NewClientConn("localhost:63333", "server.crt", "server.grpc.io", grpc.WithPerRPCCredentials(&rpc.X{Value: "abc", Key: "x"})) client := rpc.NewHelloServiceClient(conn)
 支持连接https+grpc共享端口的版本，也支持非证书版 Usage: conn, err := client.NewClientConn("localhost:63333", "server.crt", "server.grpc.io", grpc.WithPerRPCCredentials(&rpc.X{Value: "abc", Key: "x"})) client := rpc.NewHelloServiceClient(conn)
discovery
discovery/register
// register service cr := register.NewConsulRegister(fmt.Sprintf("%s:%d", host, consul_port), 15) cr.Register(discovery.RegisterInfo{ Host: host, Port: port, ServiceName: "HelloService", UpdateInterval: time.Second})
 // register service cr := register.NewConsulRegister(fmt.Sprintf("%s:%d", host, consul_port), 15) cr.Register(discovery.RegisterInfo{ Host: host, Port: port, ServiceName: "HelloService", UpdateInterval: time.Second})
discovery/resolver
server
支持https+grpc的共享端口版，不需要ca证书 获取http+grpc,两个服务必须独立端口 Usage: 如果是grpc+https s, err := server.NewServer(hfw.Config.Server, opt...) RegisterHelloServiceServer(s, &HelloServiceImpl{auth: auth.NewAuthWithHTTPS("value")}) 如果是http+grpc s, err := server.NewServer(hfw.Config.Server, opt...) RegisterHelloServiceServer(s, &HelloServiceImpl{auth: auth.NewAuth("value")}) go server.StartServer(s, ":1234")
 支持https+grpc的共享端口版，不需要ca证书 获取http+grpc,两个服务必须独立端口 Usage: 如果是grpc+https s, err := server.NewServer(hfw.Config.Server, opt...) RegisterHelloServiceServer(s, &HelloServiceImpl{auth: auth.NewAuthWithHTTPS("value")}) 如果是http+grpc s, err := server.NewServer(hfw.Config.Server, opt...) RegisterHelloServiceServer(s, &HelloServiceImpl{auth: auth.NewAuth("value")}) go server.StartServer(s, ":1234")
kill -INT pid 终止 kill -TERM pid 重启
 kill -INT pid 终止 kill -TERM pid 重启
信号处理 kill -INT pid 终止 kill -TERM pid 重启 需要调用Wg.Add() 需要监听Shutdown通道
 信号处理 kill -INT pid 终止 kill -TERM pid 重启 需要调用Wg.Add() 需要监听Shutdown通道

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.