引數配置

尹成發表於2018-11-14

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

上面的配置檔案就是在不同的 runmode 下解析不同的配置,例如在 dev 模式下,httpport 是 8080,在 prod 模式下是 8088,在 test 模式下是 8888。其他配置檔案同理。解析的時候優先解析 runmode 下的配置,然後解析預設的配置。

讀取不同模式下配置引數的方法是“模式::配置引數名”,比如:beego.AppConfig.String(“dev::mysqluser”)。

對於自定義的引數,需使用 beego.GetConfig(typ, key string, defaultVal interface{}) 來獲取指定 runmode 下的配置(需 1.4.0 以上版本),typ 為引數型別,key 為引數名, defaultVal 為預設值。

##多個配置檔案
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 和 httpport,如果有配置環境變數 ProRunMode 則優先使用該環境變數值。如果不存在或者為空,則使用 “dev” 作為 runmode。

app.conf

runmode  = "${ProRunMode||dev}"
httpport = "${ProPort||9090}"

##系統預設引數
beego 中帶有很多可配置的引數,我們來一一認識一下它們,這樣有利於我們在接下來的 beego 開發中可以充分的發揮他們的作用(你可以通過在 conf/app.conf 中設定對應的值,不區分大小寫):

##基礎配置
###BConfig
儲存了所有 beego 裡面的系統預設引數,你可以通過 beego.BConfig 來訪問和修改底下的所有配置資訊.
配置檔案路徑,預設是應用程式對應的目錄下的 conf/app.conf,使用者可以在程式程式碼中載入自己的配置檔案

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

也可以載入多個檔案,只要你呼叫多次就可以了,如果後面的檔案和前面的 key 衝突,那麼以最新載入的為最新值

###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允許使用者自定義壓縮級別、壓縮長度閾值和針對請求型別壓縮:

壓縮級別, gzipCompressLevel = 9,取值為 1~9,如果不設定為 1(最快壓縮)

壓縮長度閾值, gzipMinLength = 256,當原始內容長度大於此閾值時才開啟壓縮,預設為 20B(ngnix預設長度)

請求型別, 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.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

監聽本地網路地址型別,預設是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

####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"] = ""

學院Go語言視訊主頁
https://edu.csdn.net/lecturer/1928

清華團隊帶你實戰區塊鏈開發
掃碼獲取海量視訊及原始碼 QQ群:721929980
在這裡插入圖片描述

相關文章