scaffold

README

Scaffold

• Scaffolding for quickly building web services based on gin and zap

install

go get -u github.com/wuruipeng404/scaffold@v1.5.6

Usage

package main

import (
	"context"
	"github.com/gin-gonic/gin"
	"github.com/wuruipeng404/scaffold"
	"github.com/wuruipeng404/scaffold/logger"
	"github.com/wuruipeng404/scaffold/orm"
	"sync"
)

func init() {
	logger.InitLogger() // only os.stdout

	logger.InitPersistenceLogger("./some_logfile")
}

func main() {
	server := scaffold.NewGraceServer(":8000", gin.Default())

	server.AddBackgroundTask(func(ctx context.Context, wg *sync.WaitGroup) {
		// some background task like cronjob
	})

	server.AddDeferFunc(func() {
		// resource recycle
		logger.Debugf("exit")
	})
	server.Start()
}

Documentation

Index

• func Cors() gin.HandlerFunc
• func DefaultAllowHeaders() []string
• func DefaultCorsMap() map[string]string
• func GracefulLogger() gin.HandlerFunc
• func NewCors(headers map[string]string) gin.HandlerFunc
• func NewCorsWithDefault(headers map[string]string) gin.HandlerFunc
• type ApiPage
• type ApiResponse
• type BeautyController
  • func (c *BeautyController) Failed(ctx *gin.Context, ie er.IError)
  • func (c *BeautyController) FailedC(ctx *gin.Context, code int, message string)
  • func (c *BeautyController) FailedD(ctx *gin.Context, ie er.IError, data any)
  • func (c *BeautyController) FailedDyn(ctx *gin.Context, ie er.IError, err error)
  • func (c *BeautyController) FailedE(ctx *gin.Context, err error)
  • func (c *BeautyController) OK(ctx *gin.Context, data any)
  • func (c *BeautyController) PageOk(ctx *gin.Context, data any, page ApiPage)
  • func (c *BeautyController) PureOK(ctx *gin.Context)
  • func (c *BeautyController) RawOK(ctx *gin.Context, data any)
• type GraceServer
  • func NewGraceServer(listen string, engine *gin.Engine) *GraceServer
  • func (g *GraceServer) AddBackgroundTask(tasks ...func(ctx context.Context, wg *sync.WaitGroup))
  • func (g *GraceServer) AddDeferFunc(tasks ...func())
  • func (g *GraceServer) Start()

Functions

func Cors

func Cors() gin.HandlerFunc

Cors 处理跨域请求

func DefaultAllowHeaders

func DefaultAllowHeaders() []string

func DefaultCorsMap

func DefaultCorsMap() map[string]string

func GracefulLogger

func GracefulLogger() gin.HandlerFunc

func NewCors

func NewCors(headers map[string]string) gin.HandlerFunc

func NewCorsWithDefault

func NewCorsWithDefault(headers map[string]string) gin.HandlerFunc

Types

type ApiPage

type ApiPage struct {
	TotalCount int64  `json:"total_count"`          // 列表数据总数
	TotalPage  int64  `json:"total_page,omitempty"` // 列表页总数
	PageCount  int64  `json:"page_count"`           // 当前页数量
	PageIndex  int64  `json:"page_index"`           // 当前页码
	Sort       string `json:"sort,omitempty"`       // 排序
}

type ApiResponse

type ApiResponse struct {
	Code    int    `json:"code"`
	Msg     string `json:"msg"`
	Data    any    `json:"data,omitempty"`
	ApiPage `json:",inline"`
}

type BeautyController

type BeautyController struct{}

func (*BeautyController) Failed

func (c *BeautyController) Failed(ctx *gin.Context, ie er.IError)

Failed with IError

func (*BeautyController) FailedC

func (c *BeautyController) FailedC(ctx *gin.Context, code int, message string)

FailedC with custom code and message

func (*BeautyController) FailedD

func (c *BeautyController) FailedD(ctx *gin.Context, ie er.IError, data any)

FailedD with IError and Data

func (*BeautyController) FailedDyn

func (c *BeautyController) FailedDyn(ctx *gin.Context, ie er.IError, err error)

FailedDyn join IError message adn dynamic raw error message

func (*BeautyController) FailedE

func (c *BeautyController) FailedE(ctx *gin.Context, err error)

FailedE with default code and raw error

func (*BeautyController) OK

func (c *BeautyController) OK(ctx *gin.Context, data any)

OK response with data

func (*BeautyController) PageOk

func (c *BeautyController) PageOk(ctx *gin.Context, data any, page ApiPage)

PageOk response with page data

func (*BeautyController) PureOK

func (c *BeautyController) PureOK(ctx *gin.Context)

PureOK only http code 200

func (*BeautyController) RawOK

func (c *BeautyController) RawOK(ctx *gin.Context, data any)

RawOK without code msg

type GraceServer

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

func NewGraceServer

func NewGraceServer(listen string, engine *gin.Engine) *GraceServer

func (*GraceServer) AddBackgroundTask

func (g *GraceServer) AddBackgroundTask(tasks ...func(ctx context.Context, wg *sync.WaitGroup))

AddBackgroundTask append background goroutine and when server exit will wait then the task finish need call wg.Done()

func (*GraceServer) AddDeferFunc

func (g *GraceServer) AddDeferFunc(tasks ...func())

func (*GraceServer) Start

func (g *GraceServer) Start()

Start no stop method, because no need for