web_gin

Documentation

Index

• Variables
• func AfterTestMain(uuid, logOutUrl string, testClient *httptest.Client)
• func InitConfig() error
• func InitWeb()
• func IsExist() bool
• func Remove() error
• func ToStaticUrl(uri string) string
• type Captcha
• type CustomAspect
  • func (a *CustomAspect) GetStats() interface{}
  • func (a *CustomAspect) InRoot() bool
  • func (a *CustomAspect) Name() string
• type Limit
• type Route
• type System
• type Web
• type WebServer
  • func BeforeTestMain(mysqlPwd, redisPwd string, redisDB int, party func(wi *WebServer), ...) (string, *WebServer)
  • func Init() *WebServer
  • func (ws *WebServer) AddStatic(requestPath, root string)
  • func (ws *WebServer) AddUploadStatic()
  • func (ws *WebServer) AddWebStatic()
  • func (ws *WebServer) GetRouterGroup(relativePath string) *gin.RouterGroup
  • func (ws *WebServer) GetSources() ([]map[string]string, []map[string]string)
  • func (ws *WebServer) GetTestClient(t *testing.T) *httptest.Client
  • func (ws *WebServer) GetTestLogin(t *testing.T, url string, res httptest.Responses, datas ...interface{}) *httptest.Client
  • func (ws *WebServer) InitDriver() error
  • func (ws *WebServer) InitRouter() error
  • func (ws *WebServer) Run()

Variables

var CONFIG = Web{
	MaxSize: 1024,
	Except: Route{
		Uri:    "",
		Method: "",
	},
	System: System{
		Tls:          false,
		Level:        "debug",
		Addr:         "127.0.0.1:8085",
		StaticPrefix: "static/upload",
		WebPrefix:    "/admin",
		WebPath:      "./dist",
		DbType:       "mysql",
		CacheType:    "redis",
		TimeFormat:   "2006-01-02 15:04:05",
	},
	Limit: Limit{
		Disable: true,
		Limit:   0,
		Burst:   5,
	},
	Captcha: Captcha{
		KeyLong:   4,
		ImgWidth:  240,
		ImgHeight: 80,
	},
}

var ErrAuthDriverEmpty = errors.New("认证驱动初始化失败")

Functions

func AfterTestMain

func AfterTestMain(uuid, logOutUrl string, testClient *httptest.Client)

func InitConfig

func InitConfig() error

InitConfig 初始化配置文件

func InitWeb

func InitWeb()

InitWeb 初始化配置

func IsExist

func IsExist() bool

IsExist 配置文件是否存在

func Remove

func Remove() error

Remove 删除配置文件

func ToStaticUrl

func ToStaticUrl(uri string) string

ToStaticUrl 静态地址url

Types

type Captcha

type Captcha struct {
	KeyLong   int `mapstructure:"key-long" json:"keyLong" yaml:"key-long"`
	ImgWidth  int `mapstructure:"img-width" json:"imgWidth" yaml:"img-width"`
	ImgHeight int `mapstructure:"img-height" json:"imgHeight" yaml:"img-height"`
}

type CustomAspect

type CustomAspect struct {
	CustomValue int
}

func (*CustomAspect) GetStats

func (a *CustomAspect) GetStats() interface{}

func (*CustomAspect) InRoot

func (a *CustomAspect) InRoot() bool

func (*CustomAspect) Name

func (a *CustomAspect) Name() string

type Limit

type Limit struct {
	Disable bool    `mapstructure:"disable" json:"disable" yaml:"disable"`
	Limit   float64 `mapstructure:"limit" json:"limit" yaml:"limit"`
	Burst   int     `mapstructure:"burst" json:"burst" yaml:"burst"`
}

type Route

type Route struct {
	Uri    string `mapstructure:"uri" json:"uri" yaml:"uri"`
	Method string `mapstructure:"method" json:"method" yaml:"method"`
}

type System

type System struct {
	Tls          bool   `mapstructure:"tls" json:"tls" yaml:"tls"`
	Level        string `mapstructure:"level" json:"level" yaml:"level"` // debug,release,test
	Addr         string `mapstructure:"addr" json:"addr" yaml:"addr"`
	StaticPrefix string `mapstructure:"static-prefix" json:"staticPrefix" yaml:"static-prefix"`
	WebPrefix    string `mapstructure:"web-prefix" json:"webPrefix" yaml:"web-prefix"`
	WebPath      string `mapstructure:"web-path" json:"webPath" yaml:"web-path"`
	DbType       string `mapstructure:"db-type" json:"dbType" yaml:"db-type"`
	CacheType    string `mapstructure:"cache-type" json:"cacheType" yaml:"cache-type"`
	TimeFormat   string `mapstructure:"time-format" json:"timeFormat" yaml:"time-format"`
}

type Web

type Web struct {
	MaxSize int64   `mapstructure:"max-size" json:"burst" yaml:"max-size"`
	Except  Route   `mapstructure:"except" json:"except" yaml:"except"`
	System  System  `mapstructure:"system" json:"system" yaml:"system"`
	Limit   Limit   `mapstructure:"limit" json:"limit" yaml:"limit"`
	Captcha Captcha `mapstructure:"captcha" json:"captcha" yaml:"captcha"`
}

type WebServer

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

WebServer web服务 - app gin.Engine - idleConnsClosed - addr 服务访问地址 - timeFormat 时间格式 - staticPrefix 静态文件访问地址前缀 - staticPath 静态文件地址 - webPath 前端文件地址

func BeforeTestMain

func BeforeTestMain(mysqlPwd, redisPwd string, redisDB int, party func(wi *WebServer), seed func(wi *WebServer, mc *migration.MigrationCmd)) (string, *WebServer)

func Init

func Init() *WebServer

Init 初始化web服务 先初始化基础服务 config , zap , database , casbin e.g.

func (*WebServer) AddStatic

func (ws *WebServer) AddStatic(requestPath, root string)

AddStatic 添加静态文件

func (*WebServer) AddUploadStatic

func (ws *WebServer) AddUploadStatic()

AddUploadStatic 添加上传文件访问地址

func (*WebServer) AddWebStatic

func (ws *WebServer) AddWebStatic()

AddWebStatic 添加前端访问地址

func (*WebServer) GetRouterGroup

func (ws *WebServer) GetRouterGroup(relativePath string) *gin.RouterGroup

func (*WebServer) GetSources

func (ws *WebServer) GetSources() ([]map[string]string, []map[string]string)

GetSources 获取系统路由 - PermRoutes 权鉴路由 - NoPermRoutes 公共路由

func (*WebServer) GetTestClient

func (ws *WebServer) GetTestClient(t *testing.T) *httptest.Client

GetTestClient 获取测试验证客户端

func (*WebServer) GetTestLogin

func (ws *WebServer) GetTestLogin(t *testing.T, url string, res httptest.Responses, datas ...interface{}) *httptest.Client

GetTestLogin 测试登录web服务

func (*WebServer) InitDriver

func (ws *WebServer) InitDriver() error

InitDriver 初始化认证

func (*WebServer) InitRouter

func (ws *WebServer) InitRouter() error

InitRouter 初始化模块路由

func (*WebServer) Run

func (ws *WebServer) Run()

Run 启动web服务