C++開發網路通信程式時用asio是個不錯的選擇，但asio本身是一套函式集，自己還要處理諸如“通信執行緒池管理、連接及生命周期管理、多執行緒收發資料的同步保護等”。因此這里對asio進行了一層封裝，大大簡化了對asio的使用。代碼使用了C++17相關功能，所以只能用在C++17以上。
其中http和websocket部分用的是boost::beast，因此如果需要用到http或websocket的功能，則必須使用boost庫，如果用不到http則直接使用獨立的asio即可。在config.hpp中通過對ASIO_STANDALONE這個宏定義的開關，即可設定是使用boost::asio還是使用asio standalone.
代碼大量使用了CRTP模板編程實作(沒有使用virtual而用CRTP實作的靜態多型)，因此編譯比較耗時，但執行效率相對較好一點。（以前的v1.x版本由于設計上的原因，導致存在一些不好解決且非常不優雅的問題，因此這次統一改成模板以及其它的一些思路來實作了）
github地址：https://github.com/zhllxt/asio2
碼云地址：https://gitee.com/zhllxt/asio2
A open source cross-platform c++ library for network programming based on asio,support for tcp,udp,http,rpc,ssl and so on.
? 支持TCP,UDP,HTTP,WEBSOCKET,RPC,ICMP,SERIAL_PORT等;
? 支持可靠UDP(基于KCP),支持SSL,支持從記憶體字串加載SSL證書;
? TCP支持資料拆包功能(按指定的分隔符對資料自動進行拆包,保證用戶收到的資料是一個完整的資料包);實作了TCP的資料報模式(類似WEBSOCKET);
? 支持windows,linux,32位,64位;
? 依賴asio(boost::asio或獨立asio均可,若需要HTTP功能必須使用boost::asio),依賴C++17;
? 代碼采用hpp頭檔案方式,以原始碼級鏈入,無需編譯,只需在工程的Include包含目錄中添加asio2路徑,然后在原始碼中#include <asio2/asio2.hpp>包含頭檔案即可;
? demo目錄包含大量的示例工程(工程基于VS2017創建),各種使用方法請參考示例代碼;
TCP:
服務端:
asio2::tcp_server server;
server.bind_recv([&server](std::shared_ptr<asio2::tcp_session> & session_ptr, std::string_view s)
{
session_ptr->no_delay(true);
printf("recv : %u %.*s\n", (unsigned)s.size(), (int)s.size(), s.data());
// 異步發送(所有發送操作都是異步且執行緒安全的)
session_ptr->send(s);
// 發送時指定一個回呼函式,當發送完成后會呼叫此回呼函式,bytes_sent表示實際發送的位元組數,
// 發送是否有錯誤可以用asio2::get_last_error()函式來獲取錯誤碼
// session_ptr->send(s, [](std::size_t bytes_sent) {});
}).bind_connect([&server](auto & session_ptr)
{
printf("client enter : %s %u %s %u\n",
session_ptr->remote_address().c_str(), session_ptr->remote_port(),
session_ptr->local_address().c_str(), session_ptr->local_port());
// 可以用session_ptr這個會話啟動一個定時器,這個定時器是在這個session_ptr會話的資料收
// 發執行緒中執行的,這對于連接狀態的判斷或其它需求很有用(尤其在UDP這種無連接的協議中,有
// 時需要在資料處理程序中使用一個定時器來延時做某些操作,而且這個定時器還需要和資料處理
// 在同一個執行緒中安全觸發)
//session_ptr->start_timer(1, std::chrono::seconds(1), []() {});
}).bind_disconnect([&server](auto & session_ptr)
{
printf("client leave : %s %u %s\n",
session_ptr->remote_address().c_str(),
session_ptr->remote_port(), asio2::last_error_msg().c_str());
});
server.start("0.0.0.0", "8080");
//server.start("0.0.0.0", "8080", '\n'); // 按\n自動拆包(可以指定任意字符)
//server.start("0.0.0.0", "8080", "\r\n"); // 按\r\n自動拆包(可以指定任意字串)
//server.start("0.0.0.0", "8080", match_role('#')); // 按match_role指定的規則自動拆包(match_role請參考demo代碼)(用于對用戶自定義的協議拆包)
//server.start("0.0.0.0", "8080", asio::transfer_exactly(100)); // 每次接收固定的100位元組
//server.start("0.0.0.0", "8080", asio2::use_dgram); // 資料報模式的TCP,無論發送多長的資料,雙方接收的一定是相應長度的整包資料
客戶端:
asio2::tcp_client client;
client.bind_connect([&](asio::error_code ec)
{
if (asio2::get_last_error())
printf("connect failure : %d %s\n", asio2::last_error_val(), asio2::last_error_msg().c_str());
else
printf("connect success : %s %u\n", client.local_address().c_str(), client.local_port());
client.send("<abcdefghijklmnopqrstovuxyz0123456789>");
}).bind_disconnect([](asio::error_code ec)
{
printf("disconnect : %d %s\n", asio2::last_error_val(), asio2::last_error_msg().c_str());
}).bind_recv([&](std::string_view sv)
{
printf("recv : %u %.*s\n", (unsigned)sv.size(), (int)sv.size(), sv.data());
client.send(sv);
})
//.bind_recv(on_recv) // 系結全域函式
//.bind_recv(std::bind(&listener::on_recv, &lis, std::placeholders::_1)) // 系結成員函式(具體請查看demo代碼)
//.bind_recv(&listener::on_recv, lis) // 按lis物件的參考來系結成員函式(具體請查看demo代碼)
//.bind_recv(&listener::on_recv, &lis) // 按lis物件的指標來系結成員函式(具體請查看demo代碼)
;
client.async_start("0.0.0.0", "8080"); // 異步連接服務端
//client.start("0.0.0.0", "8080"); // 同步連接服務端
//client.async_start("0.0.0.0", "8080", '\n'); // 按\n自動拆包(可以指定任意字符)
//client.async_start("0.0.0.0", "8080", "\r\n"); // 按\r\n自動拆包(可以指定任意字串)
//client.async_start("0.0.0.0", "8080", match_role); // 按match_role指定的規則自動拆包(match_role請參考demo代碼)(用于對用戶自定義的協議拆包)
//client.async_start("0.0.0.0", "8080", asio::transfer_exactly(100)); // 每次接收固定的100位元組
//client.start("0.0.0.0", "8080", asio2::use_dgram); // 資料報模式的TCP,無論發送多長的資料,雙方接收的一定是相應長度的整包資料
UDP:
服務端:
asio2::udp_server server;
// ... 系結監聽器(請查看demo代碼)
server.start("0.0.0.0", "8080"); // 常規UDP
//server.start("0.0.0.0", "8080", asio2::use_kcp); // 可靠UDP
客戶端:
asio2::udp_client client;
// ... 系結監聽器(請查看demo代碼)
client.start("0.0.0.0", "8080");
//client.async_start("0.0.0.0", "8080", asio2::use_kcp); // 可靠UDP
RPC:
服務端:
asio2::rpc_server server;
// ... 系結監聽器(請查看demo代碼)
A a; // A的定義請查看demo代碼
server.bind("add", add); // 系結RPC全域函式
server.bind("mul", &A::mul, a); // 系結RPC成員函式
server.bind("cat", [&](const std::string& a, const std::string& b) { return a + b; }); // 系結lambda運算式
server.bind("get_user", &A::get_user, a); // 系結成員函式(按參考)
server.bind("del_user", &A::del_user, &a); // 系結成員函式(按指標)
//server.start("0.0.0.0", "8080", asio2::use_dgram); // 使用TCP資料報模式作為RPC通信底層支撐,啟動服務端時必須要使用use_dgram引數
server.start("0.0.0.0", "8080"); // 使用websocket作為RPC通信底層支撐(需要到rcp_server.hpp檔案末尾代碼中選擇使用websocket)
客戶端:
asio2::rpc_client client;
// ... 系結監聽器(請查看demo代碼)
//client.start("0.0.0.0", "8080", asio2::use_dgram); // 使用TCP資料報模式作為RPC通信底層支撐,啟動服務端時必須要使用use_dgram引數
client.start("0.0.0.0", "8080"); // 使用websocket作為RPC通信底層支撐
asio::error_code ec;
// 同步呼叫RPC函式
int sum = client.call<int>(ec, std::chrono::seconds(3), "add", 11, 2);
printf("sum : %d err : %d %s\n", sum, ec.value(), ec.message().c_str());
// 異步呼叫RPC函式,第一個引數是回呼函式,當呼叫完成或超時會自動呼叫該回呼函式,如果超時或其它錯誤,
// 錯誤碼保存在ec中,這里async_call沒有指定回傳值型別,則lambda運算式的第二個引數必須要指定型別
client.async_call([](asio::error_code ec, int v)
{
printf("sum : %d err : %d %s\n", v, ec.value(), ec.message().c_str());
}, "add", 10, 20);
// 這里async_call指定了回傳值型別,則lambda運算式的第二個引數可以為auto型別
client.async_call<int>([](asio::error_code ec, auto v)
{
printf("sum : %d err : %d %s\n", v, ec.value(), ec.message().c_str());
}, "add", 12, 21);
// 回傳值為用戶自定義資料型別(user型別的定義請查看demo代碼)
user u = client.call<user>(ec, "get_user");
printf("%s %d ", u.name.c_str(), u.age);
for (auto &[k, v] : u.purview)
{
printf("%d %s ", k, v.c_str());
}
printf("\n");
u.name = "hanmeimei";
u.age = ((int)time(nullptr)) % 100;
u.purview = { {10,"get"},{20,"set"} };
// 如果RPC函式的回傳值為void,則用戶回呼函式只有一個引數即可
client.async_call([](asio::error_code ec)
{
}, "del_user", std::move(u));
由于字數限制，第二頁再續接說明：
uj5u.com熱心網友回復：
HTTP:服務端:
asio2::http_server server;
server.bind_recv([&](std::shared_ptr<asio2::http_session> & session_ptr, http::request<http::string_body>& req)
{
// 在收到http請求時嘗試發送一個檔案到對端
{
// 如果請求是非法的,直接發送錯誤資訊到對端并回傳
if (req.target().empty() ||
req.target()[0] != '/' ||
req.target().find("..") != beast::string_view::npos)
{
session_ptr->send(http::make_response(http::status::bad_request, "Illegal request-target"));
session_ptr->stop(); // 同時直接斷開這個連接
return;
}
// Build the path to the requested file
std::string path(req.target().data(), req.target().size());
path.insert(0, std::filesystem::current_path().string());
if (req.target().back() == '/')
path.append("index.html");
// 打開檔案
beast::error_code ec;
http::file_body::value_type body;
body.open(path.c_str(), beast::file_mode::scan, ec);
// 如果打開檔案失敗,直接發送錯誤資訊到對端并直接回傳
if (ec == beast::errc::no_such_file_or_directory)
{
session_ptr->send(http::make_response(http::status::not_found,
std::string_view{ req.target().data(), req.target().size() }));
return;
}
// Cache the size since we need it after the move
auto const size = body.size();
// 生成一個檔案形式的http回應物件,然后發送給對端
http::response<http::file_body> res{
std::piecewise_construct,
std::make_tuple(std::move(body)),
std::make_tuple(http::status::ok, req.version()) };
res.set(http::field::server, BOOST_BEAST_VERSION_STRING);
res.set(http::field::content_type, http::extension_to_mimetype(path));
res.content_length(size);
res.keep_alive(req.keep_alive());
res.chunked(true);
// Specify a callback function when sending
//session_ptr->send(std::move(res));
session_ptr->send(std::move(res), [&res](std::size_t bytes_sent)
{
auto opened = res.body().is_open(); std::ignore = opened;
auto err = asio2::get_last_error(); std::ignore = err;
});
//session_ptr->send(std::move(res), asio::use_future);
return;
}
std::cout << req << std::endl;
if (true)
{
// 用make_response生成一個http回應物件,狀態碼200表示操作成功,"suceess"是HTTP訊息的body部分內容
auto rep = http::make_response(200, "suceess");
session_ptr->send(rep, []()
{
auto err = asio2::get_last_error(); std::ignore = err;
});
}
else
{
// 也可以直接發送一個http標準回應字串,內部會將這個字串自動轉換為http回應物件再發送出去
std::string_view rep =
"HTTP/1.1 404 Not Found\r\n"\
"Server: Boost.Beast/181\r\n"\
"Content-Length: 7\r\n"\
"\r\n"\
"failure";
// test send string sequence, the string will automatically parsed into a standard http request
session_ptr->send(rep, [](std::size_t bytes_sent)
{
auto err = asio2::get_last_error(); std::ignore = err;
});
}
});
server.start(host, port);
客戶端:
asio2::error_code ec;
auto req1 = http::make_request("http://www.baidu.com/get_user?name=a"); // 通過URL字串生成一個http請求物件
auto req2 = http::make_request("GET / HTTP/1.1\r\nHost: 127.0.0.1:8443\r\n\r\n"); // 通過http協議字串生成一個http請求物件
req2.set(http::field::timeout, 5000); // 給請求設定一個超時時間
auto rep1 = asio2::http_client::execute("http://www.baidu.com/get_user?name=a", ec); // 通過URL字串直接請求某個網址,回傳結果在rep1中,如果有錯誤,錯誤碼保存在ec中
auto rep2 = asio2::http_client::execute("127.0.0.1", "8080", req2); // 通過IP埠以及前面生成的req2請求物件來發送一個http請求
std::cout << rep2 << std::endl; // 顯示http請求結果
std::stringstream ss;
ss << rep2;
std::string result = ss.str(); // 通過這種方式將http請求結果轉換為字串
其它的HTTP使用方式以及WEBSOCKET使用方式請參考demo代碼
ICMP:
class ping_test // 模擬在一個類物件中使用ping組件(其它所有如TCP/UDP/HTTP等組件一樣可以在類物件中使用)
{
asio2::ping ping;
public:
ping_test() : ping(10) // 建構式傳入的10表示只ping 10次后就結束,傳入-1表示一直ping
{
ping.timeout(std::chrono::seconds(3)); // 設定ping超時
ping.interval(std::chrono::seconds(1)); // 設定ping間隔
ping.body("0123456789abcdefghijklmnopqrstovuxyz");
ping.bind_recv(&ping_test::on_recv, this) // 系結當前這個類的成員函式作為監聽器
.bind_start(std::bind(&ping_test::on_start, this, std::placeholders::_1)) // 也是系結成員函式
.bind_stop([this](asio::error_code ec) { this->on_stop(ec); }); // 系結lambda
}
void on_recv(asio2::icmp_rep& rep)
{
if (rep.lag.count() == -1) // 如果延時的值等于-1表示超時了
std::cout << "request timed out" << std::endl;
else
std::cout << rep.total_length() - rep.header_length()
<< " bytes from " << rep.source_address()
<< ": icmp_seq=" << rep.sequence_number()
<< ", ttl=" << rep.time_to_live()
<< ", time=" << std::chrono::duration_cast<std::chrono::milliseconds>(rep.lag).count() << "ms"
<< std::endl;
}
void on_start(asio::error_code ec)
{
printf("start : %d %s\n", asio2::last_error_val(), asio2::last_error_msg().c_str());
}
void on_stop(asio::error_code ec)
{
printf("stop : %d %s\n", asio2::last_error_val(), asio2::last_error_msg().c_str());
}
void run()
{
if (!ping.start("127.0.0.1"))
//if (!ping.start("123.45.67.89"))
//if (!ping.start("stackoverflow.com"))
printf("start failure : %s\n", asio2::last_error_msg().c_str());
while (std::getchar() != '\n');
ping.stop();
// ping結束后可以輸出統計資訊,包括丟包率,平均延時時長等
printf("loss rate : %.0lf%% average time : %lldms\n", ping.plp(),
std::chrono::duration_cast<std::chrono::milliseconds>(ping.avg_lag()).count());
}
};
SSL:
TCP/HTTP/WEBSOCKET均支持SSL功能(需要在config.hpp中將#define ASIO2_USE_SSL宏定義放開)
asio2::tcps_server server;
// 從記憶體字串加載SSL證書(具體請查看demo代碼)
server.set_cert("test", cer, key, dh); // cer,key,dh這三個字串的定義請查看demo代碼
// 從檔案加載SSL證書
//server.set_cert_file("test", "server.crt", "server.key", "dh512.pem");
TCP/HTTP/WEBSOCKET服務端、客戶端等SSL功能請到DEMO代碼中查看。
串口:
請查看demo示例代碼serial port 部分
其它:
定時器
// 框架中提供了定時器功能,使用非常簡單,如下:
asio2::timer timer;
// 引數1表示定時器ID,引數2表示定時器間隔,引數3為定時器回呼函式
timer.start_timer(1, std::chrono::seconds(1), [&]()
{
printf("timer 1\n");
if (true) // 滿足某個條件時關閉定時器,當然也可以在其它任意地方關閉定時器
timer.stop_timer(1);
});
還有其它一些輔助類的功能,請在原始碼或使用中去體會吧.
uj5u.com熱心網友回復：
轉載請註明出處，本文鏈接：https://www.uj5u.com/gongcheng/42150.html
標籤：網絡編程
上一篇：mfc界面呼叫問題
下一篇：vs大學課程設計