tinyserver C++編寫的輕量服務器框架

該庫為C++編寫的輕量服務器框架，服務器核心采用單進程單線程select實現，后續增加更多的實現方式如libevent，epoll，多線程，多進程。旨在學習服務端編程的方法。內部對http請求從封裝到處理主要參考django的處理方式。

編譯

這里bin目錄下為我在windows/linux下編譯好的簡單服務器，可以直接運行使用，運行后在127.0.0.1:8000可以直接訪問。

編譯流程

cd build
cmake ..
make
./MyWebServer.exe  （或者是./MyWebServer）

使用流程

#include "tinyserver.h"
#include "ejson.h"

using namespace WebServer;
using namespace EasyJson;

void render_string(HttpRequest &request, HttpResponse &response) {
	// 顯示html字符串，可以任意設置response_code
    response.set_header_attribute("key1", "value1") // 自定義header
            .set_header_attribute("key2", "value2")
            .set_response_code(404) // 自定義reponse code
            .set_data(R"(this is a test)");
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000); // 如果沒有參數的話默認端口8888
    server->enrol("/", render_string);
    server->run();
}

• 包含頭文件和名稱空間。
• 編寫響應函數（該函數作為框架的回調函數）
• 初始化HttpServer對象
• 將響應函數注冊到server中
• 進行server事件循環

瀏覽器訪問可以看到如下。

按F12重新刷新可以看到響應Http報文的頭部如下

example

example1: 文件下載

void download_file(HttpRequest &request, HttpResponse &response) {
	// 文件下載
    response.set_file("myfile")
            .set_content_type(STREAM);  
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000);
    server->enrol("/download", download_file);
    server->run();
}    

對response對象調用set_file方法和set_content_type方法，瀏覽器訪問url后會下載對應的文件。

訪問127.0.0.1/download 會自動下載文件然后保存到本地中。如果文件不存在則返回404

example2: 純文本顯示在瀏覽器上

有一些文本我們想讓瀏覽器顯示，而不被當前是html文件(即使你文件中含有html標簽也不會被瀏覽器渲染出來)

void render_plain_text(HttpRequest &request, HttpResponse &response) {
	// 將純文本展示在瀏覽器上
    FILE *f = fopen("myfile", "rb"); 
    char buf[2048];
    size_t r = fread(buf, sizeof(char), 2048, f);
    response.set_data(buf, r)
            .set_content_type(PLAIN);
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000);
    server->enrol("/text", render_plain_text);
    server->run();
}

編譯后訪問頁面可以得到如下

example3: 返回json

這里需要依賴我編寫的json庫ejson?。 可以用來做rest服務

void render_json(HttpRequest &request, HttpResponse &response) {
    // 返回json，可以做rest服務
    JSONObject obj = {
            {"test obj", {"key", "value"}},
            {"int number", 2},
            {"float number", 34.3},
            {"my string", "fsdfsdg"},
            {"nullptr", nullptr},
            {"emptylist", {}},
            {"列表嵌套列表", {1,2.3, "sdf", {1,2.242, "float"}}}, // 列表嵌套
            {"列表嵌套對象和列表", {
                {{"key1", 1234}}, // 被認為是對象
                {"key1", 1234}, // 被認為是列表
                1.23,
                234325
            }},
            {"對象", { // 所有的值都是{key, value}對則認為是嵌套對象
                {"a obj", 1234566},
                {"b obj", "b obj value"},
            }}
    };
    response.set_data(obj.toString(2)) // 將json格式化
            .set_content_type(JSON);
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000);
    server->enrol("/json", render_json);
    server->run();
}

訪問127.0.0.1:8000/json 可以得到一下頁面，這里我將json以2空格縮進打印在瀏覽器頁面上。

example4: url正則表達式匹配

void re_url_test(HttpRequest &request, HttpResponse &response) {
	// 捕抓url正則表達式匹配到的內容。
    auto match = request.get_url_parm(); // 返回一個smatch對象，可以用[]操作符索引匹配結果
    stringstream ss;
    ss << R"()";
    ss << R"(
匹配到的數字為: )" << match[0]; 
    ss << R"(
)";
    ss << "";
    response.set_data(ss.str());
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000);
    server->enrol("/re/(\\d+)", re_url_test);
    server->run();
}

訪問瀏覽器得到的結果如下

example5: 靜態html文件

void render_html(HttpRequest &request, HttpResponse &response) {
    // 根據不同的請求方法返回不同的內容。
    response.set_file("my.html");
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000);
    server->enrol("/hmpl", render_hmpl);
    server->run();
}

只需要調用set_file函數就可以將你的html顯示在瀏覽器上。(可以依此使用正則表達式匹配對應的文件，來做靜態文件服務器)

example6: html模版文件渲染

web開發中經常會用到模版，這是為了響應動態的數據。這里我使用到自己編寫的一個輕量html模板渲染庫cjinja

void render_tmpl(HttpRequest &request, HttpResponse &response) {
	// 將html模版顯示在屏幕上。
    JSONObject context = OBJECT(
            KEYVALUE("username", "hhk"),
            KEYVALUE("obj", OBJECT(
                    KEYVALUE("abcd", LIST(1,2.3, "hahahaha")),
                    KEYVALUE("obj", OBJECT(
                            KEYVALUE("key", "this is obj.obj.key' s value")
                    ))
            )),
            KEYVALUE("null", nullptr),
            KEYVALUE("list", LIST(1, "qwerty", 2.34, OBJECT(
                            KEYVALUE("key", "this is a key"),
                            KEYVALUE("key2", "this is a key2"),
                    ))),
            KEYVALUE("list1", LIST(1,2,3,4,5)),
            KEYVALUE("list2", LIST(1,2,3)),
            KEYVALUE("obj2", OBJECT(
                    KEYVALUE("key1", "value1"),
                    KEYVALUE("key2", 222),
                    KEYVALUE("key3", 333),
            )),
            KEYVALUE("a", "111"),
            KEYVALUE("b", "222"),
            KEYVALUE("c", "333"),
    );
    context.add("parm", request.get_request_parm());
    render(response, "tmpl.html", context);
}

int main() {
    IHttpServer *server = new BaseHttpServer(8000);
    server->enrol("/tmpl", render_tmpl);
    server->run();
}

傳入了一個JSONObject作為模版渲染的數據，在瀏覽器端顯示如下，模版文件為tmpl.html（位于bin目錄下）

瀏覽器渲染的部分結果如下圖所示。

example6: 根據請求的方法做不同的處理

這里使用request.get_method 獲取請求的請求的方法，然后根據不同的請求做不同的處理。

void render_html(HttpRequest &request, HttpResponse &response) {
    // 根據不同的請求方法返回不同的內容。
    if(request.get_method() == GET ) {
        response.set_file("my.html");
    } else if(request.get_method() == POST) {
        response.set_file("my2.html");
    }
}

int main() {
    IHttpServer *server = new BaseHttpServer();
    server->enrol("/html", render_html);
    server->run();
}

TODO

• epoll libevent 版本
• 多進程 多線程版本
• session的處理
• 緩存
• 大文件下載，斷點續傳