Mongo2Go 技术文档

1. 安装指南

Mongo2Go 是一个托管 MongoDB 二进制文件的包装器，可以通过 NuGet 包管理器进行安装。以下是安装步骤：

• 访问 Mongo2Go Nuget 包页面。

• 使用 .NET CLI 命令安装包：

  dotnet add package Mongo2Go
  

请注意，新版本 4.x 支持|.NET Framework 4.7.2|和|.NET Standard 2.1|，建议尽可能使用此版本。旧版本 3.x 和 2.x 分别支持|.NET Standard 2.0|和|.NET Standard 1.6|，而 1.x 版本支持经典|.NET 4.6.1|环境。

2. 项目的使用说明

Mongo2Go 主要用于两个场景：

1. 为集成测试提供多个临时且隔离的 MongoDB 数据库。
2. 为本地开发环境快速搭建 MongoDB 数据库。

集成测试模式

在集成测试模式下，每次调用静态方法 MongoDbRunner.Start() 时都会设置一个新的 MongoDB 实例。该方法使用空闲端口（从端口 27018 开始）并创建相应的数据目录。方法返回一个实现了 IDisposable 接口的 MongoDbRunner 实例。当 MongoDbRunner 被释放（或由 GC 调用 Finalizer）时，封装的 MongoDB 进程将被终止，数据目录中的所有数据将被删除。

本地调试模式

在本地调试模式下，会在默认端口 27017 上启动单个 MongoDB 实例。不会删除数据，且 MongoDB 实例不会自动终止。多次调用 MongoDbRunner.StartForDebugging() 会返回状态为 “AlreadyRunning” 的实例。在此模式下，建议不要在生成环境中使用，而是手动设置 MongoDB。

单服务器副本集模式

MongoDbRunner.Start() 可以接受一个名为 singleNodeReplSet 的可选布尔参数。当该参数设置为 true 时，将启动一个名为 singleNodeReplSet 的单节点副本集 MongoDB 实例。副本集模式是 MongoDB 4.0 或更高版本中事务工作的必要条件。

3. 项目 API 使用文档

Mongo2Go 提供了以下主要 API 方法：

• MongoDbRunner.Start(): 启动一个新的 MongoDB 实例用于集成测试。
• MongoDbRunner.StartForDebugging(): 启动一个 MongoDB 实例用于本地调试。
• MongoDbRunner.Export(string databaseName, string collectionName, string filePath): 导出指定数据库和集合的数据。
• MongoDbRunner.Import(string databaseName, string collectionName, string filePath, bool dropCollection): 导入数据到指定数据库和集合。

4. 项目安装方式

Mongo2Go 可以通过 NuGet 包管理器进行安装。以下是通过 .NET CLI 安装 Mongo2Go 的命令：

dotnet add package Mongo2Go

确保选择正确的版本以匹配您的项目框架。