基于 C++11 的 Boost.Asio 构建的 HTTP 和 WebSocket

分支	Linux / Windows	覆盖率	文档	矩阵
master
develop

简介

Beast 是一个 C++ 仅头文件库，作为编写可互操作网络库的基础，通过使用 Boost.Asio 一致的异步模型提供低级 HTTP/1、WebSocket 和网络协议词汇类型和算法。

该库设计用于：

对称性： 算法与角色无关；可构建客户端、服务器或两者。
易用性： Boost.Asio 用户将立即理解 Beast。
灵活性： 用户可以做出重要决策，如缓冲区或线程管理。
性能： 构建可处理数千个或更多连接的应用程序。
进一步抽象的基础： 组件非常适合用于构建。

亮相

<a href="https://github.com/vinniefalco/CppCon2018">CppCon 2018</a>	<a href="https://www.bishopfox.com/case_study/securing-beast/">Bishop Fox 2018</a>
<a href="https://www.youtube.com/watch?v=7FQwAjELMek"><img width="320" height="180" alt="Beast" src="https://yellow-cdn.veclightyear.com/0a4dffa0/4af248f4-9581-477a-90ed-705762116191.png"></a>	<a href="https://youtu.be/4TtyYbGDAj0"><img width="320" height="180" alt="Beast 安全审查" src="https://yellow-cdn.veclightyear.com/0a4dffa0/8756dcf2-878d-49e5-958d-8d91d102e538.png"></a>
<a href="https://github.com/vinniefalco/CppCon2018">CppCon 2017</a>	<a href="http://cppcast.com/2017/01/vinnie-falco/">CppCast 2017</a>
------------	------------
<a href="https://www.youtube.com/watch?v=WsUnnYEKPnI"><img width="320" height = "180" alt="Beast" src="https://yellow-cdn.veclightyear.com/0a4dffa0/bc44307a-4354-4a87-8211-b23bdafa77ea.png"></a>	<a href="http://cppcast.com/2017/01/vinnie-falco/"><img width="180" height="180" alt="Vinnie Falco" src="https://avatars1.githubusercontent.com/u/1503976?v=3&u=76c56d989ef4c09625256662eca2775df78a16ad&s=180"></a>

描述

这个软件正处于首次官方发布阶段。接口可能会根据用户反馈进行调整。最近的更改请查看更新日志。

要求

这个库面向熟悉Boost.Asio的程序员。希望使用异步接口的用户应该已经知道如何使用回调或协程创建并发网络程序。

C++11: 对大多数语言特性提供强大支持。
Boost: Boost.Asio和Boost的其他部分。
OpenSSL: 使用TLS/安全套接字和示例/测试时需要。

使用Microsoft Visual C++时，需要Visual Studio 2017或更高版本。

构建测试和示例需要以下组件之一：

正确配置的bjam/b2
CMake 3.5.1或更高版本（仅限Windows）

构建

Beast是仅头文件的库。要使用它，只需在源文件中添加必要的#include行，如下所示：

#include <boost/beast.hpp>

如果使用协程，需要链接Boost.Coroutine库。请参阅Boost文档，了解如何在特定构建系统中完成此操作的说明。

GitHub

要使用Beast的最新官方发布版本，只需获取最新的Boost发行版，并按照说明将其集成到您的开发环境中。如果您希望构建示例和测试，或者想预览即将推出的更改和功能，建议克隆"Boost超级项目"并在树内（即超级项目的libs/beast子目录）使用Beast。

官方仓库包含以下分支：

master 包含最新的稳定代码快照。
develop 包含最新的快照。可能包含不稳定代码。

每个分支都需要相应的Boost分支及其所有子项目。例如，如果您希望使用Beast的master分支版本，应该克隆Boost超级项目，切换到超级项目的master分支，并获取包括Beast在内的所有对应该分支的Boost库。

要在本地克隆超级项目并切换到主项目目录，请使用：

git clone --recursive https://github.com/boostorg/boost.git
cd boost

"bjam"用于构建Beast和Boost库。在非Windows系统上，使用以下命令构建bjam：

./bootstrap.sh

在Windows命令行中，使用以下命令构建bjam：

.\BOOTSTRAP.BAT

构建测试和示例

构建测试和示例需要安装OpenSSL。如果OpenSSL安装在非系统位置，您需要将user-config.jam文件复制到您的主目录，并将OPENSSL_ROOT环境变量设置为包含OpenSSL安装的路径。

Ubuntu/Debian

如果安装到系统目录中，OpenSSL将会被自动找到并使用。

sudo apt install libssl-dev

Windows

在以下代码片段中，将 path 替换为你安装 vcpkg 的路径。示例假设是32位构建，如果你构建64位版本，请将路径中的 x32-windows 替换为 x64-windows。

使用 vcpkg 和 CMD：

vcpkg install openssl --triplet x32-windows
SET OPENSSL_ROOT=path\installed\x32-windows

使用 vcpkg 和 PowerShell：

vcpkg install openssl --triplet x32-windows
$env:OPENSSL_ROOT = "path\x32-windows"

使用 vcpkg 和 bash：

vcpkg.exe install openssl --triplet x32-windows
export OPENSSL_ROOT=path/x32-windows

Mac OS

使用 brew：

brew install openssl
export OPENSSL_ROOT=$(brew --prefix openssl)
# 安装bjam工具用户特定配置文件以读取OPENSSL_ROOT
# 参见 https://www.bfgroup.xyz/b2/manual/release/index.html
cp ./libs/beast/tools/user-config.jam $HOME

确保bjam工具（也称为"b2"）在你的shell用于查找可执行文件的路径中可用。Beast项目位于包含Boot超级项目的目录相对的"libs/beast"中。要构建Beast测试、示例和文档，请使用以下命令：

export PATH=$PWD:$PATH
b2 -j2 libs/beast/test cxxstd=11      # bjam必须在你的$PATH中
b2 -j2 libs/beast/example cxxstd=11   # "-j2"表示使用两个处理器
b2 libs/beast/doc                     # 这需要Doxygen和Saxon

有关配置、使用和构建超级项目中的库的其他说明，可以在Boost Wiki中找到。

Visual Studio

可以使用CMake生成非常好的Visual Studio解决方案和一组Visual Studio项目文件，使用以下命令：

cd libs/beast
mkdir bin
cd bin
cmake -G "Visual Studio 17 2022" -A Win32 ..  # 用于32位Windows构建，或
cmake -G "Visual Studio 17 2022" -A x64 ..    # 用于64位Windows构建

存储库中的文件布局如下：

./
    bin/            创建此目录以存放可执行文件和项目文件
    bin64/          创建此目录以存放64位Windows可执行文件和项目文件
    doc/            文档的源代码和脚本
    include/        头文件所在位置
    example/        独立的示例程序
    meta/           用于Boost集成的元数据
    test/           Beast的单元测试
    tools/          用于CI测试的脚本

使用

这些示例是完整的、独立的程序，你可以自己构建和运行（它们位于example目录中）。

https://www.boost.org/doc/libs/develop/libs/beast/doc/html/beast/quick_start.html

许可证

根据Boost软件许可证1.0版分发。（见附带的LICENSE_1_0.txt文件或复制自 https://www.boost.org/LICENSE_1_0.txt）

联系

请在此报告问题或提出问题： https://github.com/boostorg/beast/issues

贡献（我们需要你的帮助！）

如果你想为Beast做出贡献并帮助我们保持高质量，请考虑对活跃的拉取请求进行代码审查。来自用户和利益相关者的任何反馈，即使是关于事物如何运作或为什么以某种方式完成的简单问题，都具有价值，可用于改进库。代码审查提供以下好处：

识别bug
文档校对
调整接口以适应用例
简化代码

你可以查看已关闭的拉取请求，了解如何进行审查。要进行代码审查，只需用你的GitHub账户登录，然后在下面的任何开放拉取请求中添加评论，不要害羞！

<p>https://github.com/boostorg/beast/pulls</p>

以下是一些学习更多关于代码审查的资源：

<a href="https://blog.scottnonnenberg.com/top-ten-pull-request-review-mistakes/">10大拉取请求审查错误</a>
<a href="https://static1.smartbear.co/smartbear/media/pdfs/best-kept-secrets-of-peer-code-review_redirected.pdf">同行代码审查的最佳秘诀（PDF）</a>
<a href="https://static1.smartbear.co/support/media/resources/cc/11_best_practices_for_peer_code_review_redirected.pdf">同行代码审查的11个最佳实践（PDF）</a>
<a href="http://www.evoketechnologies.com/blog/code-review-checklist-perform-effective-code-reviews/">代码审查清单 – 如何进行有效的代码审查</a>
<a href="https://www.codeproject.com/Articles/524235/Codeplusreviewplusguidelines">代码审查指南</a>
<a href="https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md">C++核心指南</a>
<a href="https://www.oreilly.com/library/view/c-coding-standards/0321113586/">C++编码标准（Sutter & Alexandrescu）</a>