water

README

go-water 是一款设计层面的框架，帮助 web 框架（gin，iris，beego，echo等）实现隔离友好，设计优美的系统，通过一系列接口、规范、约定，深度解耦系统。

星星增长趋势

安装

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

技术概览

• zap 日志
• rsa 加密，openssl 生成公/私钥对
• jwt 登陆认证
• errors 自定义处理
• pool 管理请求参数
• option 配置修改

样例仓库

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

官方文档

• https://go-water.cn

Documentation

Index

• Variables
• 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, signature string, err error)
• func SetAuthToken(uniqueUser, privateKeyPath string, expire time.Duration) (tokenString string, err error)
• func Warn(msg string, fields ...zap.Field)
• type Endpoint
• type ErrorHandler
• type ErrorHandlerFunc
  • func (f ErrorHandlerFunc) Handle(ctx context.Context, err error)
• type Handler
  • func NewHandler(srv Service, options ...ServerOption) Handler
• type LogErrorHandler
  • func NewLogErrorHandler(l *zap.Logger, n string) *LogErrorHandler
  • func (h *LogErrorHandler) Handle(ctx context.Context, err error)
• 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 ServerErrorHandler(errorHandler ErrorHandler) ServerOption
  • func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption
• type Service

Variables

var (
	ErrInvalidKey = errors.New("key is invalid")
)

Functions

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, signature string, err error)

ParseFromRequest 兼容 http,ws

func SetAuthToken

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

func Warn

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

Types

type Endpoint

type Endpoint func(ctx context.Context, req any) (any, error)

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 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 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 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 ServerErrorHandler

func ServerErrorHandler(errorHandler ErrorHandler) ServerOption

func ServerFinalizer

func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption

type Service

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