首页 > 代码库 > TinyWS —— 一个C++写的简易WEB服务器(三)
TinyWS —— 一个C++写的简易WEB服务器(三)
写在前面
代码已经托管在 https://git.oschina.net/augustus/TinyWS.git
可以用git clone下来。由于我可能会偶尔做一些修改，不能保证git 库上的代码与blog里的完全一致（实际上也不可能把所有的代码都贴在这里）。另外，TinyWS是基于linux写的（ubuntu 14.10 + eclipse luna，eclipse工程我也push到了git库），故在Windows上可能无法正常编译（主要是系统调用 部分可能会不同）。
前面的内容可参考上一篇 http://www.cnblogs.com/cuiluo/p/4219946.html
NetConnection
NetConnection类封装了对socket的操作。socket的原理前面简单说过，其使用方法许多地方都有介绍，这里不细说，其实对于服务端，不过就是打开socket，监听某端口，而后等待客户端请求几个步骤。
// NetConnectionclass NetConnection{public: NetConnection(); void lisen(int port); int accept(); void close();private: int lisenfd; int connfd;};
其中lisenfd是打开socket时系统函数返回的描述符，在accept客户端请求时会用到；而connfd是调用accept系统函数时返回的文件描述符，也就是实际上的数据通道。
在NetConnection的实现中，实际上在匿名namespace中封装系统调用的函数（包括后面IO操作时对系统调用的封装），摘取自《深入理解计算机系统》这本书。
// NetConnection.cppnamespace{const int LISTENQ = 1024;void unix_error(char *msg) /* unix-style error */{ fprintf(stderr, "%s: %s\n", msg, strerror(errno)); exit(0);}int open_listenfd(int port){ int listenfd, optval = 1; struct sockaddr_in serveraddr; /* Create a socket descriptor */ if ((listenfd = socket(AF_INET, SOCK_STREAM, 0)) < 0) return -1; /* Eliminates "Address already in use" error from bind. */ if (setsockopt(listenfd, SOL_SOCKET, SO_REUSEADDR, (const void *) &optval, sizeof(int)) < 0) return -1; /* Listenfd will be an endpoint for all requests to port on any IP address for this host */ bzero((char *) &serveraddr, sizeof(serveraddr)); serveraddr.sin_family = AF_INET; serveraddr.sin_addr.s_addr = htonl(INADDR_ANY); serveraddr.sin_port = htons((unsigned short) port); if (bind(listenfd, (sockaddr *) &serveraddr, sizeof(serveraddr)) < 0) return -1; /* Make it a listening socket ready to accept connection requests */ if (listen(listenfd, LISTENQ) < 0) return -1; return listenfd;}int Open_listenfd(int port){ int rc; if ((rc = open_listenfd(port)) < 0) unix_error("Open_listenfd error"); return rc;}int Accept(int s, struct sockaddr *addr, socklen_t *addrlen){ int rc; if ((rc = accept(s, addr, addrlen)) < 0) unix_error("Accept error"); return rc;}void Close(int fd){ int rc; if ((rc = close(fd)) < 0) unix_error("Close error");}}NetConnection::NetConnection() : lisenfd(-1), connfd(-1){}void NetConnection::lisen(int port){ lisenfd = Open_listenfd(port);}int NetConnection::accept(){ int clientlen; struct sockaddr_in clientaddr; clientlen = sizeof(clientaddr); connfd = Accept(lisenfd, (sockaddr *) &clientaddr, reinterpret_cast<socklen_t*>(&clientlen)); return connfd;}void NetConnection::close(){ Close(connfd);}
IoReader
IoReader类和后面的IoWriter类实际上是封装了底层的IO操作，为业务提供更简单的接口。
// IoReader.hclass IoReader{public: IoReader(int fd);void getLineSplitedByBlank(std::vector<std::string>& buf);};
这个类中，只对外提供了一个接口，用于读取http请求的报头。这个接口从accept函数返回的文件描述符中（实际就是客户端传过来的数据）读取一行，并使用“ ”分隔成多个字符串后返回。这个实际上就是对http请求报头的解析。一个请求报头，第一行可能是这样的：
GET / HTTP/1.1
包含三部分，方法名，请求的uri和协议版本号，它们之间使用“ ”分隔。当然，一个真正的GET请求后面还有若干行，但是对于我们这个简单的服务器来说，只有第一行是需要的，其他行都简单的忽略了。如果一个uri为 “/”,则说明是要返回主页，我们这里写死了为Index.html，实际上应该做成可配置，这个留作后面再改吧。
所以，getLineSplitedByBlank这个方法，就是把已经分隔好的字符串容器返回了。
//IoReader.cppnamespace{const int MAX_LENGTH = 8192;struct rio_t{ int rio_fd; /* descriptor for this internal buf */ int rio_cnt; /* unread bytes in internal buf */ char *rio_bufptr; /* next unread byte in internal buf */ char rio_buf[MAX_LENGTH]; /* internal buffer */};void unix_error(char *msg) /* unix-style error */{ fprintf(stderr, "%s: %s\n", msg, strerror(errno)); exit(0);}void rio_readinitb(rio_t *rp, int fd){ rp->rio_fd = fd; rp->rio_cnt = 0; rp->rio_bufptr = rp->rio_buf;}void Rio_readinitb(rio_t *rp, int fd){ rio_readinitb(rp, fd);}static ssize_t rio_read(rio_t *rp, char *usrbuf, size_t n){ int cnt; while (rp->rio_cnt <= 0) { /* refill if buf is empty */ rp->rio_cnt = read(rp->rio_fd, rp->rio_buf, sizeof(rp->rio_buf)); if (rp->rio_cnt < 0) { if (errno != EINTR) /* interrupted by sig handler return */ return -1; } else if (rp->rio_cnt == 0) /* EOF */ return 0; else rp->rio_bufptr = rp->rio_buf; /* reset buffer ptr */ } /* Copy min(n, rp->rio_cnt) bytes from internal buf to user buf */ cnt = n; if (rp->rio_cnt < n) cnt = rp->rio_cnt; memcpy(usrbuf, rp->rio_bufptr, cnt); rp->rio_bufptr += cnt; rp->rio_cnt -= cnt; return cnt;}ssize_t rio_readlineb(rio_t *rp, void *usrbuf, size_t maxlen){ int n, rc; char c, *bufp = reinterpret_cast<char*>(usrbuf); for (n = 1; n < maxlen; n++) { if ((rc = rio_read(rp, &c, 1)) == 1) { *bufp++ = c; if (c == ‘\n‘) break; } else if (rc == 0) { if (n == 1) return 0; /* EOF, no data read */ else break; /* EOF, some data was read */ } else return -1; /* error */ } *bufp = 0; return n;}ssize_t Rio_readlineb(rio_t *rp, void *usrbuf, size_t maxlen){ ssize_t rc; if ((rc = rio_readlineb(rp, usrbuf, maxlen)) < 0) unix_error("Rio_readlineb error"); return rc;}rio_t rio;}IoReader::IoReader(int fd){ Rio_readinitb(&rio, fd);}void IoReader::getLineSplitedByBlank(std::vector<std::string>& buf){ char innerBuf[MAX_LENGTH], method[MAX_LENGTH], uri[MAX_LENGTH], version[MAX_LENGTH]; Rio_readlineb(&rio, innerBuf, MAX_LENGTH); sscanf(innerBuf, "%s %s %s", method, uri, version); buf.push_back(method); buf.push_back(uri); buf.push_back(version);}
这里面，匿名namespace里面的函数，也是取自《深入理解计算机系统》那本书，而且几个地方还引入了重复代码，目前这样做只是为了快速实现而已，这也是我想要重构的地方。不过研究了半天还是没有完全搞清楚怎样将C++标准库中的IO流绑定在一个操作系统的文件描述符上面（当然，C的库函数很容易做到这一点），我想应该是有方法的，可惜我不熟悉这里。虽然我是靠C++吃饭的，也是做的所谓“嵌入式”系统，不过对于那种比较大型的通信软件，像我这种做业务层的，甚至不直接和操作系统打交道，也不会使用标准库，因为其他部门的同事会提供一个平台层。所以我对于这些操作并不是很了解。
IoWriter
这个类与IoReader对应，是封装底层IO写操作的，实际上就是向客户端发送数据。当解析出客户端想要访问的uri后，这里就会将相应的文件发送回去，这后浏览器解析这个文件，我们就能看到网页了。
// IoWriter.hclass IoWriter{public: IoWriter(int fd); void writeString(const std::string& str); void writeFile(const std::string& fileName, int filesSize);private: int fileDescriptor;};
这个类提供了两个接口writeString 是写入一个字符串，主要是用于发送响应报头的，writeFile就是真正的把客户端想要的文件返回。
我们看一个应答报头的例子：
HTTP/1.0 200 OKServer: Tiny Web ServerContent-length: 120Content-type: text/html第一行的 200 就是返回成功，当然HTTP的返回码大家都很熟悉，比如200是成功，404是找不到文件，403是操作权限不足等等，这里不多说了。第二行是服务器类型，我们这里当然就是TinyWS,后面两行是待返回文件的大小和类型。返回报头之后，再调用writeFile方法，返回真正的文件。
// IOWriter.cpp
namespace{void unix_error(char *msg) /* unix-style error */{ fprintf(stderr, "%s: %s\n", msg, strerror(errno)); exit(0);}ssize_t rio_writen(int fd, void *usrbuf, size_t n){ size_t nleft = n; ssize_t nwritten; char *bufp = reinterpret_cast<char*>(usrbuf); while (nleft > 0) { if ((nwritten = write(fd, bufp, nleft)) <= 0) { if (errno == EINTR) /* interrupted by sig handler return */ nwritten = 0; /* and call write() again */ else return -1; /* errorno set by write() */ } nleft -= nwritten; bufp += nwritten; } return n;}void Rio_writen(int fd, void *usrbuf, size_t n){ if (rio_writen(fd, usrbuf, n) != n) unix_error("Rio_writen error");}int Open(const char *pathname, int flags, mode_t mode){ int rc; if ((rc = open(pathname, flags, mode)) < 0) unix_error("Open error"); return rc;}void Close(int fd){ int rc; if ((rc = close(fd)) < 0) unix_error("Close error");}void* Mmap(void *addr, size_t len, int prot, int flags, int fd, off_t offset){ void *ptr; if ((ptr = mmap(addr, len, prot, flags, fd, offset)) == ((void *) -1)) unix_error("mmap error"); return (ptr);}void Munmap(void *start, size_t length){ if (munmap(start, length) < 0) unix_error("munmap error");}}IoWriter::IoWriter(int fd) : fileDescriptor(fd){}void IoWriter::writeString(const std::string& str){ Rio_writen(fileDescriptor, const_cast<char*>(str.c_str()), str.length());}void IoWriter::writeFile(const std::string& fileName, int filesSize){ int srcfd; char *srcp; srcfd = Open(const_cast<char*>(fileName.c_str()), O_RDONLY, 0); srcp = reinterpret_cast<char*>(Mmap(0, filesSize, PROT_READ, MAP_PRIVATE, srcfd, 0)); Close(srcfd); Rio_writen(fileDescriptor, srcp, filesSize); Munmap(srcp, filesSize);}
这个实现我也非常不喜欢，由于使用了那本经典书中的代码，和前面产生了很多重复。留作后面重构吧
现在，TinyWS已经基本介绍完了，我们在看一下主函数：
// Tiny.cppnamespace{int getPortFromCommandLine(char **argv){ return atoi(argv[1]);}int getDefalutPort(){ return 8080;}int getStartPort(int argc, char **argv){ if (argc == 2) return getPortFromCommandLine(argv); else return getDefalutPort();}}int main(int argc, char **argv){ NetConnection connection; connection.lisen(getStartPort(argc, argv)); while (1) { int connfd = connection.accept(); RequestManager(connfd).run(); connection.close(); }}
匿名namespace中的函数，是为了获取监听端口的，如果用户启动服务时在命令行中输入了端口，则使用用户提供的端口，否则就使用默认的8080端口，当然，这个默认值最好也应该出现在配置文件中。之所以没有选择80端口，是因为我的机器上装了apache，已经监听了80端口，否则大可不必如此，还要每次测试还要输入端口号。
测试
在代码目录中有一个我写的用于测试的一组html页面（包括html文件，图片，还有一个CSS文件），就目前存放的位置来说，如果使用eclipse倒入了这个工程，运行其TinyWS后，就可以使用http://127.0.0.1:8080/访问到它的主页。
这是一个关于蜂鸟的一组页面，其实是帮老婆写的一个作业。老婆一边工作还要一边在某高校念教育学硕士，这个专业有一门似乎是“远程教育”的课程，还让学生都要写一组html页面，确实有点过分了，不过也只好我代劳了。我做页面的水平很初级，所以页面本身很难看，对于测试静态页面倒也够用了。这中间还发现一个问题，就是经常浏览器（我使用firefox）解析之后，CSS中定义好的格式就没有了，可能刷新几次就又恢复了，目前还没仔细研究是怎么一回事。
后记
整个TinyWS中有很多可以优化和重构的地方，留作后面重构吧。同时哪位朋友知道如何将C++标准库的IO流绑定到文件描述符上，也请不吝赐教。
我在处理IO操作的地方，使用了《深入理解计算机系统》这本书里的示例代码，这本书是很不错的，几乎讲了计算机系统的方方面面，可惜我总是在前几章不断徘徊，后面的内容只是偶尔翻过，但是还记得有讲IO的网络的章节。在这本书讲网络的那章，也有一个WEB服务器的例子，是用C语言写的，区区200多行代码，实现的功能基本和我这里相同。
我这里的TinyWS,自认为也是使用“OO”的方法实现的（当然我的设计水平很烂），还不自觉的用了几个“设计模式”（还计划用设计模式改造一下response和IO操作），但看了那个C语言的例子后，我在想，如果使用OO的方法，如何才有那样简洁的实现呢？在有些时候，OO可能真的会将简单的问题复杂化。（当然，那个C语言例子的风格我并不喜欢，从命名到程序结构应该都可以做的更好，但是那份简洁真的打动了我）。
也许没有一种方法在任何时候都是合适的，才是真理吧。
最后这段也许会引起“宗教情结”一样的争论的，还好此文的读者也不会太多。
TinyWS —— 一个C++写的简易WEB服务器(三)