water

README

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

星星增长趋势

安装

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

样例仓库

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

官方文档

• https://go-water.cn

Documentation

Index

• type Config
  • func (conf *Config) NewLogger() *zap.Logger
• 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) GetRequest() any
  • 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 any) string
  • func (s *ServerBase) SetLogger(l *zap.Logger)
• type ServerFinalizerFunc
• type ServerOption
  • func ServerConfig(c *Config) ServerOption
  • func ServerErrorHandler(errorHandler ErrorHandler) ServerOption
  • func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption
• type Service

Types

type Config

type Config struct {
	Level     zapcore.Level `yaml:"level"`
	Encoding  string        `yaml:"encoding"`
	CallFull  bool          `yaml:"call_full"`
	Color     bool          `yaml:"color"`
	AddCaller bool          `yaml:"add_caller"`
}

func (*Config) NewLogger

func (conf *Config) NewLogger() *zap.Logger

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) GetRequest

func (s *Server) GetRequest() any

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 any) 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 ServerConfig

func ServerConfig(c *Config) ServerOption

func ServerErrorHandler

func ServerErrorHandler(errorHandler ErrorHandler) ServerOption

func ServerFinalizer

func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption

type Service

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