EphemeralMongo 使用指南

项目介绍

EphemeralMongo 是一个专为 .NET 开发者设计的工具集，旨在提供临时且一次性的 MongoDB 数据库服务。它通过封装 MongoDB 的多个版本（4.x, 5.x, 6.x 和 7.x）为 .NET Standard 2.0 提供支持，兼容从 .NET Framework 4.5.2 到 .NET 6 及以上版本的应用程序。此项目特别适用于集成测试环境和本地开发时的快速 MongoDB 配置。EphemeralMongo 启发自Mongo2Go，但在多版本支持、安全性、效率及内存管理方面有所增强。

项目快速启动

安装依赖

首先，确保你的开发环境已经配置好.NET SDK。然后，通过NuGet包管理器添加 EphemeralMongo 相关包到你的项目中。以安装 MongoDB v4.x 版本为例，在你的 .csproj 文件中加入以下代码：

<PackageReference Include="EphemeralMongo4" Version="最新版本号" />

或者，为了更好的系统适应性，可以按操作系统选择具体运行时包，减少下载量：

<!-- 假设是Windows环境 -->
<PackageReference Include="EphemeralMongo.Core" Version="最新版本号" />
<PackageReference Include="EphemeralMongo4.runtime.win-x64" Version="最新版本号" Condition="$([MSBuild]::IsOSPlatform('Windows'))" />

运行 MongoDB 实例

在你的测试或应用代码中，使用 MongoRunner.Run() 方法来启动一个新的 MongoDB 实例并获取连接字符串。

using MongoDB.Driver;
using Asimmon.EphemeralMongo;

// 初始化 MongoDB 运行实例
using var runner = MongoRunner.Run(new MongoRunnerOptions {
    MongoPort = 27017 // 或使用默认随机端口
});
// 获取数据库连接
var client = new MongoClient(runner.ConnectionString);
var db = client.GetDatabase("testDB");

// 此时你可以进行数据库操作了
db.CreateCollection("users");

记得处理完后，由于使用了 using 语句，MongoDB 实例将会被自动清理，包括数据目录和进程。

应用案例和最佳实践

测试环境快速搭建

在单元测试场景下，为每个测试创建一个独立的 MongoDB 实例，确保测试之间的数据隔离：

[TestFixture]
public class MyDatabaseTests
{
    private MongoServer _server;

    [SetUp]
    public void Setup()
    {
        var options = new MongoRunnerOptions { UseSingleNodeReplicaSet = true };
        _server = MongoRunner.Start(options);
    }

    [Test]
    public void TestCreateUser()
    {
        var db = new MongoClient(_server.ConnectionUri).GetDatabase("test");
        db.CreateCollection("users");
        // 执行测试逻辑
    }

    [TearDown]
    public void TearDown()
    {
        _server.Stop();
    }
}

本地开发调试

对于开发者来说，可以直接启动一个 MongoDB 实例用于即时的数据存储和查询调试，无需手动配置MongoDB服务。

var runner = MongoRunner.Run();
Console.WriteLine($"MongoDB临时实例已启动，连接字符串: {runner.ConnectionString}");

典型生态项目

虽然EphemeralMongo自身即是特定于.NET生态的解决方案，它的应用场景广泛涉及到任何需要集成MongoDB作为数据存储的.NET项目，比如Web应用程序、微服务架构或是需要数据库测试的任何.NET框架项目。与其他.NET框架如ASP.NET Core、.NET MAUI结合使用时，能够极大简化本地开发环境的设置和持续集成过程中的数据库测试配置。

---

通过上述步骤，你可以快速地在.NET项目中集成EphemeralMongo，实现便捷的MongoDB服务管理，无论是测试还是日常开发都将更加高效和灵活。记住适时查看最新的GitHub仓库更新，以获取最新的功能和维护信息。