今年開始我這邊在用C++寫一個TcpServer，包括核心的網(wǎng)絡(luò)框架部分，目前開發(fā)接近完成，所以從這篇文章開始和大家分享一下我是如何從0到1完成這個TcpServer的。

這是我開發(fā)的網(wǎng)絡(luò)框架cppbox：https://github.com/ligang1109/cppbox，期待交流

為什么做這個

可能有人想問，現(xiàn)在有很多開源的網(wǎng)絡(luò)框架啊，為啥你還要自己做一個呢？這不是重復(fù)造輪子嗎？

這里我說下自己這樣做的原因：

1. 這類需求很多，但團隊內(nèi)部并沒有一個統(tǒng)一的框架傳承下來，在不斷開發(fā)維護
2. 編程細節(jié)很重要，不了解核心細節(jié)是cover不了一個項目的。由于之前自己并沒有這方面的開發(fā)經(jīng)驗，直接用開源的話由于不能理解核心細節(jié)，所以出問題的話會很難定位，而且對潛在的風險也一無所知
3. 一個精簡的網(wǎng)絡(luò)框架的開發(fā)難度并不算很高，畢竟不是要從頭開發(fā)一個Nginx，所以還是可以接受的
4. 對團隊的技術(shù)積累是有好處的

預(yù)備知識

先說下需要具備的基礎(chǔ)知識，之前我寫過兩篇文章：

1. 應(yīng)用編程基礎(chǔ)課第一講：編程基礎(chǔ)知識：http://blog.7rule.com/2018/09/14/course-program-base-01.html
2. 應(yīng)用編程基礎(chǔ)課第二講：網(wǎng)絡(luò)編程基礎(chǔ)：http://blog.7rule.com/2018/09/23/course-program-base-02.html

另外，既然有很多開源網(wǎng)絡(luò)框架，那么找一個好的學習下也是很重要的。

這里我學習了陳碩的muduo：https://github.com/chenshuo/muduo，閱讀了它的核心源碼，這里我推薦他的書籍 “Linux多線程服務(wù)端編程” https://book.douban.com/subject/20471211/

編碼規(guī)范

編碼規(guī)范遵守 “Google C++編碼規(guī)范” https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/contents/

一個最簡單的服務(wù)端程序

摩天大樓都不是一天蓋成的，這里我也是從最簡單的功能開始，逐步完成。

服務(wù)端程序要做的，就是處理客戶端的連接，接收請求，發(fā)送響應(yīng)，那么一個最簡單的echo程序如下：

#include <iostream>
#include <sys/socket.h>
#include <netinet/in.h>
#include <cstring>
#include <arpa/inet.h>
#include <unistd.h>

#define RW_BUF_LEN 1024

void echo(int connfd) {
  ssize_t n;
  char    buf[RW_BUF_LEN];

  while (true) {
    n = read(connfd, buf, RW_BUF_LEN);
    if (n == 0) {                                  // 對端斷開連接
      std::cout << "disconnected" << std::endl;
      break;
    }
    if (n < 0) {                                   // 讀取錯誤
      if (errno != EINTR && errno != EWOULDBLOCK) {
        perror("read error");
        return;
      }
      std::cout << "nonblock" << std::endl;        // 對端沒有數(shù)據(jù)
      sleep(3);
    } else {                                       // 讀到數(shù)據(jù)發(fā)送回顯
      write(connfd, buf, n);
    }
  }
}

int main() {
  int listenfd = socket(AF_INET, SOCK_STREAM, 0);  // 打開socket
  if (listenfd == -1) {
    perror("listenfd fail");
    return 1;
  }

  struct sockaddr_in serverAddr;
  memset(&serverAddr, 0, sizeof(struct sockaddr_in));

  serverAddr.sin_family = AF_INET;
  if (inet_pton(AF_INET, "127.0.0.1", &(serverAddr.sin_addr)) != 1) {
    std::cout << "inet_pton fail" << std::endl;
    return 1;
  }

//    serverAddr.sin_addr.s_addr = htonl(INADDR_ANY);
  serverAddr.sin_port = htons(8838);

  if (bind(listenfd, (struct sockaddr *) &serverAddr, sizeof(serverAddr)) == -1) {  // bind
    perror("bind fail");
    return 1;
  }

  if (listen(listenfd, 1024) == -1) {      // listen
    perror("listen failed");
    return 1;
  }

  bool running = true;
  while (running) {
    struct sockaddr_in clientAddr;
    memset(&clientAddr, 0, sizeof(struct sockaddr_in));
    socklen_t clientLen;

    int connfd = accept4(listenfd, (struct sockaddr *) &clientAddr, &clientLen, SOCK_NONBLOCK | SOCK_CLOEXEC);    // accept得到connfd，用于之后的連接讀寫
    if (connfd == -1) {
      running = false;
      perror("accept failed");
    } else {
      echo(connfd);
    }

    close(connfd);
  }

  return 0;
}

簡單說明

上面是一個簡單的不能再簡單的EchoServer，如果函數(shù)使用有不明白的地方，請看下我前面介紹的預(yù)備知識。

這個程序，目前只能處理單個客戶端的Tcp連接，僅實現(xiàn)了最基本的功能，諸如連接超時、讀寫buffer等都沒有實現(xiàn)，但這個是最基礎(chǔ)的東西，之后的一切功能，都是在這個基礎(chǔ)上添磚加瓦。

cppbox中的封裝

cppbox中封裝了最常用到的幾個基礎(chǔ)操作：

src/cppbox/net/net.h

static const int kDefaultBacklog = 128;

int NewTcpIpV4NonBlockSocket();     // 相當于之后調(diào)用accept的sockfd是非阻塞的

misc::ErrorUptr SetSockOpt(int sockfd, int level, int optname, const void *optval, socklen_t optlen);

misc::ErrorUptr SetReuseAddr(int sockfd);

misc::ErrorUptr BindForTcpIpV4(int sockfd, const char *ip, uint16_t port);

misc::ErrorUptr Listen(int sockfd, int backlog = kDefaultBacklog);

misc::ErrorUptr BindAndListenForTcpIpV4(int sockfd, const char *ip, uint16_t port, bool reuseaddr = true, int backlog = kDefaultBacklog);  // bind + listen + reuse addr

struct InetAddress {
  std::string ip;
  uint16_t    port;
};

int Accept(int listenfd, struct InetAddress &address, int flags = SOCK_CLOEXEC | SOCK_NONBLOCK); // accept得到非阻塞connfd，同時獲得client的ip + port

使用示例

src/cppbox/net/test/net_test.cc

TEST_F(NetTest, Misc) {
  int sockfd = ::socket(AF_INET, SOCK_STREAM | SOCK_CLOEXEC, 0);
  if (sockfd == -1) {
    std::cout << cppbox::misc::NewErrorUptrByErrno()->String() << std::endl;
    return;
  }

  auto error_uptr = cppbox::net::BindAndListenForTcpIpV4(sockfd, "127.0.0.1", 8860);
  if (error_uptr != nullptr) {
    std::cout << error_uptr->String() << std::endl;
    return;
  }

  cppbox::net::InetAddress raddr;

  int connfd = cppbox::net::Accept(sockfd, raddr);
  if (connfd == -1) {
    std::cout << "accept error: "
              << cppbox::misc::NewErrorUptrByErrno()->String()
              << std::endl;
    return;
  }

  std::cout << "remote ip is " << raddr.ip << std::endl;
  std::cout << "remote port is " << raddr.port << std::endl;

  ::sleep(10);
}