Beego框架 app.conf配置参数及环境配置

Beego框架 app.conf配置

beego 目前支持 INI、XML、JSON、YAML格式的配置文件解析，但是默认采用了 INI 格式解析，用户可以通过简单的配置就可以获得很大的灵活性。

beego 默认会解析当前应用下的 conf/app.conf 文件。

BConfig 就是 beego 里面的默认的配置，你也可以直接通过beego.BConfig.AppName="beepkg"这样来修改，和上面的配置效果一样，只是一个在代码里面写死了，而配置文件就会显得更加灵活。

配置参数

App配置

下面是对于 beego.BConfig 中的一些配置参数的说明，包括默认值：

配置参数	说明	默认值
AppName	应用名称，默认是 "beego"。通过 bee new 创建的是创建的项目名。	"beego"
RunMode	应用的运行模式，可选值为 "prod", "dev" 或者 "test"。默认是 "dev"，为开发模式，在开发模式下出错会提示友好的出错页面。	"dev"
RouterCaseSensitive	是否路由忽略大小写匹配，默认是 true，区分大小写。	true
ServerName	beego 服务器默认在请求的时候输出 server 为 "beego"。	"beego"
RecoverPanic	是否异常恢复，默认值为 true，即当应用出现异常的情况，通过 recover 恢复回来，而不会导致应用异常退出。	true
CopyRequestBody	是否允许在 HTTP 请求时，返回原始请求体数据字节，默认为 false。	false
EnableGzip	是否开启 Gzip 支持，默认为 false。一旦开启了 Gzip，模板输出的内容会进行 Gzip 或者 zlib 压缩，根据用户的 Accept-Encoding 来判断。	false
MaxMemory	文件上传默认内存缓存大小，默认值是 1 << 26 (64M)。	1 << 26
EnableErrorsShow	是否显示系统错误信息，默认为 true。	true
EnableErrorsRender	是否将错误信息进行渲染，默认值为 true，即出错会提示友好的出错页面。对于 API 类型的应用可能需要将该选项设置为 false 以阻止在 dev 模式下不必要的模板渲染信息返回。	true

Gzip允许用户自定义压缩级别、压缩长度阈值和针对请求类型压缩:

1. 压缩级别, gzipCompressLevel = 9,取值为 1~9,如果不设置为 1(最快压缩)

2. 压缩长度阈值, gzipMinLength = 256,当原始内容长度大于此阈值时才开启压缩,默认为 20B(ngnix默认长度)

3. 请求类型, includedMethods = get;post,针对哪些请求类型进行压缩,默认只针对 GET 请求压缩

Web配置

以下是一些 beego.BConfig.WebConfig 中的配置参数的说明，包括默认值：

配置参数	说明	默认值
AutoRender	是否模板自动渲染，默认值为 true。对于 API 类型的应用，应用需要把该选项设置为 false，不需要渲染模板。	true
EnableDocs	是否开启文档内置功能，默认值为 false。	false
FlashName	Flash 数据设置时 Cookie 的名称，默认是 "BEEGO_FLASH"。	"BEEGO_FLASH"
FlashSeparator	Flash 数据的分隔符，默认是 "BEEGOFLASH"。	"BEEGOFLASH"
DirectoryIndex	是否开启静态目录的列表显示，默认不显示目录，返回 403 错误。	false
StaticDir	静态文件目录设置，默认是 "static"。可配置单个或多个目录。	"static"
StaticExtensionsToGzip	允许哪些后缀名的静态文件进行 gzip 压缩，默认支持 .css 和 .js。	[".css", ".js"]
TemplateLeft	模板左标签，默认值是 "{{"。	"{{"
TemplateRight	模板右标签，默认值是 "}}"。	"}}"
ViewsPath	模板路径，默认值是 "views"。	"views"
EnableXSRF	是否开启 XSRF，默认为 false，不开启。	false
XSRFKEY	XSRF 的 key 信息，默认值是 "beegoxsrf"。 EnableXSRF=true 才有效。	"beegoxsrf"
XSRFExpire	XSRF 过期时间，默认值是 0，不过期。	0

 StaticDir：

可配置单个或多个目录:

1. 单个目录, StaticDir = download. 相当于 beego.SetStaticPath("/download","download")

2. 多个目录, StaticDir = download:down download2:down2. 相当于 beego.SetStaticPath("/download","down") 和 beego.SetStaticPath("/download2","down2")

StaticExtensionsToGzip：

允许哪些后缀名的静态文件进行 gzip 压缩，默认支持 .css 和 .js

beego.BConfig.WebConfig.StaticExtensionsToGzip = []string{".css", ".js"}

等价 config 文件中

  StaticExtensionsToGzip = .css, .js

监听配置

以下是一些 beego.BConfig.Listen 中的配置参数的说明，包括默认值：

配置参数	说明	默认值
Graceful	是否开启热升级，默认是 false，关闭热升级。	false
ServerTimeOut	设置 HTTP 的超时时间，默认是 0，不超时。	0
ListenTCP4	监听本地网络地址类型，默认是 TCP6，可以通过设置为 true 设置为 TCP4。	false
EnableHTTP	是否启用 HTTP 监听，默认是 true。	true
HTTPAddr	应用监听地址，默认为空，监听所有的网卡 IP。	""
HTTPPort	应用监听端口，默认为 8080。	8080
EnableHTTPS	是否启用 HTTPS，默认是 false 关闭。当需要启用时，先设置 EnableHTTPS = true，并设置 HTTPSCertFile 和 HTTPSKeyFile。	false
HTTPSAddr	应用监听地址，默认为空，监听所有的网卡 IP。	""
HTTPSPort	应用监听端口，默认为 10443。	10443
HTTPSCertFile	开启 HTTPS 后，SSL 证书路径，默认为空。	"conf/ssl.crt"
HTTPSKeyFile	开启 HTTPS 之后，SSL 证书 keyfile 的路径。	"conf/ssl.key"
EnableAdmin	是否开启进程内监控模块，默认 false 关闭。	false
AdminAddr	监控程序监听的地址，默认值是 "localhost"。	"localhost"
AdminPort	监控程序监听的地址，默认值是 8088。	8088
EnableFcgi	是否启用 fastcgi，默认是 false。	false
EnableStdIo	通过 fastcgi 标准 I/O，启用 fastcgi 后才生效，默认 false。	false

Session配置

以下是一些 beego.BConfig.WebConfig.Session 中的配置参数的说明，包括默认值：

配置参数	说明	默认值
SessionOn	session 是否开启，默认是 false。	false
SessionProvider	session 的引擎，默认是 "memory"，详细参见 session 模块。	""
SessionName	存在客户端的 cookie 名称，默认值是 "beegosessionID"。	"beegosessionID"
SessionGCMaxLifetime	session 过期时间，默认值是 3600 秒。	3600
SessionProviderConfig	配置信息，根据不同的引擎设置不同的配置信息，详细的配置请看下面的引擎设置，详细参见 session 模块。	""
SessionCookieLifeTime	session 默认存在客户端的 cookie 的时间，默认值是 3600 秒。	3600
SessionAutoSetCookie	是否开启 SetCookie，默认值 true 开启。	true
SessionDomain	session cookie 存储域名，默认空。	""

Log配置

以下是一些 beego.BConfig.Log 中的配置参数的说明，包括默认值：

配置参数	说明	默认值
AccessLogs	是否输出日志到 Log，默认在 prod 模式下不会输出日志，默认为 false 不输出日志。此参数不支持配置文件配置。	false
FileLineNum	是否在日志里面显示文件名和输出日志行号，默认 true。此参数不支持配置文件配置。	true
Outputs	日志输出配置，参考 logs 模块，console file 等配置，此参数不支持配置文件配置。	map[string]string{"console": ""}

多配置：Beego框架：参数配置 - 范斯猫 (fansimao.com)

更多参数：https://godoc.org/github.com/astaxie/beego#pkg-constants

通过配置文件配置参数

默认配置

beego 默认会解析当前应用下的 conf/app.conf 文件。通过这个文件你可以初始化很多 beego 的默认参数：

appname = bee
httpaddr = "127.0.0.1"
httpport = 9090
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "views"

多环境配置

多环境下，不同级别的配置。

appname = bee
httpaddr = "127.0.0.1"
httpport = 9090
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "views"
​
[dev]
httpport = 8080
[prod]
httpport = 8088
[test]
httpport = 8888

httpport 默认端口9090，dev，prod，test三个模式下分别对应不同端口

读取不同模式下配置参数的方法是“模式::配置参数名”，比如：

beego.AppConfig.String("dev::httpport")

对于自定义的参数，需使用 beego.GetConfig(typ, key string, defaultVal interface{}) 来获取指定 runmode 下的配置（需 1.4.0 以上版本），typ 为参数类型，key 为参数名, defaultVal 为默认值。

多个配置文件

app.conf:

appname = bee
httpaddr = "127.0.0.1"
httpport = 9090
​
include "app2.conf"
app2.conf
​
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "views"
[dev]
httpport = 8080
[test]
httpport = 8888

app2.conf:

[prod]
httpport = 8088

支持环境变量配置

appname = bee
httpaddr = "127.0.0.1"
httpport = "${ProPort||9090}"
​
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "views"

带环境参数启动(指定运行模式为dev)

# 在 Linux 或 macOS 中
BEEGO_RUNMODE=dev bee run
​
# 在 Windows 中
set BEEGO_RUNMODE=dev && bee run

加载自己的配置文件

配置文件路径，默认是应用程序对应的目录下的 conf/app.conf，用户可以在程序代码中加载自己的配置文件

beego.LoadAppConfig("ini", "conf/app2.conf")

通过代码配置参数

 BConfig 就是 beego 里面的默认的配置，你也可以直接通过beego.BConfig.AppName="beepkg"这样来修改，和配置效果一样，只是一个在代码里面写死了， 而配置文件就会显得更加灵活。

自定义配置信息

mysqluser = "root"
mysqlpass = "rootpass"
mysqlurls = "127.0.0.1"
mysqldb   = "beego"

那么你就可以通过如下的方式获取设置的配置信息:

beego.AppConfig.String("mysqluser")
beego.AppConfig.String("mysqlpass")
beego.AppConfig.String("mysqlurls")
beego.AppConfig.String("mysqldb")

AppConfig 的方法如下：

• Set(key, val string) error
• String(key string) string
• Strings(key string) []string
• Int(key string) (int, error)
• Int64(key string) (int64, error)
• Bool(key string) (bool, error)
• Float(key string) (float64, error)
• DefaultString(key string, defaultVal string) string
• DefaultStrings(key string, defaultVal []string)
• DefaultInt(key string, defaultVal int) int
• DefaultInt64(key string, defaultVal int64) int64
• DefaultBool(key string, defaultVal bool) bool
• DefaultFloat(key string, defaultVal float64) float64
• DIY(key string) (interface{}, error)
• GetSection(section string) (map[string]string, error)
• SaveConfigFile(filename string) error

在使用 ini 类型的配置文件中, key 支持 section::key 模式，section可以是多环境。

你可以用 Default* 方法返回默认值.

参考文章：Beego框架 app.conf配置 - 范斯猫 (fansimao.com)