Muduo 网络编程示例之二：Boost.Asio 的聊天服务器

陈硕 (giantchen_AT_gmail)

Blog.csdn.net/Solstice

这是《Muduo 网络编程示例》系列的第二篇文章。

Muduo 全系列文章列表： http://blog.csdn.net/Solstice/category/779646.aspx

本文讲介绍一个与 Boost.Asio 的示例代码中的聊天服务器功能类似的网络服务程序，包括客户端与服务端的 muduo 实现。这个例子的主要目的是介绍如何处理分包，并初步涉及 Muduo 的多线程功能。Muduo 的下载地址： http://muduo.googlecode.com/files/muduo-0.1.7-alpha.tar.gz ，SHA1 873567e43b3c2cae592101ea809b30ba730f2ee6，本文的完整代码可在线阅读

http://code.google.com/p/muduo/source/browse/trunk/examples/asio/chat/ 。

TCP 分包

前面一篇《五个简单 TCP 协议》中处理的协议没有涉及分包，在 TCP 这种字节流协议上做应用层分包是网络编程的基本需求。分包指的是在发生一个消息(message)或一帧(frame)数据时，通过一定的处理，让接收方能从字节流中识别并截取（还原）出一个个消息。“粘包问题”是个伪问题。

对于短连接的 TCP 服务，分包不是一个问题，只要发送方主动关闭连接，就表示一条消息发送完毕，接收方 read() 返回 0，从而知道消息的结尾。例如前一篇文章里的 daytime 和 time 协议。

对于长连接的 TCP 服务，分包有四种方法：

1. 消息长度固定，比如 muduo 的 roundtrip 示例就采用了固定的 16 字节消息；
2. 使用特殊的字符或字符串作为消息的边界，例如 HTTP 协议的 headers 以 "\r\n" 为字段的分隔符；
3. 在每条消息的头部加一个长度字段，这恐怕是最常见的做法，本文的聊天协议也采用这一办法；
4. 利用消息本身的格式来分包，例如 XML 格式的消息中 <root>...</root> 的配对，或者 JSON 格式中的 { ... } 的配对。解析这种消息格式通常会用到状态机。

在后文的代码讲解中还会仔细讨论用长度字段分包的常见陷阱。

聊天服务

本文实现的聊天服务非常简单，由服务端程序和客户端程序组成，协议如下：

• 服务端程序中某个端口侦听 (listen) 新的连接；
• 客户端向服务端发起连接；
• 连接建立之后，客户端随时准备接收服务端的消息并在屏幕上显示出来；
• 客户端接受键盘输入，以回车为界，把消息发送给服务端；
• 服务端接收到消息之后，依次发送给每个连接到它的客户端；原来发送消息的客户端进程也会收到这条消息；
• 一个服务端进程可以同时服务多个客户端进程，当有消息到达服务端后，每个客户端进程都会收到同一条消息，服务端广播发送消息的顺序是任意的，不一定哪个客户端会先收到这条消息。
• （可选）如果消息 A 先于消息 B 到达服务端，那么每个客户端都会先收到 A 再收到 B。

这实际上是一个简单的基于 TCP 的应用层广播协议，由服务端负责把消息发送给每个连接到它的客户端。参与“聊天”的既可以是人，也可以是程序。在以后的文章中，我将介绍一个稍微复杂的一点的例子 hub，它有“聊天室”的功能，客户端可以注册特定的 topic(s)，并往某个 topic 发送消息，这样代码更有意思。

消息格式

本聊天服务的消息格式非常简单，“消息”本身是一个字符串，每条消息的有一个 4 字节的头部，以网络序存放字符串的长度。消息之间没有间隙，字符串也不一定以 '\0' 结尾。比方说有两条消息 "hello" 和 "chenshuo"，那么打包后的字节流是：

0x00, 0x00, 0x00, 0x05, 'h', 'e', 'l', 'l', 'o', 0x00, 0x00, 0x00, 0x08, 'c', 'h', 'e', 'n', 's', 'h', 'u', 'o'

共 21 字节。

打包的代码

这段代码把 const string& message 打包为 muduo::net::Buffer，并通过 conn 发送。

void send(muduo::net::TcpConnection* conn, const string& message)
{
  muduo::net::Buffer buf;
  buf.append(message.data(), message.size());
  int32_t len = muduo::net::sockets::hostToNetwork32(static_cast<int32_t>(message.size()));
  buf.prepend(&len, sizeof len);
  conn->send(&buf);
}

muduo::Buffer 有一个很好的功能，它在头部预留了 8 个字节的空间，这样第 6 行的 prepend() 操作就不需要移动已有的数据，效率较高。

分包的代码

解析数据往往比生成数据复杂，分包打包也不例外。

void onMessage(const muduo::net::TcpConnectionPtr& conn,
               muduo::net::Buffer* buf,
               muduo::Timestamp receiveTime)
{
  while (buf->readableBytes() >= kHeaderLen)
  {
    const void* data = buf->peek();
    int32_t tmp = *static_cast<const int32_t*>(data);
    int32_t len = muduo::net::sockets::networkToHost32(tmp);
    if (len > 65536 || len < 0)
    {
      LOG_ERROR << "Invalid length " << len;
      conn->shutdown();
    }
    else if (buf->readableBytes() >= len + kHeaderLen)
    {
      buf->retrieve(kHeaderLen);
      muduo::string message(buf->peek(), len);
      buf->retrieve(len);
      messageCallback_(conn, message, receiveTime);  // 收到完整的消息，通知用户
    }
    else
    {
      break;
    }
  }
}

上面这段代码第 7 行用了 while 循环来反复读取数据，直到 Buffer 中的数据不够一条完整的消息。请读者思考，如果换成 if (buf->readableBytes() >= kHeaderLen) 会有什么后果。

以前面提到的两条消息的字节流为例：

0x00, 0x00, 0x00, 0x05, 'h', 'e', 'l', 'l', 'o', 0x00, 0x00, 0x00, 0x08, 'c', 'h', 'e', 'n', 's', 'h', 'u', 'o'

假设数据最终都全部到达，onMessage() 至少要能正确处理以下各种数据到达的次序，每种情况下 messageCallback_ 都应该被调用两次：

1. 每次收到一个字节的数据，onMessage() 被调用 21 次；
2. 数据分两次到达，第一次收到 2 个字节，不足消息的长度字段；
3. 数据分两次到达，第一次收到 4 个字节，刚好够长度字段，但是没有 body；
4. 数据分两次到达，第一次收到 8 个字节，长度完整，但 body 不完整；
5. 数据分两次到达，第一次收到 9 个字节，长度完整，body 也完整；
6. 数据分两次到达，第一次收到 10 个字节，第一条消息的长度完整、body 也完整，第二条消息长度不完整；
7. 请自行移动分割点，验证各种情况；
8. 数据一次就全部到达，这时必须用 while 循环来读出两条消息，否则消息会堆积。

请读者验证 onMessage() 是否做到了以上几点。这个例子充分说明了 non-blocking read 必须和 input buffer 一起使用。

编解码器 LengthHeaderCodec

有人评论 Muduo 的接收缓冲区不能设置回调函数的触发条件，确实如此。每当 socket 可读，Muduo 的 TcpConnection 会读取数据并存入 Input Buffer，然后回调用户的函数。不过，一个简单的间接层就能解决问题，让用户代码只关心“消息到达”而不是“数据到达”，如本例中的 LengthHeaderCodec 所展示的那一样。

#ifndef MUDUO_EXAMPLES_ASIO_CHAT_CODEC_H
#define MUDUO_EXAMPLES_ASIO_CHAT_CODEC_H

#include <muduo/base/Logging.h>
#include <muduo/net/Buffer.h>
#include <muduo/net/SocketsOps.h>
#include <muduo/net/TcpConnection.h>

#include <boost/function.hpp>
#include <boost/noncopyable.hpp>

using muduo::Logger;

class LengthHeaderCodec : boost::noncopyable
{
 public:
  typedef boost::function<void (const muduo::net::TcpConnectionPtr&,
                                const muduo::string& message,
                                muduo::Timestamp)> StringMessageCallback;

  explicit LengthHeaderCodec(const StringMessageCallback& cb)
    : messageCallback_(cb)
  {
  }

  void onMessage(const muduo::net::TcpConnectionPtr& conn,
                 muduo::net::Buffer* buf,
                 muduo::Timestamp receiveTime)
  { 同上 }

  void send(muduo::net::TcpConnection* conn, const muduo::string& message)
  { 同上 }

 private:
  StringMessageCallback messageCallback_;
  const static size_t kHeaderLen = sizeof(int32_t);
};

#endif  // MUDUO_EXAMPLES_ASIO_CHAT_CODEC_H

这段代码把以 Buffer* 为参数的 MessageCallback 转换成了以 const string& 为参数的 StringMessageCallback，让用户代码不必关心分包操作。客户端和服务端都能从中受益。

服务端的实现

聊天服务器的服务端代码小于 100 行，不到 asio 的一半。

请先阅读第 68 行起的数据成员的定义。除了经常见到的 EventLoop 和 TcpServer，ChatServer 还定义了 codec_ 和 std::set<TcpConnectionPtr> connections_ 作为成员，connections_ 是目前已建立的客户连接，在收到消息之后，服务器会遍历整个容器，把消息广播给其中每一个 TCP 连接。

首先，在构造函数里注册回调：

 #include "codec.h"

 #include <muduo/base/Logging.h>
 #include <muduo/base/Mutex.h>
 #include <muduo/net/EventLoop.h>
 #include <muduo/net/SocketsOps.h>
 #include <muduo/net/TcpServer.h>

 #include <boost/bind.hpp>

 #include <set>
 #include <stdio.h>

 using namespace muduo;
 using namespace muduo::net;

 class ChatServer : boost::noncopyable
 {
  public:
   ChatServer(EventLoop* loop,
              const InetAddress& listenAddr)
   : loop_(loop),
     server_(loop, listenAddr, "ChatServer"),
     codec_(boost::bind(&ChatServer::onStringMessage, this, _1, _2, _3))
   {
     server_.setConnectionCallback(
         boost::bind(&ChatServer::onConnection, this, _1));
     server_.setMessageCallback(
         boost::bind(&LengthHeaderCodec::onMessage, &codec_, _1, _2, _3));
   }

   void start()
   {
     server_.start();
   }

这里有几点值得注意，在以往的代码里是直接把本 class 的 onMessage() 注册给 server_；这里我们把 LengthHeaderCodec::onMessage() 注册给 server_，然后向 codec_ 注册了 ChatServer::onStringMessage()，等于说让 codec_ 负责解析消息，然后把完整的消息回调给 ChatServer。这正是我前面提到的“一个简单的间接层”，在不增加 Muduo 库的复杂度的前提下，提供了足够的灵活性让我们在用户代码里完成需要的工作。
另外，server_.start() 绝对不能在构造函数里调用，这么做将来会有线程安全的问题，见我在《当析构函数遇到多线程 ── C++ 中线程安全的对象回调》一文中的论述。
以下是处理连接的建立和断开的代码，注意它把新建的连接加入到 connections_ 容器中，把已断开的连接从容器中删除。这么做是为了避免内存和资源泄漏，TcpConnectionPtr 是 boost::shared_ptr<TcpConnection>，是 muduo 里唯一一个默认采用 shared_ptr 来管理生命期的对象。以后我们会谈到这么做的原因。
  private:
   void onConnection(const TcpConnectionPtr& conn)
   {
     LOG_INFO << conn->localAddress().toHostPort() << " -> "
         << conn->peerAddress().toHostPort() << " is "
         << (conn->connected() ? "UP" : "DOWN");

     MutexLockGuard lock(mutex_);
     if (conn->connected())
     {
       connections_.insert(conn);
     }
     else
     {
       connections_.erase(conn);
     }
   }

以下是服务端处理消息的代码，它遍历整个 connections_ 容器，把消息打包发送给各个客户连接。
   void onStringMessage(const TcpConnectionPtr&,
                        const string& message,
                        Timestamp)
   {
     MutexLockGuard lock(mutex_);
     for (ConnectionList::iterator it = connections_.begin();
         it != connections_.end();
         ++it)
     {
       codec_.send(get_pointer(*it), message);
     }
   }

数据成员：
   typedef std::set<TcpConnectionPtr> ConnectionList;
   EventLoop* loop_;
   TcpServer server_;
   LengthHeaderCodec codec_;
   MutexLock mutex_;
   ConnectionList connections_;
 };

main() 函数里边是例行公事的代码：
 int main(int argc, char* argv[])
 {
   LOG_INFO << "pid = " << getpid();
   if (argc > 1)
   {
     EventLoop loop;
     uint16_t port = static_cast<uint16_t>(atoi(argv[1]));
     InetAddress serverAddr(port);
     ChatServer server(&loop, serverAddr);
     server.start();
     loop.loop();
   }
   else
   {
     printf("Usage: %s port\n", argv[0]);
   }
 }

如果你读过 asio 的对应代码，会不会觉得 Reactor 往往比 Proactor 容易使用？

客户端的实现

我有时觉得服务端的程序常常比客户端的更容易写，聊天服务器再次验证了我的看法。客户端的复杂性来自于它要读取键盘输入，而 EventLoop 是独占线程的，所以我用了两个线程，main() 函数所在的线程负责读键盘，另外用一个 EventLoopThread 来处理网络 IO。我暂时没有把标准输入输出融入 Reactor 的想法，因为服务器程序的 stdin 和 stdout 往往是重定向了的。

来看代码，首先，在构造函数里注册回调，并使用了跟前面一样的 LengthHeaderCodec 作为中间层，负责打包分包。

 #include "codec.h"

 #include <muduo/base/Logging.h>
 #include <muduo/base/Mutex.h>
 #include <muduo/net/EventLoopThread.h>
 #include <muduo/net/TcpClient.h>

 #include <boost/bind.hpp>
 #include <boost/noncopyable.hpp>

 #include <iostream>
 #include <stdio.h>

 using namespace muduo;
 using namespace muduo::net;

 class ChatClient : boost::noncopyable
 {
  public:
   ChatClient(EventLoop* loop, const InetAddress& listenAddr)
     : loop_(loop),
       client_(loop, listenAddr, "ChatClient"),
       codec_(boost::bind(&ChatClient::onStringMessage, this, _1, _2, _3))
   {
     client_.setConnectionCallback(
         boost::bind(&ChatClient::onConnection, this, _1));
     client_.setMessageCallback(
         boost::bind(&LengthHeaderCodec::onMessage, &codec_, _1, _2, _3));
     client_.enableRetry();
   }

   void connect()
   {
     client_.connect();
   }

disconnect() 目前为空，客户端的连接由操作系统在进程终止时关闭。
   void disconnect()
   {
     // client_.disconnect();
   }

write() 会由 main 线程调用，所以要加锁，这个锁不是为了保护 TcpConnection，而是保护 shared_ptr。
   void write(const string& message)
   {
     MutexLockGuard lock(mutex_);
     if (connection_)
     {
       codec_.send(get_pointer(connection_), message);
     }
   }

onConnection() 会由 EventLoop 线程调用，所以要加锁以保护 shared_ptr。
  private:
   void onConnection(const TcpConnectionPtr& conn)
   {
     LOG_INFO << conn->localAddress().toHostPort() << " -> "
         << conn->peerAddress().toHostPort() << " is "
         << (conn->connected() ? "UP" : "DOWN");

     MutexLockGuard lock(mutex_);
     if (conn->connected())
     {
       connection_ = conn;
     }
     else
     {
       connection_.reset();
     }
   }

把收到的消息打印到屏幕，这个函数由 EventLoop 线程调用，但是不用加锁，因为 printf() 是线程安全的。
注意这里不能用 cout，它不是线程安全的。
   void onStringMessage(const TcpConnectionPtr&,
                        const string& message,
                        Timestamp)
   {
     printf("<<< %s\n", message.c_str());
   }


数据成员：
   EventLoop* loop_;
   TcpClient client_;
   LengthHeaderCodec codec_;
   MutexLock mutex_;
   TcpConnectionPtr connection_;
 };

main() 函数里除了例行公事，还要启动 EventLoop 线程和读取键盘输入。
 int main(int argc, char* argv[])
 {
   LOG_INFO << "pid = " << getpid();
   if (argc > 2)
   {
     EventLoopThread loopThread;
     uint16_t port = static_cast<uint16_t>(atoi(argv[2]));
     InetAddress serverAddr(argv[1], port);

     ChatClient client(loopThread.startLoop(), serverAddr); // 注册到 EventLoopThread 的 EventLoop 上。
     client.connect();
     std::string line;
     while (std::getline(std::cin, line))
     {
       string message(line.c_str()); // 这里似乎多此一举，可直接发送 line。这里是
       client.write(message);
     }
     client.disconnect();
   }
   else
   {
     printf("Usage: %s host_ip port\n", argv[0]);
   }
 }

简单测试

开三个命令行窗口，在第一个运行

$ ./asio_chat_server 3000

第二个运行

$ ./asio_chat_client 127.0.0.1 3000

第三个运行同样的命令

$ ./asio_chat_client 127.0.0.1 3000

这样就有两个客户端进程参与聊天。在第二个窗口里输入一些字符并回车，字符会出现在本窗口和第三个窗口中。

下一篇文章我会介绍 Muduo 中的定时器，并实现 Boost.Asio 教程中的 timer2~5 示例，以及带流量统计功能的 discard 和 echo 服务器（来自 Java Netty）。流量等于单位时间内发送或接受的字节数，这要用到定时器功能。

(待续)