C++ 编译和使用MongoDB驱动

参考：http://mongocxx.org/mongocxx-v3/installation/

安装mongocxx驱动程序

先决条件

• 任何标准的Unix平台，或Windows 7 SP1 +
• 支持C ++ 11（gcc，clang或Visual Studio）的编译器
• CMake 3.2或更高版本
• 提升标题（可选）

我们目前使用以下配置测试驱动程序：

	Linux的	苹果系统	视窗
铛	3.8	7.0（Apple）	-
GCC	4.8,5.4	-	-
VS	N / A	N / A	14（2015）更新3
促进	-	1.5.3	1.6.0

列出的版本较旧的版本可能无法使用且不受支持; 使用它们需要您自担风险。

比上面列出的版本更新的版本应该有效; 如果您有问题，请通过JIRA提交错误报告 。

安装

步骤1：安装最新版本的MongoDB C驱动程序。

mongocxx驱动程序构建在MongoDB C驱动程序之上。

• 对于mongocxx-3.4.x，需要libmongoc 1.13.0或更高版本。
• 对于mongocxx-3.3.x，需要libmongoc 1.10.1或更高版本。
• 对于mongocxx-3.2.x，需要libmongoc 1.9.2或更高版本。
• 对于mongocxx-3.1.4 +，需要libmongoc 1.7.0或更高版本。
• 对于mongocxx-3.1。[0-3]，需要libmongoc 1.5.0或更高版本。
• 对于mongocxx-3.0.x，我们建议使用libmongoc的最后1.4.x版本

除非您知道您的软件包管理器提供了足够高的版本，否则您需要从源代码下载和构建。从C驱动程序版本页面获取tarball 。

按照安装libmongoc中的tarball构建说明进行 操作。

行业最佳实践和一些法规要求使用TLS 1.1或更新版本。如果OpenSSL至少是1.0.1版本，MongoDB C驱动程序在Linux上支持TLS 1.1。在macOS和Windows上，C驱动程序使用支持TLS 1.1的本机TLS实现。

第2步：选择C ++ 17 polyfill

mongocxx驱动程序使用C ++ 17的功能std::optional和 std::string_view。要编译用于预C ++ 17的mongocxx驱动程序，必须为这些功能选择以下实现之一：

MNMLSTC / core（非Windows平台的默认设置）选择-DBSONCXX_POLY_USE_MNMLSTC=1。 注意：此选项将MNMLSTC / core的仅标头安装提供到bsoncxx库安装中，因此将在构建过程中从GitHub下载MLNMLSTC。如果您的系统上已有可用的MNMLSTC版本，则可以使用避免下载步骤-DBSONCXX_POLY_USE_SYSTEM_MNMLSTC。

Boost（Windows平台的默认设置）选择-DBSONCXX_POLY_USE_BOOST=1。如果您使用MSVC，这是目前唯一的选择。

std::experimental 选择-DBSONCXX_POLY_USE_STD_EXPERIMENTAL=1。如果您的工具链的标准库提供optional并 string_view在命名空间中std::experimental，则可以使用此选项。请注意，标准库的std::experimental实现可能会随着时间的推移而发生变化，从而以意外方式破坏二进制兼容性。请注意，不建议使用此填充，并且不支持此填充。

大多数用户应该很好地坚持默认。但是，如果您的现有应用程序大量使用其中一个可用库，您可能更喜欢针对同一个库构建mongocxx驱动程序。

如果需要创建稳定的二进制接口，请勿更改项目的polyfill。

第3步：下载最新版本的mongocxx驱动程序。

要通过git获取源代码，releases/stable分支机构将跟踪最新的稳定版本。例如，从稳定版本分支的浅层结账工作：

git clone https://github.com/mongodb/mongo-cxx-driver.git \
    --branch releases/stable --depth 1
cd mongo-cxx-driver/build

如果您希望下载tarball，请在mongocxx版本页面上查找您希望安装的版本的发行版tarball的链接。例如，要下载3.3.1版本：

curl -OL https://github.com/mongodb/mongo-cxx-driver/archive/r3.3.1.tar.gz
tar -xzf r3.3.1.tar.gz
cd mongo-cxx-driver-r3.3.1/build

确保切换到build您获得的任何源树的目录。

第4步：配置驱动程序

在Unix系统上，默认libmongoc安装/usr/local。要配置mongocxx安装/usr/local，请使用以下cmake命令：

（注意：..下面的结尾很重要！不要忽略它。）

cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..

/usr/local可能会libmongoc被安装到的目录替换。

如果需要安装mongocxx到与安装目录不同的目录中，libmongoc则必须指示cmake如何查找libmongoc安装目录。这样做的过程因mongocxx版本而异：

• 构建mongocxx版本3.2.x或更高版本的用户应该用于 CMAKE_PREFIX_PATH指定libmongoc安装目录。例如（确保分别替换/your/cdriver/prefix和 /your/cxxdriver/prefix使用用于安装C驱动程序的前缀和所需的安装前缀）：

cmake -DCMAKE_BUILD_TYPE=Release \
    -DCMAKE_INSTALL_PREFIX=/your/cxxdriver/prefix \
    -DCMAKE_PREFIX_PATH=/your/cdriver/prefix ..

• 注意：如果您需要多个路径CMAKE_PREFIX_PATH，请用分号分隔它们，如下所示：-DCMAKE_PREFIX_PATH="/your/cdriver/prefix;/some/other/path"

• 构建mongocxx版本3.1.x和3.0.x的用户应libmongoc使用-DLIBMONGOC_DIR和 -DLIBBSON_DIR选项指定 安装目录cmake。请看下面的例子，其中假定两个libmongoc和libbson安装到/your/cdriver/prefix：

cmake -DCMAKE_BUILD_TYPE=Release \
    -DCMAKE_INSTALL_PREFIX=/your/cxxdriver/prefix
    -DLIBMONGOC_DIR=/your/cdriver/prefix
    -DLIBBSON_DIR=/your/cdriver/prefix ..

请记住：要选择填充，请将选项传递给cmake。例如，要选择Boost polyfill，请cmake使用以下内容替换该行：

cmake -DCMAKE_BUILD_TYPE=Release -DBSONCXX_POLY_USE_BOOST=1 \
    -DCMAKE_INSTALL_PREFIX=/usr/local ..

在Windows上，这是一个如何配置MSVC的示例（假设libmongoc和libbson C:\mongo-c-driver在mongoc Windows安装说明中给出， 并且提升在c:\local\boost_1_59_0：

'C:\Program Files (x86)\CMake\bin\cmake.exe' -G "Visual Studio 14 2015 Win64"
    -DCMAKE_INSTALL_PREFIX=C:\mongo-cxx-driver
    -DCMAKE_PREFIX_PATH=C:\mongo-c-driver
    -DBOOST_ROOT=C:\local\boost_1_59_0 ..

mongocxx默认情况下构建共享库。这是新手用户的推荐构建设置。

• 对于mongocxx 3.2.x及更高版本的用户，请注意：如果需要，高级用户可以通过指定-DBUILD_SHARED_LIBS=OFFCMake 来构建静态库。指定此选项将引入对libmongoc静态库的依赖性 。不支持将应用程序与共享libmongoc和静态mongocxx链接，也不支持链接静态libmongoc和共享mongocxx。

对于使用Visual Studio 2017构建（没有C ++ 17 polyfill），需要配置一个附加选项，/Zc:__cplusplus以选择正确定义__cplusplus（此处描述的问题）：

'C:\Program Files (x86)\CMake\bin\cmake.exe' -G "Visual Studio 15 2017 Win64"
    -DCMAKE_INSTALL_PREFIX=C:\mongo-cxx-driver
    -DCMAKE_PREFIX_PATH=C:\mongo-c-driver
    -DCMAKE_CXX_STANDARD=17
    -DCMAKE_CXX_FLAGS="/Zc:__cplusplus" ..

第5步：构建并安装驱动程序

如果您使用的是默认MNMLSTC填充工具，并安装到一个目录需要root权限，你应该安装用填充工具sudo在运行之前make，所以你不必运行所有的make有 sudo：

# Only for MNMLSTC polyfill
sudo make EP_mnmlstc_core

安装MNMLSTC后，或者如果您使用的是其他polyfill，请构建并安装驱动程序：

make && sudo make install

在Windows上，从命令行构建和安装如下：

msbuild.exe ALL_BUILD.vcxproj
msbuild.exe INSTALL.vcxproj

第6步：测试您的安装

使用test.cpp 任何目录下的文件名保存以下源文件：

#include 

#include 
#include 

#include 
#include 

int main(int, char**) {
    mongocxx::instance inst{};
    mongocxx::client conn{mongocxx::uri{}};

    bsoncxx::builder::stream::document document{};

    auto collection = conn["testdb"]["testcollection"];
    document << "hello" << "world";

    collection.insert_one(document.view());
    auto cursor = collection.find({});

    for (auto&& doc : cursor) {
        std::cout << bsoncxx::to_json(doc) << std::endl;
    }
}

在CMake的帮助下编译

如果您正在为项目使用CMake，则可以使用find_package（）指令来启用编译和链接mongocxx。该find_package（）指令将设置在目前的环境变量（例如LIBMONGOCXX_INCLUDE_DIRS，LIBMONGOCXX_LIBRARIES需要被传播到您的构建目标等）。如果已安装mongocxx 或libmongoc系统上的非标准位置，则需要在运行时设置CMAKE_PREFIX_PATH库安装前缀（在构建时指定CMAKE_INSTALL_PREFIX）cmake。

在mongocxx源存储库（版本3.2.x或更新版本）中，请参阅examples/projects/mongocxx/cmake使用共享库（默认选项）的示例CMake应用程序的目录，以及使用静态库的示例CMake应用程序（仅限高级用户）。

在pkg-config的帮助下编译

使用以下命令编译上面的测试程序：

c++ --std=c++11 test.cpp -o test $(pkg-config --cflags --libs libmongocxx)

使用静态库的高级用户必须将上面的libmongocxx参数替换为 （这需要mongocxx 3.2.x或更高版本）。pkg-configlibmongocxx-static

如果您安装到pkg-config搜索路径中的某个位置，请记住首先设置PKG_CONFIG_PATH环境变量：

export PKG_CONFIG_PATH="$MY_INSTALL_PREFIX/lib/pkgconfig"

没有pkg-config或CMake编译

如果您没有为项目使用CMake并且没有可用的pkg-config，则需要在命令行或IDE中手动设置include和library标志。

以下是上面编译行的示例扩展，在安装了mongocxx和libmongoc的系统中/usr/local：

c++ --std=c++11 test.cpp -o test \
    -I/usr/local/include/mongocxx/v_noabi \
    -I/usr/local/include/bsoncxx/v_noabi \
    -L/usr/local/lib -lmongocxx -lbsoncxx

仅限高级用户：以下是使用静态库时上述编译行的同一系统上的示例扩展。请注意，预处理器定义MONGOCXX_STATIC并且BSONCXX_STATIC必须在包含mongocxx头的所有源文件中定义; 如果不这样做，将导致难以诊断的链接器错误。

c++ --std=c++11 test.cpp -o test \
    -DMONGOCXX_STATIC -DBSONCXX_STATIC -DMONGOC_STATIC -DBSON_STATIC \
    -I/usr/local/include/libmongoc-1.0 \
    -I/usr/local/include/libbson-1.0 \
    -I/usr/local/include/mongocxx/v_noabi \
    -I/usr/local/include/bsoncxx/v_noabi \
    -L/usr/local/lib -lmongocxx-static -lbsoncxx-static
    -lmongoc-static-1.0 -lsasl2 -lssl -lcrypto -lbson-static-1.0 -lm -lpthread

使用MSVC进行编译

要在MSVC上进行编译，您需要设置项目以包括所有必需的包含路径，库路径，预处理器定义和链接库。为此，您可以通过UI或.vcxproj直接编辑XML 文件来设置这些值。要确认您已正确设置所有内容， 以下是Debug x64构建的设置PropertyGroup和ItemDefinitionGroup设置示例：

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
    <LinkIncremental>trueLinkIncremental>
    <IncludePath>c:\local\boost_1_59_0\;C:\mongo-cxx-driver\include\mongocxx\v_noabi;C:\mongo-cxx-driver\include\bsoncxx\v_noabi;C:\mongo-c-driver\include\libmongoc-1.0;C:\mongo-c-driver\include\libbson-1.0;$(IncludePath)IncludePath>
    <LibraryPath>c:\mongo-c-driver\lib\;c:\mongo-cxx-driver\lib\;$(LibraryPath)LibraryPath>
  PropertyGroup>
  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
    <ClCompile>
      <PrecompiledHeader>UsePrecompiledHeader>
      <WarningLevel>Level3WarningLevel>
      <Optimization>DisabledOptimization>
      <PreprocessorDefinitions>MONGOCXX_STATIC;BSONCXX_STATIC;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)PreprocessorDefinitions>
      <SDLCheck>trueSDLCheck>
    ClCompile>
    <Link>
      <SubSystem>ConsoleSubSystem>
      <GenerateDebugInformation>trueGenerateDebugInformation>
      <AdditionalDependencies>libmongocxx.lib;libbsoncxx.lib;mongoc-static-1.0.lib;bson-1.0.lib;%(AdditionalDependencies)AdditionalDependencies>
    Link>
  ItemDefinitionGroup>