app

type App struct {
	Name string // 程序名称

	Version string // 程序版本

	// 在运行服务之前对 Server 的额外操作
	//
	// 比如添加模块等。不可以为空。
	Init func(s *server.Server, action string) error

	// 在初始化 Server 之前对 Options 的二次处理
	//
	// 可以为空。
	Options func(*server.Options)

	// 命令行输出信息的通道
	//
	// 默认为 os.Stdout。
	Out io.Writer

	// 配置文件的加载器
	//
	// 为空则会给定一个能解析 .xml、.yaml、.yml 和 .json 文件的默认对象。
	// 该值可能会被 Options 操作所覆盖。
	Files *serialization.Files

	// 配置文件的文件名
	//
	// 仅是文件名，相对的路径由命令行 -f 指定。
	// 如果为空，则直接采用 &Options{} 初始化 Server 对象。
	ConfigFilename string

	// 本地化的相关操作接口
	//
	// 如果为空，则会被初始化一个空对象，该值可能会被 Options 操作所覆盖。
	Catalog *catalog.Builder

	// 触发退出的信号
	//
	// 为空(nil 或是 []) 表示没有。
	Signals []os.Signal

	// 通过信号触发退出时的等待时间
	SignalTimeout time.Duration
	// contains filtered or unexported fields
}

type CORS struct {
	// Origins 对应 Origin
	//
	// 可以是 *，如果包含了 *，那么其它的设置将不再启作用。
	// 此字段将被用于与请求头的 Origin 字段作验证，以确定是否放行该请求。
	//
	// 如果此值为空，表示不启用跨域的相关设置。
	Origins []string `yaml:"origins,omitempty" json:"origins,omitempty" xml:"origin,omitempty"`

	// AllowHeaders 对应 Access-Control-Allow-Headers
	//
	// 可以包含 *，表示可以是任意值，其它值将不再启作用。
	AllowHeaders []string `yaml:"allowHeaders,omitempty" json:"allowHeaders,omitempty" xml:"allowHeader,omitempty"`

	// ExposedHeaders 对应 Access-Control-Expose-Headers
	ExposedHeaders []string `yaml:"exposedHeaders,omitempty" json:"exposedHeaders,omitempty" xml:"exposedHeader,omitempty"`

	// MaxAge 对应 Access-Control-Max-Age
	//
	// 0 不输出该报头；
	// -1 表示禁用；
	// 其它 >= -1 的值正常输出数值；
	MaxAge int `yaml:"maxAge,omitempty" json:"maxAge,omitempty" xml:"maxAge,attr,omitempty"`

	// AllowCredentials 对应 Access-Control-Allow-Credentials
	AllowCredentials bool `yaml:"allowCredentials,omitempty" json:"allowCredentials,omitempty" xml:"allowCredentials,attr,omitempty"`
}

type Cache struct {
	// 表示缓存的方式
	//
	// 目前支持以下几种试：
	// - memory 以内存作为缓存；
	// - memcached 以 memcached 作为缓存；
	// - redis 以 redis 作为缓存；
	// - file 以文件作为缓存；
	Type string `yaml:"type" json:"type" xml:"type,attr"`

	// 表示连接缓存服务器的参数
	//
	// - memory，此值为 time.Duration 格式的参数，用于表示执行回收的间隔；
	// - memcached，则为服务器列表，多个服务器，以分号作为分隔；
	// - redis，则为符合 Redis URI scheme 的字符串，可参考 https://www.iana.org/assignments/uri-schemes/prov/redis；
	// - file，表示以半有分号分隔的参数列表，可以指定以下两个参数：
	//  - path 文件路径；
	//  - gc 执行回收的间隔，time.Duration 格式；
	DSN string `yaml:"dsn" json:"dsn" xml:"dsn"`
}

type Certificate struct {
	Cert string `yaml:"cert,omitempty" json:"cert,omitempty" xml:"cert,omitempty"`
	Key  string `yaml:"key,omitempty" json:"key,omitempty" xml:"key,omitempty"`
}

type Config struct {
	XMLName struct{} `yaml:"-" json:"-" xml:"web"`

	// 指定默认语言
	//
	// 当客户端未指定 Accept-Language 时，会采用此值，
	// 如果为空，则会尝试当前用户的语言。
	Language string `yaml:"language,omitempty" json:"language,omitempty" xml:"language,attr,omitempty"`

	// 网站端口
	//
	// 格式与 net/http.Server.Addr 相同。可以为空，表示由 net/http.Server 确定其默认值。
	Port string `yaml:"port,omitempty" json:"port,omitempty" xml:"port,attr,omitempty"`

	// 路由的相关设置
	//
	// 提供了对全局路由的设置，但是用户依然可以通过 server.Server.MuxGroups().AddRouter 忽略这些设置项。
	Router *Router `yaml:"router,omitempty" json:"router,omitempty" xml:"router,omitempty"`

	// 与 HTTP 请求相关的设置项
	HTTP *HTTP `yaml:"http,omitempty" json:"http,omitempty" xml:"http,omitempty"`

	// 时区名称
	//
	// 可以是 Asia/Shanghai 等，具体可参考：
	// https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	//
	// 为空和 Local(注意大小写) 值都会被初始化本地时间。
	Timezone string `yaml:"timezone,omitempty" json:"timezone,omitempty" xml:"timezone,omitempty"`

	// 指定缓存对象
	//
	// 如果为空，则会采用内存作为缓存对象。
	Cache *Cache `yaml:"cache,omitempty" json:"cache,omitempty" xml:"cache,omitempty"`

	// 日志初始化参数
	//
	// 如果为空，则初始化一个空日志，不会输出任何日志。
	Logs *config.Config `yaml:"logs,omitempty" json:"logs,omitempty" xml:"logs,omitempty"`
	// contains filtered or unexported fields
}

type Duration time.Duration

type Error struct {
	Config  string      // 配置文件的路径
	Field   string      // 字段名
	Message interface{} // 错误信息
	Value   interface{} // 原始值
}

type HTTP struct {
	// 网站的域名证书
	//
	// 不能同时与 LetsEncrypt 生效
	Certificates []*Certificate `yaml:"certificates,omitempty" json:"certificates,omitempty" xml:"certificate,omitempty"`

	// 配置 Let's Encrypt 证书
	//
	// 不能同时与 Certificates 生效
	LetsEncrypt *LetsEncrypt `yaml:"letsEncrypt,omitempty" json:"letsEncrypt,omitempty" xml:"letsEncrypt,omitempty"`

	// 应用于 http.Server 的几个变量
	ReadTimeout       Duration `yaml:"readTimeout,omitempty" json:"readTimeout,omitempty" xml:"readTimeout,attr,omitempty"`
	WriteTimeout      Duration `yaml:"writeTimeout,omitempty" json:"writeTimeout,omitempty" xml:"writeTimeout,attr,omitempty"`
	IdleTimeout       Duration `yaml:"idleTimeout,omitempty" json:"idleTimeout,omitempty" xml:"idleTimeout,attr,omitempty"`
	ReadHeaderTimeout Duration `yaml:"readHeaderTimeout,omitempty" json:"readHeaderTimeout,omitempty" xml:"readHeaderTimeout,attr,omitempty"`
	MaxHeaderBytes    int      `yaml:"maxHeaderBytes,omitempty" json:"maxHeaderBytes,omitempty" xml:"maxHeaderBytes,attr,omitempty"`
	// contains filtered or unexported fields
}

type LetsEncrypt struct {
	Domains []string `yaml:"domains" json:"domains" xml:"domains"`
	Cache   string   `yaml:"cache" json:"cache" xml:"cache"`
	Email   string   `yaml:"email,omitempty" json:"email,omitempty" xml:"email,omitempty"`

	// 定义提早几天开始续订，如果为 0 表示提早 30 天。
	RenewBefore uint `yaml:"renewBefore,omitempty" json:"renewBefore,omitempty" xml:"renewBefore,attr,omitempty"`
}

type Router struct {
	// 是否忽略大小写
	//
	// 如果为 true，那么客户请求的 URL 都将被转换为小写字符。
	// 不会影响服务端添加的路由项。
	CaseInsensitive bool `yaml:"caseInsensitive,omitempty" json:"caseInsensitive,omitempty" xml:"caseInsensitive,attr,omitempty"`

	// 跨域的相关设置
	//
	// 为空表示禁用跨域的相关设置。
	CORS *CORS `yaml:"cors,omitempty" json:"cors,omitempty" xml:"cors,omitempty"`
	// contains filtered or unexported fields
}