water

README

简介：go-water 是一款设计层面的框架，帮助您更好的使用 web 框架（比如：gin，iris，beego，echo等），更好的业务隔离，更好的系统设计，通过一系列接口、规范、约定、中间件，深度解耦业务系统。

星星增长趋势

安装

go get -u github.com/go-water/water

技术概览

• zap 日志
• rsa 加密，openssl 生成公/私钥对
• jwt 登陆认证
• errors 自定义处理
• pool 管理请求参数
• option 配置修改
• rate limit（限流）
• circuit breaker（熔断）

样例仓库

• https://github.com/go-water/go-water

官方文档

• https://iissy.com/go-water

Documentation

Index

• Constants
• func BindJSON[T any](c *Context) (t *T, err error)
• func Error(msg string, fields ...zap.Field)
• func Info(msg string, fields ...zap.Field)
• func InitZap()
• func NewLogger() *zap.Logger
• func ParseFromRequest(req *http.Request, publicKeyPath string) (uniqueUser, issuer, signature string, err error)
• func SetAuthToken(uniqueUser, issuer, privateKeyPath string, expire time.Duration) (tokenString string, err error)
• func Warn(msg string, fields ...zap.Field)
• type Context
  • func (c *Context) Deadline() (deadline time.Time, ok bool)
  • func (c *Context) Done() <-chan struct{}
  • func (c *Context) Err() error
  • func (c *Context) Get(key string) (value any, exists bool)
  • func (c *Context) JSON(status int, data any) error
  • func (c *Context) Param(key string) string
  • func (c *Context) Set(key string, value any)
  • func (c *Context) ShouldBindJSON(obj any) error
  • func (c *Context) ShouldBindWith(obj any, b binding.Binding) error
  • func (c *Context) Value(key any) any
• type ErrorHandler
• type ErrorHandlerFunc
  • func (f ErrorHandlerFunc) Handle(ctx context.Context, err error)
• type H
• type Handler
  • func NewHandler(srv Service, options ...ServerOption) Handler
• type HandlerFunc
  • func (handle HandlerFunc) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type LogErrorHandler
  • func NewLogErrorHandler(l *zap.Logger, n string) *LogErrorHandler
  • func (h *LogErrorHandler) Handle(ctx context.Context, err error)
• type Router
  • func NewRouter() *Router
  • func (r *Router) Get(route string, handler HandlerFunc)
  • func (r *Router) Group(prefix string) *Router
  • func (r *Router) Method(method, route string, handler HandlerFunc)
  • func (r *Router) Post(route string, handler HandlerFunc)
  • func (r *Router) Serve(addr string, server ...*http.Server) error
  • func (r *Router) Use(middlewares ...func(HandlerFunc) HandlerFunc)
• type Server
  • func (s *Server) GetLogger() *zap.Logger
  • func (s *Server) ServerWater(ctx context.Context, req any) (resp any, err error)
• type ServerBase
  • func (s *ServerBase) GetLogger() *zap.Logger
  • func (s *ServerBase) Name(srv Service) string
  • func (s *ServerBase) SetLogger(l *zap.Logger)
• type ServerFinalizerFunc
• type ServerOption
  • func ServerBreaker(breaker *gobreaker.CircuitBreaker) ServerOption
  • func ServerErrorHandler(errorHandler ErrorHandler) ServerOption
  • func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption
  • func ServerLimiter(interval time.Duration, b int) ServerOption
• type Service

Constants

const ContextKey = "_go-water/context-key"

Functions

func BindJSON

func BindJSON[T any](c *Context) (t *T, err error)

func Error

func Error(msg string, fields ...zap.Field)

func Info

func Info(msg string, fields ...zap.Field)

func InitZap

func InitZap()

func NewLogger

func NewLogger() *zap.Logger

func ParseFromRequest

func ParseFromRequest(req *http.Request, publicKeyPath string) (uniqueUser, issuer, signature string, err error)

ParseFromRequest 兼容 http,ws

func SetAuthToken

func SetAuthToken(uniqueUser, issuer, privateKeyPath string, expire time.Duration) (tokenString string, err error)

func Warn

func Warn(msg string, fields ...zap.Field)

Types

type Context

type Context struct {
	Request *http.Request
	Writer  http.ResponseWriter

	Keys map[string]any
	// contains filtered or unexported fields
}

func (*Context) Deadline

func (c *Context) Deadline() (deadline time.Time, ok bool)

Deadline returns that there is no deadline (ok==false) when c.Request has no Context.

func (*Context) Done

func (c *Context) Done() <-chan struct{}

Done returns nil (chan which will wait forever) when c.Request has no Context.

func (*Context) Err

func (c *Context) Err() error

Err returns nil when c.Request has no Context.

func (*Context) Get

func (c *Context) Get(key string) (value any, exists bool)

func (*Context) JSON

func (c *Context) JSON(status int, data any) error

func (*Context) Param

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

func (*Context) Set

func (c *Context) Set(key string, value any)

func (*Context) ShouldBindJSON

func (c *Context) ShouldBindJSON(obj any) error

func (*Context) ShouldBindWith

func (c *Context) ShouldBindWith(obj any, b binding.Binding) error

func (*Context) Value

func (c *Context) Value(key any) any

Value returns the value associated with this context for key, or nil if no value is associated with key. Successive calls to Value with the same key returns the same result.

type ErrorHandler

type ErrorHandler interface {
	Handle(ctx context.Context, err error)
}

type ErrorHandlerFunc

type ErrorHandlerFunc func(ctx context.Context, err error)

func (ErrorHandlerFunc) Handle

func (f ErrorHandlerFunc) Handle(ctx context.Context, err error)

type H

type H map[string]any

type Handler

type Handler interface {
	ServerWater(ctx context.Context, req any) (any, error)
	GetLogger() *zap.Logger
}

func NewHandler

func NewHandler(srv Service, options ...ServerOption) Handler

type HandlerFunc

type HandlerFunc func(*Context)

func (HandlerFunc) ServeHTTP

func (handle HandlerFunc) ServeHTTP(w http.ResponseWriter, req *http.Request)

type LogErrorHandler

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

func NewLogErrorHandler

func NewLogErrorHandler(l *zap.Logger, n string) *LogErrorHandler

func (*LogErrorHandler) Handle

func (h *LogErrorHandler) Handle(ctx context.Context, err error)

type Router

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

func NewRouter

func NewRouter() *Router

func (*Router) Get

func (r *Router) Get(route string, handler HandlerFunc)

func (*Router) Group

func (r *Router) Group(prefix string) *Router

func (*Router) Method

func (r *Router) Method(method, route string, handler HandlerFunc)

func (*Router) Post

func (r *Router) Post(route string, handler HandlerFunc)

func (*Router) Serve

func (r *Router) Serve(addr string, server ...*http.Server) error

func (*Router) Use

func (r *Router) Use(middlewares ...func(HandlerFunc) HandlerFunc)

type Server

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

func (*Server) GetLogger

func (s *Server) GetLogger() *zap.Logger

func (*Server) ServerWater

func (s *Server) ServerWater(ctx context.Context, req any) (resp any, err error)

type ServerBase

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

func (*ServerBase) GetLogger

func (s *ServerBase) GetLogger() *zap.Logger

func (*ServerBase) Name

func (s *ServerBase) Name(srv Service) string

func (*ServerBase) SetLogger

func (s *ServerBase) SetLogger(l *zap.Logger)

type ServerFinalizerFunc

type ServerFinalizerFunc func(ctx context.Context, err error)

type ServerOption

type ServerOption func(*Server)

func ServerBreaker

func ServerBreaker(breaker *gobreaker.CircuitBreaker) ServerOption

func ServerErrorHandler

func ServerErrorHandler(errorHandler ErrorHandler) ServerOption

func ServerFinalizer

func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption

func ServerLimiter

func ServerLimiter(interval time.Duration, b int) ServerOption

type Service

type Service interface {
	Name(srv Service) string
	SetLogger(l *zap.Logger)
}