cinatra

# cinatra--一个高效易用的c++ http框架

English | 中文

| OS (Compiler Version) | Status | |------------------------------------------------|----------------------------------------------------------------------------------------------------------| | Ubuntu 22.04 (clang 14.0.0) | | | Ubuntu 22.04 (gcc 11.2.0) | | | macOS Monterey 12 (AppleClang 14.0.0.14000029) | | | Windows Server 2022 (MSVC 19.33.31630.0) | | # 目录 ## [使用cinatra常见问题汇总(FAQ)](https://github.com/qicosmos/cinatra/wiki) [基于C++20 协程的http库](lang/coroutine_based_http_lib.md) * [cinatra简介](#cinatra简介) * [如何使用](#如何使用) * [快速示例](#快速示例) * [性能测试](#性能测试) * [注意事项](#注意事项) * [roadmap](#roadmap) * [联系方式](#联系方式) # cinatra简介 [cinatra](https://github.com/qicosmos/cinatra)是一个高性能易用的http框架，它是用modern c++(c++20)开发的，它的目标是提供一个快速开发的c++ http框架。它的主要特点如下： 1. 统一而简单的接口 2. header-only 3. 跨平台 4. 高效 5. 支持面向切面编程 cinatra目前支持了http1.1/1.0, ssl和websocket, 你可以用它轻易地开发一个http服务器，比如常见的数据库访问服务器、文件上传下载服务器、实时消息推送服务器，你也可以基于cinatra开发一个mqtt服务器。 cinatra是世界上性能最好的http服务器之一，性能测试详见[性能测试](#性能测试) 除此之外，cinatra 还提供了一个基于C++20 协程的http(https) client，包括普通get/post请求、文件上传下载和web socket、redirect、proxy等功能。 ## 谁在用cinatra cinatra目前被很多公司在使用，在这里可以看到[谁在用cinatra](https://github.com/qicosmos/cinatra/wiki/%E8%B0%81%E5%9C%A8%E7%94%A8cinatra). # 如何使用 ## 编译器版本 1. C++20 编译器 (gcc 10.2, clang 13, Visual Studio 2022,或者更高的版本) ## 使用 cinatra是header-only的，引用include头文件目录，并设置如下编译选项： 如果 linux， 设置: set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread -std=c++20") 如果 g++ 编译，再设置： set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fcoroutines") set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -fno-tree-slp-vectorize") ## cinatra指令集功能使用 cinatra支持通过指令集优化其内部逻辑，其通过宏来控制是否使用指令集。使用之前请确保cpu支持。 使用如下命令即可编译带simd优化的cinatra。注意只能开启一种simd指令集优化,开启多个会导致编译失败。 ```shell cmake -DENABLE_SIMD=SSE42 .. # 启用sse4.2指令集 cmake -DENABLE_SIMD=AVX2 .. # 启用avx2指令集 cmake -DENABLE_SIMD=AARCH64 .. # arm环境下,启用neon指令集 ``` # 快速示例 ## 示例1：一个简单的hello world ```c++ #include "include/cinatra.hpp" using namespace cinatra; int main() { int max_thread_num = std::thread::hardware_concurrency(); coro_http_server server(max_thread_num, 8080); server.set_http_handler("/", [](coro_http_request& req, coro_http_response& res) { res.set_status_and_content(status_type::ok, "hello world"); }); server.sync_start(); return 0; } ``` 5行代码就可以实现一个简单http服务器了，用户不需要关注多少细节，直接写业务逻辑就行了。 ## 示例2：基本用法 ``` … ``` ## 示例3：面向切面的http服务器 ``` … ``` 本例中有两个切面，一个校验http请求的切面，一个是日志切面，这个切面用户可以根据需求任意增加。本例会先检查http请求的合法性，如果不合法就会返回bad request，合法就会进入下一个切面，即日志切面，日志切面会打印出一个before表示进入业务逻辑之前的处理，业务逻辑完成之后会打印after表示业务逻辑结束之后的处理。 ## 示例4：文件上传、下载、websocket 见[example中的例子](example/main.cpp) ## 示例5：RESTful服务端路径参数设置 本代码演示如何使用RESTful路径参数。下面设置了两个RESTful API。第一个API当访问，比如访问这样的url`http://127.0.0.1:8080/numbers/1234/test/5678`时服务器可以获取到1234和5678这两个参数，第一个RESTful API的参数是`(\d+)`是一个正则表达式表明只能参数只能为数字。获取第一个参数的代码是`req.matches_[1]`。因为每一个req不同所以每一个匹配到的参数都放在`request`结构体中。 同时还支持任意字符的RESTful API，即示例的第二种RESTful API`"/string/:id/test/:name"`，要获取到对应的参数使用`req.params_`即可，其参数只能为注册的变量(如果不为依然运行但是有报错)，例子中参数名是id和name，要获取id参数调用`req.params_["id"]`即可。示例代码运行后，当访问`http://127.0.0.1:8080/string/params_1/test/api_test`时，浏览器会返回`api_test`字符串。 #include "cinatra.hpp" using namespace cinatra; int main() { int max_thread_num = std::thread::hardware_concurrency(); coro_http_server server(max_thread_num, 8080); server.set_http_handler( R"(/numbers/(\d+)/test/(\d+))", [](request &req, response &res) { std::cout << " matches[1] is : " << req.matches_[1] << " matches[2] is: " << req.matches_[2] << std::endl; res.set_status_and_content(status_type::ok, "hello world"); }); server.set_http_handler( "/string/:id/test/:name", [](request &req, response &res) { std::string id = req.params_["id"]; std::cout << "id value is: " << id << std::endl; std::cout << "name value is: " << req.params_["name"] << std::endl; res.set_status_and_content(status_type::ok, req.params_["name"]); }); server.sync_start(); return 0; } ## 示例6: 限流功能 需要先声明限速器，限速器支持协程和普通函数。共六个外部接口。 见[限流器详细说明](lang/rate_limiter_cn.md) [rate rlimiter-english_version](lang/english/rate_limiter_en.md) ``` … ``` ## 反向代理 cinatra 支持反向代理也很简单，3步5行代码就可以了。 先看一个简单的例子： ```c++ reverse_proxy proxy_rr(10, 8091); proxy_rr.add_dest_host("127.0.0.1:9001"); proxy_rr.add_dest_host("127.0.0.1:9002"); proxy_rr.add_dest_host("127.0.0.1:9003"); proxy_rr.start_reverse_proxy("/rr", true, coro_io::load_blance_algorithm::RR); ``` 第一步创建一个代理服务器，设置其线程数和端口； 第二步添加需要访问的服务器列表； 第三步启动代理服务，设置loadbalance 策略，这里选择的是round robin 策略。 在浏览器或者client里访问http://127.0.0.1:8091/rr 就会根据RR 策略选择三个服务器中的一个。 如果要选择random 策略就设置为coro_io::load_blance_algorithm::random。 如果要选择weight round robin 策略，就需要设置服务器权重。 ```c++ reverse_proxy proxy_wrr(10, 8090); proxy_wrr.add_dest_host("127.0.0.1:9001", 10); proxy_wrr.add_dest_host("127.0.0.1:9002", 5); proxy_wrr.add_dest_host("127.0.0.1:9003", 5); proxy_wrr.start_reverse_proxy("/wrr", true, coro_io::load_blance_algorithm::WRR); ``` 在浏览器或者client里访问http://127.0.0.1:8090/wrr ，第一次和第二次会返回9001服务器的结果，第三次返回9002服务器的结果，第四次返回9003服务器的结果，第五次又重新返回9001服务器的结果，这就是WRR的策略。 ## cinatra客户端使用 [使用文档](lang/coro_http_client_introduction.md) ### sync_send get/post message ``` … ``` ### async get/post message ``` … ``` ### upload(multipart) file ``` … ``` ``` async_simple::coro::Lazy test_upload() { std::string uri = "http://127.0.0.1:9001/form_data"; coro_http_client client{}; client.add_str_part("hello", "coro_http_client"); client.add_file_part("test", "yourfile.jpg"); result = co_await client.async_upload_multipart(uri); print(result.status); std::cout << "upload finished\n"; } ``` ### download file(ranges and chunked) ``` async_simple::coro::Lazy test_download() { coro_http_client client{}; std::string uri = "http://www.httpwatch.com/httpgallery/chunked/chunkedimage.aspx"; std::string filename = "test.jpg"; std::error_code ec{}; std::filesystem::remove(filename, ec); auto r = co_await client.async_download(uri, filename); assert(!r.net_err); assert(r.status == 200); std::cout << "download finished\n"; } ``` ### chunked request and SSE 普通字符串请求体如果希望用chunked 方式发送，可以使用`async_post_chunked` 或者`async_request_chunked`；文件、iostream 或自定义异步数据源仍然使用`async_upload_chunked`。 ```c++ async_simple::coro::Lazy test_chunked_request() { coro_http_client client{}; auto result = co_await client.async_post_chunked( "http://127.0.0.1:9001/chunked", "hello chunked string"); assert(result.status == 200); } ``` SSE(Server-Sent Events) 基于`text/event-stream`，cinatra 的SSE 实现复用chunked 传输。服务端通过`begin_sse`、`write_sse_event`、`end_sse` 写事件流，客户端通过`async_get_sse` 读取解析后的`sse_event`。 ``` … ``` ### web socket ``` … ``` ## 基于cinatra客户端的http/https压测工具使用 cinatra提供了一个高性能的http1.1 压测工具, 它是基于coro_http_client 实现的，内部通过多线程和协程实现了高效的压测，能够在单核或多核cpu上发送大量请求以此来测试服务器性能。 ### 基础使用 ```shell ./cinatra_press_tool -t 4 -c 40 -d 30s http://127.0.0.1 ``` 上面的命令代表使用4个线程并且保持40个连接打开(协程)对网址`http://127.0.0.1`进行30s的基准测试。 输出如下: ``` Running 30s test @ http://127.0.0.1 4 threads and 40 connections Thread Status Avg Max Variation Stdev Latency 4.12ms 8.15ms 3.367ms 1.835ms 462716 requests in 30.001s, 592.198250MB read, total: 462716, errors: 0 Requests/sec: 15423.86666667 Transfer/sec: 19.739390MB ``` ### 命令行参数选项 ``` … ``` 这里有两个参数与wrk不同 `-H`参数，它表示添加http头到http请求中，该参数不止可以添加一个http头还可以以` && `符号(4个字符)为分隔符来组装多个http头到http请求。 比如`-H User-Agent: coro_http_press`就是添加一个http头，而`-H User-Agent: coro_http_press && x-frame-options: SAMEORIGIN`则为添加`User-Agent: coro_http_press`和`x-frame-options: SAMEORIGIN`两个http头到http请求。添加三个以及多个http头的方法和上述方法相同。 `-r`参数，它表示是否读固定长度的response，这个参数可以避免频繁的解析response优化性能，有些服务器对于相同的请求返回的长度可能不同，这种情况下不设置这个参数或者将它设置为0。 # 性能测试 ## 测试用例： # 注意事项 websocket的业务函数是会多次进入的，因此写业务逻辑的时候需要注意，推荐按照示例中的方式去做。 # deps cinatra depends on asio and async_simple. press_tool depends on cinatra and cmdline. # submodule A submodule of cinatra is iguana. When you want to use this submodule, using the command `git submodule init` will pull the iguana library. If you want to use the latest iguana, please use the command `git submodule update --remote`. # 联系方式 [email protected] 线上讨论：[项目讨论](https://purecpp.cn/chatroom.html) [http://purecpp.cn/](http://purecpp.cn/ "purecpp") [https://github.com/qicosmos/cinatra](https://github.com/qicosmos/cinatra "cinatra") [https://gitcode.com/qicosmos/cinatra](https://gitcode.com/qicosmos/cinatra "cinatra")