libhv

English | 中文

libhv

libhv是一个类似于libevent、libev、libuv的跨平台网络库，提供了更简单的接口和更丰富的协议。

✨ 特征

• 跨平台（Linux, Windows, MacOS, Solaris）
• 高性能事件循环（网络IO事件、定时器事件、空闲事件）
• TCP/UDP服务端/客户端/代理
• SSL/TLS加密通信（WITH_OPENSSL or WITH_MBEDTLS）
• HTTP服务端/客户端（https http1/x http2 grpc）
• HTTP文件服务、目录服务、API服务（支持RESTful）
• WebSocket服务端/客户端

⌛️ 构建

见BUILD.md

libhv提供了以下构建方式:

1、通过Makefile:

./configure
make
sudo make install

2、通过cmake:

mkdir build
cd build
cmake ..
cmake --build .

3、通过vcpkg:

vcpkg install libhv

4、通过xmake:

xrepo install libhv

⚡️ 入门与体验

运行脚本./getting_started.sh:

# 下载编译
git clone https://github.com/ithewei/libhv.git
cd libhv
make

# 运行httpd服务
bin/httpd -h
bin/httpd -d
#bin/httpd -c etc/httpd.conf -s restart -d
ps aux | grep httpd

# 文件服务
bin/curl -v localhost:8080

# 目录服务
bin/curl -v localhost:8080/downloads/

# API服务
bin/curl -v localhost:8080/ping
bin/curl -v localhost:8080/echo -d "hello,world!"
bin/curl -v localhost:8080/query?page_no=1\&page_size=10
bin/curl -v localhost:8080/kv   -H "Content-Type:application/x-www-form-urlencoded" -d 'user=admin&pswd=123456'
bin/curl -v localhost:8080/json -H "Content-Type:application/json" -d '{"user":"admin","pswd":"123456"}'
bin/curl -v localhost:8080/form -F "user=admin pswd=123456"
bin/curl -v localhost:8080/upload -F "file=@LICENSE"

bin/curl -v localhost:8080/test -H "Content-Type:application/x-www-form-urlencoded" -d 'bool=1&int=123&float=3.14&string=hello'
bin/curl -v localhost:8080/test -H "Content-Type:application/json" -d '{"bool":true,"int":123,"float":3.14,"string":"hello"}'
bin/curl -v localhost:8080/test -F 'bool=1 int=123 float=3.14 string=hello'
# RESTful API: /group/:group_name/user/:user_id
bin/curl -v -X DELETE localhost:8080/group/test/user/123

HTTP

HTTP服务端

见examples/http_server_test.cpp

golang gin style

#include "HttpServer.h"

int main() {
    HttpService router;
    router.GET("/ping", [](HttpRequest* req, HttpResponse* resp) {
        return resp->String("pong");
    });

    router.GET("/data", [](HttpRequest* req, HttpResponse* resp) {
        static char data[] = "0123456789";
        return resp->Data(data, 10);
    });

    router.GET("/paths", [&router](HttpRequest* req, HttpResponse* resp) {
        return resp->Json(router.Paths());
    });

    router.GET("/get", [](HttpRequest* req, HttpResponse* resp) {
        resp->json["origin"] = req->client_addr.ip;
        resp->json["url"] = req->url;
        resp->json["args"] = req->query_params;
        resp->json["headers"] = req->headers;
        return 200;
    });

    router.POST("/echo", [](HttpRequest* req, HttpResponse* resp) {
        resp->content_type = req->content_type;
        resp->body = req->body;
        return 200;
    });

    http_server_t server;
    server.port = 8080;
    server.service = &router;
    http_server_run(&server);
    return 0;
}

HTTP客户端

见examples/http_client_test.cpp

python requests style

#include "requests.h"

int main() {
    auto resp = requests::get("http://www.example.com");
    if (resp == NULL) {
        printf("request failed!\n");
    } else {
        printf("%s\n", resp->body.c_str());
    }

    resp = requests::post("127.0.0.1:8080/echo", "hello,world!");
    if (resp == NULL) {
        printf("request failed!\n");
    } else {
        printf("%s\n", resp->body.c_str());
    }

    return 0;
}

js axios style

#include "axios.h"

int main() {
    const char* strReq = R"({
        "method": "POST",
        "url": "http://127.0.0.1:8080/echo",
        "params": {
            "page_no": "1",
            "page_size": "10"
        },
        "headers": {
            "Content-Type": "application/json"
        },
        "body": {
            "app_id": "123456",
            "app_secret": "abcdefg"
        }
    })";

    // sync
    auto resp = axios::axios(strReq);
    if (resp == NULL) {
        printf("request failed!\n");
    } else {
        printf("%s\n", resp->body.c_str());
    }

    // async
    int finished = 0;
    axios::axios(strReq, [&finished](const HttpResponsePtr& resp) {
        if (resp == NULL) {
            printf("request failed!\n");
        } else {
            printf("%s\n", resp->body.c_str());
        }
        finished = 1;
    });

    // wait async finished
    while (!finished) hv_sleep(1);
    return 0;
}

HTTP压测

# sudo apt install wrk
wrk -c 100 -t 4 -d 10s http://127.0.0.1:8080/

# sudo apt install apache2-utils
ab -c 100 -n 100000 http://127.0.0.1:8080/

libhv(port:8080) vs nginx(port:80)

🍭 示例

c版本

• 事件循环: examples/hloop_test.c
• TCP回显服务: examples/tcp_echo_server.c
• TCP聊天服务: examples/tcp_chat_server.c
• TCP代理服务: examples/tcp_proxy_server.c
• UDP回显服务: examples/udp_echo_server.c
• UDP代理服务: examples/udp_proxy_server.c

c++版本

• 事件循环: evpp/EventLoop_test.cpp
• 事件循环线程: evpp/EventLoopThread_test.cpp
• 事件循环线程池: evpp/EventLoopThreadPool_test.cpp
• TCP服务端: evpp/TcpServer_test.cpp
• TCP客户端: evpp/TcpClient_test.cpp
• UDP服务端: evpp/UdpServer_test.cpp
• UDP客户端: evpp/UdpClient_test.cpp
• HTTP服务端: examples/http_server_test.cpp
• HTTP客户端: examples/http_client_test.cpp
• WebSocket服务端: examples/websocket_server_test.cpp
• WebSocket客户端: examples/websocket_client_test.cpp

模拟实现著名的命令行工具

• 网络连接工具: examples/nc
• 网络扫描工具: examples/nmap
• HTTP服务程序: examples/httpd
• URL请求工具: examples/curl
• 文件下载工具: examples/wget
• 服务注册与发现: examples/consul

🥇 性能测试

cd echo-servers
./build.sh
./benchmark.sh

吞吐量:

libevent running on port 2001
libev running on port 2002
libuv running on port 2003
libhv running on port 2004
asio running on port 2005
poco running on port 2006

==============2001=====================================
[127.0.0.1:2001] 4 threads 1000 connections run 10s
total readcount=1616761 readbytes=1655563264
throughput = 157 MB/s

==============2002=====================================
[127.0.0.1:2002] 4 threads 1000 connections run 10s
total readcount=2153171 readbytes=2204847104
throughput = 210 MB/s

==============2003=====================================
[127.0.0.1:2003] 4 threads 1000 connections run 10s
total readcount=1599727 readbytes=1638120448
throughput = 156 MB/s

==============2004=====================================
[127.0.0.1:2004] 4 threads 1000 connections run 10s
total readcount=2202271 readbytes=2255125504
throughput = 215 MB/s

==============2005=====================================
[127.0.0.1:2005] 4 threads 1000 connections run 10s
total readcount=1354230 readbytes=1386731520
throughput = 132 MB/s

==============2006=====================================
[127.0.0.1:2006] 4 threads 1000 connections run 10s
total readcount=1699652 readbytes=1740443648
throughput = 165 MB/s

📚 中文资料

• libhv 教程: https://hewei.blog.csdn.net/article/details/113733758
• libhv QQ群: 739352073，欢迎加群交流

💎 用户案例

如果您在使用libhv，欢迎通过PR将信息提交至此列表，让更多的用户了解libhv的实际使用场景，以建立更好的网络生态。

用户 (公司名/项目名/个人联系方式)	案例 (项目简介/业务场景)
阅面科技	猎户AIoT平台设备管理、人脸检测HTTP服务、人脸搜索HTTP服务
socks5-libhv	socks5代理
hvloop	类似uvloop的python异步IO事件循环