GF框架的WebServer配置管理非常方便，支持多种配置方式以及若干配置方法。

配置对象

配置对象定义：
https://godoc.org/github.com/gogf/gf/net/ghttp#ServerConfig

配置管理方法

方法列表： https://godoc.org/github.com/gogf/gf/net/ghttp#Server

简要说明：

可以通过SetConfig及SetConfigWithMap来设置。
也可以使用Server对象的Set*/Enable*方法进行特定配置的设置。
主要注意的是，配置项在Server执行Start之后便不能再修改，防止产生并发安全问题。

`SetConfigWithMap`方法

我们可以使用SetConfigWithMap方法通过Key-Value键值对来设置/修改Server的特定配置，其余的配置使用默认配置即可。其中Key的名称即是ServerConfig这个struct中的属性名称，并且不区分大小写，单词间也支持使用-/_/空格符号连接，具体可参考【gconv.Struct转换规则】章节。

简单示例：

s := g.Server()
s.SetConfigWithMap(g.Map{
    "Address":    ":80",
    "ServerRoot": "/var/www/MyServerRoot",
})
s.Run()

其中ServerRoot的键名也可以使用serverRoot, server-root, server_root, server root，其他配置属性以此类推。

一个比较完整的示例：

s := g.Server()
s.SetConfigWithMap(g.Map{
    "Address":          ":80",
    "ServerRoot":       "/var/www/Server",
    "IndexFiles":       g.Slice{"index.html", "main.html"},
    "AccessLogEnabled": true,
    "ErrorLogEnabled":  true,
    "PProfEnabled":     true,
    "LogPath":          "/var/log/ServerLog",
    "SessionIdName":    "MySessionId",
    "SessionPath":      "/tmp/MySessionStoragePath",
    "SessionMaxAge":    24 * time.Hour,
    "DumpRouterMap":    false,
})
s.Run()

配置文件

Server对象也支持通过配置文件进行便捷的配置。支持的配置选项以及配置说明请查看接口文档说明，文档中有详细说明，以下章节不会对配置选项作介绍。

当使用g.Server(单例名称)获取Server单例对象时，将会自动通过默认的配置管理对象获取对应的Server配置。默认情况下会读取server.单例名称配置项，当该配置项不存在时，将会读取server配置项。

支持的配置文件配置项请参考Server配置管理对象属性：https://godoc.org/github.com/gogf/gf/net/ghttp#ServerConfig

示例1，默认配置项

[server]
    Address    = ":80"
    ServerRoot = "/var/www/Server"

随后可以使用g.Server()获取默认的单例对象时自动获取并设置该配置。

示例2，多个配置项

多个Server的配置示例：

[server]
    Address    = ":80"
    ServerRoot = "/var/www/Server"
    [server.server1]
        Address    = ":8080"
        ServerRoot = "/var/www/Server1"
    [server.server2]
        Address    = ":8088"
        ServerRoot = "/var/www/Server2"

我们可以通过单例对象名称获取对应配置的Server单例对象：

// 对应 server.server1 配置项
s1 := g.Server("server1")
// 对应 server.server2 配置项
s2 := g.Server("server2")
// 对应默认配置项 server
s3 := g.Server("none")
// 对应默认配置项 server
s4 := g.Server()

示例3，较完整示例

比如上一个章节的示例，对应的配置文件如下：

[server]
    Address          = ":8199"
    ServerRoot       = "/var/www/Server"
    IndexFiles       = ["index.html", "main.html"]
    AccessLogEnabled = true
    ErrorLogEnabled  = true
    PProfEnabled     = true
    LogPath          = "/var/log/ServerLog"
    SessionIdName    = "MySessionId"
    SessionPath      = "/tmp/MySessionStoragePath"
    SessionMaxAge    = "24h"
    DumpRouterMap    = false

同理，配置属性项的名称也不区分大小写，单词间也支持使用-/_符号连接。也就是说以下配置文件效果和上面的配置文件一致：

[server]
    address          = ":8199"
    serverRoot       = "/var/www/Server"
    indexFiles       = ["index.html", "main.html"]
    accessLogEnabled = true
    errorLogEnabled  = true
    pprofEnabled     = true
    log-path         = "/var/log/ServerLog"
    session_Id_Name  = "MySessionId"
    Session-path     = "/tmp/MySessionStoragePath"
    session_MaxAge   = "24h"
    DumpRouterMap    = false

上传限制

Server对于客户端提交的数据是由大小限制的，主要有两个配置参数控制：

MaxHeaderBytes：请求头大小限制，请求头包括客户端提交的Cookie数据，默认设置为10KB。
ClientMaxBodySize：客户端提交的Body大小限制，同时也影响文件上传大小，默认设置为8MB。

由于安全性的考虑，默认的上传限制都不是很高，特别是ClientMaxBodySize的大小限制，在需要文件上传的场景可适当考虑调整，通过配置文件配置即可，例如：

[server]
    MaxHeaderBytes    = "20KB"
    ClientMaxBodySize = "200MB"

这样便修改请求头大小限制为20KB，文件上传大小限制为200MB。

最后编辑: kuteng 文档更新时间: 2021-01-09 18:11 作者：kuteng

基本介绍