beego目前支持INI、XML、JSON、YAML格式的配置文件解析,但是默认采用了INI格式解析,用户可以通过简单的配置就可以获得很大的灵活性。
一、默认配置解析
beego 默认会解析当前应用下的 conf/app.conf
文件。
通过这个文件你可以初始化很多 beego 的默认参数:
appname = beepkg
httpaddr = "127.0.0.1"
httpport = 9090
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "myview"
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 模式。你可以用 Default* 方法返回默认值。
二、不同级别的配置
在配置文件里面支持section,可以有不同的Runmode的配置,默认优先读取runmode下面的配置信息。例如:
appname = beepkg
httpaddr = "127.0.0.1"
httpport = 9090
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "myview"
[dev]
httpport = 8080
[prod]
httpport = 8088
[test]
httpport = 8888
上面的httpport设置了三中配置。解析的时候优先解析runmode下的配置,然后解析默认的配置。
三、多个配置文件
INI格式配置支持include方式,引用多个配置文件。
app.conf::
appname = beepkg
httpaddr = "127.0.0.1"
httpport = 9090
include "app2.conf"
app2.conf
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "myview"
[dev]
httpport = 8080
[prod]
httpport = 8088
[test]
httpport = 8888
四、支持环境变量配置
配置文件解析支持从环境变量中获取配置项,配置项格式:${环境变量}。
runmode = "${ProRunMode||dev}"
httpport = "${ProPort||9090}"
如果环境变量中配置了ProRunMode则优先使用,否则使用dev作为runmode。
五、系统默认参数
1.基础配置
BConfig保存了所有 beego 里面的系统默认参数,你可以通过 beego.BConfig
来访问和修改底下的所有配置信息。
配置文件路径,默认是应用程序对应的目录下的 conf/app.conf
,用户可以在程序代码中加载自己的配置文件beego.LoadAppConfig("ini", "conf/app2.conf")。
也可以加载多个文件,只要你调用多次就可以了,如果后面的文件和前面的 key 冲突,那么以最新加载的为最新值。
2.App配置
(1)AppName
应用名称,默认是 beego。通过 bee new
创建的是创建的项目名。
beego.BConfig.AppName = "beego"
(2)RunMode
应用的运行模式,可选值为 prod
, dev
或者 test
. 默认是 dev
, 为开发模式,在开发模式下出错会提示友好的出错页面,如前面错误描述中所述。
beego.BConfig.RunMode = "dev"
(3)RouterCaseSensitive
是否路由忽略大小写匹配,默认是 true,区分大小写。
beego.BConfig.RouterCaseSensitive = true
(4)ServerName
beego 服务器默认在请求的时候输出 server 为 beego。
beego.BConfig.ServerName = "beego"
(5)RecoverPanic
是否异常恢复,默认值为 true,即当应用出现异常的情况,通过 recover 恢复回来,而不会导致应用异常退出。
beego.BConfig.RecoverPanic = true
(6)CopyRequestBody
是否允许在 HTTP 请求时,返回原始请求体数据字节,默认为 false (GET or HEAD or 上传文件请求除外)。
beego.BConfig.CopyRequestBody = false
(7)EnableGzip
是否开启 gzip 支持,默认为 false 不支持 gzip,一旦开启了 gzip,那么在模板输出的内容会进行 gzip 或者 zlib 压缩,根据用户的 Accept-Encoding 来判断。
beego.BConfig.EnableGzip = false
Gzip允许用户自定义压缩级别、压缩长度阈值和针对请求类型压缩:
-
压缩级别,
gzipCompressLevel = 9
,取值为 1~9,如果不设置为 1(最快压缩) -
压缩长度阈值,
gzipMinLength = 256
,当原始内容长度大于此阈值时才开启压缩,默认为 20B(ngnix默认长度) -
请求类型,
includedMethods = get;post
,针对哪些请求类型进行压缩,默认只针对 GET 请求压缩
(8)MaxMemory
文件上传默认内存缓存大小,默认值是 1 << 26
(64M)。
beego.BConfig.MaxMemory = 1 << 26
(9)EnableErrorsShow
是否显示系统错误信息,默认为 true。
beego.BConfig.EnableErrorsShow = true
(10)EnableErrorsRender
是否将错误信息进行渲染,默认值为 true,即出错会提示友好的出错页面,对于 API 类型的应用可能需要将该选项设置为 false 以阻止在 dev
模式下不必要的模板渲染信息返回。
3.Web配置
(1)AutoRender
是否模板自动渲染,默认值为 true,对于 API 类型的应用,应用需要把该选项设置为 false,不需要渲染模板。
beego.BConfig.WebConfig.AutoRender = true
(2)EnableDocs
是否开启文档内置功能,默认是 false
beego.BConfig.WebConfig.EnableDocs = true
(3)FlashName
Flash 数据设置时 Cookie 的名称,默认是 BEEGO_FLASH
beego.BConfig.WebConfig.FlashName = "BEEGO_FLASH"
(4)FlashSeperator
Flash 数据的分隔符,默认是 BEEGOFLASH
beego.BConfig.WebConfig.FlashSeperator = "BEEGOFLASH"
(5)DirectoryIndex
是否开启静态目录的列表显示,默认不显示目录,返回 403 错误。
beego.BConfig.WebConfig.DirectoryIndex = false
(6)StaticDir
静态文件目录设置,默认是static,
beego.BConfig.WebConfig.StaticDir=
可配置单个或多个目录:
单个目录:
StaticDir = download
. 相于 beego.SetStaticPath("/download","download")
多个目录:
StaticDir = download:down download2:down2
. 相当于 beego.SetStaticPath("/download","down")
和 beego.SetStaticPath("/download2","down2")
(7)StaticExtensionsToGzip
允许哪些后缀名的静态文件进行 gzip 压缩,默认支持 .css 和 .js
beego.BConfig.WebConfig.StaticExtensionsToGzip = []string{".css", ".js"}
等价 config 文件中:
StaticExtensionsToGzip = .css, .js
(8)TemplateLeft
模板左标签,默认值是{{
。
beego.BConfig.WebConfig.TemplateLeft="{{"
(9)TemplateRight
模板右标签,默认值是}}
。
beego.BConfig.WebConfig.TemplateRight="}}"
(10)ViewsPath
模板路径,默认值是 views。
beego.BConfig.WebConfig.ViewsPath="views"
(11)EnableXSRF
是否开启 XSRF,默认为 false,不开启。
beego.BConfig.WebConfig.EnableXSRF = false
(12)XSRFKEY
XSRF 的 key 信息,默认值是 beegoxsrf。 EnableXSRF=true 才有效
beego.BConfig.WebConfig.XSRFKEY = "beegoxsrf"
(13)XSRFExpire
XSRF 过期时间,默认值是 0,不过期。
beego.BConfig.WebConfig.XSRFExpire = 0
4.监听配置
(1)Graceful
是否开启热升级,默认是false,关闭热升级。
beego.BConfig.Listen.Graceful=false
(2)ServerTimeout
设置HTTP的超时时间,默认是0,不超时。
beego.BConfig.Listen.ServerTimeOut=0
(3)ListenTCP4
监听本地网络地址类型,默认是TCP6,可以通过设置为true设置为TCP4。
beego.BConfig.Listen.ListenTCP4 = true
(4)EnableHTTP
是否启用HTTP监听,默认是true。
beego.BConfig.Listen.EnableHTTP = true
(5)HTTPAddr
应用监听地址,默认为空,监听所有的网卡IP。
beego.BConfig.Listen.HTTPAddr = ""
(6)HTTPPort
应用监听端口,默认为8080.
beego.BConfig.Listen.HTTPPort = 8080
(7)HTTPSCertFile
开启HTTPS后,ssl证书路径,默认为空。
beego.BConfig.Listen.HTTPSCertFile = "conf/ssl.crt"
(8)HTTPSKeyFile
开启HTTPS之后,SSL证书keyfile的路径。
beego.BConfig.Listen.HTTPSKeyFile = "conf/ssl.key"
(9)EnableAdmin
是否开启进程内监控模块,默认false关闭。
beego.BConfig.Listen.EnableAdmin = false
(10)AdminAddr
监听程序监听的地址,默认值是localhost。
beego.BConfig.Listen.AdminAddr = "localhost"
(11)AdminPort
监听程序监听的端口,默认是8088.
beego.BConfig.Listen.AdminPort = 8088
(12)EnableFcgi
是否启用fastcgi,默认是false。
beego.BConfig.Listen.EnableFcgi = false
(13)EnableStdlo
通过fastcgi标准I/O,启用fastcgi后才生效,默认false。
beego.BConfig.Listen.EnableStdIo = false
5.Session配置
(1)SessionOn
session是否开启,默认是false。
beego.BConfig.WebConfig.Session.SessionOn = false
(2)SessionProvider
session的引擎,默认是memory。
beego.BConfig.WebConfig.Session.SessionProvider = ""
(3)SessionName
存在客户端的cookie名称,默认值是beegosessionID。
beego.BConfig.WebConfig.Session.SessionName = "beegosessionID"
(4)SessionGCMaxLifetime
session过期时间,默认值是3600秒。
beego.BConfig.WebConfig.Session.SessionGCMaxLifetime = 3600
(5)SessionProviderConfig
配置信息,根据不同的引擎设置不同的配置信息。
(6)SessionCookieLifeTime
session默认存在客户端的cookie的时间,默认值是3600。
beego.BConfig.WebConfig.Session.SessionCookieLifeTime = 3600
(7)SessionAutoSetCookie
是否开启SetCookie,默认值true开启。
beego.BConfig.WebConfig.Session.SessionAutoSetCookie = true
(8)SessionDomain
session cookie存储域名,默认为空。
beego.BConfig.WebConfig.Session.SessionDomain = ""
6.Log配置
(1)AccessLogs
是否输出到Log,默认在prod模式下不会输出日志,默认为false不输出日志。此参数不支持配置文件配置。
beego.BConfig.Log.AccessLogs = false
(2)FileLineNum
是否在日志里面显式文件名和输出日志行号,默认true。此参数不支持配置文件配置。
beego.BConfig.Log.FileLineNum = true
(3)Outputs
日志输出配置,此参数不支持配置文件配置。下面两种方式都可以:
beego.BConfig.Log.Outputs = map[string]string{"console": ""}
beego.BConfig.Log.Outputs["console"] = ""