CivetWeb嵌入式C++接口开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00561/article/details/148755175

CivetWeb嵌入式C++接口开发指南

civetweb 项目地址: https://gitcode.com/gh_mirrors/civ/civetweb

概述

CivetWeb是一个轻量级的嵌入式Web服务器，提供了C++接口以便开发者快速构建Web应用。本文将通过分析embedded_cpp.cpp示例代码，深入讲解如何使用CivetWeb的C++接口开发Web服务。

环境准备

在使用CivetWeb的C++接口前，需要确保：

已正确安装CivetWeb库
项目中包含了CivetServer.h头文件
链接了CivetWeb的库文件

核心组件解析

CivetServer类

CivetServer是CivetWeb的核心类，负责管理Web服务器的生命周期和请求处理。示例中展示了两种初始化方式：

// C风格初始化
const char *options[] = {"document_root", DOCUMENT_ROOT, "listening_ports", PORT, 0};
CivetServer server(options);

// C++风格初始化
std::vector<std::string> cpp_options;
for (int i=0; i<(sizeof(options)/sizeof(options[0])-1); i++) {
    cpp_options.push_back(options[i]);
}
CivetServer server(cpp_options);

请求处理机制

CivetWeb采用基于处理器的请求处理模型，开发者需要继承CivetHandler类并实现相应的处理方法。

处理器实现详解

基础GET处理器(ExampleHandler)

class ExampleHandler : public CivetHandler {
public:
    bool handleGet(CivetServer *server, struct mg_connection *conn) {
        mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nConnection: close\r\n\r\n");
        // HTML内容生成
        return true;
    }
};

这个处理器展示了：

如何设置HTTP响应头
使用mg_printf输出HTML内容
返回true表示处理成功

带参数处理的处理器(AHandler)

class AHandler : public CivetHandler {
private:
    bool handleAll(const char *method, CivetServer *server, struct mg_connection *conn) {
        std::string s = "";
        if (CivetServer::getParam(conn, "param", s)) {
            // 参数存在时的处理
        } else {
            // 参数不存在时的处理
        }
        return true;
    }
public:
    bool handleGet(CivetServer *server, struct mg_connection *conn) {
        return handleAll("GET", server, conn);
    }
    bool handlePost(CivetServer *server, struct mg_connection *conn) {
        return handleAll("POST", server, conn);
    }
};

这个处理器展示了：

GET和POST方法的统一处理
如何使用getParam获取请求参数
根据请求方法的不同进行差异化响应

文件上传处理器(FooHandler的PUT方法)

bool handlePut(CivetServer *server, struct mg_connection *conn) {
    // 获取请求信息
    const struct mg_request_info *req_info = mg_get_request_info(conn);
    long long tlen = req_info->content_length;
    
    // 打开文件准备写入
    FILE *f = fopen_recursive(buf, "wb");
    
    // 读取并写入文件内容
    while (nlen < tlen) {
        rlen = mg_read(conn, buf, (size_t)rlen);
        wlen = fwrite(buf, 1, (size_t)rlen, f);
        nlen += wlen;
    }
    
    // 根据结果返回响应
    if (fail) {
        mg_printf(conn, "HTTP/1.1 409 Conflict\r\n...");
    } else {
        mg_printf(conn, "HTTP/1.1 201 Created\r\n...");
    }
    return true;
}

这个处理器展示了：

如何处理文件上传(PUT方法)
分块读取请求体内容
文件写入操作
根据操作结果返回不同的HTTP状态码

WebSocket支持

CivetWeb提供了完整的WebSocket支持：

WebSocket页面处理器(WsStartHandler)

class WsStartHandler : public CivetHandler {
public:
    bool handleGet(CivetServer *server, struct mg_connection *conn) {
        mg_printf(conn, "<script>\n");
        mg_printf(conn, "var connection = new WebSocket(...);\n");
        // JavaScript WebSocket客户端代码
        mg_printf(conn, "</script>\n");
        return true;
    }
};

WebSocket处理器(WebSocketHandler)

class WebSocketHandler : public CivetWebSocketHandler {
    virtual bool handleConnection(...) { /* 连接建立时调用 */ }
    virtual void handleReadyState(...) { /* 准备就绪时调用 */ }
    virtual bool handleData(...) { /* 收到数据时调用 */ }
    virtual void handleClose(...) { /* 连接关闭时调用 */ }
};

服务器生命周期管理

示例中展示了完整的服务器生命周期：

int main() {
    // 初始化库
    mg_init_library(0);
    
    // 创建并配置服务器
    CivetServer server(options);
    
    // 添加各种处理器
    server.addHandler(EXAMPLE_URI, h_ex);
    // ...
    
    // 主循环
    while (!exitNow) {
        sleep(1);
    }
    
    // 清理
    mg_exit_library();
    return 0;
}