beego 目前支持 INI病瞳、XML获诈、JSON舔涎、YAML 格式的配置文件解析,但是默認(rèn)采用了 INI 格式解析嚎于,用戶可以通過簡單的配置就可以獲得很大的靈活性于购。
默認(rèn)配置解析
通過這個(gè)文件你可以初始化很多 beego 的默認(rèn)參數(shù):
appname = beepkg
httpaddr = "127.0.0.1"
httpport = 9090
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "myview"
這里的配置是通過beego.BConfig
生效的肋僧,所以,你可以直接將配置寫入到beego.BConfig
你也可以在配置文件中配置應(yīng)用需要用的一些配置信息止潘,例如下面所示的數(shù)據(jù)庫信息:
mysqluser = "root"
mysqlpass = "rootpass"
mysqlurls = "127.0.0.1"
mysqldb = "beego"
那么你就可以通過如下的方式獲取設(shè)置的配置信息:
beego.AppConfig.String("mysqluser")
beego.AppConfig.String("mysqlpass")
beego.AppConfig.String("mysqlurls")
beego.AppConfig.String("mysqldb")
不同級別的配置
根據(jù)不同的運(yùn)行環(huán)境凭戴,不同的配置炕矮,如開發(fā)環(huán)境肤视,正式生產(chǎn)線上邢滑,配置不同。
在配置文件里面支持 section遭垛,可以有不同的 Runmode 的配置锯仪,默認(rèn)優(yōu)先讀取 runmode 下的配置信息趾盐,例如下面的配置文件:
appname = youdi
httpaddr = "localhost"
httpport = 8080
runmode ="dev"
autorender = false
recoverpanic = false
viewspath = "myview"
[dev]
httpport = 8080
[prod]
httpport = 80
[test]
httpport = 8888
上面的配置文件就是在不同的 runmode 下解析不同的配置救鲤,例如在 dev 模式下本缠,httpport 是 8080,在 prod 模式下是 80稀颁,在 test 模式下是 8888匾灶。其他配置文件同理。解析的時(shí)候優(yōu)先解析 runmode 下的配置颊糜,然后解析默認(rèn)的配置芭析。
讀取不同模式下配置參數(shù)的方法是“模式::配置參數(shù)名”吞瞪,比如:beego.AppConfig.String(“dev::mysqluser”)芍秆。
對于自定義的參數(shù)妖啥,需使用 beego.GetConfig(tpy, key string, defaultVal interface{}) 來獲取指定 runmode 下的配置(需 1.4.0 以上版本)对碌,typ 為參數(shù)類型朽们,key 為參數(shù)名, defaultVal 為默認(rèn)值。
多個(gè)配置文件
INI 格式配置支持 include 方式菜枷,引用多個(gè)配置文件啤誊,例如下面的兩個(gè)配置文件效果同上:
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
支持環(huán)境變量配置
使用環(huán)境變量蚊锹,是非常靈活的一種方式牡昆,修改配置方便快捷摊欠,對于跨平臺適應(yīng)性也很好钻心。安全性也很高。值得注意是铅协,機(jī)器重啟后捷沸,注意變量生效問題。
配置文件解析支持從環(huán)境變量中獲取配置項(xiàng)狐史,配置項(xiàng)格式:${環(huán)境變量}痒给。例如下面的配置中優(yōu)先使用環(huán)境變量中配置的 runmode 和 httpport,如果有配置環(huán)境變量 ProRunMode 則優(yōu)先使用該環(huán)境變量值。如果不存在或者為空骏全,則使用 “dev” 作為 runmode苍柏。
app.conf
runmode = "${ProRunMode||dev}"
httpport = "${ProPort||9090}"
系統(tǒng)默認(rèn)參數(shù)
beego 中帶有很多可配置的參數(shù)姜贡,我們來一一認(rèn)識一下它們试吁,這樣有利于我們在接下來的 beego 開發(fā)中可以充分的發(fā)揮他們的作用(你可以通過在 conf/app.conf 中設(shè)置對應(yīng)的值,不區(qū)分大小寫):
基礎(chǔ)配置
- BConfig
保存了所有 beego 里面的系統(tǒng)默認(rèn)參數(shù)楼咳,你可以通過 beego.BConfig 來訪問和修改底下的所有配置信息.
配置文件路徑熄捍,默認(rèn)是應(yīng)用程序?qū)?yīng)的目錄下的 conf/app.conf,用戶可以在程序代碼中加載自己的配置文件
beego.LoadAppConfig("ini", "conf/app2.conf")
也可以加載多個(gè)文件母怜,只要你調(diào)用多次就可以了余耽,如果后面的文件和前面的 key 沖突,那么以最新加載的為最新值
下面給一些具體參數(shù)配置
App 配置
AppName
應(yīng)用名稱苹熏,默認(rèn)是 beego碟贾。通過 bee new 創(chuàng)建的是創(chuàng)建的項(xiàng)目名。
beego.BConfig.AppName = "beego"
RunMode
應(yīng)用的運(yùn)行模式轨域,可選值為 prod, dev 或者 test. 默認(rèn)是 dev, 為開發(fā)模式袱耽,在開發(fā)模式下出錯(cuò)會提示友好的出錯(cuò)頁面,如前面錯(cuò)誤描述中所述干发。
beego.BConfig.RunMode = "dev"
RouterCaseSensitive
是否路由忽略大小寫匹配扛邑,默認(rèn)是 true,區(qū)分大小寫
beego.BConfig.RouterCaseSensitive = true
ServerName
beego 服務(wù)器默認(rèn)在請求的時(shí)候輸出 server 為 beego铐然。
beego.BConfig.ServerName = "beego"
RecoverPanic
是否異呈弑溃恢復(fù),默認(rèn)值為 true搀暑,即當(dāng)應(yīng)用出現(xiàn)異常的情況沥阳,通過 recover 恢復(fù)回來,而不會導(dǎo)致應(yīng)用異常退出自点。
beego.BConfig.RecoverPanic = true
CopyRequestBody
是否允許在 HTTP 請求時(shí)桐罕,返回原始請求體數(shù)據(jù)字節(jié),默認(rèn)為 true (GET or HEAD or 上傳文件請求除外)。
beego.BConfig.CopyRequestBody = false
EnableGzip
是否開啟 gzip 支持功炮,默認(rèn)為 false 不支持 gzip溅潜,一旦開啟了 gzip,那么在模板輸出的內(nèi)容會進(jìn)行 gzip 或者 zlib 壓縮薪伏,根據(jù)用戶的 Accept-Encoding 來判斷滚澜。
beego.BConfig.EnableGzip = false
Gzip允許用戶自定義壓縮級別、壓縮長度閾值和針對請求類型壓縮:
- 壓縮級別, gzipCompressLevel = 9,取值為 1~9,如果不設(shè)置為 1(最快壓縮)
- 壓縮長度閾值, gzipMinLength = 256,當(dāng)原始內(nèi)容長度大于此閾值時(shí)才開啟壓縮,默認(rèn)為 20B(ngnix默認(rèn)長度)
- 請求類型, includedMethods = get;post,針對哪些請求類型進(jìn)行壓縮,默認(rèn)只針對 GET 請求壓縮
MaxMemory
文件上傳默認(rèn)內(nèi)存緩存大小嫁怀,默認(rèn)值是 1 << 26(64M)设捐。
beego.BConfig.MaxMemory = 1 << 26
EnableErrorsShow
是否顯示系統(tǒng)錯(cuò)誤信息,默認(rèn)為 true塘淑。
beego.BConfig.EnableErrorsShow = true
EnableErrorsRender
是否將錯(cuò)誤信息進(jìn)行渲染褐奥,默認(rèn)值為 true豌鸡,即出錯(cuò)會提示友好的出錯(cuò)頁面,對于 API 類型的應(yīng)用可能需要將該選項(xiàng)設(shè)置為 false 以阻止在 dev 模式下不必要的模板渲染信息返回栏赴。
Web配置
AutoRender
是否模板自動(dòng)渲染凰慈,默認(rèn)值為 true鲤屡,對于 API 類型的應(yīng)用塑径,應(yīng)用需要把該選項(xiàng)設(shè)置為 false该酗,不需要渲染模板。
beego.BConfig.WebConfig.AutoRender = true
EnableDocs
是否開啟文檔內(nèi)置功能具滴,默認(rèn)是 false
beego.BConfig.WebConfig.EnableDocs = true
FlashName
Flash 數(shù)據(jù)設(shè)置時(shí) Cookie 的名稱,默認(rèn)是 BEEGO_FLASH
beego.BConfig.WebConfig.FlashName = "BEEGO_FLASH"
FlashSeperator
Flash 數(shù)據(jù)的分隔符师倔,默認(rèn)是 BEEGOFLASH
beego.BConfig.WebConfig.FlashSeperator = "BEEGOFLASH"
DirectoryIndex
是否開啟靜態(tài)目錄的列表顯示构韵,默認(rèn)不顯示目錄,返回 403 錯(cuò)誤趋艘。
beego.BConfig.WebConfig.DirectoryIndex = false
StaticDir
靜態(tài)文件目錄設(shè)置疲恢,默認(rèn)是static
可配置單個(gè)或多個(gè)目錄:
單個(gè)目錄, StaticDir = download. 相當(dāng)于 beego.SetStaticPath("/download","download")
多個(gè)目錄, StaticDir = download:down download2:down2. 相當(dāng)于 beego.SetStaticPath("/download","down") 和
beego.SetStaticPath("/download2","down2")
beego.BConfig.WebConfig.StaticDir
StaticExtensionsToGzip
允許哪些后綴名的靜態(tài)文件進(jìn)行 gzip 壓縮,默認(rèn)支持 .css 和 .js
beego.BConfig.WebConfig.StaticExtensionsToGzip = []string{".css", ".js"}
等價(jià) config 文件中
StaticExtensionsToGzip = .css, .js
TemplateLeft
模板左標(biāo)簽瓷胧,默認(rèn)值是{{显拳。
beego.BConfig.WebConfig.TemplateLeft="{{"
TemplateRight
模板右標(biāo)簽,默認(rèn)值是}}搓萧。
beego.BConfig.WebConfig.TemplateRight="}}"
ViewsPath
模板路徑杂数,默認(rèn)值是 views。
beego.BConfig.WebConfig.ViewsPath="views"
EnableXSRF
是否開啟 XSRF瘸洛,默認(rèn)為 false揍移,不開啟。
beego.BConfig.WebConfig.EnableXSRF = false
XSRFKEY
XSRF 的 key 信息反肋,默認(rèn)值是 beegoxsrf那伐。 EnableXSRF=true 才有效
beego.BConfig.WebConfig.XSRFKEY = "beegoxsrf"
XSRFExpire
XSRF 過期時(shí)間,默認(rèn)值是 0,不過期罕邀。
beego.BConfig.WebConfig.XSRFExpire = 0
監(jiān)聽配置
Graceful
是否開啟熱升級畅形,默認(rèn)是 false,關(guān)閉熱升級诉探。
beego.BConfig.Listen.Graceful=false
ServerTimeOut
設(shè)置 HTTP 的超時(shí)時(shí)間日熬,默認(rèn)是 0,不超時(shí)阵具。
beego.BConfig.Listen.ServerTimeOut=0
ListenTCP4
監(jiān)聽本地網(wǎng)絡(luò)地址類型碍遍,默認(rèn)為 “tcp4”,該值可以是 “tcp”, “tcp4”, “tcp6”, “unix” or “unixpacket” 之一阳液。
beego.BConfig.Listen.ListenTCP4 = "tcp4"
EnableHTTP
是否啟用 HTTP 監(jiān)聽怕敬,默認(rèn)是 true。
beego.BConfig.Listen.EnableHTTP = true
HTTPAddr
應(yīng)用監(jiān)聽地址帘皿,默認(rèn)為空东跪,監(jiān)聽所有的網(wǎng)卡 IP。
beego.BConfig.Listen.HTTPAddr = ""
HTTPPort
應(yīng)用監(jiān)聽端口鹰溜,默認(rèn)為 8080虽填。
beego.BConfig.Listen.HTTPPort = 8080
EnableHTTPS
是否啟用 HTTPS,默認(rèn)是 false 關(guān)閉曹动。當(dāng)需要啟用時(shí)斋日,先設(shè)置 EnableHTTPS = true,并設(shè)置 HTTPSCertFile 和 HTTPSKeyFile
beego.BConfig.Listen.EnableHTTPS = false
HTTPSAddr
應(yīng)用監(jiān)聽地址墓陈,默認(rèn)為空恶守,監(jiān)聽所有的網(wǎng)卡 IP。
beego.BConfig.Listen.HTTPSAddr = ""
HTTPSPort
應(yīng)用監(jiān)聽端口贡必,默認(rèn)為 10443
beego.BConfig.Listen.HTTPSPort = 10443
HTTPSCertFile
開啟 HTTPS 后兔港,ssl 證書路徑,默認(rèn)為空仔拟。
beego.BConfig.Listen.HTTPSCertFile = "conf/ssl.crt"
HTTPSKeyFile
開啟 HTTPS 之后衫樊,SSL 證書 keyfile 的路徑。
beego.BConfig.Listen.HTTPSKeyFile = "conf/ssl.key"
EnableAdmin
是否開啟進(jìn)程內(nèi)監(jiān)控模塊利花,默認(rèn) false 關(guān)閉科侈。
beego.BConfig.Listen.EnableAdmin = false
AdminAddr
監(jiān)控程序監(jiān)聽的地址,默認(rèn)值是 localhost 炒事。
beego.BConfig.Listen.AdminAddr = "localhost"
AdminPort
監(jiān)控程序監(jiān)聽的地址兑徘,默認(rèn)值是 8088 。
beego.BConfig.Listen.AdminPort = 8088
EnableFcgi
是否啟用 fastcgi 羡洛, 默認(rèn)是 false挂脑。
beego.BConfig.Listen.EnableFcgi = false
EnableStdIo
通過fastcgi 標(biāo)準(zhǔn)I/O藕漱,啟用 fastcgi 后才生效,默認(rèn) false崭闲。
beego.BConfig.Listen.EnableStdIo = false
Session配置
SessionOn
session 是否開啟肋联,默認(rèn)是 false。
beego.BConfig.WebConfig.Session.SessionOn = false
SessionProvider
session 的引擎刁俭,默認(rèn)是 memory橄仍,詳細(xì)參見 session 模塊。
beego.BConfig.WebConfig.Session.SessionProvider = ""
SessionName
存在客戶端的 cookie 名稱牍戚,默認(rèn)值是 beegosessionID侮繁。
beego.BConfig.WebConfig.Session.SessionName = "beegosessionID"
SessionGCMaxLifetime
session 過期時(shí)間,默認(rèn)值是 3600 秒如孝。
beego.BConfig.WebConfig.Session.SessionGCMaxLifetime = 3600
SessionProviderConfig
配置信息宪哩,根據(jù)不同的引擎設(shè)置不同的配置信息,詳細(xì)的配置請看下面的引擎設(shè)置第晰,詳細(xì)參見 session 模塊
SessionCookieLifeTime
session 默認(rèn)存在客戶端的 cookie 的時(shí)間锁孟,默認(rèn)值是 3600 秒。
beego.BConfig.WebConfig.Session.SessionCookieLifeTime = 3600
SessionAutoSetCookie
是否開啟SetCookie, 默認(rèn)值 true 開啟茁瘦。
beego.BConfig.WebConfig.Session.SessionAutoSetCookie = true
SessionDomain
session cookie 存儲域名, 默認(rèn)空品抽。
beego.BConfig.WebConfig.Session.SessionDomain = ""
Log配置
AccessLogs
是否輸出日志到 Log,默認(rèn)在 prod 模式下不會輸出日志甜熔,默認(rèn)為 false 不輸出日志圆恤。此參數(shù)不支持配置文件配置。
beego.BConfig.Log.AccessLogs = false
FileLineNum
是否在日志里面顯示文件名和輸出日志行號腔稀,默認(rèn) true盆昙。此參數(shù)不支持配置文件配置。
beego.BConfig.Log.FileLineNum = true
Outputs
日志輸出配置烧颖,參考 logs 模塊弱左,console file 等配置窄陡,此參數(shù)不支持配置文件配置炕淮。
beego.BConfig.Log.Outputs = map[string]string{"console": ""}
or
beego.BConfig.Log.Outputs["console"] = ""