Skip to content

Latest commit

 

History

History
127 lines (96 loc) · 4.55 KB

README-zh.md

File metadata and controls

127 lines (96 loc) · 4.55 KB
Raw

XQUIC

简介

阿里巴巴发布的XQUIC库

  • 是一个遵循IETF标准的QUIC和HTTP/3的客户端和服务端实现。 目前支持的QUIC版本是v1和draft-29。

  • 是跨平台的。 目前支持Android、iOS、Linux、macOS和Windows。绝大部分代码被用于我们自己的产品，并已在安卓、iOS APP以及服务端上进行了大规模测试。

  • 目前仍在积极开发中。 我们定期与其他QUIC实现进行互通性测试。

依赖

编译XQUIC，你需要：

  • CMake
  • BoringSSL 或者 BabaSSL

运行测试用例，你需要：

  • libevent
  • CUnit

快速入门指南

XQUIC 支持 BoringSSL 和 BabaSSL。

使用 BabaSSL（Tongsuo） 编译

# 获取 XQUIC 源码
git clone https://github.com/alibaba/xquic.git
cd xquic

# 编译 BabaSSL(Tongsuo)
git clone -b 8.3-stable https://github.com/Tongsuo-Project/Tongsuo.git ./third_party/babassl
cd ./third_party/babassl/
./config --prefix=/usr/local/babassl
make -j
SSL_TYPE_STR="babassl"
SSL_PATH_STR="${PWD}"
cd -

# 使用 BabaSSL（Tongsuo） 编译 XQUIC
# 选择BabaSSL编译XQUIC时，会默认从/usr/local/babassl寻找头文件、依赖库，如果BabaSSL在其
# 他位置，可以通过SSL_PATH指定位置。
# 在编译测试程序时，依赖了libevent、CUnit，默认会从系统安装路径下寻找，如果用户部署在特定位置
# 下，可以通过-DCUNIT_DIR、-DLIBEVENT_DIR指定目录。
git submodule update --init --recursive
mkdir -p build; cd build
cmake -DGCOV=on -DCMAKE_BUILD_TYPE=Debug -DXQC_ENABLE_TESTING=1 -DXQC_SUPPORT_SENDMMSG_BUILD=1 -DXQC_ENABLE_EVENT_LOG=1 -DXQC_ENABLE_BBR2=1 -DXQC_ENABLE_RENO=1 -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} ..

# 如果CMake发生错误，则结束编译
if [ $? -ne 0 ]; then
    echo "cmake failed"
    exit 1
fi

make -j

使用 BoringSSL 编译

# 获取 XQUIC 源码
git clone https://github.com/alibaba/xquic.git
cd xquic

# 编译 BoringSSL
git clone https://github.com/google/boringssl.git ./third_party/boringssl
cd ./third_party/boringssl
mkdir -p build && cd build
cmake -DBUILD_SHARED_LIBS=0 -DCMAKE_C_FLAGS="-fPIC" -DCMAKE_CXX_FLAGS="-fPIC" ..
make ssl crypto
cd ..
SSL_TYPE_STR="boringssl"
SSL_PATH_STR="${PWD}"
cd ../..

# 使用 BoringSSL 编译 XQUIC
# 选择boringssl编译XQUIC时，会默认从源码third_party/boringssl寻找头文件、依赖库，如果
# boringssl在其他位置，可以通过SSL_PATH指定位置。
# 在编译测试程序时，依赖了libevent、CUnit，默认会从系统安装路径下寻找，如果用户部署在特定位置
# 下，可以通过-DCUNIT_DIR、-DLIBEVENT_DIR指定目录。
git submodule update --init --recursive
mkdir -p build; cd build
cmake -DGCOV=on -DCMAKE_BUILD_TYPE=Debug -DXQC_ENABLE_TESTING=1 -DXQC_SUPPORT_SENDMMSG_BUILD=1 -DXQC_ENABLE_EVENT_LOG=1 -DXQC_ENABLE_BBR2=1 -DXQC_ENABLE_RENO=1 -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} ..

# 如果CMake发生错误，则结束编译
if [ $? -ne 0 ]; then
    echo "cmake failed"
    exit 1
fi

make -j

运行测试用例

sh ../scripts/xquic_test.sh

文档

Contributing

我们希望你能为XQUIC做出贡献，帮助它变得比现在更好！我们鼓励并重视所有类型的贡献，请参阅我们的贡献指南了解更多信息。

如果你有任何问题，请随时在我们的讨论区开启一个新的讨论主题。

License

XQUIC 使用 Apache 2.0 许可证。