config

Documentation

Index

• Variables
• func MustLoad(path string)
• func PrintWithJSON()
• type CORS
• type Captcha
• type Casbin
• type Config
  • func (c *Config) IsDebugMode() bool
• type GZIP
• type Generate
• type Gorm
  • func (g *Gorm) DSN(index string) string
• type JWTAuth
• type Log
• type LogGormHook
• type LogHook
  • func (h LogHook) IsGorm() bool
• type Monitor
• type MySQL
  • func (a MySQL) DSN() string
• type MySQLs
  • func (m MySQLs) DSN(index string) string
• type OSS
• type Postgres
  • func (a Postgres) DSN() string
• type Postgress
  • func (p Postgress) DSN(index string) string
• type RateLimiter
• type Redis
• type Server
• type Sqlite3
  • func (a Sqlite3) DSN() string
• type Sqlite3s
  • func (s Sqlite3s) DSN(index string) string

Variables

var (
	// C 全局配置(需要先执行MustLoad，否则拿不到配置)
	C = new(Config)
)

Functions

func MustLoad

func MustLoad(path string)

MustLoad 加载配置

func PrintWithJSON

func PrintWithJSON()

PrintWithJSON 基于JSON格式输出配置

Types

type CORS

type CORS struct {
	Enable           bool
	AllowOrigins     []string
	AllowMethods     []string
	AllowHeaders     []string
	AllowCredentials bool
	MaxAge           int
}

CORS 跨域请求配置参数

type Captcha

type Captcha struct {
	Store       string
	Length      int
	Width       int
	Height      int
	RedisDB     int
	RedisPrefix string
}

Captcha 图形验证码配置参数

type Casbin

type Casbin struct {
	Enable           bool
	Debug            bool
	Model            string
	AutoLoad         bool
	AutoLoadInternal int
}

Casbin casbin配置参数

type Config

type Config struct {
	RunMode     string
	EnableDP    bool
	WWW         string
	Version     string
	Swagger     bool
	PrintConfig bool
	Solt        string
	AESKey      string
	Server      Server
	Casbin      Casbin
	Log         Log
	LogGormHook LogGormHook
	JWTAuth     JWTAuth
	Monitor     Monitor
	Captcha     Captcha
	RateLimiter RateLimiter
	CORS        CORS
	GZIP        GZIP
	Redis       Redis
	Gorm        Gorm
	MySQLs      MySQLs
	Postgress   Postgress
	Sqlite3s    Sqlite3s
	Generate    Generate
	Oss         OSS
}

Config 配置参数

func (*Config) IsDebugMode

func (c *Config) IsDebugMode() bool

IsDebugMode 是否是debug模式

type GZIP

type GZIP struct {
	Enable             bool
	ExcludedExtentions []string
	ExcludedPaths      []string
}

GZIP gzip压缩

type Generate

type Generate struct {
	DBName    string
	FrontPath string
}

Generate 代码生成结构

type Gorm

type Gorm struct {
	Debug             bool
	DBType            string
	MaxLifetime       int
	MaxOpenConns      int
	MaxIdleConns      int
	TablePrefix       string
	EnableAutoMigrate bool
}

Gorm gorm配置参数

func (*Gorm) DSN

func (g *Gorm) DSN(index string) string

DSN Gorm DSN 数据库连接串

type JWTAuth

type JWTAuth struct {
	Enable        bool
	SigningMethod string
	SigningKey    string
	Expired       int
	Store         string
	FilePath      string
	RedisDB       int
	RedisPrefix   string
	ExcludePaths  []string
}

JWTAuth 用户认证

type Log

type Log struct {
	Level         int
	Format        string
	Output        string
	OutputFile    string
	EnableHook    bool
	HookLevels    []string
	Hook          LogHook
	HookMaxThread int
	HookMaxBuffer int
}

Log 日志配置参数

type LogGormHook

type LogGormHook struct {
	DBType       string
	MaxLifetime  int
	MaxOpenConns int
	MaxIdleConns int
	Table        string
}

LogGormHook 日志钩子配置

type LogHook

type LogHook string

LogHook 日志钩子

func (LogHook) IsGorm

func (h LogHook) IsGorm() bool

IsGorm 是否是gorm钩子

type Monitor

type Monitor struct {
	Enable    bool
	Addr      string
	ConfigDir string
}

Monitor 监控配置参数

type MySQL

type MySQL struct {
	Host       string
	Port       int
	User       string
	Password   string
	DBName     string
	Parameters string
}

MySQL mysql配置参数

func (MySQL) DSN

func (a MySQL) DSN() string

DSN 数据库连接串

type MySQLs

type MySQLs map[string]*MySQL

MySQLs 多数据库

func (MySQLs) DSN

func (m MySQLs) DSN(index string) string

DSN 根据索引获取DSN

type OSS

type OSS struct {
	Enable           bool
	Type             string // 支持类型minio、aliyun、huawei、local; local：本地文件存储
	Endpoint         string
	AccessKeyID      string
	SecretAccessKey  string
	BucketName       string
	ObjectNameFormat string
	SecurityToken    string // 仅对华为OBS需要
	StorageRoot      string // 仅对本地(local)文件存储需要
	CDN              string
}

OSS oss存储

type Postgres

type Postgres struct {
	Host     string
	Port     int
	User     string
	Password string
	DBName   string
	SSLMode  string
}

Postgres postgres配置参数

func (Postgres) DSN

func (a Postgres) DSN() string

DSN 数据库连接串

type Postgress

type Postgress map[string]*Postgres

Postgress 多数据库

func (Postgress) DSN

func (p Postgress) DSN(index string) string

DSN 根据索引获取DSN

type RateLimiter

type RateLimiter struct {
	Enable  bool
	Count   int64
	RedisDB int
}

RateLimiter 请求频率限制配置参数

type Redis

type Redis struct {
	Addr     string
	Password string
}

Redis redis配置参数

type Server

type Server struct {
	Host             string
	Port             int
	CertFile         string
	KeyFile          string
	ShutdownTimeout  int
	MaxContentLength int64
	MaxLoggerLength  int
}

Server Server配置参数

type Sqlite3

type Sqlite3 struct {
	Path string
}

Sqlite3 sqlite3配置参数

func (Sqlite3) DSN

func (a Sqlite3) DSN() string

DSN 数据库连接串

type Sqlite3s

type Sqlite3s map[string]*Sqlite3

Sqlite3s 多数据库

func (Sqlite3s) DSN

func (s Sqlite3s) DSN(index string) string

DSN 根据索引获取DSN