準(zhǔn)項(xiàng)目】發(fā)布訂閱式消息隊(duì)列(篇二):C++ 第三方庫(kù)實(shí)戰(zhàn):Protobuf 與 Muduo 從原理到上手)
先看全景這兩個(gè)庫(kù)在項(xiàng)目里各自站哪個(gè)位置一個(gè)典型的 C 網(wǎng)絡(luò)服務(wù)比如消息隊(duì)列、RPC 框架、游戲網(wǎng)關(guān)骨架大致是三層Protobuf 是協(xié)議層的答案你用.proto描述數(shù)據(jù)結(jié)構(gòu)編譯器給你生成 C 類序列化出來(lái)是緊湊的二進(jìn)制跨語(yǔ)言、跨平臺(tái)、可向后兼容地演進(jìn)。Muduo 是傳輸層的答案陳碩寫的非阻塞 IO 事件驅(qū)動(dòng)網(wǎng)絡(luò)庫(kù)主從 Reactor 模型one loop per thread讓你用「注冊(cè)回調(diào)」的方式寫高并發(fā) TCP 服務(wù)而不用手寫epoll那套狀態(tài)機(jī)。兩者組合起來(lái)就是一個(gè)能對(duì)外提供穩(wěn)定二進(jìn)制協(xié)議服務(wù)的最小工業(yè)級(jí)骨架。下面分兩大塊講。第一部分Protobuf1.1 Protobuf 是什么Protocol Buffers簡(jiǎn)稱 Protobuf / PB是一套數(shù)據(jù)結(jié)構(gòu)序列化與反序列化框架。三個(gè)核心特點(diǎn)特點(diǎn)含義語(yǔ)言無(wú)關(guān)、平臺(tái)無(wú)關(guān)一份.proto可生成 Java / C / Python / Go 等多語(yǔ)言代碼天然支持跨端通信高效二進(jìn)制編碼 變長(zhǎng)整數(shù)編碼比 XML 更小、更快、更簡(jiǎn)單典型場(chǎng)景體積約為 JSON 的 1/3 ~ 1/10擴(kuò)展性、兼容性好可以往 message 里加字段而不破壞已經(jīng)上線的舊程序——這是它能做長(zhǎng)期協(xié)議演進(jìn)的根本原因?yàn)槭裁醇幼侄尾黄茐呐f程序能成立這是 PB 最值錢的設(shè)計(jì)值得單獨(dú)說清楚每個(gè)字段都有唯一編號(hào)編碼進(jìn)字節(jié)流的是編號(hào)不是字段名新版本增加的新編號(hào)舊程序解析時(shí)不認(rèn)識(shí)就跳過skip不會(huì)報(bào)錯(cuò)舊程序發(fā)的數(shù)據(jù)缺少新字段新程序讀到的是字段默認(rèn)值proto3 中標(biāo)量默認(rèn)是 0 / 空串 / false。所以協(xié)議演進(jìn)的原則是只加不減、不換類型、不復(fù)用編號(hào)。1.2 Protobuf 使用流程標(biāo)準(zhǔn)三步走1. 寫 .proto 文件 定義 message 及其字段 ↓ 2. protoc 編譯 .proto 生成 xxx.pb.h / xxx.pb.cc ↓ 3. 在業(yè)務(wù)代碼里 include 用生成的類 set/get 字段、序列化、反序列化可以理解為.proto是協(xié)議源碼protoc是協(xié)議編譯器.pb.h/.pb.cc是協(xié)議 SDK。改協(xié)議 改.proto重新編譯業(yè)務(wù)代碼跟著編永遠(yuǎn)不存在手寫解析函數(shù)寫漏一個(gè)字段的問題。下面用一個(gè)通訊錄 Demo把這套流程完整跑一遍。1.3 快速上手通訊錄 DemoDemo 目標(biāo)很樸素但足以覆蓋全部關(guān)鍵動(dòng)作對(duì)一個(gè)聯(lián)系人信息用 PB 序列化拿到二進(jìn)制結(jié)果把二進(jìn)制結(jié)果用 PB 反序列化解析出聯(lián)系人信息聯(lián)系人字段姓名 年齡。Step 1創(chuàng)建.proto文件命名規(guī)范文件名全小寫多個(gè)單詞用_連接例如lower_snake_case.proto??s進(jìn)規(guī)范文件內(nèi)代碼統(tǒng)一2 個(gè)空格縮進(jìn)不是 4 個(gè)這是官方風(fēng)格。新建contacts.proto。Step 2加注釋支持//單行與/* ... */多行和 C 一致。Step 3指定 proto3 語(yǔ)法syntax proto3;proto3 是當(dāng)前最新的語(yǔ)法版本簡(jiǎn)化了 proto2 的寫法且必須寫在除去注釋后的第一行不寫這行編譯器默認(rèn)按proto2解析——很多為什么生成代碼里多了一堆has_xxx()的疑惑都源于此。Step 4package聲明可選但強(qiáng)烈建議package contacts;package表示.proto的命名空間用來(lái)避免不同模塊間 message 重名沖突編譯成 C 后它會(huì)變成同名的 namespace即contacts::PeopleInfo項(xiàng)目里要有唯一性通常用「項(xiàng)目名.模塊名」的層級(jí)寫法如package mq.common;。Step 5定義 message消息message就是我們要傳輸?shù)慕Y(jié)構(gòu)化對(duì)象。在網(wǎng)絡(luò)里雙方必須先定制協(xié)議——說白了就是約定結(jié)構(gòu)體長(zhǎng)什么樣PB 用message來(lái)承載這件事并據(jù)此幫你生成類和方法。message 消息類型名 { }命名規(guī)范駝峰命名首字母大寫。syntax proto3; package contacts; // 定義聯(lián)系人消息 message PeopleInfo { }Step 6定義消息字段字段格式字段類型 字段名 字段唯一編號(hào);三條規(guī)范務(wù)必記住字段名全小寫多個(gè)單詞用_連接snake_case字段類型分為標(biāo)量數(shù)據(jù)類型int32 / string …和特殊類型枚舉、其他 message 等字段唯一編號(hào)用來(lái)標(biāo)識(shí)字段一旦投入使用就不能改改了等于換了字段。標(biāo)量類型對(duì)照表以 C 為例.proto Type說明C Typedouble8 字節(jié)浮點(diǎn)doublefloat4 字節(jié)浮點(diǎn)floatint32變長(zhǎng)編碼。負(fù)數(shù)的編碼效率較低——字段可能為負(fù)時(shí)應(yīng)用sint32int32int64變長(zhǎng)編碼。負(fù)數(shù)的編碼效率較低——字段可能為負(fù)時(shí)應(yīng)用sint64int64uint32變長(zhǎng)編碼uint32uint64變長(zhǎng)編碼uint64sint32變長(zhǎng)編碼符號(hào)整型負(fù)值編碼效率高于int32int32sint64變長(zhǎng)編碼符號(hào)整型負(fù)值編碼效率高于int64int64fixed32定長(zhǎng) 4 字節(jié)。值常大于 2sup28/sup 時(shí)比uint32更高效uint32fixed64定長(zhǎng) 8 字節(jié)。值常大于 2sup56/sup 時(shí)比uint64更高效uint64sfixed32定長(zhǎng) 4 字節(jié)int32sfixed64定長(zhǎng) 8 字節(jié)int64bool布爾boolstringUTF-8 / ASCII 字符串長(zhǎng)度不超過 2sup32/supstd::stringbytes任意字節(jié)序列長(zhǎng)度不超過 2sup32/supstd::string關(guān)于變長(zhǎng)編碼Varint經(jīng)過 PB 編碼后原本需要 4 字節(jié)或 8 字節(jié)的數(shù)可能只占 1~2 個(gè)字節(jié)。 這就是為什么int32 age 20;編碼出來(lái)只有一個(gè)字節(jié)——小數(shù)值極其省空間。 而負(fù)數(shù)在 Varint 里會(huì)被當(dāng)作 64 位補(bǔ)碼處理固定占 10 個(gè)字節(jié)所以可能為負(fù)的字段一定優(yōu)先選sint32/sint64。另注bytes在 C 里同樣映射為std::string但語(yǔ)義是裸字節(jié)不要直接當(dāng)文本用。更新contacts.proto加入姓名與年齡syntax proto3; package contacts; message PeopleInfo { string name 1; int32 age 2; }字段編號(hào)的兩個(gè)硬性約束A. 取值范圍1 ~ 536,870,911即 2sup29/sup ? 1其中 19000 ~ 19999 不可用。19000~19999 是 PB 協(xié)議實(shí)現(xiàn)內(nèi)部預(yù)留的。硬寫上去編譯期就會(huì)告警// 消息中定義了如下編號(hào)代碼會(huì)告警 // Field numbers 19,000 through 19,999 are reserved for the protobuf implementation string name 19000;B. 1 ~ 15 編號(hào)只占 1 個(gè)字節(jié)16 ~ 2047 占 2 個(gè)字節(jié)。編碼后的字節(jié)不僅包含編號(hào)還包含字段類型wire type。所以1 ~ 15 應(yīng)該留給出現(xiàn)最頻繁的字段同時(shí)為將來(lái)可能新增的高頻字段預(yù)留幾個(gè)低編號(hào)。這是一條協(xié)議設(shè)計(jì)時(shí)就要想清楚的性能約束不是編譯器會(huì)幫你兜底的東西。Step 7編譯contacts.proto命令行格式protoc [--proto_pathIMPORT_PATH] --cpp_outDST_DIR path/to/file.proto參數(shù)含義參數(shù)說明protocProtocol Buffers 提供的命令行編譯工具--proto_path/-I指定被編譯.proto文件所在目錄可多次指定。不指定則默認(rèn)在當(dāng)前目錄搜索。當(dāng).proto之間互相import或被編譯文件不在當(dāng)前目錄時(shí)必須用-I--cpp_outOUT_DIR指定生成C代碼以及輸出目標(biāo)目錄path/to/file.proto要編譯的.proto文件編譯我們的通訊錄protoc --cpp_out. contacts.proto生成兩個(gè)文件contacts.pb.h // 類的聲明 contacts.pb.cc // 類的實(shí)現(xiàn)生成代碼的整體規(guī)律每個(gè)message→ 生成一個(gè)對(duì)應(yīng)的消息類類里為每個(gè)字段提供getter / setter以及一系列操作字段的方法每個(gè).proto文件 → 一對(duì).h/.cc聲明與實(shí)現(xiàn)分離。Step 8讀懂生成的代碼contacts.pb.h片段class PeopleInfo final : public ::PROTOBUF_NAMESPACE_ID::Message { public: using ::PROTOBUF_NAMESPACE_ID::Message::CopyFrom; void CopyFrom(const PeopleInfo from); using ::PROTOBUF_NAMESPACE_ID::Message::MergeFrom; void MergeFrom(const PeopleInfo from) { PeopleInfo::MergeImpl(*this, from); } static ::PROTOBUF_NAMESPACE_ID::StringPiece FullMessageName() { return PeopleInfo; } // string name 1; void clear_name(); const std::string name() const; template typename ArgT0 const std::string, typename... ArgT void set_name(ArgT0 arg0, ArgT... args); std::string* mutable_name(); PROTOBUF_NODISCARD std::string* release_name(); void set_allocated_name(std::string* name); // int32 age 2; void clear_age(); int32_t age() const; void set_age(int32_t value); };命名規(guī)律一目了然getter名稱與字段名完全相同小寫如name()、age()setter以set_開頭如set_name()、set_age()每個(gè)字段都有clear_方法把字段重置回 empty 狀態(tài)字符串字段額外有mutable_/release_/set_allocated_用于避免拷貝或轉(zhuǎn)移所有權(quán)——mutable_name()返回可直接修改的內(nèi)部指針級(jí)對(duì)象這是高頻修改字符串時(shí)唯一不產(chǎn)生拷貝的入口。contacts.pb.cc中是這些方法的具體實(shí)現(xiàn)通常不需要看。序列化 / 反序列化 API 在哪不在消息類自己身上而在其父類MessageLite中class MessageLite { public: // 序列化 bool SerializeToOstream(ostream* output) const; // 寫入文件流 bool SerializeToArray(void* data, int size) const; bool SerializeToString(string* output) const; // 反序列化 bool ParseFromIstream(istream* input); // 從流讀取再反序列化 bool ParseFromArray(const void* data, int size); bool ParseFromString(const string data); };四個(gè)要點(diǎn)序列化結(jié)果是二進(jìn)制字節(jié)序列不是文本格式三個(gè)序列化方法沒有本質(zhì)區(qū)別只是輸出載體不同流 / 裸內(nèi)存 / string按場(chǎng)景選序列化 API 都是const成員函數(shù)——序列化不改變對(duì)象內(nèi)容只把結(jié)果寫到入?yún)⒅付ǖ牡刂犯暾?message API 見官方 Message 完整列表。Step 9序列化與反序列化的實(shí)際使用運(yùn)行結(jié)果第二部分Muduo2.1 Muduo 是什么解決什么問題Muduo 是陳碩開發(fā)的、基于非阻塞 IO 與事件驅(qū)動(dòng)的 C 高并發(fā) TCP 網(wǎng)絡(luò)編程庫(kù)。它解決的是手寫網(wǎng)絡(luò)服務(wù)的經(jīng)典痛點(diǎn)裸用epoll時(shí)你得自己管理fd生命周期、處理EAGAIN/短讀短寫、維護(hù)每連接的緩沖區(qū)、處理跨線程喚醒……任何一個(gè)細(xì)節(jié)寫錯(cuò)都是線上事故。Muduo 把這一整套封裝成注冊(cè)回調(diào) 事件循環(huán)的編程模型。2.1.1 主從 Reactor 模型main Reactor只有一個(gè)專職accept新連接然后把連接分發(fā)給某個(gè) sub Reactorsub ReactorN 個(gè)各自跑在自己的線程里負(fù)責(zé)已建立連接的讀寫事件與業(yè)務(wù)回調(diào)。2.1.2one loop per thread線程模型的核心約定一個(gè)線程只能有一個(gè)事件循環(huán)EventLoop用于響應(yīng)計(jì)時(shí)器和 IO 事件一個(gè)文件描述符只能由一個(gè)線程進(jìn)行讀寫——換句話說一個(gè) TCP 連接必須歸屬于某個(gè) EventLoop 管理。這條約定的工程價(jià)值因?yàn)檫B接只屬于一個(gè) loop業(yè)務(wù)回調(diào)天然是單線程串行執(zhí)行的。 你在onMessage里操作連接自己的狀態(tài)時(shí)不需要加鎖 需要跨線程操作時(shí)Muduo 提供runInLoop/queueInLoop把任務(wù)丟回目標(biāo) loop 執(zhí)行這也是定時(shí)器能線程安全地從其他線程調(diào)用的原理。并發(fā)難點(diǎn)從到處鎖變成了想清楚哪些變量屬于哪個(gè) loop這是 Muduo 最舒服的地方。2.2 五個(gè)必須掌握的核心類類職責(zé)一句話記住InetAddress封裝 IP 端口描述哪個(gè)地址EventLoop事件循環(huán)epoll的封裝驅(qū)動(dòng)一切的心臟TcpServerTCP 服務(wù)器服務(wù)端入口負(fù)責(zé) accept 分發(fā)TcpClientTCP 客戶端客戶端入口負(fù)責(zé) connectTcpConnection一條TCP 連接收發(fā)數(shù)據(jù)都通過它Buffer每連接的讀寫緩沖區(qū)解決數(shù)據(jù)沒到齊/發(fā)不完CountDownLatch倒計(jì)時(shí)門閂把異步連接同步化2.2.1TcpServertypedef std::shared_ptrTcpConnection TcpConnectionPtr; typedef std::functionvoid (const TcpConnectionPtr) ConnectionCallback; typedef std::functionvoid (const TcpConnectionPtr, Buffer*, Timestamp) MessageCallback; class InetAddress : public muduo::copyable { public: InetAddress(StringArg ip, uint16_t port, bool ipv6 false); }; class TcpServer : noncopyable { public: enum Option { kNoReusePort, kReusePort, }; TcpServer(EventLoop* loop, const InetAddress listenAddr, const string nameArg, Option option kNoReusePort); void setThreadNum(int numThreads); // 設(shè)置 sub Reactor 線程數(shù) void start(); // 啟動(dòng)創(chuàng)建監(jiān)聽 socket 并注冊(cè)進(jìn) loop /// 當(dāng)一個(gè)新連接建立成功的時(shí)候被調(diào)用 void setConnectionCallback(const ConnectionCallback cb) { connectionCallback_ cb; } /// 消息的業(yè)務(wù)處理回調(diào)函數(shù)——收到新連接消息的時(shí)候被調(diào)用 void setMessageCallback(const MessageCallback cb) { messageCallback_ cb; } };要點(diǎn)三個(gè)入?yún)⒂媚膫€(gè) loop、監(jiān)聽地址、服務(wù)器名日志標(biāo)識(shí)setThreadNum(n)設(shè)置 sub Reactor 數(shù)量n 0就是單線程模式所有 IO 都在 main loop 里setConnectionCallback參數(shù)只有 1 個(gè)連接對(duì)象setMessageCallback參數(shù)有 3 個(gè)連接對(duì)象、Buffer、時(shí)間戳——這是新手最常見的編譯錯(cuò)誤來(lái)源kReusePort設(shè)置SO_REUSEPORT服務(wù)器重啟不必等TIME_WAIT超時(shí)調(diào)試期建議開。2.2.2EventLoopclass EventLoop : noncopyable { public: /// Loops forever. /// Must be called in the same thread as creation of the object. void loop(); /// Quits loop. /// This is not 100% thread safe, if you call through a raw pointer, /// better to call through shared_ptrEventLoop for 100% safety. void quit(); TimerId runAt(Timestamp time, TimerCallback cb); /// Runs callback after c delay seconds. Safe to call from other threads. TimerId runAfter(double delay, TimerCallback cb); /// Runs callback every c interval seconds. Safe to call from other threads. TimerId runEvery(double interval, TimerCallback cb); /// Cancels the timer. Safe to call from other threads. void cancel(TimerId timerId); private: std::atomicbool quit_; std::unique_ptrPoller poller_; // 對(duì) epoll 的封裝 mutable MutexLock mutex_; std::vectorFunctor pendingFunctors_ GUARDED_BY(mutex_); };要點(diǎn)loop()是死循環(huán)阻塞接口必須與創(chuàng)建該對(duì)象的線程相同線程歸屬約定quit()用來(lái)退出定時(shí)器三件套runAt絕對(duì)時(shí)間、runAfter延遲一次、runEvery周期注意線程安全注釋定時(shí)器接口是可從其他線程安全調(diào)用的實(shí)現(xiàn)方式就是把回調(diào)queueInLoop到目標(biāo) looppendingFunctors_mutex_就是跨線程任務(wù)的落地機(jī)制也是eventfd喚醒epoll_wait的觸發(fā)點(diǎn)GUARDED_BY(mutex_)是 clang 線程安全注解告訴靜態(tài)分析這個(gè)成員必須在持鎖下訪問。2.2.3TcpConnectionclass TcpConnection : noncopyable, public std::enable_shared_from_thisTcpConnection { public: /// Constructs a TcpConnection with a connected sockfd /// User should not create this object. TcpConnection(EventLoop* loop, const string name, int sockfd, const InetAddress localAddr, const InetAddress peerAddr); bool connected() const { return state_ kConnected; } bool disconnected() const { return state_ kDisconnected; } void send(string message); // C11 void send(const void* message, int len); void send(const StringPiece message); // void send(Buffer message); // C11 void send(Buffer* message); // this one will swap data void shutdown(); // NOT thread safe, no simultaneous calling void setContext(const boost::any context) { context_ context; } const boost::any getContext() const { return context_; } boost::any* getMutableContext() { return context_; } void setConnectionCallback(const ConnectionCallback cb) { connectionCallback_ cb; } void setMessageCallback(const MessageCallback cb) { messageCallback_ cb; } private: enum StateE { kDisconnected, kConnecting, kConnected, kDisconnecting }; EventLoop* loop_; ConnectionCallback connectionCallback_; MessageCallback messageCallback_; WriteCompleteCallback writeCompleteCallback_; boost::any context_; };要點(diǎn)不要自己 newTcpConnection——它由TcpServer/TcpClient內(nèi)部創(chuàng)建用shared_ptr管理生命周期繼承enable_shared_from_this回調(diào)里需要續(xù)命時(shí)用shared_from_this()拿到shared_ptr避免對(duì)象在使用中被析構(gòu)send()是線程安全的內(nèi)部會(huì)runInLoop到所屬 loop 執(zhí)行可從任意線程調(diào)用shutdown()不是線程安全的且不能同時(shí)調(diào)用——這是注釋里明確寫的限制context_是boost::any類型的每連接用戶數(shù)據(jù)槽做連接級(jí)會(huì)話狀態(tài)用戶 ID、登錄態(tài)、解析中間態(tài)的標(biāo)準(zhǔn)位置四個(gè)連接狀態(tài)kDisconnected / kConnecting / kConnected / kDisconnecting業(yè)務(wù)里用connected()/disconnected()判斷即可。2.2.4TcpClientclass TcpClient : noncopyable { public: TcpClient(EventLoop* loop, const InetAddress serverAddr, const string nameArg); ~TcpClient(); // force out-line dtor, for std::unique_ptr members. void connect(); // 連接服務(wù)器 void disconnect(); // 關(guān)閉連接 void stop(); // 獲取客戶端對(duì)應(yīng)的通信連接 Connection 對(duì)象 // 注意發(fā)起 connect 后有可能還沒有連接建立成功 TcpConnectionPtr connection() const { MutexLockGuard lock(mutex_); return connection_; } /// 連接服務(wù)器成功時(shí)的回調(diào)函數(shù) void setConnectionCallback(ConnectionCallback cb) { connectionCallback_ std::move(cb); } /// 收到服務(wù)器發(fā)送的消息時(shí)的回調(diào)函數(shù) void setMessageCallback(MessageCallback cb) { messageCallback_ std::move(cb); } private: EventLoop* loop_; ConnectionCallback connectionCallback_; MessageCallback messageCallback_; WriteCompleteCallback writeCompleteCallback_; TcpConnectionPtr connection_ GUARDED_BY(mutex_); };注意Muduo 不管服務(wù)端還是客戶端連接動(dòng)作都是異步的。/* 因?yàn)?muduo 庫(kù)不管是服務(wù)端還是客戶端都是異步操作 對(duì)于客戶端來(lái)說如果我們?cè)谶B接還沒有完全建立成功的時(shí)候發(fā)送數(shù)據(jù) 這是不被允許的。 因此我們可以使用內(nèi)置的 CountDownLatch 類進(jìn)行同步控制。 */connect()只是發(fā)起連接就返回了connection()可能還是空的。要連上再發(fā)就得用CountDownLatch把異步變同步class CountDownLatch : noncopyable { public: explicit CountDownLatch(int count); void wait() { MutexLockGuard lock(mutex_); while (count_ 0) { condition_.wait(); // 等待方阻塞直到計(jì)數(shù)歸零 } } void countDown() { MutexLockGuard lock(mutex_); --count_; if (count_ 0) { condition_.notifyAll(); // 通知方歸零時(shí)喚醒所有等待者 } } int getCount() const; private: mutable MutexLock mutex_; Condition condition_ GUARDED_BY(mutex_); int count_ GUARDED_BY(mutex_); };用法就是經(jīng)典的主線程 waitIO 線程在onConnection里 countDownCountDownLatch latch(1);→latch.wait();卡住 → 連上后回調(diào)里latch.countDown();→ 主線程被喚醒此刻連接一定可用了。注意條件的檢查方式是while (count_ 0)而非if——這是防虛假喚醒的標(biāo)準(zhǔn)寫法自己寫條件變量時(shí)照抄。2.2.5Bufferclass Buffer : public muduo::copyable { public: static const size_t kCheapPrepend 8; static const size_t kInitialSize 1024; explicit Buffer(size_t initialSize kInitialSize) : buffer_(kCheapPrepend initialSize), readerIndex_(kCheapPrepend), writerIndex_(kCheapPrepend) {} void swap(Buffer rhs); size_t readableBytes() const; // 可讀字節(jié)數(shù) size_t writableBytes() const; // 可寫字節(jié)數(shù) const char* peek() const; // 可讀數(shù)據(jù)的起始位置 const char* findEOL() const; // 找 \n解析文本協(xié)議常用 const char* findEOL(const char* start) const; void retrieve(size_t len); // 消費(fèi) len 字節(jié) void retrieveInt64(); void retrieveInt32(); void retrieveInt16(); void retrieveInt8(); string retrieveAllAsString(); // 取走全部可讀數(shù)據(jù) string retrieveAsString(size_t len); void append(const StringPiece str); void append(const char* /*restrict*/ data, size_t len); void append(const void* /*restrict*/ data, size_t len); char* beginWrite(); const char* beginWrite() const; void hasWritten(size_t len); // 讀完之后告知我寫了 len 字節(jié) void appendInt64(int64_t x); // 網(wǎng)絡(luò)字節(jié)序?qū)懭?void appendInt32(int32_t x); void appendInt16(int16_t x); void appendInt8(int8_t x); int64_t readInt64(); // 網(wǎng)絡(luò)字節(jié)序讀出 int32_t readInt32(); int16_t readInt16(); int8_t readInt8(); int64_t peekInt64() const; // 只看不消費(fèi) int32_t peekInt32() const; int16_t peekInt16() const; int8_t peekInt8() const; void prependInt64(int64_t x); // 前插常用于把長(zhǎng)度頭補(bǔ)回前面 void prependInt32(int32_t x); void prependInt16(int16_t x); void prependInt8(int8_t x); void prepend(const void* /*restrict*/ data, size_t len); private: std::vectorchar buffer_; // 底層存儲(chǔ) size_t readerIndex_; // 讀位置 size_t writerIndex_; // 寫位置 static const char kCRLF[]; };設(shè)計(jì)要點(diǎn)readerIndex_ / writerIndex_ 雙指針把vector分成已讀廢棄區(qū) | 可讀數(shù)據(jù)區(qū) | 可寫空閑區(qū)三段避免每次讀都erase搬內(nèi)存kCheapPrepend 8前面預(yù)留 8 字節(jié)廉價(jià)空間用于prepend補(bǔ)協(xié)議頭如長(zhǎng)度字段而不用整體搬移kInitialSize 1024初始 1KB按需擴(kuò)容這點(diǎn)很關(guān)鍵TCP 是字節(jié)流一次read不保證拿到一條完整消息Buffer 就是用來(lái)攢夠一條消息的appendInt32/readInt32系列自動(dòng)做網(wǎng)絡(luò)字節(jié)序轉(zhuǎn)換自定義二進(jìn)制協(xié)議時(shí)直接用它寫長(zhǎng)度前綴比手寫htons安全retrieve 消費(fèi)數(shù)據(jù)移動(dòng)readerIndex_peek 看一眼不消費(fèi)注意區(qū)分這是解析消息時(shí)最容易寫錯(cuò)的地方。2.3 快速上手英譯漢 TCP 服務(wù)端 / 客戶端用 Muduo 實(shí)現(xiàn)一個(gè)最簡(jiǎn)單的英譯漢服務(wù) 客戶端發(fā)一個(gè)詞 → 服務(wù)端查字典 → 把譯文發(fā)回客戶端。2.3.1 服務(wù)端server.cpp幾個(gè)容易被忽略的細(xì)節(jié)成員聲明順序 構(gòu)造順序_baseloop必須寫在_server前面因?yàn)開server構(gòu)造時(shí)要用_baseloop。寫反了就是拿未初始化對(duì)象取地址行為未定義。InetAddress(port)這種只傳端口的寫法等價(jià)監(jiān)聽本機(jī)所有網(wǎng)卡要限定 IP 就寫InetAddress(0.0.0.0, port)。onMessage里msg.back()前應(yīng)判空如果對(duì)端只發(fā)了連接不發(fā)數(shù)據(jù)或發(fā)來(lái)空包back()是 UB。生產(chǎn)代碼要寫成if (msg.empty()) return;。同樣這里用retrieveAllAsString()是假設(shè)一次收到一條完整消息的偷懶寫法真實(shí)協(xié)議必須自己按長(zhǎng)度/分隔符做拆包配合findEOL()或readInt32()長(zhǎng)度前綴。send()不保證立刻發(fā)出內(nèi)核發(fā)送緩沖區(qū)滿時(shí)數(shù)據(jù)會(huì)留在 Muduo 的輸出 Buffer 里等EPOLLOUT所以別在send()后立刻假設(shè)對(duì)端已收到。2.3.2 客戶端client.cpp客戶端設(shè)計(jì)的三個(gè)關(guān)鍵點(diǎn)EventLoopThread客戶端通常沒有 main loop 需求用一個(gè)EventLoopThread起一個(gè)后臺(tái)線程跑 loop主線程就可以自由地做cin、等待等阻塞操作同時(shí)_baseloop上的 IO 照常進(jìn)行。 成員聲明順序上_loopthread必須在_baseloop之前、_baseloop必須在_client之前_baseloop(_loopthread.startLoop())才能拿到合法的 loop 指針。CountDownLatch才是主角_client.connect()是異步的直接send會(huì)被 Muduo 拒絕或丟數(shù)據(jù)。構(gòu)造函數(shù)里_connect_latch(1)→connect()里wait()→onConnection里countDown()三步把連接成功這件事變成一次確定的同步點(diǎn)。_conn的生命周期onConnection斷開分支里_conn.reset()translate里if (_conn)兜底判空——連接還沒建好或已斷開時(shí)只能安全地什么都不發(fā)。2.3.3 編譯Makefile運(yùn)行效果