Skip to content

Latest commit

 

History

History
147 lines (102 loc) · 3.91 KB

README_ch.md

File metadata and controls

147 lines (102 loc) · 3.91 KB
Raw

Zoe

Vcpkg package badge

简体中文 | English

特性

  • 多协议支持，如 HTTP(s), FTP(s)...

  • 分片下载和断点续传

  • 下载限速

  • 配置磁盘缓存

  • 支持大文件下载（TB级别）

  • 兼容服务器对客户端加速下载的限制

编译与安装

方式一、使用vcpkg

zoe 库已经收录到微软的 vcpkg 之中，可以使用如下命令快速安装:

  1. 下载安装vcpkg（详见https://github.com/microsoft/vcpkg
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
PS> bootstrap-vcpkg.bootstrap
Linux:~/$ ./bootstrap-vcpkg.sh
  1. 安装zoe
PS> .\vcpkg install zoe [--triplet x64-windows-static/x64-windows/x64-windows-static-md and etc...]
Linux:~/$ ./vcpkg install zoe

方式二、使用源码编译

1. 安装依赖项

我倾向于使用 vcpkg 来安装依赖项，当然，这不是安装依赖项的唯一方式，你可以使用任何方式来安装依赖项。

建议将 vcpkg.exe 所在目录添加到 PATH 环境变量。

  • libcurl

    # 如果需要支持非http协议，如ftp等，需要指定[non-http]选项
vcpkg install curl[non-http]:x86-windows

  • gtest

    vcpkg install gtest:x86-windows

2. 编译

使用CMake生成相应的工程，然后编译即可。

Windows示例：

cmake.exe -G "Visual Studio 15 2017" -DBUILD_SHARED_LIBS=ON -DBUILD_TESTS=ON -S %~dp0 -B %~dp0build

Linux示例：

cmake -DBUILD_SHARED_LIBS=ON -DBUILD_TESTS=ON

# 如果使用vcpkg安装依赖库，需要指定CMAKE_TOOLCHAIN_FILE
cmake -DCMAKE_TOOLCHAIN_FILE=/xxx/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux -DBUILD_SHARED_LIBS=ON -DBUILD_TESTS=ON

make

快速开始

#include <iostream>
#include "zoe.h"

int main(int argc, char** argv) {
  using namespace zoe;

  Zoe::GlobalInit();

  Zoe z;

  z.setThreadNum(10);                     // 可选的
  z.setTmpFileExpiredTime(3600);          // 可选的
  z.setDiskCacheSize(20 * (2 << 19));     // 可选的
  z.setMaxDownloadSpeed(50 * (2 << 19));  // 可选的
  z.setHashVerifyPolicy(ALWAYS, MD5, "6fe294c3ef4765468af4950d44c65525"); // 可选的, 支持 MD5, CRC32, SHA256
  // 还支持其他更多的选择，请查看zoe.h
  z.setVerboseOutput([](const utf8string& verbose) { // 可选的
    printf("%s\n", verbose.c_str());
  });
  z.setHttpHeaders({  // 可选的
    {u8"Origin", u8"http://xxx.xxx.com"},
    {u8"User-Agent", u8"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)"}
   });
  
  std::shared_future<Result> res = z.start(
      u8"http://xxx.xxx.com/test.exe", u8"D:\\test.exe",
      [](Result result) {  // 可选的
        // 结果回调
      },
      [](int64_t total, int64_t downloaded) {  // 可选的
        // 进度回调
      },
      [](int64_t byte_per_secs) {  // 可选的
        // 实时速率回调
      });

  res.wait();

  Zoe::GlobalUnInit();

  return 0;
}

命令行工具

zoe_tool是一个基于zoe库开发的命令行下载工具，用法如下：

zoe_tool URL TargetFilePath [ThreadNum] [DiskCacheMb] [MD5] [TmpExpiredSeconds] [MaxSpeed]

参数解释：

  • URL: 下载链接
  • TargetFilePath: 下载的目标文件保存路径
  • ThreadNum: 线程数量，可选，默认为1
  • DiskCacheMb: 磁盘缓存大小，单位Mb，默认为20Mb
  • MD5: 下载文件的MD5，可选，若不为空，则在下载完成之后会进行文件MD5校验
  • TmpExpiredSeconds: 秒数，可选，临时文件经过多少秒之后过期
  • MaxSpeed: 最高下载速度(byte/s)