配置文件詳解 · beego私房菜

## 配置文件路徑： * #### beego 默認會解析當前應用下的 conf/app.conf 文件 ##### 應用名稱： `appname = beepkg` `beego.BConfig.AppName = "beego"` ip地址：`httpaddr = "127.0.0.1"` 端口：`httpport = 9090` 運行模式：`runmode ="dev"` 默認dev，開發模式 * ##### dev 開發環境 * ##### tets：測試環境 * ##### sprod：準生產 * ##### prod：生產 ##### `beego.BConfig.RunMode = "dev"` 是否關閉模板渲染：`autorender = false` 改變視圖目錄 `viewspath = "myview"` `beego.SetViewsPath(“test\_view”)` ## 讀取配置文件信息： ` beego.AppConfig.String("mysqluser")` ## 多個配置文件：比如數據庫配置信息 * #### 在conf/app.conf配置文件中引入其他的配置文件 `include "mysql_server.conf"` ## 詳細配置信息如下： #### 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 請求時，返回原始請求體數據字節，默認為 false （GET or HEAD or 上傳文件請求除外）。 `beego.BConfig.CopyRequestBody = false` * EnableGzip 是否開啟 gzip 支持，默認為 false 不支持 gzip，一旦開啟了 gzip，那么在模板輸出的內容會進行 gzip 或者 zlib 壓縮，根據用戶的 Accept-Encoding 來判斷。 `beego.BConfig.EnableGzip = false` Gzip允許用戶自定義壓縮級別、壓縮長度閾值和針對請求類型壓縮: 1. 壓縮級別,`gzipCompressLevel = 9`,取值為 1~9,如果不設置為 1(最快壓縮) 2. 壓縮長度閾值,`gzipMinLength = 256`,當原始內容長度大于此閾值時才開啟壓縮,默認為 20B(ngnix默認長度) 3. 請求類型,`includedMethods = get;post`,針對哪些請求類型進行壓縮,默認只針對 GET 請求壓縮 * **MaxMemory** 文件上傳默認內存緩存大小，默認值是`1 << 26`(64M)。 `beego.BConfig.MaxMemory = 1 << 26` * EnableErrorsShow 是否顯示系統錯誤信息，默認為 true。 `beego.BConfig.EnableErrorsShow = true` * EnableErrorsRender 是否將錯誤信息進行渲染，默認值為 true，即出錯會提示友好的出錯頁面，對于 API 類型的應用可能需要將該選項設置為 false 以阻止在`dev`模式下不必要的模板渲染信息返回。 #### 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.FlashSeparator = "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 監聽本地網絡地址類型，默認是TCP6，可以通過設置為true設置為TCP4。 `beego.BConfig.Listen.ListenTCP4 = true` * 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.EnableAdmin = 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 模塊](https://beego.me/docs/mvc/controller/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"] = ""` 三.操作配置文件的方法： * 獲取配置信息 * beego.AppConfig.String("user\_name") * 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 四.配置文件的key 支持 section::key 模式。優先解析 runmode 下的配置，然后解析默認的配置 \[dev\] httpport = 8080 \[prod\] httpport = 8088 \[test\] httpport = 8888 五.配置文件支持環境變量配置 ~~~ runmode = "${ProRunMode||dev}" httpport = "${ProPort||9090}" ~~~ 優先級：如果有配置環境變量 ProRunMode 則優先使用該環境變量值。如果不存在或者為空，則使用 “dev” 作為 runmode。