新聞中心
?GOFrame?框架的?WebServer?配置管理非常方便,支持多種配置方式以及若干配置方法。

10年積累的成都網(wǎng)站設(shè)計(jì)、網(wǎng)站制作經(jīng)驗(yàn),可以快速應(yīng)對(duì)客戶(hù)對(duì)網(wǎng)站的新想法和需求。提供各種問(wèn)題對(duì)應(yīng)的解決方案。讓選擇我們的客戶(hù)得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識(shí)你,你也不認(rèn)識(shí)我。但先網(wǎng)站制作后付款的網(wǎng)站建設(shè)流程,更有錦州免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。
配置對(duì)象
配置對(duì)象定義: https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp#ServerConfig
配置管理方法
方法列表: https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp#Server
簡(jiǎn)要說(shuō)明:
- 可以通過(guò)?
SetConfig?及?SetConfigWithMap?來(lái)設(shè)置。 - 也可以使用?
Server?對(duì)象的?Set*?/?Enable*?方法進(jìn)行特定配置的設(shè)置。 - 主要注意的是,配置項(xiàng)在?
Server?執(zhí)行?Start?之后便不能再修改,防止產(chǎn)生并發(fā)安全問(wèn)題。
SetConfigWithMap方法
我們可以使用?SetConfigWithMap?方法通過(guò)?Key-Value?鍵值對(duì)來(lái)設(shè)置/修改?Server?的特定配置,其余的配置使用默認(rèn)配置即可。其中?Key?的名稱(chēng)即是?ServerConfig?這個(gè)?struct?中的屬性名稱(chēng),并且不區(qū)分大小寫(xiě),單詞間也支持使用?-?/?_?/空格符號(hào)連接。
簡(jiǎn)單示例:
s := g.Server()
s.SetConfigWithMap(g.Map{
"Address": ":80",
"ServerRoot": "/var/www/MyServerRoot",
})
s.Run()其中?ServerRoot?的鍵名也可以使用?serverRoot?, ?server-root?, ?server_root?, ?server root?,其他配置屬性以此類(lèi)推。
一個(gè)比較完整的示例:
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?對(duì)象也支持通過(guò)配置文件進(jìn)行便捷的配置。支持的配置選項(xiàng)以及配置說(shuō)明請(qǐng)查看接口文檔說(shuō)明,文檔中有詳細(xì)說(shuō)明,以下章節(jié)不會(huì)對(duì)配置選項(xiàng)作介紹。
當(dāng)使用?g.Server?(單例名稱(chēng))獲取?Server?單例對(duì)象時(shí),將會(huì)自動(dòng)通過(guò)默認(rèn)的配置管理對(duì)象獲取對(duì)應(yīng)的?Server?配置。默認(rèn)情況下會(huì)讀取?server?.單例名稱(chēng)配置項(xiàng),當(dāng)該配置項(xiàng)不存在時(shí),將會(huì)讀取?server?配置項(xiàng)。
支持的配置文件配置項(xiàng)請(qǐng)參考?Server?配置管理對(duì)象屬性:https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp#ServerConfig
示例1,默認(rèn)配置項(xiàng)
[server]
address = ":80"
serverRoot = "/var/www/Server"隨后可以使用?g.Server()?獲取默認(rèn)的單例對(duì)象時(shí)自動(dòng)獲取并設(shè)置該配置。
示例2,多個(gè)配置項(xiàng)
多個(gè)?Server?的配置示例:
[server]
address = ":80"
serverRoot = "/var/www/Server"
[server.server1]
address = ":8080"
serverRoot = "/var/www/Server1"
[server.server2]
address = ":8088"
serverRoot = "/var/www/Server2"我們可以通過(guò)單例對(duì)象名稱(chēng)獲取對(duì)應(yīng)配置的?Server?單例對(duì)象:
// 對(duì)應(yīng) server.server1 配置項(xiàng)
s1 := g.Server("server1")
// 對(duì)應(yīng) server.server2 配置項(xiàng)
s2 := g.Server("server2")
// 對(duì)應(yīng)默認(rèn)配置項(xiàng) server
s3 := g.Server("none")
// 對(duì)應(yīng)默認(rèn)配置項(xiàng) server
s4 := g.Server()
示例3,較完整示例
比如上一個(gè)章節(jié)的示例,對(duì)應(yīng)的配置文件如下:
[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同理,配置屬性項(xiàng)的名稱(chēng)也不區(qū)分大小寫(xiě),單詞間也支持使用?-?/?_?符號(hào)連接。也就是說(shuō)以下配置文件效果和上面的配置文件一致:
[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我們推薦配置文件中的配置項(xiàng)名稱(chēng)統(tǒng)一使用小駝峰的格式。
上傳限制
?Server?對(duì)于客戶(hù)端提交的數(shù)據(jù)是由大小限制的,主要有兩個(gè)配置參數(shù)控制:
- ?
MaxHeaderBytes?:請(qǐng)求頭大小限制,請(qǐng)求頭包括客戶(hù)端提交的?Cookie?數(shù)據(jù),默認(rèn)設(shè)置為10KB。 - ?
ClientMaxBodySize?:客戶(hù)端提交的?Body?大小限制,同時(shí)也影響文件上傳大小,默認(rèn)設(shè)置為8MB。
由于安全性的考慮,默認(rèn)的上傳限制都不是很高,特別是?ClientMaxBodySize?的大小限制,在需要文件上傳的場(chǎng)景可適當(dāng)考慮調(diào)整,通過(guò)配置文件配置即可,例如:
[server]
maxHeaderBytes = "20KB"
clientMaxBodySize = "200MB"這樣便修改請(qǐng)求頭大小限制為?20KB?,文件上傳大小限制為?200MB?。如果不想做上傳大小做任何限制,那么將?clientMaxBodySize?設(shè)置為0即可。
日志配置
從v2版本開(kāi)始,?Server?增加了對(duì)配置文件中?Logger?的配置項(xiàng)支持,主要是為了統(tǒng)一日志組件配置、并解決日志滾動(dòng)切分的問(wèn)題。配置示例:
[server]
address = ":8080"
[server.logger]
path = "/var/log/server"
file = "{Y-m-d}.log"
stdoutPrint = false
rotateSize = "100M"
rotateBackupLimit = 10
rotateBackupExpire = "60d"
rotateBackupCompress = 9
rotateCheckInterval = "24h"
配置示例
所有的配置項(xiàng)請(qǐng)參考?ServerConfig?對(duì)象屬性: https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp#ServerConfig
以下為配置示例文件:
[server]
# 基本配置
address = ":80" # 本地監(jiān)聽(tīng)地址。默認(rèn)":80"
httpsAddr = ":443" # TLS/HTTPS配置,同時(shí)需要配置證書(shū)和密鑰。默認(rèn)關(guān)閉
httpsCertPath = "" # TLS/HTTPS證書(shū)文件本地路徑,建議使用絕對(duì)路徑。默認(rèn)關(guān)閉
httpsKeyPath = "" # TLS/HTTPS密鑰文件本地路徑,建議使用絕對(duì)路徑。默認(rèn)關(guān)閉
readTimeout = "60s" # 請(qǐng)求讀取超時(shí)時(shí)間,一般不需要配置。默認(rèn)為60秒
writeTimeout = "0" # 數(shù)據(jù)返回寫(xiě)入超時(shí)時(shí)間,一般不需要配置。默認(rèn)不超時(shí)(0)
idleTimeout = "60s" # 僅當(dāng)Keep-Alive開(kāi)啟時(shí)有效,請(qǐng)求閑置時(shí)間。默認(rèn)為60秒
maxHeaderBytes = "10240" # 請(qǐng)求Header大小限制(Byte)。默認(rèn)為10KB
keepAlive = true # 是否開(kāi)啟Keep-Alive功能。默認(rèn)true
serverAgent = "GoFrame HTTP Server" # 服務(wù)端Agent信息。默認(rèn)為"GoFrame HTTP Server"
# 靜態(tài)服務(wù)配置
indexFiles = ["index.html","index.htm"] # 自動(dòng)首頁(yè)靜態(tài)文件檢索。默認(rèn)為["index.html", "index.htm"]
indexFolder = false # 當(dāng)訪(fǎng)問(wèn)靜態(tài)文件目錄時(shí),是否展示目錄下的文件列表。默認(rèn)關(guān)閉,那么請(qǐng)求將返回403
serverRoot = "/var/www" # 靜態(tài)文件服務(wù)的目錄根路徑,配置時(shí)自動(dòng)開(kāi)啟靜態(tài)文件服務(wù)。默認(rèn)關(guān)閉
searchPaths = ["/home/www","/var/lib/www"] # 提供靜態(tài)文件服務(wù)時(shí)額外的文件搜索路徑,當(dāng)根路徑找不到時(shí)則按照順序在搜索目錄查找。默認(rèn)關(guān)閉
fileServerEnabled = false # 靜態(tài)文件服務(wù)總開(kāi)關(guān)。默認(rèn)false
# Cookie配置
cookieMaxAge = "365d" # Cookie有效期。默認(rèn)為365天
cookiePath = "/" # Cookie有效路徑。默認(rèn)為"/"表示全站所有路徑下有效
cookieDomain = "" # Cookie有效域名。默認(rèn)為當(dāng)前配置Cookie時(shí)的域名
# Sessions配置
sessionMaxAge = "24h" # Session有效期。默認(rèn)為24小時(shí)
sessionIdName = "gfsessionid" # SessionId的鍵名名稱(chēng)。默認(rèn)為gfsessionid
sessionCookieOutput = true # Session特性開(kāi)啟時(shí),是否將SessionId返回到Cookie中。默認(rèn)true
sessionPath = "/tmp/gsessions" # Session存儲(chǔ)的文件目錄路徑。默認(rèn)為當(dāng)前系統(tǒng)臨時(shí)目錄下的gsessions目錄
# Logging配置
logPath = "" # 日志文件存儲(chǔ)目錄路徑,建議使用絕對(duì)路徑。默認(rèn)為空,表示關(guān)閉
logStdout = true # 日志是否輸出到終端。默認(rèn)為true
errorStack = true # 當(dāng)Server捕獲到異常時(shí)是否記錄堆棧信息到日志中。默認(rèn)為true
errorLogEnabled = true # 是否記錄異常日志信息到日志中。默認(rèn)為true
errorLogPattern = "error-{Ymd}.log" # 異常錯(cuò)誤日志文件格式。默認(rèn)為"error-{Ymd}.log"
accessLogEnabled = false # 是否記錄訪(fǎng)問(wèn)日志。默認(rèn)為false
accessLogPattern = "access-{Ymd}.log" # 訪(fǎng)問(wèn)日志文件格式。默認(rèn)為"access-{Ymd}.log"
# PProf配置
pprofEnabled = false # 是否開(kāi)啟PProf性能調(diào)試特性。默認(rèn)為false
pprofPattern = "" # 開(kāi)啟PProf時(shí)有效,表示PProf特性的頁(yè)面訪(fǎng)問(wèn)路徑,對(duì)當(dāng)前Server綁定的所有域名有效。
# 其他配置
clientMaxBodySize = 810241024 # 客戶(hù)端最大Body上傳限制大小,影響文件上傳大小(Byte)。默認(rèn)為8*1024*1024=8MB
formParsingMemory = 1048576 # 解析表單時(shí)的緩沖區(qū)大小(Byte),一般不需要配置。默認(rèn)為1024*1024=1MB
nameToUriType = 0 # 路由注冊(cè)中使用對(duì)象注冊(cè)時(shí)的路由生成規(guī)則。默認(rèn)為0
routeOverWrite = false # 當(dāng)遇到重復(fù)路由注冊(cè)時(shí)是否強(qiáng)制覆蓋。默認(rèn)為false,重復(fù)路由存在時(shí)將會(huì)在啟動(dòng)時(shí)報(bào)錯(cuò)退出
dumpRouterMap = true # 是否在Server啟動(dòng)時(shí)打印所有的路由列表。默認(rèn)為true
graceful = false # 是否開(kāi)啟平滑重啟特性,開(kāi)啟時(shí)將會(huì)在本地增加10000的本地TCP端口用于進(jìn)程間通信。默認(rèn)false
gracefulTimeout = 2 # 父進(jìn)程在平滑重啟后多少秒退出,默認(rèn)2秒。若請(qǐng)求耗時(shí)大于該值,可能會(huì)導(dǎo)致請(qǐng)求中斷
網(wǎng)頁(yè)標(biāo)題:創(chuàng)新互聯(lián)GoFrame教程:GoFrameWEB服務(wù)開(kāi)發(fā)-服務(wù)配置
文章起源:http://www.5511xx.com/article/ccccjce.html


咨詢(xún)
建站咨詢(xún)
