配置文件内的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"] = ""