properties

Documentation

Index

• type Aliyun
• type AuthConfig
• type CORS
• type CORSWhitelist
• type Captcha
• type Email
• type JWT
• type Local
• type Oauth
• type RabbitMQ
  • func (r *RabbitMQ) GetUrl() string
• type Redis
• type System
• type Upload
• type Zap
  • func (z *Zap) TransportLevel() zapcore.Level
  • func (z *Zap) ZapEncodeLevel() zapcore.LevelEncoder

Types

type Aliyun

type Aliyun struct {
	Zone            string `mapstructure:"zone" json:"zone" yaml:"zone"`
	Endpoint        string `mapstructure:"endpoint" json:"endpoint" yaml:"endpoint"`
	AccessKeyId     string `mapstructure:"access-key-id" json:"access-key-id" yaml:"access-key-id"`
	AccessKeySecret string `mapstructure:"access-key-secret" json:"access-key-secret" yaml:"access-key-secret"`
	BucketName      string `mapstructure:"bucket-name" json:"bucket-name" yaml:"bucket-name"`
	BucketUrl       string `mapstructure:"bucket-url" json:"bucket-url" yaml:"bucket-url"`
	BasePath        string `mapstructure:"base-path" json:"base-path" yaml:"base-path"`
}

type AuthConfig

type AuthConfig struct {
	ClientID     string `json:"client-id" yaml:"client-id" mapstructure:"client-id"`
	ClientSecret string `json:"client-secret" yaml:"client-secret" mapstructure:"client-secret"`
	RedirectUrl  string `json:"redirect-url" yaml:"redirect-url" mapstructure:"redirect-url"`
}

type CORS

type CORS struct {
	Mode      string          `mapstructure:"mode" json:"mode" yaml:"mode"`
	Whitelist []CORSWhitelist `mapstructure:"whitelist" json:"whitelist" yaml:"whitelist"`
}

type CORSWhitelist

type CORSWhitelist struct {
	AllowOrigin      string `mapstructure:"allow-origin" json:"allow-origin" yaml:"allow-origin"`
	AllowMethods     string `mapstructure:"allow-methods" json:"allow-methods" yaml:"allow-methods"`
	AllowHeaders     string `mapstructure:"allow-headers" json:"allow-headers" yaml:"allow-headers"`
	ExposeHeaders    string `mapstructure:"expose-headers" json:"expose-headers" yaml:"expose-headers"`
	AllowCredentials bool   `mapstructure:"allow-credentials" json:"allow-credentials" yaml:"allow-credentials"`
}

type Captcha

type Captcha struct {
	KeyLong            int `mapstructure:"key-long" json:"key-long" yaml:"key-long"`                                     // 验证码长度
	ImgWidth           int `mapstructure:"img-width" json:"img-width" yaml:"img-width"`                                  // 验证码宽度
	ImgHeight          int `mapstructure:"img-height" json:"img-height" yaml:"img-height"`                               // 验证码高度
	OpenCaptcha        int `mapstructure:"open-captcha" json:"open-captcha" yaml:"open-captcha"`                         // 防爆破验证码开启此数，0代表每次登录都需要验证码，其他数字代表错误密码此数，如3代表错误三次后出现验证码
	OpenCaptchaTimeOut int `mapstructure:"open-captcha-timeout" json:"open-captcha-timeout" yaml:"open-captcha-timeout"` // 防爆破验证码超时时间，单位：s(秒)
}

type Email

type Email struct {
	Host     string `mapstructure:"host" json:"host" yaml:"host"`             // 服务器地址 例如 smtp.qq.com  请前往QQ或者你要发邮件的邮箱查看其smtp协议
	Port     int    `mapstructure:"port" json:"port" yaml:"port"`             // 端口     请前往QQ或者你要发邮件的邮箱查看其smtp协议 大多为 465
	Username string `mapstructure:"username" json:"username" yaml:"username"` // 发件人  你自己要发邮件的邮箱
	Password string `mapstructure:"password" json:"password" yaml:"password"` // 密钥    用于登录的密钥 最好不要用邮箱密码 去邮箱smtp申请一个用于登录的密钥
	Deliver  string `mapstructure:"deliver" json:"deliver" yaml:"deliver"`    // 抄送邮箱:多个以英文逗号分隔 例：a@qq.com b@qq.com 正式开发中请把此项目作为参数使用
	Nickname string `mapstructure:"nickname" json:"nickname" yaml:"nickname"` // 发件人昵称
	IsSSL    bool   `mapstructure:"is-ssl" json:"isSSL" yaml:"is-ssl"`        // 是否使用 SSL/TLS
}

type JWT

type JWT struct {
	SigningKey  string `mapstructure:"signing-key" json:"signing-key" yaml:"signing-key"`    // jwt签名
	ExpiresTime string `mapstructure:"expires-time" json:"expires-time" yaml:"expires-time"` // 过期时间
	BufferTime  string `mapstructure:"buffer-time" json:"buffer-time" yaml:"buffer-time"`    // 缓冲时间
	Issuer      string `mapstructure:"issuer" json:"issuer" yaml:"issuer"`                   // 签发者
}

type Local

type Local struct {
	Url  string `mapstructure:"url" json:"url" yaml:"url"`    // 本地项目访问地址
	Path string `mapstructure:"path" json:"path" yaml:"path"` // 本地文件访问目录
}

type Oauth

type Oauth struct {
	QQ     AuthConfig `json:"qq" yaml:"qq" mapstructure:"qq"`
	Feishu AuthConfig `json:"feishu" yaml:"feishu" mapstructure:"feishu"`
	Weibo  AuthConfig `json:"weibo" yaml:"weibo" mapstructure:"weibo"`
}

type RabbitMQ

type RabbitMQ struct {
	Host     string `mapstructure:"host" json:"host" yaml:"host"`             // RabbitMQ服务器地址
	Port     int    `mapstructure:"port" json:"port" yaml:"port"`             // RabbitMQ端口
	Username string `mapstructure:"username" json:"username" yaml:"username"` // RabbitMQ用户名
	Password string `mapstructure:"password" json:"password" yaml:"password"` // RabbitMQ密码
}

func (*RabbitMQ) GetUrl

func (r *RabbitMQ) GetUrl() string

type Redis

type Redis struct {
	DB       int    `mapstructure:"db" json:"db" yaml:"db"`       // redis的哪个数据库
	Host     string `mapstructure:"host" json:"host" yaml:"host"` // 服务器地址:端口
	Port     string `mapstructure:"port" json:"port" yaml:"port"`
	Password string `mapstructure:"password" json:"password" yaml:"password"` // 密码
}

type System

type System struct {
	Env           string `mapstructure:"env" json:"env" yaml:"env"`                                  // 环境值
	Addr          int    `mapstructure:"addr" json:"addr" yaml:"addr"`                               // 端口值
	DbType        string `mapstructure:"db-type" json:"db-type" yaml:"db-type"`                      // 数据库类型:mysql(默认)|sqlite|sqlserver|postgresql
	OssType       string `mapstructure:"oss-type" json:"oss-type" yaml:"oss-type"`                   // Oss类型
	UseMultipoint bool   `mapstructure:"use-multipoint" json:"use-multipoint" yaml:"use-multipoint"` // 多点登录拦截
	UseRedis      bool   `mapstructure:"use-redis" json:"use-redis" yaml:"use-redis"`                // 使用redis
	LimitCountIP  int    `mapstructure:"iplimit-count" json:"iplimit-count" yaml:"iplimit-count"`
	LimitTimeIP   int    `mapstructure:"iplimit-time" json:"iplimit-time" yaml:"iplimit-time"`
	RouterPrefix  string `mapstructure:"router-prefix" json:"router-prefix" yaml:"router-prefix"`
	RuntimePath   string `mapstructure:"runtime-path" json:"runtime-path" yaml:"runtime-path"` // 运行时目录
}

type Upload

type Upload struct {
	Mode   string `mapstructure:"mode"`
	Local  Local  `mapstructure:"local"`
	Aliyun Aliyun `mapstructure:"aliyun"`
	Qiniu  Aliyun `mapstructure:"qiniu"`
}

type Zap

type Zap struct {
	Level         string `mapstructure:"level" json:"level" yaml:"level"`                            // 级别
	Prefix        string `mapstructure:"prefix" json:"prefix" yaml:"prefix"`                         // 日志前缀
	Format        string `mapstructure:"format" json:"format" yaml:"format"`                         // 输出
	Director      string `mapstructure:"director" json:"director"  yaml:"director"`                  // 日志文件夹
	EncodeLevel   string `mapstructure:"encode-level" json:"encode-level" yaml:"encode-level"`       // 编码级
	StacktraceKey string `mapstructure:"stacktrace-key" json:"stacktrace-key" yaml:"stacktrace-key"` // 栈名

	MaxAge       int  `mapstructure:"max-age" json:"max-age" yaml:"max-age"`                      // 日志留存时间
	ShowLine     bool `mapstructure:"show-line" json:"show-line" yaml:"show-line"`                // 显示行
	LogInConsole bool `mapstructure:"log-in-console" json:"log-in-console" yaml:"log-in-console"` // 输出控制台
}

func (*Zap) TransportLevel

func (z *Zap) TransportLevel() zapcore.Level

TransportLevel 根据字符串转化为 zapcore.Level Author [SliverHorn](https://github.com/SliverHorn)

func (*Zap) ZapEncodeLevel

func (z *Zap) ZapEncodeLevel() zapcore.LevelEncoder

ZapEncodeLevel 根据 EncodeLevel 返回 zapcore.LevelEncoder Author [SliverHorn](https://github.com/SliverHorn)