ginger

README

ginger

Package of gin framework

使用到的包与组件

1.gin

github.com/gin-gonic/gin

2.gzip压缩

https://github.com/gin-contrib/gzip

3.swagger

github.com/swaggo/gin-swagger

Wish list

1.gzip yes

2.上传，图像裁剪，真实URL屏蔽 no

3.gin常用功能封装 yes

4.gin命令行工具 yes

5.数据库工具(数据库迁移，数据库填充，数据库默认创建，自动字段生成) no

6.日志处理 ES，FILE支持 no

7.swagger集成 yes

8.socket和ws协议集成 no

9.grpc支持 no

10.test单元测试，基准测试快速创建工具 no

Documentation

Index

• Constants
• Variables
• func Cors() gin.HandlerFunc
• func DefaultDecompressHandle(c *gin.Context)
• func Gzip(level int, options ...Option) gin.HandlerFunc
• type Cli
  • func GetCli() *Cli
  • func (c *Cli) Explain(info string) *Cli
  • func (c *Cli) Item(name string) *Cli
  • func (c *Cli) Save() CliInput
  • func (c *Cli) SaveExplain() bool
  • func (c *Cli) SetBoolDefault(d interface{}) *Cli
  • func (c *Cli) SetDefault(d interface{}) *Cli
  • func (c *Cli) SetExplainItem(info string) *Cli
  • func (c *Cli) SetIntDefault(d interface{}) *Cli
  • func (c *Cli) SetUsage(usage string) *Cli
• type CliData
  • func (c *CliData) GetBool() bool
  • func (c *CliData) GetInt() int
  • func (c *CliData) GetString() string
• type CliInput
• type CliRow
• type ExcludedExtensions
  • func NewExcludedExtensions(extensions []string) ExcludedExtensions
  • func (e ExcludedExtensions) Contains(target string) bool
• type ExcludedPaths
  • func NewExcludedPaths(paths []string) ExcludedPaths
  • func (e ExcludedPaths) Contains(requestURI string) bool
• type Explain
• type GRPCContainer
  • func (g *GRPCContainer) New(addr string) *GRPCContainer
  • func (g *GRPCContainer) Register(server *interface{})
• type Ginger
  • func GetIns() *Ginger
  • func (g *Ginger) Debug(isDebug bool) *Ginger
  • func (g *Ginger) GetHTTPServeMux() *http.ServeMux
  • func (g *Ginger) LoadRouter(router func(router *gin.Engine) gin.IRoutes) *Ginger
  • func (g *Ginger) Run(addr string, f ...func(server *grpc.Server)) (err error)
  • func (g *Ginger) Start(addr string)
  • func (g *Ginger) Swagger(openSwagger bool) *Ginger
• type Option
  • func WithDecompressFn(decompressFn func(c *gin.Context)) Option
  • func WithExcludedExtensions(args []string) Option
  • func WithExcludedPaths(args []string) Option
• type Options

Constants

const (
	CliString = iota
	CliBool
	CliInt
)

const (
	ExplainMain = iota
	ExplainItem
)

const (
	BestCompression    = gzip.BestCompression
	BestSpeed          = gzip.BestSpeed
	DefaultCompression = gzip.DefaultCompression
	NoCompression      = gzip.NoCompression
)

Variables

var (
	DefaultExcludedExtensions = NewExcludedExtensions([]string{
		".png", ".gif", ".jpeg", ".jpg",
	})
	DefaultOptions = &Options{
		ExcludedExtensions: DefaultExcludedExtensions,
	}
)

Functions

func Cors

func Cors() gin.HandlerFunc

func DefaultDecompressHandle

func DefaultDecompressHandle(c *gin.Context)

func Gzip

func Gzip(level int, options ...Option) gin.HandlerFunc

Types

type Cli

type Cli struct {
	Row        CliRow
	ExplainRow Explain
	Explains   []Explain
}

var CliIns *Cli

func GetCli

func GetCli() *Cli

单例模式获取实例

func (*Cli) Explain

func (c *Cli) Explain(info string) *Cli

func (*Cli) Item

func (c *Cli) Item(name string) *Cli

func (*Cli) Save

func (c *Cli) Save() CliInput

func (*Cli) SaveExplain

func (c *Cli) SaveExplain() bool

解析CLI命令并返回是否有说明

func (*Cli) SetBoolDefault

func (c *Cli) SetBoolDefault(d interface{}) *Cli

func (*Cli) SetDefault

func (c *Cli) SetDefault(d interface{}) *Cli

func (*Cli) SetExplainItem

func (c *Cli) SetExplainItem(info string) *Cli

func (*Cli) SetIntDefault

func (c *Cli) SetIntDefault(d interface{}) *Cli

func (*Cli) SetUsage

func (c *Cli) SetUsage(usage string) *Cli

type CliData

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

func (*CliData) GetBool

func (c *CliData) GetBool() bool

func (*CliData) GetInt

func (c *CliData) GetInt() int

func (*CliData) GetString

func (c *CliData) GetString() string

type CliInput

type CliInput interface {
	GetInt() int
	GetString() string
	GetBool() bool
}

type CliRow

type CliRow struct {
	Name    string
	Type    int
	Default interface{}
	UseAge  string
}

type ExcludedExtensions

type ExcludedExtensions map[string]bool

Using map for better lookup performance

func NewExcludedExtensions

func NewExcludedExtensions(extensions []string) ExcludedExtensions

func (ExcludedExtensions) Contains

func (e ExcludedExtensions) Contains(target string) bool

type ExcludedPaths

type ExcludedPaths []string

func NewExcludedPaths

func NewExcludedPaths(paths []string) ExcludedPaths

func (ExcludedPaths) Contains

func (e ExcludedPaths) Contains(requestURI string) bool

type Explain

type Explain struct {
	Info string
	Type int
}

type GRPCContainer

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

func (*GRPCContainer) New

func (g *GRPCContainer) New(addr string) *GRPCContainer

func (*GRPCContainer) Register

func (g *GRPCContainer) Register(server *interface{})

type Ginger

type Ginger struct {
	App *gin.Engine
	// contains filtered or unexported fields
}

var IGinger *Ginger

func GetIns

func GetIns() *Ginger

单例模式获取实例

func (*Ginger) Debug

func (g *Ginger) Debug(isDebug bool) *Ginger

默认就是DEBUG。如果设置为FALSE，则ReleaseMode

func (*Ginger) GetHTTPServeMux

func (g *Ginger) GetHTTPServeMux() *http.ServeMux

func (*Ginger) LoadRouter

func (g *Ginger) LoadRouter(router func(router *gin.Engine) gin.IRoutes) *Ginger

加载路由

func (*Ginger) Run

func (g *Ginger) Run(addr string, f ...func(server *grpc.Server)) (err error)

func (*Ginger) Start

func (g *Ginger) Start(addr string)

开启服务

func (*Ginger) Swagger

func (g *Ginger) Swagger(openSwagger bool) *Ginger

开启swagger

type Option

type Option func(*Options)

func WithDecompressFn

func WithDecompressFn(decompressFn func(c *gin.Context)) Option

func WithExcludedExtensions

func WithExcludedExtensions(args []string) Option

func WithExcludedPaths

func WithExcludedPaths(args []string) Option

type Options

type Options struct {
	ExcludedExtensions ExcludedExtensions
	ExcludedPaths      ExcludedPaths
	DecompressFn       func(c *gin.Context)
}