MinIO C++客户端SDK用于亚马逊S3兼容云存储

MinIO C++SDK是一个简单的存储服务(又名S3)客户端,用于对任何与亚马逊S3兼容的对象存储服务执行bucket和对象操作。

有关完整的API和示例列表,请查看MinIO C++客户端API参考

构建要求

cmake 3.10或更高版本。
vcpkg软件包管理器。
支持至少C++17的工作C++编译器。

通过`vcpkg`安装

MinIO C++客户端SDK可以通过vcpkg软件包管理器安装:

$ vcpkg install minio-cpp

通常,minio-cpp将是vcpkg.json文件中指定的依赖项的一部分:

{
  "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
  "name": "your-project",
  "version": "0.0.1",
  "dependencies": [
    { "name": "minio-cpp" }
  ]
}

使用`cmake`中的`minio-cpp`

MinIO C++客户端SDK可以作为依赖项在CMakeLists.txt中使用,以下可以用作示例:

cmake_minimum_required(VERSION 3.10)

project(miniocpp_example LANGUAGES C CXX)

# 这将尝试找到miniocpp软件包及其所有依赖项。
find_package(miniocpp REQUIRED)

# 创建一个名为miniocpp-example的可执行文件:
add_executable(miniocpp-example example.cpp)

# 将可执行文件链接到miniocpp及其所有依赖项:
target_link_libraries(miniocpp-example PRIVATE miniocpp::miniocpp)

# 确保使用至少C++17:
target_compile_features(miniocpp-example PUBLIC cxx_std_17)

请注意,miniocpp::miniocpp是一个cmake导入目标,它包含了从您的cmake项目文件中使用minio-cpp库所需的所有指令。

修改minio-cpp

为了运行minio-cpp测试和示例,您可以执行以下操作,假设VCPKG_ROOT指向一个有效的vcpkg安装:

$ git clone https://github.com/minio/minio-cpp
$ cd minio-cpp
$ ${VCPKG_ROOT}/vcpkg install
$ cmake . -B build/Debug -DCMAKE_BUILD_TYPE=Debug -DMINIO_CPP_TEST=ON -DCMAKE_TOOLCHAIN_FILE=${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake
$ cmake --build ./build/Debug

请注意,cmake也支持多配置生成器。多配置生成器在配置时不使用CMAKE_BUILD_TYPE。例如,可以按以下方式设置Visual Studio项目:

$ git clone https://github.com/minio/minio-cpp
$ cd minio-cpp
$ ${VCPKG_ROOT}/vcpkg install
$ cmake . -B build -DMINIO_CPP_TEST=ON -DCMAKE_TOOLCHAIN_FILE=${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake
$ cmake --build ./build --config Debug

上面的示例假设您已经安装了vcpkg,并且您有一个VCPKG_ROOT环境变量设置。如果您没有安装vcpkg,并且只想使用它来测试minio-cpp,您可以像这样本地安装它:

$ git clone https://github.com/minio/minio-cpp
$ cd minio-cpp
$ git clone https://github.com/microsoft/vcpkg.git
$ ./vcpkg/bootstrap-vcpkg.sh
$ ./vcpkg/vcpkg install
$ cmake . -B ./build/Debug -DCMAKE_BUILD_TYPE=Debug -DMINIO_CPP_TEST=ON -DCMAKE_TOOLCHAIN_FILE=./vcpkg/scripts/buildsystems/vcpkg.cmake
$ cmake --build ./build/Debug

我们建议使用带有VCPKG_ROOT的设置进行开发。在这种情况下,有一个configure.sh脚本可用于创建调试和发布项目:

$ git clone https://github.com/minio/minio-cpp
$ cd minio-cpp
$ ./configure.sh -DMINIO_CPP_TEST=ON

示例:: file-uploader.cc

#include <miniocpp/client.h>

int main(int argc, char* argv[]) {
  // 创建S3基URL。
  minio::s3::BaseUrl base_url("play.min.io");

  // 创建凭证提供程序。
  minio::creds::StaticProvider provider(
      "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG");

  // 创建S3客户端。
  minio::s3::Client client(base_url, &provider);
  std::string bucket_name = "asiatrip";

  // 检查'asiatrip'bucket是否存在。
  bool exist;
  {
    minio::s3::BucketExistsArgs args;
    args.bucket = bucket_name;

    minio::s3::BucketExistsResponse resp = client.BucketExists(args);
    if (!resp) {
      std::cout << "无法检查bucket是否存在;" << resp.Error()
                << std::endl;
      return EXIT_FAILURE;
    }

    exist = resp.exist;
  }

  // 如果'asiatrip'bucket不存在,则创建它。
  if (!exist) {
    minio::s3::MakeBucketArgs args;
    args.bucket = bucket_name;

    minio::s3::MakeBucketResponse resp = client.MakeBucket(args);
    if (!resp) {
      std::cout << "无法创建bucket;" << resp.Error() << std::endl;
      return EXIT_FAILURE;
    }
  }

  // 将'/home/user/Photos/asiaphotos.zip'上传为对象名称
  // 'asiaphotos-2015.zip'到bucket'asiatrip'。
  minio::s3::UploadObjectArgs args;
  args.bucket = bucket_name;
  args.object = "asiaphotos-2015.zip";
  args.filename = "/home/user/Photos/asiaphotos.zip";

  minio::s3::UploadObjectResponse resp = client.UploadObject(args);
  if (!resp) {
    std::cout << "无法上传对象;" << resp.Error() << std::endl;
    return EXIT_FAILURE;
  }

  std::cout << "'/home/user/Photos/asiaphotos.zip'已成功上传为"
            << "对象'asiaphotos-2015.zip'到bucket'asiatrip'."
            << std::endl;

  return EXIT_SUCCESS;
}