echop

package module
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2023 License: MIT Imports: 11 Imported by: 0

README

Echop

Go Reference

Echop is a wrapper of echo framework, which provides some useful features.

Feature Overview

  • Standard response body format
  • Logger
  • Context adds logging methods and standard response body methods
  • Logging errors caught by error handling functions
  • Request logger middleware and request id middleware are added by default

Installation

go get -u echop.ldnorm.dev

Document

Example

package main

import (
	echop "echop.ldnorm.dev"
	"github.com/labstack/echo/v4"
)

func main() {
	echop.AppName = "app-name"
	echop.RequestIDConfig.TargetHeader = "Request-Id"
	ep := echop.New()

	group := ep.Group("/api")

	type Payload struct {
		Name string `json:"name" validate:"required"`
	}

	group.POST("/ping", func(c echop.Context) error {
		payload := new(Payload)
		if err := c.BindAndValidate(payload); err != nil {
			// Error will be caught and logged
			return err
		}

		if payload.Name != "test" {
			return c.JsonFail("", "name error")
		} else {
			return c.JsonSuccess(echo.Map{
				"ping": "ping ping pong pong",
			}, "success msg")
		}

	})

	ep.Echo.Start(":1323")
}

Documentation

Overview

Package echop is a wrapper of echo framework, which provides some useful features.

Package echop Group. Since methods and properties cannot be renamed, and to accommodate the habit of using Group methods to create new route groups, use nominal inheritance and override all methods, regardless of whether the method needs to add WrapHandlerFunc

Index

Constants

This section is empty.

Variables

View Source 
var (
	// AppName is the name of the application, which will be used in log file name
	AppName = "echop"
	// RequestIDConfig middleware.RequestIDWithConfig
	RequestIDConfig                                           = middleware.DefaultRequestIDConfig
	GetCurrentUser  func(c echo.Context) (CurrentUser, error) = nil
	// RequestLoggerConfig middleware.RequestLoggerConfig
	RequestLoggerConfig = middleware.RequestLoggerConfig{
		LogURI:      true,
		LogStatus:   true,
		LogMethod:   true,
		LogRemoteIP: true,
		LogHost:     true,
		LogLatency:  true,
		LogValuesFunc: func(c echo.Context, v middleware.RequestLoggerValues) error {
			var logFunc func(c echo.Context, msg string, fields ...zap.Field)
			if v.Status >= 500 {
				logFunc = LogErrorWithContext
			} else if v.Status >= 400 {
				logFunc = LogWarnWithContext
			} else {
				logFunc = LogInfoWithContext
			}

			logFields := []zap.Field{
				zap.String("request_id", GetRequestID(c)),
				zap.String("method", v.URI),
				zap.String("method", v.Method),
				zap.String("remote_ip", v.RemoteIP),
				zap.String("host", v.Host),
				zap.String("latency", v.Latency.String()),
			}

			var currentUser CurrentUser
			if GetCurrentUser != nil {
				currentUser, _ = GetCurrentUser(c)
			}
			if currentUser.ID > 0 {
				logFields = append(logFields, zap.Uint64("operator_id", currentUser.ID))
			}
			if currentUser.Name != "" {
				logFields = append(logFields, zap.String("operator_name", currentUser.Name))
			}
			logFunc(
				c, "request",
				logFields...,
			)
			return nil
		},
	}
	DefaultResponseSuccessCode = 0
	DefaultResponseFailCode    = 1
	DefaultResponseSuccessMsg  = "ok"
	DefaultResponseFailMsg     = "fail"
	RouteNotFound              = "echo_route_not_found"
	Logger                     *zap.Logger
)

Functions

func GetAppRunPath 

func GetAppRunPath() (runPath string)

GetAppRunPath returns the path where the app is running.

func GetRequestID added in v0.1.1 

func GetRequestID(c echo.Context) (id string)

func InitLogger 

func InitLogger(l *zap.Logger)

InitLogger initializes the logger. default logger is initialized if l is nil.

func LogDebug 

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

func LogDebugWithContext 

func LogDebugWithContext(c echo.Context, msg string, fields ...zap.Field)

func LogError 

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

func LogErrorWithContext 

func LogErrorWithContext(c echo.Context, msg string, fields ...zap.Field)

func LogInfo 

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

func LogInfoWithContext 

func LogInfoWithContext(c echo.Context, msg string, fields ...zap.Field)

func LogWarn 

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

func LogWarnWithContext 

func LogWarnWithContext(c echo.Context, msg string, fields ...zap.Field)

func OverrideContext 

func OverrideContext() echo.MiddlewareFunc

func WrapHandlerFunc 

func WrapHandlerFunc(h HandlerFunc) echo.HandlerFunc

WrapHandlerFunc wraps HandlerFunc to echo.HandlerFunc

Types

type Context 

type Context interface {
	echo.Context
	Json(httpCode int, resp JSONResponse) error
	// JsonSuccess is a shortcut of JsonSuccessWithCode with DefaultResponseSuccessCode
	JsonSuccess(i any, msg string) error
	// JsonFail is a shortcut of JsonFailWithCode with DefaultResponseFailCode
	JsonFail(i any, msg string) error
	// JsonSuccessWithCode is a shortcut of Json with http code is http.StatusOK and default msg is DefaultResponseSuccessMsg
	JsonSuccessWithCode(code any, data any, msg string) error
	// JsonFailWithCode is a shortcut of Json with http code is http.StatusOK and default msg is DefaultResponseFailMsg
	JsonFailWithCode(code any, data any, msg string) error
	// LogInfo is a shortcut of LogInfoWithContext
	LogInfo(msg string, fields ...zap.Field)
	// LogError is a shortcut of LogErrorWithContext
	LogError(msg string, fields ...zap.Field)
	// LogWarn is a shortcut of LogWarnWithContext
	LogWarn(msg string, fields ...zap.Field)
	// BindAndValidate is a shortcut of echo context Bind and Validate
	BindAndValidate(payload any) error
}

Context is a wrapper of echo.Context

type CurrentUser added in v0.1.2 

type CurrentUser struct {
	ID       uint64 `json:"userID"`
	Name     string `json:"name"`
	Nickname string `json:"nickname"`
}

CurrentUser Get info about the user who initiated the request

type Echop 

type Echop struct {
	*echo.Echo
}

func New 

func New() (ep *Echop)

New creates an instance of Echop.

It will set the following echo middlewares:

middleware.RequestIDWithConfig middleware.RequestLoggerWithConfig

func (*Echop) Add 

func (ep *Echop) Add(method, path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) Any 

func (ep *Echop) Any(path string, h HandlerFunc, m ...echo.MiddlewareFunc) []*echo.Route

func (*Echop) CONNECT 

func (ep *Echop) CONNECT(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) DELETE 

func (ep *Echop) DELETE(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) DefaultHTTPErrorHandler 

func (ep *Echop) DefaultHTTPErrorHandler(err error, c echo.Context)

func (*Echop) GET 

func (ep *Echop) GET(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) Group 

func (ep *Echop) Group(prefix string, m ...echo.MiddlewareFunc) *Group

func (*Echop) HEAD 

func (ep *Echop) HEAD(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) Match 

func (ep *Echop) Match(methods []string, path string, h HandlerFunc, m ...echo.MiddlewareFunc) []*echo.Route

func (*Echop) OPTIONS 

func (ep *Echop) OPTIONS(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) PATCH 

func (ep *Echop) PATCH(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) POST 

func (ep *Echop) POST(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) PUT 

func (ep *Echop) PUT(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) RouteNotFound 

func (ep *Echop) RouteNotFound(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) TRACE 

func (ep *Echop) TRACE(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Echop) URI 

func (ep *Echop) URI(handler HandlerFunc, params ...interface{}) string

func (*Echop) URL 

func (ep *Echop) URL(handler HandlerFunc, params ...interface{}) string

type Group 

type Group struct {
	G *echo.Group
}

func (*Group) Add 

func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...echo.MiddlewareFunc) *echo.Route

func (*Group) Any 

func (g *Group) Any(path string, handler HandlerFunc, middleware ...echo.MiddlewareFunc) []*echo.Route

func (*Group) CONNECT 

func (g *Group) CONNECT(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) DELETE 

func (g *Group) DELETE(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) File 

func (g *Group) File(path, file string)

func (*Group) FileFS 

func (g *Group) FileFS(path, file string, filesystem fs.FS, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) GET 

func (g *Group) GET(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) Group 

func (g *Group) Group(prefix string, m ...echo.MiddlewareFunc) *Group

func (*Group) HEAD 

func (g *Group) HEAD(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) Match 

func (g *Group) Match(methods []string, path string, handler HandlerFunc, middleware ...echo.MiddlewareFunc) []*echo.Route

func (*Group) OPTIONS 

func (g *Group) OPTIONS(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) PATCH 

func (g *Group) PATCH(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) POST 

func (g *Group) POST(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) PUT 

func (g *Group) PUT(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) RouteNotFound 

func (g *Group) RouteNotFound(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) Static 

func (g *Group) Static(pathPrefix, fsRoot string)

func (*Group) StaticFS 

func (g *Group) StaticFS(pathPrefix string, filesystem fs.FS)

func (*Group) TRACE 

func (g *Group) TRACE(path string, h HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

func (*Group) Use 

func (g *Group) Use(middleware ...echo.MiddlewareFunc)

type HandlerFunc 

type HandlerFunc func(c Context) error

type JSONResponse 

type JSONResponse struct {
	Code    any    `json:"code"`
	Message string `json:"message"`
	Data    any    `json:"data,omitempty"`
}

JSONResponse is a standard response format

type LoggerFields 

type LoggerFields struct {
	Msg    string
	Fields []zap.Field
	C      echo.Context
}

type Validator 

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

func NewValidator 

func NewValidator() *Validator

func (*Validator) Validate 

func (v *Validator) Validate(i any) error

Source Files

View all Source files

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.