HTTP服務(wù)器:從TCP到RESTful API實(shí)戰(zhàn))
1. 為什么我要用QT C手搓一個(gè)HTTP服務(wù)器先說結(jié)論這個(gè)項(xiàng)目適合那些已經(jīng)寫過一點(diǎn)C、用過QT做界面但一直沒搞明白“網(wǎng)絡(luò)請(qǐng)求到底怎么從瀏覽器跑到程序里”的人。我當(dāng)初動(dòng)手做這件事起因特別簡單——公司內(nèi)網(wǎng)有個(gè)小工具需要暴露一個(gè)接口給其他系統(tǒng)調(diào)用裝Nginx太重寫Python又不想額外維護(hù)運(yùn)行環(huán)境手頭正好有個(gè)QT項(xiàng)目就想著干脆用QT自帶的網(wǎng)絡(luò)模塊擼一個(gè)輕量級(jí)HTTP服務(wù)器出來。你可能會(huì)有疑問QT不是做桌面界面的嗎怎么還能干服務(wù)器的活實(shí)際上QT的網(wǎng)絡(luò)模塊QtNetwork封裝得相當(dāng)完整QTcpServer和QTcpSocket這兩個(gè)類把TCP層面的連接管理、數(shù)據(jù)收發(fā)都處理好了我們只需要在TCP之上按照HTTP協(xié)議的格式解析請(qǐng)求、組裝響應(yīng)就行。整個(gè)過程不需要引入任何第三方庫編譯出來的可執(zhí)行文件也就幾MB扔到哪臺(tái)機(jī)器上都能跑。這個(gè)實(shí)踐指南要解決的問題很明確從TCP連接建立開始一步步實(shí)現(xiàn)一個(gè)能處理GET/POST請(qǐng)求、能返回JSON數(shù)據(jù)、支持簡單路由的RESTful API服務(wù)器。我會(huì)把我在這個(gè)過程中踩過的坑、調(diào)過的參數(shù)、想明白的原理都攤開來講。不管你是剛學(xué)完C基礎(chǔ)想找個(gè)項(xiàng)目練手還是已經(jīng)工作但沒接觸過網(wǎng)絡(luò)編程跟著走一遍都能跑通。核心關(guān)鍵詞我先擺出來QT、C、HTTP服務(wù)器、TCP、RESTful API。這五個(gè)詞貫穿全文后面每個(gè)章節(jié)都會(huì)圍繞它們展開。我用的環(huán)境是QT 5.15.2 MinGW編譯器Windows和gLinux代碼在兩個(gè)平臺(tái)上都驗(yàn)證過。QT 6的API有少量變化我會(huì)在涉及的地方標(biāo)注出來。2. 整體設(shè)計(jì)思路與方案選型2.1 為什么選QT而不是裸寫Socket裸寫Socket當(dāng)然可以C標(biāo)準(zhǔn)庫加上系統(tǒng)調(diào)用socket()、bind()、listen()、accept()一路寫下來能跑。但問題在于跨平臺(tái)。Windows下你要用WSAStartup初始化Linux下不用Windows的closesocket和Linux的close不一樣更別說IO多路復(fù)用Windows是select和IOCPLinux是epoll。這些差異處理起來非常瑣碎。QT的QTcpServer把這些平臺(tái)差異全部封裝掉了。你調(diào)用listen(QHostAddress::Any, port)它在Windows下走Winsock在Linux下走BSD Socket對(duì)你來說接口完全一致。而且QT的信號(hào)槽機(jī)制天然適合事件驅(qū)動(dòng)的服務(wù)器模型——新連接來了觸發(fā)newConnection信號(hào)數(shù)據(jù)到了觸發(fā)readyRead信號(hào)你只需要在槽函數(shù)里處理就行不需要自己寫事件循環(huán)。另一個(gè)考慮是部署便利性。QT編譯出來的程序在Windows上可以用windeployqt打包依賴在Linux上鏈接動(dòng)態(tài)庫或者靜態(tài)編譯都行。相比之下如果你用Boost.Asio寫還得額外處理Boost的依賴用Python寫目標(biāo)機(jī)器上得有Python環(huán)境。QT C的方案在這方面的優(yōu)勢(shì)很明顯。2.2 HTTP協(xié)議解析自己寫還是用現(xiàn)成庫QT本身沒有提供HTTP服務(wù)器端的解析器。QHttpServer是QT 6.4之后才引入的模塊QT 5.15沒有。所以對(duì)于QT 5.15的用戶來說HTTP報(bào)文的解析必須自己動(dòng)手。自己寫解析器聽起來嚇人但HTTP/1.1的請(qǐng)求格式其實(shí)很規(guī)整。一個(gè)典型的GET請(qǐng)求長這樣GET /api/users?id1 HTTP/1.1\r\n Host: 127.0.0.1:8080\r\n User-Agent: curl/7.68.0\r\n Accept: */*\r\n \r\n請(qǐng)求行 請(qǐng)求頭 空行 請(qǐng)求體GET通常沒有體。解析的核心就是按\r\n切分第一行提取方法、路徑、版本后續(xù)行提取頭部字段遇到空行說明頭部結(jié)束后面是body。POST請(qǐng)求的body長度由Content-Length頭決定。我選擇自己寫解析器的原因有兩個(gè)一是可控性強(qiáng)出問題能直接定位到哪一行代碼二是學(xué)習(xí)價(jià)值高寫完這一遍你對(duì)HTTP協(xié)議的理解會(huì)比看十篇文章都深。當(dāng)然如果你的項(xiàng)目對(duì)安全性要求極高建議還是用成熟的庫因?yàn)樽约簩懙慕馕銎髟谔幚砘螆?bào)文時(shí)容易出漏洞。2.3 路由設(shè)計(jì)從if-else到RESTful最簡單的路由就是一堆if-elseif (path /api/users method GET) { // 返回用戶列表 } else if (path /api/users method POST) { // 創(chuàng)建用戶 }這種寫法在接口少的時(shí)候沒問題但接口一多就亂套了。我采用的是注冊(cè)式路由用一個(gè)QHashQString, Handler存儲(chǔ)路徑到處理函數(shù)的映射key是“方法路徑”value是std::function。注冊(cè)的時(shí)候router.addRoute(GET, /api/users, handleGetUsers); router.addRoute(POST, /api/users, handleCreateUser); router.addRoute(GET, /api/users/:id, handleGetUserById);對(duì)于帶參數(shù)的路徑比如/api/users/123我在匹配時(shí)做一次模式解析把:id提取出來作為路徑參數(shù)傳給處理函數(shù)。這樣設(shè)計(jì)的好處是新增接口只需要注冊(cè)一行不用改核心邏輯符合RESTful API的規(guī)范——用HTTP方法表示操作類型用路徑表示資源。2.4 并發(fā)模型單線程還是多線程QTcpServer默認(rèn)是單線程的所有連接的處理都在主線程的事件循環(huán)里。對(duì)于輕量級(jí)場景幾十個(gè)并發(fā)連接、請(qǐng)求處理邏輯簡單單線程完全夠用而且避免了線程安全問題。但如果某個(gè)請(qǐng)求的處理邏輯很耗時(shí)比如查數(shù)據(jù)庫、讀大文件單線程就會(huì)阻塞其他請(qǐng)求。我的做法是核心網(wǎng)絡(luò)IO保持單線程耗時(shí)操作丟到線程池。QT提供了QThreadPool和QtConcurrent用起來很方便。具體來說當(dāng)解析完請(qǐng)求后如果處理函數(shù)標(biāo)記為“異步”就把它提交到線程池處理完再通過信號(hào)槽回到主線程發(fā)送響應(yīng)。這種混合模型兼顧了簡單性和性能。對(duì)于大多數(shù)內(nèi)部工具級(jí)別的HTTP服務(wù)器這個(gè)方案足夠用了。3. 核心細(xì)節(jié)解析與實(shí)操要點(diǎn)3.1 TCP連接的建立與管理QTcpServer的使用非常直接QTcpServer *server new QTcpServer(this); connect(server, QTcpServer::newConnection, this, HttpServer::onNewConnection); if (!server-listen(QHostAddress::Any, 8080)) { qDebug() Listen failed: server-errorString(); }listen的第二個(gè)參數(shù)是端口號(hào)。這里有個(gè)坑端口被占用時(shí)listen會(huì)返回false但錯(cuò)誤信息可能不夠明確。我在實(shí)際調(diào)試中遇到過“error: listen tcp 127.0.0.1:11434: bind: only one usage of each socket address”這類報(bào)錯(cuò)本質(zhì)就是端口沖突。解決辦法是換端口或者用SO_REUSEADDR選項(xiàng)。QTcpServer默認(rèn)會(huì)設(shè)置SO_REUSEADDR但在某些系統(tǒng)上仍然可能沖突這時(shí)候可以先用netstat -ano | findstr 8080Windows或lsof -i:8080Linux查一下誰占用了。新連接到來時(shí)nextPendingConnection()返回一個(gè)QTcpSocket*。這個(gè)socket的生命周期需要管理好——我把它存到一個(gè)QSetQTcpSocket*里在disconnected信號(hào)觸發(fā)時(shí)從集合中移除并調(diào)用deleteLater()。如果不管理連接多了之后內(nèi)存會(huì)持續(xù)增長。void HttpServer::onNewConnection() { QTcpSocket *socket server-nextPendingConnection(); clients.insert(socket); connect(socket, QTcpSocket::readyRead, this, HttpServer::onReadyRead); connect(socket, QTcpSocket::disconnected, this, HttpServer::onDisconnected); }3.2 HTTP請(qǐng)求報(bào)文的完整解析readyRead信號(hào)觸發(fā)時(shí)數(shù)據(jù)可能不是一次性到齊的。TCP是流式協(xié)議一個(gè)HTTP請(qǐng)求可能分多次到達(dá)。所以不能假設(shè)一次readAll()就能拿到完整報(bào)文。我的處理策略是每個(gè)socket關(guān)聯(lián)一個(gè)緩沖區(qū)每次readyRead把數(shù)據(jù)追加到緩沖區(qū)然后嘗試解析。解析分兩步先找\r\n\r\n如果找到了說明頭部完整再根據(jù)Content-Length判斷body是否完整。如果都完整就處理請(qǐng)求并從緩沖區(qū)中移除已消費(fèi)的數(shù)據(jù)否則等待下次readyRead。void HttpServer::onReadyRead() { QTcpSocket *socket qobject_castQTcpSocket*(sender()); QByteArray buffer buffers[socket]; buffer.append(socket-readAll()); int headerEnd buffer.indexOf(\r\n\r\n); if (headerEnd -1) return; // 頭部不完整 QByteArray header buffer.left(headerEnd); HttpRequest req parseHeader(header); int contentLength req.header(Content-Length).toInt(); int totalLength headerEnd 4 contentLength; if (buffer.size() totalLength) return; // body不完整 req.body buffer.mid(headerEnd 4, contentLength); buffer.remove(0, totalLength); handleRequest(socket, req); }解析請(qǐng)求行時(shí)要注意方法可能是GET、POST、PUT、DELETE、OPTIONS等路徑可能帶查詢字符串?keyvalueHTTP版本通常是HTTP/1.1。我用QString::split按空格切分然后對(duì)路徑部分再按?切分分別得到純路徑和查詢參數(shù)。查詢參數(shù)的解析我用QUrlQueryQUrl url(req.path); QUrlQuery query(url.query()); QString id query.queryItemValue(id);頭部字段的解析就是按行切分每行按第一個(gè):切分key做trimvalue做trim。注意頭部字段名是大小寫不敏感的我統(tǒng)一轉(zhuǎn)成小寫存儲(chǔ)。3.3 響應(yīng)報(bào)文的組裝與發(fā)送HTTP響應(yīng)的格式HTTP/1.1 200 OK\r\n Content-Type: application/json\r\n Content-Length: 27\r\n Connection: close\r\n \r\n {message:hello world}狀態(tài)碼和狀態(tài)描述要對(duì)應(yīng)常見的200 OK、201 Created、400 Bad Request、404 Not Found、405 Method Not Allowed、500 Internal Server Error。Content-Length必須是body的字節(jié)數(shù)不是字符數(shù)。如果返回中文一個(gè)漢字在UTF-8下占3個(gè)字節(jié)用QString::toUtf8().size()來算。Connection頭我通常設(shè)為close因?yàn)閷?shí)現(xiàn)keep-alive需要處理更多邊界情況比如超時(shí)、管道化請(qǐng)求。對(duì)于輕量級(jí)服務(wù)器每次請(qǐng)求后關(guān)閉連接是最簡單的做法。如果性能要求高可以改成keep-alive但要在socket上設(shè)置超時(shí)定時(shí)器。發(fā)送響應(yīng)時(shí)用socket-write()然后socket-flush()確保數(shù)據(jù)發(fā)出。最后調(diào)用socket-disconnectFromHost()等disconnected信號(hào)觸發(fā)后清理資源。void HttpServer::sendResponse(QTcpSocket *socket, const HttpResponse resp) { QByteArray data; data.append(HTTP/1.1 resp.statusCode resp.statusText \r\n); for (auto it resp.headers.begin(); it ! resp.headers.end(); it) { data.append(it.key() : it.value() \r\n); } data.append(\r\n); data.append(resp.body); socket-write(data); socket-flush(); socket-disconnectFromHost(); }3.4 RESTful路由的注冊(cè)與匹配路由注冊(cè)我用一個(gè)結(jié)構(gòu)體存儲(chǔ)struct Route { QString method; QString pattern; Handler handler; }; QListRoute routes;匹配時(shí)遍歷routes先比較method再比較路徑。對(duì)于帶參數(shù)的路徑我把pattern按/切分把請(qǐng)求路徑也按/切分逐段比較。如果pattern段以:開頭就是參數(shù)段提取出來存入pathParams。bool matchRoute(const QString pattern, const QString path, QHashQString,QString params) { QStringList patternParts pattern.split(/, Qt::SkipEmptyParts); QStringList pathParts path.split(/, Qt::SkipEmptyParts); if (patternParts.size() ! pathParts.size()) return false; for (int i 0; i patternParts.size(); i) { if (patternParts[i].startsWith(:)) { params[patternParts[i].mid(1)] pathParts[i]; } else if (patternParts[i] ! pathParts[i]) { return false; } } return true; }處理函數(shù)簽名統(tǒng)一為std::functionvoid(const HttpRequest, HttpResponse)這樣每個(gè)handler只需要關(guān)注業(yè)務(wù)邏輯不用管socket的讀寫。3.5 JSON的序列化與反序列化QT 5.15內(nèi)置了QJsonDocument、QJsonObject、QJsonArray處理JSON非常方便。返回JSON時(shí)QJsonObject obj; obj[code] 0; obj[message] success; QJsonDocument doc(obj); resp.body doc.toJson(QJsonDocument::Compact); resp.headers[Content-Type] application/json; charsetutf-8;解析請(qǐng)求body中的JSONQJsonParseError err; QJsonDocument doc QJsonDocument::fromJson(req.body, err); if (err.error ! QJsonParseError::NoError) { // 返回400 } QJsonObject obj doc.object();注意QJsonDocument::fromJson接受的是QByteArray如果body是UTF-8編碼的中文直接傳沒問題。但如果客戶端發(fā)來的編碼不是UTF-8需要先轉(zhuǎn)換。4. 完整實(shí)操過程與核心環(huán)節(jié)實(shí)現(xiàn)4.1 項(xiàng)目結(jié)構(gòu)搭建我用的是qmake構(gòu)建系統(tǒng)QT 5.15的默認(rèn)選擇項(xiàng)目文件httpserver.proQT core network QT - gui CONFIG c11 console CONFIG - app_bundle TARGET httpserver TEMPLATE app SOURCES main.cpp \ httpserver.cpp \ httprequest.cpp \ httpresponse.cpp \ router.cpp HEADERS httpserver.h \ httprequest.h \ httpresponse.h \ router.h如果你用CMake對(duì)應(yīng)的CMakeLists.txtcmake_minimum_required(VERSION 3.5) project(httpserver LANGUAGES CXX) set(CMAKE_CXX_STANDARD 11) set(CMAKE_AUTOMOC ON) find_package(Qt5 COMPONENTS Core Network REQUIRED) add_executable(httpserver main.cpp httpserver.cpp httprequest.cpp httpresponse.cpp router.cpp ) target_link_libraries(httpserver Qt5::Core Qt5::Network)這里有個(gè)細(xì)節(jié)QT - gui表示這是一個(gè)控制臺(tái)程序不需要GUI模塊。如果你在Windows下用MinGW編譯不加這一行會(huì)鏈接GUI庫程序啟動(dòng)時(shí)會(huì)彈出一個(gè)空窗口。另外CONFIG console確保有控制臺(tái)輸出方便調(diào)試。4.2 核心類設(shè)計(jì)我設(shè)計(jì)了四個(gè)核心類HttpServer繼承QObject管理QTcpServer和所有客戶端連接負(fù)責(zé)接收連接、讀取數(shù)據(jù)、分發(fā)請(qǐng)求。HttpRequest純數(shù)據(jù)類存儲(chǔ)方法、路徑、查詢參數(shù)、頭部、body。HttpResponse純數(shù)據(jù)類存儲(chǔ)狀態(tài)碼、頭部、body。Router管理路由注冊(cè)和匹配。HttpServer的頭文件class HttpServer : public QObject { Q_OBJECT public: explicit HttpServer(QObject *parent nullptr); bool start(quint16 port); Router router() { return m_router; } private slots: void onNewConnection(); void onReadyRead(); void onDisconnected(); private: void handleRequest(QTcpSocket *socket, const HttpRequest req); void sendResponse(QTcpSocket *socket, const HttpResponse resp); QTcpServer *m_server; Router m_router; QHashQTcpSocket*, QByteArray m_buffers; QSetQTcpSocket* m_clients; };4.3 請(qǐng)求解析的完整實(shí)現(xiàn)HttpRequest的解析函數(shù)bool HttpRequest::parse(const QByteArray rawData) { int headerEnd rawData.indexOf(\r\n\r\n); if (headerEnd -1) return false; QByteArray headerPart rawData.left(headerEnd); QListQByteArray lines headerPart.split(\n); if (lines.isEmpty()) return false; // 解析請(qǐng)求行 QByteArray requestLine lines[0].trimmed(); QListQByteArray parts requestLine.split( ); if (parts.size() ! 3) return false; method QString::fromUtf8(parts[0]); QString fullPath QString::fromUtf8(parts[1]); version QString::fromUtf8(parts[2]); // 分離路徑和查詢字符串 int qPos fullPath.indexOf(?); if (qPos ! -1) { path fullPath.left(qPos); queryString fullPath.mid(qPos 1); } else { path fullPath; } // 解析頭部 for (int i 1; i lines.size(); i) { QByteArray line lines[i].trimmed(); if (line.isEmpty()) continue; int colonPos line.indexOf(:); if (colonPos -1) continue; QString key QString::fromUtf8(line.left(colonPos)).trimmed().toLower(); QString value QString::fromUtf8(line.mid(colonPos 1)).trimmed(); headers[key] value; } // 解析body int contentLength headers.value(content-length, 0).toInt(); if (contentLength 0) { body rawData.mid(headerEnd 4, contentLength); } return true; }這里有幾個(gè)容易出錯(cuò)的地方。第一split(\n)之后每行末尾可能還有\(zhòng)r所以要用trimmed()去掉。第二頭部key要轉(zhuǎn)小寫因?yàn)镠TTP規(guī)范規(guī)定頭部字段名大小寫不敏感。第三Content-Length可能不存在GET請(qǐng)求通常沒有默認(rèn)值設(shè)為0。4.4 路由注冊(cè)與請(qǐng)求分發(fā)Router類的實(shí)現(xiàn)class Router { public: using Handler std::functionvoid(const HttpRequest, HttpResponse); void addRoute(const QString method, const QString pattern, Handler handler) { m_routes.append({method.toUpper(), pattern, handler}); } bool dispatch(const HttpRequest req, HttpResponse resp) { QHashQString, QString params; for (const auto route : m_routes) { if (route.method ! req.method) continue; if (matchRoute(route.pattern, req.path, params)) { req.pathParams params; route.handler(req, resp); return true; } } return false; } private: struct Route { QString method; QString pattern; Handler handler; }; QListRoute m_routes; };在main.cpp中注冊(cè)路由int main(int argc, char *argv[]) { QCoreApplication app(argc, argv); HttpServer server; server.router().addRoute(GET, /api/health, [](const HttpRequest req, HttpResponse resp) { resp.statusCode 200; resp.headers[Content-Type] application/json; QJsonObject obj; obj[status] ok; obj[timestamp] QDateTime::currentDateTime().toString(Qt::ISODate); resp.body QJsonDocument(obj).toJson(QJsonDocument::Compact); }); server.router().addRoute(GET, /api/users, [](const HttpRequest req, HttpResponse resp) { QJsonArray users; QJsonObject u1; u1[id] 1; u1[name] Alice; QJsonObject u2; u2[id] 2; u2[name] Bob; users.append(u1); users.append(u2); resp.statusCode 200; resp.headers[Content-Type] application/json; resp.body QJsonDocument(users).toJson(QJsonDocument::Compact); }); server.router().addRoute(GET, /api/users/:id, [](const HttpRequest req, HttpResponse resp) { QString id req.pathParams[id]; QJsonObject obj; obj[id] id; obj[name] User id; resp.statusCode 200; resp.headers[Content-Type] application/json; resp.body QJsonDocument(obj).toJson(QJsonDocument::Compact); }); server.router().addRoute(POST, /api/users, [](const HttpRequest req, HttpResponse resp) { QJsonParseError err; QJsonDocument doc QJsonDocument::fromJson(req.body, err); if (err.error ! QJsonParseError::NoError) { resp.statusCode 400; resp.headers[Content-Type] application/json; QJsonObject obj; obj[error] Invalid JSON; resp.body QJsonDocument(obj).toJson(QJsonDocument::Compact); return; } QJsonObject input doc.object(); QJsonObject output; output[id] 100; output[name] input[name]; resp.statusCode 201; resp.headers[Content-Type] application/json; resp.body QJsonDocument(output).toJson(QJsonDocument::Compact); }); if (!server.start(8080)) { qDebug() Server start failed; return 1; } qDebug() Server listening on port 8080; return app.exec(); }4.5 編譯與運(yùn)行驗(yàn)證在Linux下qmake httpserver.pro make -j4 ./httpserver在Windows下用MinGWqmake httpserver.pro mingw32-make -j4 httpserver.exe啟動(dòng)后用curl測(cè)試curl http://127.0.0.1:8080/api/health # {status:ok,timestamp:2024-01-15T10:30:00} curl http://127.0.0.1:8080/api/users # [{id:1,name:Alice},{id:2,name:Bob}] curl http://127.0.0.1:8080/api/users/42 # {id:42,name:User42} curl -X POST http://127.0.0.1:8080/api/users -H Content-Type: application/json -d {name:Charlie} # {id:100,name:Charlie}如果curl返回curl: (35) tcp connection reset by peer說明服務(wù)器端在發(fā)送響應(yīng)前就關(guān)閉了連接。檢查socket-disconnectFromHost()是否在write之前調(diào)用了。正確的順序是write→flush→disconnectFromHost。4.6 性能壓測(cè)與參數(shù)調(diào)優(yōu)我用abApache Bench做了簡單壓測(cè)ab -n 1000 -c 10 http://127.0.0.1:8080/api/health單線程模式下QPS大約在2000-3000左右取決于機(jī)器性能。這個(gè)數(shù)字對(duì)于內(nèi)部工具完全夠用。如果要做優(yōu)化有幾個(gè)方向啟用keep-alive減少TCP握手開銷QPS能提升30%左右。多線程處理把請(qǐng)求處理丟到QThreadPool但要注意線程安全。減少內(nèi)存拷貝QByteArray的mid和left會(huì)拷貝數(shù)據(jù)可以用QByteArrayViewQT 6或直接操作指針。我實(shí)測(cè)下來對(duì)于并發(fā)不超過50的場景單線程keep-alive是最佳平衡點(diǎn)。再往上就需要考慮用QThread做多線程accept或者換用更底層的網(wǎng)絡(luò)庫。5. 常見問題與排查技巧實(shí)錄5.1 端口被占用導(dǎo)致啟動(dòng)失敗這是最常見的問題。報(bào)錯(cuò)信息通常是error: listen tcp 127.0.0.1:11434: bind: only one usage of each socket address。排查步驟Windows下netstat -ano | findstr 8080找到PID后在任務(wù)管理器里結(jié)束進(jìn)程。Linux下lsof -i:8080或ss -tlnp | grep 8080。如果找不到占用進(jìn)程可能是之前的程序沒有正常退出socket處于TIME_WAIT狀態(tài)。等30秒或設(shè)置SO_REUSEADDR。QTcpServer默認(rèn)會(huì)設(shè)置SO_REUSEADDR但在Windows上這個(gè)選項(xiàng)的行為和Linux不同。如果確實(shí)需要立即重用端口可以在listen之前手動(dòng)設(shè)置server-setSocketOption(QAbstractSocket::ReuseAddressHint, 1);5.2 請(qǐng)求體讀取不完整前面提到過TCP是流式協(xié)議一個(gè)請(qǐng)求可能分多次到達(dá)。我遇到過一個(gè)典型場景客戶端發(fā)送一個(gè)較大的JSON body比如100KB服務(wù)器只收到了前幾KB就觸發(fā)了readyRead解析時(shí)發(fā)現(xiàn)body不完整直接返回了400。解決辦法就是前面說的緩沖區(qū)機(jī)制。關(guān)鍵點(diǎn)是不要假設(shè)一次readyRead就是一個(gè)完整請(qǐng)求。每次收到數(shù)據(jù)都追加到緩沖區(qū)然后嘗試解析解析成功才處理否則繼續(xù)等。還有一個(gè)細(xì)節(jié)如果客戶端發(fā)送了Expect: 100-continue頭服務(wù)器需要先返回HTTP/1.1 100 Continue客戶端才會(huì)發(fā)送body。很多HTTP客戶端庫比如Python的requests在body較大時(shí)會(huì)自動(dòng)加這個(gè)頭。如果不處理客戶端會(huì)一直等直到超時(shí)。if (req.headers.value(expect).toLower() 100-continue) { socket-write(HTTP/1.1 100 Continue\r\n\r\n); socket-flush(); }5.3 中文亂碼問題返回中文時(shí)Content-Type必須指定charsetutf-8并且body要用toUtf8()轉(zhuǎn)換。如果客戶端是瀏覽器不指定charset的話瀏覽器可能按ISO-8859-1解碼導(dǎo)致亂碼。resp.headers[Content-Type] application/json; charsetutf-8; resp.body doc.toJson(QJsonDocument::Compact); // QJsonDocument默認(rèn)輸出UTF-8如果手動(dòng)拼接字符串記得QString text 你好; resp.body text.toUtf8();5.4 內(nèi)存泄漏與連接管理每個(gè)QTcpSocket對(duì)象如果不手動(dòng)釋放會(huì)一直占用內(nèi)存。我的做法是在disconnected信號(hào)中清理void HttpServer::onDisconnected() { QTcpSocket *socket qobject_castQTcpSocket*(sender()); if (!socket) return; m_clients.remove(socket); m_buffers.remove(socket); socket-deleteLater(); }用deleteLater()而不是delete是因?yàn)閐isconnected信號(hào)可能在socket的事件處理過程中觸發(fā)直接delete會(huì)導(dǎo)致懸空指針。deleteLater()會(huì)在當(dāng)前事件循環(huán)結(jié)束后安全釋放。另外如果客戶端連接后一直不發(fā)數(shù)據(jù)比如惡意連接socket會(huì)一直占用。我加了一個(gè)超時(shí)定時(shí)器QTimer::singleShot(30000, socket, [socket]() { if (socket-state() QAbstractSocket::ConnectedState) { socket-disconnectFromHost(); } });30秒內(nèi)沒有完成請(qǐng)求就強(qiáng)制斷開。5.5 QT版本兼容性問題QT 5.15和QT 6在Network模塊上有一些差異。比如QAbstractSocket::error()在QT 5.15中返回QAbstractSocket::SocketError在QT 6中改名為errorOccurred信號(hào)。如果你從QT 5遷移到QT 6需要改這些地方。另外報(bào)錯(cuò)fatal: cannot mix incompatible qt library (version ex50601) with this library通常是因?yàn)榫幾g時(shí)用的QT版本和運(yùn)行時(shí)鏈接的庫版本不一致。解決辦法是確保qmake和運(yùn)行時(shí)庫來自同一個(gè)QT安裝。在Windows下可以用windeployqt自動(dòng)拷貝正確的DLL。還有一個(gè)常見報(bào)錯(cuò)qt.qpa.plugin: could not find the qt platform plugin linuxfb。這是因?yàn)槌绦蛘也坏狡脚_(tái)插件。如果是控制臺(tái)程序加上QT - gui就不會(huì)加載平臺(tái)插件了。如果確實(shí)需要GUI確保plugins/platforms目錄在可執(zhí)行文件旁邊或者設(shè)置QT_QPA_PLATFORM_PLUGIN_PATH環(huán)境變量。5.6 常見問題速查表問題現(xiàn)象可能原因解決方法listen失敗端口被占用其他進(jìn)程占用端口netstat/lsof查進(jìn)程換端口或結(jié)束進(jìn)程請(qǐng)求體不完整TCP分包使用緩沖區(qū)累積數(shù)據(jù)按Content-Length判斷中文亂碼未指定charsetContent-Type加charsetutf-8body用toUtf8內(nèi)存持續(xù)增長socket未釋放disconnected信號(hào)中deleteLatercurl報(bào)connection reset響應(yīng)未發(fā)完就斷開write→flush→disconnectFromHostQT版本沖突編譯和運(yùn)行庫不一致用同一QT安裝windeployqt打包平臺(tái)插件找不到缺少plugins目錄控制臺(tái)程序去掉gui模塊或設(shè)置插件路徑100-continue超時(shí)未處理Expect頭收到后先回100 Continue6. 進(jìn)階擴(kuò)展與個(gè)人實(shí)操心得6.1 支持文件上傳與靜態(tài)文件服務(wù)在現(xiàn)有框架上擴(kuò)展文件上傳并不復(fù)雜。核心是解析multipart/form-data格式的body。這個(gè)格式用boundary分隔各個(gè)字段解析起來比JSON麻煩一些但邏輯是清晰的先從頭部的Content-Type中提取boundary然后按boundary切分body每段再解析頭部和內(nèi)容。靜態(tài)文件服務(wù)更簡單收到GET請(qǐng)求后把路徑映射到本地文件路徑檢查文件是否存在讀取內(nèi)容根據(jù)擴(kuò)展名設(shè)置Content-Type.html→text/html.css→text/css.js→application/javascript.png→image/png。注意要做路徑安全檢查防止../目錄穿越攻擊。QString safePath QDir::cleanPath(rootDir req.path); if (!safePath.startsWith(rootDir)) { resp.statusCode 403; return; }6.2 用QThreadPool處理耗時(shí)請(qǐng)求如果某個(gè)接口需要查數(shù)據(jù)庫或者調(diào)用外部服務(wù)處理時(shí)間可能幾百毫秒甚至幾秒。在單線程模式下這會(huì)阻塞所有其他請(qǐng)求。我的做法是給handler加一個(gè)標(biāo)記表示是否異步server.router().addAsyncRoute(GET, /api/slow, [](const HttpRequest req, HttpResponse resp) { QThread::sleep(2); // 模擬耗時(shí)操作 resp.statusCode 200; resp.body {\result\:\done\}; });異步路由的處理邏輯是在主線程中把請(qǐng)求拷貝一份提交到QThreadPool處理完后通過QMetaObject::invokeMethod回到主線程發(fā)送響應(yīng)。這里要注意socket不能跨線程使用所以響應(yīng)發(fā)送必須在主線程做。6.3 日志記錄與調(diào)試技巧調(diào)試HTTP服務(wù)器時(shí)把原始請(qǐng)求報(bào)文打印出來非常有用。我在onReadyRead里加了一行qDebug() Raw request: buffer;但生產(chǎn)環(huán)境不能這么干會(huì)泄露敏感信息。我的做法是用一個(gè)編譯開關(guān)控制#ifdef HTTP_DEBUG qDebug() Raw request: buffer; #endif在.pro文件中加DEFINES HTTP_DEBUG來開啟調(diào)試模式。另外用Wireshark抓包可以看到TCP三次握手和HTTP報(bào)文的具體內(nèi)容。如果遇到詭異的連接問題抓包是最直接的排查手段。我遇到過一次客戶端發(fā)送的請(qǐng)求頭里Content-Length和實(shí)際body長度不一致導(dǎo)致服務(wù)器一直等body最后超時(shí)。抓包一看就發(fā)現(xiàn)了。6.4 我踩過的幾個(gè)坑第一個(gè)坑是信號(hào)槽的連接方式。QTcpSocket::readyRead信號(hào)在數(shù)據(jù)到達(dá)時(shí)觸發(fā)但如果我在槽函數(shù)里調(diào)用了readAll()而數(shù)據(jù)還沒讀完下一次readyRead可能不會(huì)立即觸發(fā)。解決辦法是循環(huán)讀取直到bytesAvailable()為0。不過對(duì)于HTTP請(qǐng)求通常一次readAll就夠了因?yàn)檎?qǐng)求體不會(huì)太大。第二個(gè)坑是QByteArray的隱式共享。QByteArray在拷貝時(shí)是淺拷貝修改時(shí)才會(huì)深拷貝。這在多線程環(huán)境下可能導(dǎo)致問題。如果要把buffer傳給其他線程用QByteArray::fromRawData或者顯式調(diào)用detach()。第三個(gè)坑是HTTP狀態(tài)碼和狀態(tài)描述的對(duì)應(yīng)。我一開始只寫了狀態(tài)碼狀態(tài)描述隨便填結(jié)果某些客戶端比如Postman顯示異常。后來老老實(shí)實(shí)按RFC規(guī)范填200對(duì)應(yīng)OK201對(duì)應(yīng)Created400對(duì)應(yīng)Bad Request404對(duì)應(yīng)Not Found500對(duì)應(yīng)Internal Server Error。第四個(gè)坑是IPv6監(jiān)聽。QHostAddress::Any在有些系統(tǒng)上只監(jiān)聽IPv4要同時(shí)監(jiān)聽IPv6需要用QHostAddress::AnyIPv6或者分別監(jiān)聽。對(duì)于內(nèi)部工具監(jiān)聽IPv4就夠了但如果客戶端用localhost訪問有些系統(tǒng)會(huì)解析到::1IPv6導(dǎo)致連接失敗。解決辦法是同時(shí)監(jiān)聽兩個(gè)地址或者客戶端明確用127.0.0.1。6.5 這個(gè)項(xiàng)目還能怎么擴(kuò)展如果你已經(jīng)跑通了基礎(chǔ)版本可以考慮這幾個(gè)方向繼續(xù)深入WebSocket支持在HTTP升級(jí)請(qǐng)求Upgrade: websocket時(shí)切換到WebSocket協(xié)議實(shí)現(xiàn)雙向通信。QT提供了QWebSocketServer但自己實(shí)現(xiàn)升級(jí)握手過程能學(xué)到更多。HTTPS支持用QSslSocket替換QTcpSocket加載證書和私鑰實(shí)現(xiàn)TLS加密。QT的SSL支持依賴OpenSSL庫需要額外配置。RESTful API的完整實(shí)現(xiàn)加上PUT更新、DELETE刪除、PATCH部分更新以及分頁、過濾、排序等查詢參數(shù)。集成數(shù)據(jù)庫用QSqlDatabase連接SQLite或MySQL把路由處理函數(shù)中的數(shù)據(jù)操作落到數(shù)據(jù)庫。壓力測(cè)試與性能優(yōu)化用wrk或ab做壓測(cè)找出瓶頸嘗試多線程、連接池、零拷貝等優(yōu)化手段。我個(gè)人在實(shí)際操作中的體會(huì)是寫這個(gè)HTTP服務(wù)器的最大收獲不是學(xué)會(huì)了某個(gè)API而是把TCP連接、HTTP協(xié)議、事件驅(qū)動(dòng)、路由設(shè)計(jì)這些概念串成了一條線。以前看HTTP協(xié)議總覺得是紙上談兵自己動(dòng)手解析一遍報(bào)文之后那些頭部字段、狀態(tài)碼、Content-Length都變得具體了。如果你也在學(xué)C和網(wǎng)絡(luò)編程強(qiáng)烈建議自己動(dòng)手寫一遍哪怕只實(shí)現(xiàn)GET請(qǐng)求收獲也比看十篇教程大。