README_ch.md

简体中文 | English

一、介绍

目前虽然有很多成熟且功能强大的下载工具，如Free Download Manager, Aria2等等，但当我想找一个支持多种协议(如http， ftp)、多线程下载、断点续传、跨平台的开源库时，发现很难找到满意的，特别是使用C++开发的。于是我基于libcurl开发了这个名为"teemo"下载库，它可以支持如下特性：

✅ 多协议支持，由于是基于libcurl的，所以支持libcurl所支持的所有协议，如http, https, ftp等。

✅ 支持多线程下载

✅ 支持断点续传

✅ 支持暂停/继续下载

✅ 支持获取实时下载速率

✅ 支持下载限速

✅ 支持磁盘缓存

✅ 支持文件哈希校验

---

二、编译与安装

方式一、使用vcpkg

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

vcpkg install teemo:x86-windows

关于vcpkg的介绍，可以参考：https://github.com/microsoft/vcpkg/blob/master/README_zh_CN.md

方式二、使用源码编译

1. 安装依赖项

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

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

• libcurl

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

• gtest 单元测试项目使用了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
make

---

三、快速开始

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

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

  Teemo::GlobalInit();

  Teemo efd;

  efd.setThreadNum(10);                     // Optional
  efd.setTmpFileExpiredTime(3600);          // Optional
  efd.setDiskCacheSize(20 * (2 << 19));     // Optional
  efd.setMaxDownloadSpeed(50 * (2 << 19));  // Optional
  efd.setHashVerifyPolicy(ALWAYS, MD5, "6fe294c3ef4765468af4950d44c65525"); // Optional, support MD5, CRC32, SHA256
  efd.setVerboseOutput([](const utf8string& verbose) { // Optional
    printf("%s\n", verbose.c_str());
  });

  std::shared_future<Result> async_task = efd.start(
      u8"http://xxx.xxx.com/test.exe", u8"D:\\test.exe",
      [](Result result) {  // Optional
        // result callback
      },
      [](int64_t total, int64_t downloaded) {  // Optional
        // progress callback
      },
      [](int64_t byte_per_secs) {  // Optional
        // real-time speed callback
      });

  async_task.wait();

  Teemo::GlobalUnInit();

  return 0;
}

---

四、命令行工具

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

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

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

---

五、捐赠

本项目暂不接受捐赠，感谢你的好意，如果你觉得这个项目帮助到了你，可以给该项目点颗小星星.