.Net Core对接MongoDb如何根据实体自动创建数据库与集合

MongoDB本身默认是惰性创建数据库和集合，首次写入数据时才会自动生成对应资源。如果需要和FluentMigrator类似的显式初始化流程，提前创建库、集合甚至预置索引/迁移数据，可以按照以下方案实现：

第一步：安装依赖NuGet包 #

首先安装官方MongoDB驱动：

Install-Package MongoDB.Driver

第二步：实现初始化逻辑 #

1. 定义MongoDB配置类 #

public class MongoDbSettings
{
    public string ConnectionString { get; set; }
    public string DatabaseName { get; set; }
}

2. 实现初始化服务 #

该服务负责扫描所有继承BaseEntity的实体类，自动创建对应集合，也可扩展加入索引创建、数据迁移逻辑：

public interface IMongoDbInitializer
{
    Task InitializeAsync();
}

public class MongoDbInitializer : IMongoDbInitializer
{
    private readonly MongoDbSettings _settings;

    public MongoDbInitializer(IOptions<MongoDbSettings> settings)
    {
        _settings = settings.Value;
    }

    public async Task InitializeAsync()
    {
        var client = new MongoClient(_settings.ConnectionString);
        var database = client.GetDatabase(_settings.DatabaseName);

        // 扫描当前程序集中所有继承BaseEntity的非抽象实体类
        var entityTypes = AppDomain.CurrentDomain.GetAssemblies()
            .SelectMany(a => a.GetTypes())
            .Where(t => t.IsClass && !t.IsAbstract && t.IsSubclassOf(typeof(BaseEntity)))
            .ToList();

        foreach (var entityType in entityTypes)
        {
            // 约定集合名：实体类名复数形式，也可自定义特性读取指定集合名
            var collectionName = Pluralize(entityType.Name);
            // 集合不存在时自动创建，已存在则跳过
            var collections = await database.ListCollectionNamesAsync(new ListCollectionNamesOptions
            {
                Filter = Builders<BsonDocument>.Filter.Eq("name", collectionName)
            });
            if (!await collections.AnyAsync())
            {
                await database.CreateCollectionAsync(collectionName);
            }

            // 可扩展：此处添加对应集合的索引创建逻辑
            // 示例：给Basket集合的CustomerId创建唯一索引
            if (entityType == typeof(Basket))
            {
                var basketCollection = database.GetCollection<Basket>(collectionName);
                var indexKeys = Builders<Basket>.IndexKeys.Ascending(x => x.CustomerId);
                var indexOptions = new CreateIndexOptions { Unique = true };
                await basketCollection.Indexes.CreateOneAsync(new CreateIndexModel<Basket>(indexKeys, indexOptions));
            }
        }
    }

    // 简单的复数转换方法，也可引用Humanizer库实现更完善的转换
    private string Pluralize(string name)
    {
        return name.EndsWith("y") ? $"{name[..^1]}ies" : $"{name}s";
    }
}

第三步：注册服务并启动时执行 #

1. 注册服务 #

在Program.cs中添加配置和服务注册：

// 读取配置
builder.Services.Configure<MongoDbSettings>(builder.Configuration.GetSection("MongoDb"));
// 注册初始化服务
builder.Services.AddSingleton<IMongoDbInitializer, MongoDbInitializer>();

2. 启动时执行初始化 #

构建完WebApplication后，在启动管道前执行初始化逻辑：

var app = builder.Build();

// 执行MongoDB初始化
using (var scope = app.Services.CreateScope())
{
    var initializer = scope.ServiceProvider.GetRequiredService<IMongoDbInitializer>();
    await initializer.InitializeAsync();
}

// 其他中间件配置...
app.Run();

扩展说明 #

• 如果需要自定义集合名，可以给实体类添加自定义特性（如[BsonCollection("自定义集合名")]），扫描实体时读取特性值作为集合名即可
• 若需要版本化的迁移逻辑，可参考FluentMigrator的思路，定义迁移接口，给每个迁移类加版本号特性，初始化时按版本顺序执行迁移逻辑，实现数据结构/数据的迭代更新
• 该方案和FluentMigrator的流程逻辑一致，完全满足启动时自动初始化数据库资源的需求，无需手动创建库和集合

内容的提问来源于stack exchange，提问作者Ismail Dogan