Go底層之http標準庫服務端實現(xiàn)原理分析
背景
http協(xié)議的交互框架是C-S架構(gòu),C對應客戶端模塊,S對應服務端模塊,接下來我們就基于Go1.23源碼來熟悉http標準庫中服務端的實現(xiàn)。
核心數(shù)據(jù)結(jié)構(gòu)
【1】Server對象
位于net/http/server.go文件,其源碼如下:
type Server struct {
Addr string //服務器監(jiān)聽規(guī)定TCP地址
Handler Handler //處理http請求的處理器。若為nil,使用http.DefaultServeMux
DisableGeneralOptionsHandler bool //若為true,將OPTIONS*請求交給Handler處理,否在自動響應200 OK
TLSConfig *tls.Config //TLS配置
ReadTimeout time.Duration //讀取整個請求(含請求體)的最大超時時間。若小于等于0,表示無超時
ReadHeaderTimeout time.Duration //單獨讀取請求頭的超時時間。若小于等于0,繼承ReadTimeout的值
WriteTimeout time.Duration //寫入響應的最大超時時間。若小于等于0,表示無超時
IdleTimeout time.Duration //保持連接空閑的最大時間(用于keep-Alice)若小于等于0,繼承ReadTimeout的值
MaxHeaderBytes int //請求頭的最大字節(jié)數(shù)。若為0,使用DefaultMaxHeaderBytes
TLSNextProto map[string]func(*Server, *tls.Conn, Handler) //用于處理ALPN協(xié)議升級
ConnState func(net.Conn, ConnState) //客戶端連接狀態(tài)變更時的回調(diào)函數(shù)(如新建、活躍、空閑、關閉)
ErrorLog *log.Logger //自定義錯誤日志記錄器。若為nil,則使用標準庫的log包
BaseContext func(net.Listener) context.Context //為每個請求生成基礎上下文
ConnContext func(ctx context.Context, c net.Conn) context.Context //修改新連接的上下文
inShutdown atomic.Bool //標記服務器是否正在關閉
disableKeepAlives atomic.Bool //控制是否禁用Keep-Alive
nextProtoOnce sync.Once //確保HTTP/2配置只初始化一次
nextProtoErr error //存儲HTTP/2配置的錯誤結(jié)果
mu sync.Mutex //保護listeners和activceConn
listeners map[*net.Listener]struct{} //當前活躍的監(jiān)聽器集合
activeConn map[*conn]struct{} //當前活躍的連接集合
onShutdown []func() //服務器關閉時執(zhí)行的鉤子函數(shù)
listenerGroup sync.WaitGroup //用于等待所有監(jiān)聽器關閉的同步組
}
【2】Handler對象
位于net/http/server.go文件,其源碼如下:
/*
Handler接口定義了HTTP請求處理器的標準行為,任何實現(xiàn)ServerHTTP方法的類型都可以處理HTTP請求。
Request:包含HTTP請求的所有信息。
ResponseWriter:用于構(gòu)造HTTP響應。
*/
type Handler interface {
ServeHTTP(ResponseWriter, *Request)
}
【3】ServeMux對象
位于net/http/server.go文件,其源碼如下:
/*
ServeMux是HTTP請求路由器的核心實現(xiàn),復雜將不同URL路徑的請求分發(fā)給對應的處理函數(shù)。
其核心作用是通過內(nèi)部的路由樹(tree)和索引(index)高效匹配請求路徑,同時通過互斥
鎖(mu)保證并發(fā)安全,并兼容舊版本路由邏輯(mux121)。
*/
type ServeMux struct {
mu sync.RWMutex //保護路由表的并發(fā)安全(注冊路由時寫鎖,匹配路由時讀鎖)
tree routingNode //路由前綴樹,存儲URL路徑與處理函數(shù)的映射關系,支持高效路徑匹配
index routingIndex //路由加速索引,優(yōu)化特定場景的查找性能
patterns []*pattern //兼容舊版本的路由模式列表
mux121 serveMux121 //Go1.21及之前舊版本路由實現(xiàn)
}
服務端代碼示例
使用http標準庫實現(xiàn)的一個簡單http服務示例如下:
func main() {
//路由注冊
http.HandleFunc("POST /xxx", func(writer http.ResponseWriter, request *http.Request) {
writer.Write([]byte("AAA"))
})
//服務啟用、路由匹配
http.ListenAndServe(":8000", nil)
}
可以看到一個http服務端由兩個部分組成:路由注冊和服務啟用,其中服務啟用內(nèi)部實現(xiàn)了路由匹配邏輯,接下來再深究內(nèi)部。
路由注冊
路由注冊的入口為http.HandleFunc函數(shù),其源碼如下:
func HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {
if use121 {
//Go1.21及以前版本路由注冊實現(xiàn)
DefaultServeMux.mux121.handleFunc(pattern, handler)
} else {
//新版本路由注冊實現(xiàn)
DefaultServeMux.register(pattern, HandlerFunc(handler))
}
}
舊版本路由注冊實現(xiàn)源碼如下:
func (mux *serveMux121) handleFunc(pattern string, handler func(ResponseWriter, *Request)) {
...
//將路徑和對應的回調(diào)函數(shù)關聯(lián)起來,具體關聯(lián)方法不深究
mux.handle(pattern, HandlerFunc(handler))
}
新版本路由注冊實現(xiàn)源碼如下:
func (mux *ServeMux) registerErr(patstr string, handler Handler) error {
...
pat, err := parsePattern(patstr)
if err != nil {
return fmt.Errorf("parsing %q: %w", patstr, err)
}
...
//關聯(lián)路徑和對應的回調(diào)函數(shù)
mux.tree.addPattern(pat, handler)
mux.index.addPattern(pat)
mux.patterns = append(mux.patterns, pat)
return nil
}
舊版本和新版本都會將對應的回調(diào)函數(shù)轉(zhuǎn)換為http.HandlerFunc類型,這是因為http.HandlerFunc類型實現(xiàn)了http.Handler接口:
//實現(xiàn)了Handler接口
type HandlerFunc func(ResponseWriter, *Request)
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
f(w, r)
}
路由匹配
路由匹配的邏輯在服務啟動http.ListenAndServe里,其源碼調(diào)用邏輯鏈路為:
func ListenAndServe(addr string, handler Handler) error {
server := &Server{Addr: addr, Handler: handler}
return server.ListenAndServe()
}
func (srv *Server) ListenAndServe() error {
...
ln, err := net.Listen("tcp", addr)
if err != nil {
return err
}
return srv.Serve(ln)
}
func (srv *Server) Serve(l net.Listener) error {
...
for {
rw, err := l.Accept() //阻塞等待客戶端連接
...
c := srv.newConn(rw)
c.setState(c.rwc, StateNew, runHooks) // before Serve can return
go c.serve(connCtx) //協(xié)程去響應客戶端連接
}
}
func (c *conn) serve(ctx context.Context) {
...
for {
//讀取客戶端請求并構(gòu)造響應結(jié)構(gòu)體w
w, err := c.readRequest(ctx)
...
//處理并響應請求
serverHandler{c.server}.ServeHTTP(w, w.req)
...
}
}
func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request) {
handler := sh.srv.Handler
if handler == nil { //未定義handler就使用默認的http處理器
handler = DefaultServeMux
}
...
//處理客戶端請求并響應
handler.ServeHTTP(rw, req)
}
//默認http處理器實現(xiàn)的處理客戶端請求并響應的方法
func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request) {
...
var h Handler
if use121 { //舊版本根據(jù)請求進行路由匹配
h, _ = mux.mux121.findHandler(r)
} else { //新版本根據(jù)請求進行路由匹配
h, r.Pattern, r.pat, r.matches = mux.findHandler(r)
}
/*
這里執(zhí)行的是HandlerFunc類型的ServeHTTP方法,因為在注冊路由時都將回調(diào)函數(shù)轉(zhuǎn)換為了HandlerFunc類型。
type HandlerFunc func(ResponseWriter, *Request)
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
f(w, r)
}
*/
h.ServeHTTP(w, r)
}
總結(jié)
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
使用自定義錯誤碼攔截grpc內(nèi)部狀態(tài)碼問題
這篇文章主要介紹了使用自定義錯誤碼攔截grpc內(nèi)部狀態(tài)碼問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-09-09

