config

Documentation

Index

• Variables
• func MustLoad(fpaths ...string)
• func Print()
• func PrintWithJSON()
• type CORS
• type Casbin
• type Config
  • func (c *Config) IsDebugMode() bool
• type GZIP
• type HTTP
• type I18N
• type JWTAuth
• type Logging
• type MiddleConfig
• type MySQL
  • func (a MySQL) DSN() string
• type Postgres
  • func (a Postgres) DSN() string
• type RateLimiter
• type Redis
• type Sqlite3
  • func (a Sqlite3) DSN() string
• type WWW

Variables

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

Functions

func MustLoad

func MustLoad(fpaths ...string)

MustLoad 加载配置

func Print

func Print()

Print 基于JSON格式输出配置

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 Casbin

type Casbin struct {
	Enable bool
	Debug  bool
}

Casbin casbin配置参数

type Config

type Config struct {
	RunMode      string `default:"release"`
	Swagger      bool
	PrintConfig  bool
	HTTP         HTTP
	Casbin       Casbin
	Logging      Logging
	RateLimiter  RateLimiter
	JWTAuth      JWTAuth
	CORS         CORS
	GZIP         GZIP
	Redis        Redis
	MySQL        MySQL
	MySQL2       MySQL
	Postgres     Postgres
	Sqlite3      Sqlite3
	WWW          WWW
	I18N         I18N
	MiddleConfig MiddleConfig
}

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 HTTP

type HTTP struct {
	Host             string `default:"0.0.0.0"`
	Port             int    `default:"80"`
	CertFile         string
	KeyFile          string
	ShutdownTimeout  int
	MaxContentLength int64
	ContextPath      string `default:"api"`
	Prefixes         []string
}

HTTP http配置参数

type I18N

type I18N struct {
	DBEnable bool `default:"false"`
}

I18N 国际化

type JWTAuth

type JWTAuth struct {
	Enable        bool `default:"true"`
	SigningMethod string
	SigningKey    string
	SigningSecret string
	Expired       int
	Store         string
	FilePath      string
	RedisDB       int
	RedisPrefix   string
	LimitTime     int64  `default:"0"`     // 同时间内, 获取的访问令牌相同, 可以配置<=0, 不使用缓存
	LimitExpired  int    `default:"7200"`  // 访问令牌过期时间, 默认60分钟
	LimitRefresh  int    `default:"86400"` // 刷新令牌过期时间, 默认24小时
	AuthzServer   string // 认证服务器， 子服务器需要认证权限时候调用
}

JWTAuth 用户认证

type Logging

type Logging struct {
	Level            string `default:"info"`
	Format           string // json | text
	Output           string
	OutputFile       string
	EnableSyslogHook bool
	SyslogNetwork    string `default:"udp"`
	SyslogAddr       string
	SyslogTag        string
}

Logging 日志配置参数

type MiddleConfig

type MiddleConfig struct {
	Logger  bool
	Recover bool
}

MiddleConfig 中间件启动和关闭

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 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 RateLimiter

type RateLimiter struct {
	Enable  bool
	Count   int64
	RedisDB int
}

RateLimiter 请求频率限制配置参数

type Redis

type Redis struct {
	Addr     string
	Password string
}

Redis redis配置参数

type Sqlite3

type Sqlite3 struct {
	Path string
}

Sqlite3 sqlite3配置参数

func (Sqlite3) DSN

func (a Sqlite3) DSN() string

DSN 数据库连接串

type WWW

type WWW struct {
	Index   string `default:"index.html"`
	RootDir string `default:"www"`
}

WWW 静态资源