name: 参数配置

sort: 1

参数配置

beego 目前支持 INI、XML、JSON、YAML 格式的配置文件解析,但是默认采用了 INI 格式解析,用户可以通过简单的配置就可以获得很大的灵活性。

默认配置解析

beego 默认会解析当前应用下的 conf/app.conf 文件。

通过这个文件你可以初始化很多 beego 的默认参数:

  1. appname = beepkg
  2. httpaddr = "127.0.0.1"
  3. httpport = 9090
  4. runmode ="dev"
  5. autorender = false
  6. recoverpanic = false
  7. viewspath = "myview"

上面这些参数会替换 beego 默认的一些参数, beego 的参数主要有哪些呢?请参考https://godoc.org/github.com/astaxie/beego#pkg-constants 。BConfig 就是 beego 里面的默认的配置,你也可以直接通过beego.BConfig.AppName="beepkg"这样来修改,和上面的配置效果一样,只是一个在代码里面写死了,而配置文件就会显得更加灵活。

你也可以在配置文件中配置应用需要用的一些配置信息,例如下面所示的数据库信息:

  1. mysqluser = "root"
  2. mysqlpass = "rootpass"
  3. mysqlurls = "127.0.0.1"
  4. mysqldb = "beego"

那么你就可以通过如下的方式获取设置的配置信息:

  1. beego.AppConfig.String("mysqluser")
  2. beego.AppConfig.String("mysqlpass")
  3. beego.AppConfig.String("mysqlurls")
  4. 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 下的配置信息,例如下面的配置文件:

  1. appname = beepkg
  2. httpaddr = "127.0.0.1"
  3. httpport = 9090
  4. runmode ="dev"
  5. autorender = false
  6. recoverpanic = false
  7. viewspath = "myview"
  8. [dev]
  9. httpport = 8080
  10. [prod]
  11. httpport = 8088
  12. [test]
  13. 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

  1. appname = beepkg
  2. httpaddr = "127.0.0.1"
  3. httpport = 9090
  4. include "app2.conf"

app2.conf

  1. runmode ="dev"
  2. autorender = false
  3. recoverpanic = false
  4. viewspath = "myview"
  5. [dev]
  6. httpport = 8080
  7. [prod]
  8. httpport = 8088
  9. [test]
  10. httpport = 8888

支持环境变量配置

配置文件解析支持从环境变量中获取配置项,配置项格式:${环境变量}。例如下面的配置中优先使用环境变量中配置的 runmode 和 httpport,如果有配置环境变量 ProRunMode 则优先使用该环境变量值。如果不存在或者为空,则使用 “dev” 作为 runmode。

app.conf

  1. runmode = "${ProRunMode||dev}"
  2. 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允许用户自定义压缩级别、压缩长度阈值和针对请求类型压缩:

    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 文件中

    1. 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,并设置 HTTPSCertFileHTTPSKeyFile

    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 模块

  • 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配置

  1. 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"] = ""