ws - web server

一个使用 C++11 编写的基于 Reactor 模式的 Web 服务器，支持 GET/HEAD/POST 请求。支持中间件，支持自定义路由， 可以编写代码来处理指定路径上的请求。支持长链接，支持超时自动断开。另外实现了一个异步的日志模块。

我使用这个服务器来做静态资源服务，使用的内容是我的博客内容：WangYu's Space

示例

在用户接口上我模仿了 express 的设计，重载 use 方法，可以添加中间件、路由。

#include "http/HTTPServer.h"
#include "http/mw/StaticFileMiddleware.h"
#include "log/logging.h"

using namespace ws::http;

int main(int argc, char* argv[]) {
    // 启动异步日志模块，如果不启动，日志会打印到 stdout 上
    // ws::logging::start_async_backend(argv[0]);
    ws::logging::set_level(ws::logging::INFO);

    // 创建一个 http server，用 8 个线程处理请求
    HTTPServer server(8);

    // 添加一个中间件用来处理静态文件
    auto sfm = std::make_shared<StaticFileMiddleware>();
    // 请根据自己的环境修改一下路径
    sfm->add_static_file_dir("/Users/wangyu/code/blog/_site");
    server.use(sfm);

    // 处理 post 请求
    server.use("POST", "/form", [](Request &req, Response &res) {
        res.set_status(200);
        std::string text;
        if(req.is_multipart_form_data() && req.form_data.has("foo")){
            const FormDataItem& item = req.form_data.get("foo");
            text = item.content;
        }else{
            text = "<null>";
        }
        res.write(text);
        res.end();
    });

    // 处理 get 请求 /hello?name=world
    server.use("GET", "/hello", [](Request &req, Response &res) {
        std::string name =  req.query["name"];
        std::string text = "hello " + name;

        res.set_status(200);
        res.write(text);
        res.end();
    });

    // 在 8006 端口上启动 server
    server.listen("0.0.0.0", 8006);
}

编译与运行

项目中使用了 C++11 的语法，可以在 Linux 和 macOS 上运行，我使用的开发环境是 WSL Ubuntu 18.04 和 macOS 10.15。使用 gcc 7.5 和 clang 11 编译。

可以使用下面几行命令即可编译并运行，我是使用 CLion 来开发的。

$ cmake CMakeLists.txt
$ make
$ ./ws

代码行数

-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C++                             31            474            130           2148
C/C++ Header                    28            447            115           1309
Markdown                         1             23              0             69
HTML                             1              9              0             51
CMake                            1              3              0              6
CSS                              1              0              0              3
-------------------------------------------------------------------------------
SUM:                            63            956            245           3586
-------------------------------------------------------------------------------

TODO

• 断开超时未响应连接
• 支持路由的模式匹配，实现例如 /user/:id/home 这样的路由配置。
• 支持 POST 请求的常见格式
• 支持路由配置的模块化
• 在 server 内部再启动一个 server，在别的端口上，用来监控 server 的状态

后记

在看 APUE / UNP / 《Linux多线程服务端编程》 / Linux高性能服务器编程 等书时，写了不少百十行的代码，用来实践书中的内容。后来希望实现一个较大的项目，感觉 HTTP 服务器是不错的选择，于是就动手写了，这里的代码就是我的初步实现。

开始采用了 select + 线程池的模型，主线程 accept 后，把处理请求的任务加入到线程池的任务队列中。 后来尝试基于 Reactor 模式来实现，折腾了几天后，已经可以跑了，但是代码比较混乱，有莫名的 BUG。后来读了陈硕写的 《Linux多线程服务端编程》， 了解了 Reactor 模式中的一些有用的抽象，比如 Channel、EventLoop 等，通读了 muduo 的大部分代码后，对我的代码进行了重构。

写完后发现 Github 上好多 HTTP 服务器，而且代码结构长得都很像 :D。

后来有了一台 Mac Book Pro 我就不想使用原来的 Windows 本了，于是在 Mac 上对 IO 多路复用进行了抽象，在 macOS 上使用 select 实现， 在 Linux 上使用 epoll 实现。这过程中我阅读了 Redis 中的部分代码，借鉴了其思想。