3.3.1 參數配置 · beego開發文檔

[TOC] # 參數配置 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" 上面這些參數會替換 beego 默認的一些參數。你可以在配置文件中配置應用需要用的一些配置信息，例如下面所示的數據庫信息： 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 上面的配置文件就是在不同的runmode下解析不同的配置，例如在dev模式下，httpport是8080，在prod模式下是8088，在test模式下是8888.其他配置文件同理。解析的時候優先解析runmode下的配置，然后解析默認的配置。讀取不同模式下配置參數的方法是“模式::配置參數名”，比如：beego.AppConfig.String("dev::mysqluser")。對于自定義的參數，需使用beego.GetConfig(typ, key string)來獲取指定runmode下的配置（需1.4.0以上版本），typ為參數類型，key為參數名。 ### 多個配置文件 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 ### 系統默認參數 beego 中帶有很多可配置的參數，我們來一一認識一下它們，這樣有利于我們在接下來的 beego 開發中可以充分的發揮他們的作用(你可以通過在`conf/app.conf`中設置對應的值，不區分大小寫)： #### 基礎配置 * AppConfigPath 配置文件路徑，默認是應用程序對應的目錄下的 `conf/app.conf`，用戶可以在程序代碼中修改該值配置自己的配置文件 `beego.AppConfigPath = "conf/app2.conf"` * AppConfigProvider 配置文件的格式，默認是ini，可以配置為xml，yaml，json `beego.AppConfigProvider = "ini"` #### App配置 * AppName 應用名稱，默認是 beego。通過`bee new`創建的是創建的項目名。 `beego.BConfig.AppName = "beego"` * RunMode 應用的運行模式，可選值為 `prod`, `dev` 或者 `test`. 默認是 `dev`, 為開發模式，在開發模式下出錯會提示友好的出錯頁面，如前面錯誤描述中所述。 `beego.BConfig.RunMode = "dev"` * RouterCaseSensitive 是否路由忽略大小寫匹配，默認是 true，區分大小寫 `beego.BConfig.RouterCaseSensitive = true` * ServerName beego 服務器默認在請求的時候輸出 server 為 beego。 `beego.BConfig.ServerName = "beego"` * RecoverPanic 是否異常恢復，默認值為 true，即當應用出現異常的情況，通過 recover 恢復回來，而不會導致應用異常退出。 `beego.BConfig.RecoverPanic = true` * CopyRequestBody 是否允許在HTTP請求時，返回原始請求體數據字節，默認為 true （GET or HEAD or 上傳文件請求除外）。 `beego.BConfig.CopyRequestBody = true` * EnableGzip 是否開啟 gzip 支持，默認為 false 不支持 gzip，一旦開啟了 gzip，那么在模板輸出的內容會進行 gzip 或者 zlib 壓縮，根據用戶的 Accept-Encoding 來判斷。 `beego.BConfig.EnableGzip = false` * MaxMemory 文件上傳默認內存緩存大小，默認值是 `1 << 26`(64M)。 `beego.BConfig.MaxMemory = 1 << 26` * EnableErrorsShow 是否顯示系統錯誤信息，默認為 true。 `beego.BConfig.EnableErrorsShow = true` #### Web配置 * AutoRender 是否模板自動渲染，默認值為 true，對于 API 類型的應用，應用需要把該選項設置為 false，不需要渲染模板。 `beego.BConfig.WebConfig.AutoRender = true` * EnableDocs 是否開啟文檔內置功能，默認是false `beego.BConfig.WebConfig.EnableDocs = true` * FlashName Flash數據設置時Cookie的名稱，默認是 BEEGO_FLASH `beego.BConfig.WebConfig.FlashName = "BEEGO_FLASH"` * FlashSeperator Flash數據的分隔符，默認是 BEEGOFLASH `beego.BConfig.WebConfig.FlashSeperator = "BEEGOFLASH"` * DirectoryIndex 是否開啟靜態目錄的列表顯示，默認不顯示目錄，返回 403 錯誤。 `beego.BConfig.WebConfig.DirectoryIndex = false` * StaticDir 靜態文件目錄設置，默認是static 可配置單個或多個目錄: 1. 單個目錄, `StaticDir = download`. 相當于`beego.SetStaticPath("/download","download")` 2. 多個目錄, `StaticDir = download:down download2:down2`. 相當于`beego.SetStaticPath("/download","down")`和`beego.SetStaticPath("/download2","down2")` `beego.BConfig.WebConfig.StaticDir` * StaticExtensionsToGzip 允許哪些后綴名的靜態文件進行gzip壓縮，默認支持 .css 和 .js `beego.BConfig.WebConfig.StaticExtensionsToGzip = []string{".css", ".js"}` 等價config文件中 StaticExtensionsToGzip = .css, .js * TemplateLeft 模板左標簽，默認值是`{{`。 `beego.BConfig.WebConfig.TemplateLeft="{{"` * TemplateRight 模板右標簽，默認值是`}}`。 `beego.BConfig.WebConfig.TemplateRight="}}"` * ViewsPath 模板路徑，默認值是 views。 `beego.BConfig.WebConfig.ViewsPath="views"` * EnableXSRF 是否開啟 XSRF，默認為 false，不開啟。 `beego.BConfig.WebConfig.EnableXSRF = false` * XSRFKEY XSRF 的 key 信息，默認值是 beegoxsrf。 EnableXSRF＝true 才有效 `beego.BConfig.WebConfig.XSRFKEY = "beegoxsrf"` * XSRFExpire XSRF 過期時間，默認值是 0，不過期。 `beego.BConfig.WebConfig.XSRFExpire = 0` #### 監聽配置 * Graceful 是否開啟熱升級，默認是false，關閉熱升級。 `beego.BConfig.Listen.Graceful=false` * ServerTimeOut 設置 HTTP 的超時時間，默認是 0，不超時。 `beego.BConfig.Listen.ServerTimeOut=0` * ListenTCP4 監聽本地網絡地址類型，默認為 "tcp4"，該值可以是"tcp", "tcp4", "tcp6", "unix" or "unixpacket"之一。 `beego.BConfig.Listen.ListenTCP4 = "tcp4"` * EnableHTTP 是否啟用HTTP監聽，默認是true。 `beego.BConfig.Listen.EnableHTTP = true` * HTTPAddr 應用監聽地址，默認為空，監聽所有的網卡 IP。 `beego.BConfig.Listen.HTTPAddr = ""` * HTTPPort 應用監聽端口，默認為 8080。 `beego.BConfig.Listen.HTTPPort = 8080` * EnableHTTPS 是否啟用 HTTPS，默認是 false 關閉。當需要啟用時，先設置 EnableHTTPS = true，并設置`HTTPSCertFile` 和 `HTTPSKeyFile` `beego.BConfig.Listen.EnableHTTPS = false` * HTTPSAddr 應用監聽地址，默認為空，監聽所有的網卡 IP。 `beego.BConfig.Listen.HTTPSAddr = ""` * HTTPSPort 應用監聽端口，默認為 10443 `beego.BConfig.Listen.HTTPSPort = 10443` * HTTPSCertFile 開啟HTTPS后，ssl證書路徑，默認為空。 `beego.BConfig.Listen.HTTPSCertFile = "conf/ssl.crt"` * HTTPSKeyFile 開啟 HTTPS 之后，SSL證書keyfile 的路徑。 `beego.BConfig.Listen.HTTPSKeyFile = "conf/ssl.key"` * EnableAdmin 是否開啟進程內監控模塊，默認 false 關閉。 `beego.BConfig.Listen.AdminEnable = false` * AdminAddr 監控程序監聽的地址，默認值是 localhost 。 `beego.BConfig.Listen.AdminAddr = "localhost"` * AdminPort 監控程序監聽的地址，默認值是 8088 。 `beego.BConfig.Listen.AdminPort = 8088` * EnableFcgi 是否啟用 fastcgi ，默認是 false。 `beego.BConfig.Listen.EnableFcgi = false` * EnableStdIo 通過fastcgi 標準I/O，啟用 fastcgi 后才生效，默認 false。 `beego.BConfig.Listen.EnableStdIo = false` #### Session配置 * SessionOn session 是否開啟，默認是 false。 `beego.BConfig.WebConfig.Session.SessionOn = false` * SessionProvider session 的引擎，默認是 memory，詳細參見 `session 模塊`。 `beego.BConfig.WebConfig.Session.SessionProvider = ""` * SessionName 存在客戶端的 cookie 名稱，默認值是 beegosessionID。 `beego.BConfig.WebConfig.Session.SessionName = "beegosessionID"` * SessionGCMaxLifetime session 過期時間，默認值是 3600 秒。 `beego.BConfig.WebConfig.Session.SessionGCMaxLifetime = 3600` * SessionProviderConfig 配置信息，根據不同的引擎設置不同的配置信息，詳細的配置請看下面的引擎設置，詳細參見 [session 模塊](zh-CN/module/session.md) * SessionCookieLifeTime session 默認存在客戶端的 cookie 的時間，默認值是 3600 秒。 `beego.BConfig.WebConfig.Session.SessionCookieLifeTime = 3600` * SessionAutoSetCookie 是否開啟SetCookie, 默認 true 不開啟。 `beego.BConfig.WebConfig.Session.SessionAutoSetCookie = true` * SessionDomain session cookie存儲域名, 默認空。 `beego.BConfig.WebConfig.Session.SessionDomain = ""` #### Log配置 log詳細配置，請參見 `logs 模塊`。 * AccessLogs 是否輸出日志到Log，默認在prod模式下不會輸出日志，默認為 false 不輸出日志。，此參數不支持配置文件配置。 `beego.BConfig.Log.AccessLogs = false` * FileLineNum 是否在日志里面顯示文件名和輸出日志行號，默認 true。此參數不支持配置文件配置。 `beego.BConfig.Log.FileLineNum = true` * Outputs 日志輸出配置，參考logs模塊，console file 等配置，此參數不支持配置文件配置。 `beego.BConfig.Log.Outputs = map[string]string{"console": ""}` or `beego.BConfig.Log.Outputs["console"] = ""`