beego配置文件

配置文件內的key不區分大小寫

關於App配置：

#App配置 for Api
AppName = ApiService
RunMode = dev
RouterCaseSensitive = true
ServerName = ApiService
RecoverPanic = true
CopyRequestBody = true
EnableGzip = false
MaxMemory = 1 << 26
EnableErrorsShow = true
EnableErrorsRender = false

• AppName 應用名稱，經過bee new建立的項目名
  AppName = beego
beego.BConfig.AppName = "beego"

• RunMode 可選prod、dev、test。默認dev爲開發模式有日誌打印，prod會關閉日誌的打印，test測試模式還沒用過
  RunMode = dev
beego.BConfig.RunMode = "dev"

• RouterCaseSensitive 路由忽略大小寫匹配，默認爲true，意思是不須要刻意配置
  RouterCaseSensitive = true
beego.BConfig.RouterCaseSensitive = true

• ServerName beego 服務器默認在請求的時候輸出 server 爲 beego
  ServerName = beego
beego.BConfig.ServerName = "beego"

• RecoverPanic 是否異常恢復，默認值爲 true，即當應用出現異常的狀況，經過 recover 恢復回來，而不會致使應用異常退出。意思是不須要刻意配置
  RecoverPanic = true
beego.BConfig.RecoverPanic = true

• CopyRequestBody 是否容許在 HTTP 請求時，返回原始請求體數據字節，默認爲 true （GET or HEAD or 上傳文件請求除外）。
  CopyRequestBody = true
beego.BConfig.CopyRequestBody = true

• EnableGzip 是否開啓 gzip 支持，默認爲 false 不支持 gzip，一旦開啓了 gzip，那麼在模板輸出的內容會進行 gzip 或者 zlib 壓縮，根據用戶的 Accept-Encoding 來判斷。web項目應該設置爲true，經過流量的壓縮加速網站開啓速度，以及在有限的帶寬條件下，支持更多人的訪問
  EnableGzip = false
beego.BConfig.EnableGzip = false
  Gzip容許用戶自定義壓縮級別、壓縮長度閾值和針對請求類型壓縮:

  • 壓縮級別, gzipCompressLevel = 9,取值爲 1~9,默認爲 1(最快壓縮)
  • 壓縮長度閾值, gzipMinLength = 256,當原始內容長度大於此閾值時纔開啓壓縮,默認爲 20B(ngnix默認長度)
  • 請求類型, includedMethods = get;post,針對哪些請求類型進行壓縮,默認只針對 GET 請求壓縮

• MaxMemory 文件上傳默認內存緩存大小，默認值是 1 << 26(64M)。
  MaxMemory = 1 << 26
beego.BConfig.MaxMemory = 1 << 26

• EnableErrorsShow 是否顯示系統錯誤信息，默認爲 true。
  EnableErrorsShow = true
beego.BConfig.EnableErrorsShow = true

• EnableErrorsRender 是否將錯誤信息進行渲染，默認值爲 true，即出錯會提示友好的出錯頁面，對於 API 類型的應用可能須要將該選項設置爲 false 以阻止在 dev 模式下沒必要要的模板渲染信息返回。
  EnableErrorsRender = true
beego.BConfig.EnableErrorsRender = true

關於Web配置：

#Web配置 for Api
AutoRender = false
EnableDocs = true
FlashName = API_FLASH
FlashSeperator = APIFLASH
#==配合swagger使用start==
DirectoryIndex = true
StaticDir = swagger
#==配合swagger使用end==
StaticExtensionsToGzip = .css, .js
TemplateLeft = {{
TemplateRight = }}
ViewsPath = views
EnableXSRF = false
XSRFKEY = beegoxsrf
XSRFExpire = 0

• AutoRender 是否模板自動渲染，默認值爲 true，對於 API 類型的應用，應用須要把該選項設置爲 false，不須要渲染模板。
  AutoRender = true
beego.BConfig.WebConfig.AutoRender = true
• EnableDocs 是否開啓文檔內置功能，默認是 false，API配合swagger時，設置爲true。
  EnableDocs = false
beego.BConfig.WebConfig.EnableDocs = false
• FlashName Flash 數據設置時 Cookie 的名稱，默認是 BEEGO_FLASH
  FlashName = BEEGO_FLASH
beego.BConfig.WebConfig.FlashName = "BEEGO_FLASH"
• FlashSeperator Flash 數據的分隔符，默認是 BEEGOFLASH，==還沒學會怎麼用的==。
  FlashSeperator = BEEGOFLASH
beego.BConfig.WebConfig.FlashSeperator = "BEEGOFLASH"
• DirectoryIndex 是否開啓靜態目錄的列表顯示，默認不顯示目錄，返回 403 錯誤。配合swagger須要設置爲true。
  DirectoryIndex = false
beego.BConfig.WebConfig.DirectoryIndex = false
• StaticDir 靜態文件目錄設置，默認是static。可配置單個或多個目錄:
  StaticDir = swagger
beego.BConfig.WebConfig.StaticDir["/swagger"] = "swagger"
  • 單個目錄, StaticDir = download. 至關於 beego.SetStaticPath("/download","download")
  • 多個目錄, StaticDir = download:down download2:down2. 至關於 beego.SetStaticPath("/download","down") 和 beego.SetStaticPath("/download2","down2")
• StaticExtensionsToGzip 容許哪些後綴名的靜態文件進行 gzip 壓縮，默認支持 .css 和 .js
  StaticExtensionsToGzip = .css, .js
beego.BConfig.WebConfig.StaticExtensionsToGzip = []string{".css", ".js"}
• TemplateLeft 模板左標籤，默認值是{{。
  TemplateLeft = {{
beego.BConfig.WebConfig.TemplateLeft="{{"
• TemplateRight 模板右標籤，默認值是}}。
  TemplateRight = }}
beego.BConfig.WebConfig.TemplateRight = "}}"
• ViewsPath 模板路徑，默認值是 views。
  ViewsPath = views
beego.BConfig.WebConfig.ViewsPath = "views"
• EnableXSRF 是否開啓 XSRF，默認爲 false，不開啓。XSRF全稱是 cross-site request forgery（跨站點請求僞造），也稱爲CSRF，是一種常見的web攻擊方式。
  EnableXSRF = false
beego.BConfig.WebConfig.EnableXSRF = false
  beego如何作到XSRF防禦
• XSRFKEY XSRF 的 key 信息，默認值是 beegoxsrf。 EnableXSRF＝true 纔有效
  XSRFKEY = beegoxsrf
beego.BConfig.WebConfig.XSRFKEY = "beegoxsrf"
• XSRFExpire XSRF 過時時間，默認值是 0，不過時。
  XSRFExpire = 0
beego.BConfig.WebConfig.XSRFExpire = 0

關於listener配置：

#listener配置
Graceful = false
ServerTimeOut = 30
ListenTCP4 = tcp4
EnableHTTP = true
HTTPAddr =
HTTPPort = 8080
EnableHTTPS = false
HTTPSAddr =
HTTPSPort = 10443
HTTPSCertFile = conf/ssl.crt
HTTPSKeyFile= conf/ssl.key
EnableAdmin = true
AdminAddr = localhost
AdminPort = 8088
EnableFcgi = false
EnableStdIo = false

• Graceful 是否開啓熱升級，默認是 false，關閉熱升級。
  Graceful = false
beego.BConfig.Listen.Graceful = false
• ServerTimeOut 設置 HTTP 的超時時間，默認是 0，不超時。
  ServerTimeOut = 0
beego.BConfig.Listen.ServerTimeOut = 0
• ListenTCP4 監聽本地網絡地址類型，默認爲 「tcp4」，該值能夠是 「tcp」, 「tcp4」, 「tcp6」, 「unix」 or 「unixpacket」 之一。
  ListenTCP4 = tcp4
beego.BConfig.Listen.ListenTCP4 = "tcp4"
• EnableHTTP 是否啓用 HTTP 監聽，默認是 true。
  EnableHTTP = true
beego.BConfig.Listen.EnableHTTP = true
• HTTPAddr 應用監聽地址，默認爲空，監聽全部的網卡 IP。
  HTTPAddr =
beego.BConfig.Listen.HTTPAddr = ""
• HTTPPort 應用監聽端口，默認爲 8080。
  HTTPPort = 8080
beego.BConfig.Listen.HTTPPort = 8080
• EnableHTTPS 是否啓用 HTTPS，默認是 false 關閉。當須要啓用時，先設置 EnableHTTPS = true，並設置 HTTPSCertFile 和 HTTPSKeyFile
  EnableHTTPS = false
beego.BConfig.Listen.EnableHTTPS = false
• HTTPSAddr 應用監聽地址，默認爲空，監聽全部的網卡 IP。
  HTTPSAddr =
beego.BConfig.Listen.HTTPSAddr = ""
• HTTPSPort 應用監聽端口，默認爲 10443
  HTTPSPort = 10443
beego.BConfig.Listen.HTTPSPort = 10443
• HTTPSCertFile 開啓 HTTPS 後，ssl 證書路徑，默認爲空。
  HTTPSCertFile = conf/ssl.crt
beego.BConfig.Listen.HTTPSCertFile = "conf/ssl.crt"
• HTTPSKeyFile 開啓 HTTPS 以後，SSL 證書 keyfile 的路徑。
  HTTPSKeyFile= conf/ssl.key
beego.BConfig.Listen.HTTPSKeyFile= "conf/ssl.key"
• EnableAdmin 是否開啓進程內監控模塊，默認 false 關閉。
  EnableAdmin = false
beego.BConfig.Listen.EnableAdmin = false
• AdminAddr 監控程序監聽的地址，默認值是 localhost 。
  AdminAddr = localhost
beego.BConfig.Listen.AdminAddr = "localhost"
• AdminPort 監控程序監聽的地址，默認值是 8088 。
  AdminPort = 8088
beego.BConfig.Listen.AdminPort = 8088
• EnableFcgi 是否啓用 fastcgi ， 默認是 false。
  EnableFcgi = false
beego.BConfig.Listen.EnableFcgi = false
  什麼是fastcgi?
• EnableStdIo 經過fastcgi 標準I/O，啓用 fastcgi 後才生效，默認 false。
  EnableStdIo = false
beego.BConfig.Listen.EnableStdIo = false

關於Session配置：

#Session配置
SessionOn = false
SessionProvider =
SessionName = beegosessionID
SessionGCMaxLifetime = 3600
SessionCookieLifeTime = 3600
SessionAutoSetCookie = true
SessionDomain =

• SessionOn session 是否開啓，默認是 false。
  SessionOn = false
beego.BConfig.WebConfig.Session.SessionOn = false
• SessionProvider session 的引擎，默認是 memory
  SessionProvider =
beego.BConfig.WebConfig.Session.SessionProvider = ""
• SessionName 存在客戶端的 cookie 名稱，默認值是 beegosessionID。
  SessionName = beegosessionID
beego.BConfig.WebConfig.Session.SessionName = "beegosessionID"
• SessionGCMaxLifetime session 過時時間，默認值是 3600 秒。
  SessionGCMaxLifetime = 3600
beego.BConfig.WebConfig.Session.SessionGCMaxLifetime = 3600
• SessionProviderConfig 配置信息，根據不一樣的引擎設置不一樣的配置信息
• SessionCookieLifeTime session 默認存在客戶端的 cookie 的時間，默認值是 3600 秒。
  SessionCookieLifeTime = 3600
beego.BConfig.WebConfig.Session.SessionCookieLifeTime = 3600
• SessionAutoSetCookie 是否開啓SetCookie, 默認值 true 開啓。
  SessionAutoSetCookie = true
beego.BConfig.WebConfig.Session.SessionAutoSetCookie = true
• SessionDomain session cookie 存儲域名, 默認空。
  SessionDomain =
beego.BConfig.WebConfig.Session.SessionDomain = ""

關於Log配置：

• 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": ""}
beego.BConfig.Log.Outputs["console"] = ""

 

 

3人點贊

 

Beego框架使用筆記