MongoDbGenericRepository
这是一个使用MongoDB C# Sharp 2.0驱动程序(异步)实现的通用仓储示例
现已作为nuget包提供: https://www.nuget.org/packages/MongoDbGenericRepository/
有400多个集成测试覆盖,并且还在增加。
MongoDbGenericRepository也在AspNetCore.Identity.MongoDbCore中使用。
支持本项目
如果你发现这个项目对你有帮助,无论是作为你使用的库还是学习工具,请考虑为Alex买杯咖啡:
值得注意的事项
这个包默认将MongoDefaults.GuidRepresentation
设置为MongoDB.Bson.GuidRepresentation.Standard
,而不是驱动程序的默认设置MongoDB.Bson.GuidRepresentation.CSharpLegacy
。如果你之前在现有应用程序中使用过该驱动程序,或者正在使用CosmosDB,这可能会导致问题。
你可以在应用程序启动例程中覆盖此行为,以强制使用旧版行为,如下所示:
MongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation.CSharpLegacy)
。更多信息在此。
使用示例
这个仓储旨在被继承。
你负责管理其生命周期,建议将此仓储设置为单例。
以下是仓储使用的示例,其中TestRepository实现了2个自定义方法:
public interface ITestRepository : IBaseMongoRepository
{
void DropTestCollection<TDocument>();
void DropTestCollection<TDocument>(string partitionKey);
}
public class TestRepository : BaseMongoRepository, ITestRepository
{
public TestRepository(string connectionString, string databaseName) : base(connectionString, databaseName)
{
}
public void DropTestCollection<TDocument>()
{
MongoDbContext.DropCollection<TDocument>();
}
public void DropTestCollection<TDocument>(string partitionKey)
{
MongoDbContext.DropCollection<TDocument>(partitionKey);
}
}
如果你的所有文档都有相同类型的Id
,你可以使用更具体的BaseMongoRepository<TKey>
,其中TKey
是你文档的Id
类型。
public class TestTKeyRepository<TKey> : BaseMongoRepository<TKey>, ITestRepository<TKey> where TKey : IEquatable<TKey>
{
const string connectionString = "mongodb://localhost:27017/MongoDbTests";
private static readonly ITestRepository<TKey> _instance = new TestTKeyRepository<TKey>(connectionString);
/// <inheritdoc />
private TestTKeyRepository(string connectionString) : base(connectionString)
{
}
}
实例化
可以按如下方式实例化仓储:
ITestRepository testRepository = new TestRepository(connectionString, "MongoDbTests");
ITestRepository<TKey> testTKeyRepository = new TestTKeyRepository<TKey>(connectionString);
如果你更喜欢在整个应用程序中重用同一个MongoDB数据库,你可以使用实现IMongoDatabase
接口的MongoDB驱动程序的MongoDatabase
:
var client = new MongoClient(connectionString);
var mongoDbDatabase = Client.GetDatabase(databaseName);
ITestRepository testRepository = new TestRepository(mongoDbDatabase);
添加文档
要添加文档,其类必须继承自Document
类,实现IDocument
或IDocument<TKey>
接口:
public class MyDocument : Document
{
public MyDocument()
{
Version = 2; // 如果随时间更改文档架构,可以提高文档版本
}
public string SomeContent { get; set; }
}
IDocument
和IDocument<TKey>
接口如下所示:
/// <summary>
/// 这个类代表可以存储在MongoDB中的基本文档。
/// 你的文档必须实现这个类,以便MongoDbRepository能够处理它们。
/// </summary>
public interface IDocument
{
Guid Id { get; set; }
int Version { get; set; }
}
/// <summary>
/// 这个类代表可以存储在MongoDB中的基本文档。
/// 你的文档必须实现这个类,以便MongoDbRepository能够处理它们。
/// </summary>
public interface IDocument<TKey> where TKey : IEquatable<TKey>
{
/// <summary>
/// 主键,如果你希望MongoDB C#驱动程序将其视为文档ID,则必须用[BsonId]属性修饰。
/// </summary>
[BsonId]
TKey Id { get; set; }
/// <summary>
/// 版本号,用于指示架构的版本。
/// </summary>
int Version { get; set; }
}
分区集合
此仓储还允许你将文档分区到多个集合中,这在运行SaaS应用程序并希望保持良好性能时很有用。
要使用分区集合,你必须使用实现IPartitionedDocument接口的PartitionedDocument类来定义你的文档:
public class MyPartitionedDocument : PartitionedDocument
{
public MyPartitionedDocument(string myPartitionKey) : base(myPartitionKey)
{
Version = 1;
}
public string SomeContent { get; set; }
}
这个分区键将作为您集合名称的前缀。 集合名称是由文档类型的名称派生而来的,设置为驼峰命名法,并使用 Humanizer (https://github.com/Humanizr/Humanizer) 中的一个类进行复数化。
var myDoc = new MyPartitionedDocument("myPartitionKey");
_testRepository.AddOne(myDoc);
上面的代码将生成一个名为 myPartitionKey-myPartitionedDocuments
的集合。
CollectionName 特性
现在可以使用 CollectionName
特性来更改集合名称:
[CollectionName("MyCollectionName")]
public class MyDocument : Document
{
public MyDocument()
{
Version = 2;
}
public string SomeContent { get; set; }
}
这种类型的文档将被插入到名为 "MyCollectionName" 的集合中。
索引管理
从版本 1.3.8 开始,MongoDbGenericRepository
实现了 IBaseMongoRepository_Index
和 IBaseMongoRepository_Index<TKey>
接口。
这暴露了以通用方式对集合进行编程式索引管理的功能。
以下方法已暴露并经过完整的集成测试:
- CreateAscendingIndexAsync
- CreateDescendingIndexAsync
- CreateCombinedTextIndexAsync
- CreateHashedIndexAsync
- CreateTextIndexAsync
- DropIndexAsync
- GetIndexesNamesAsync
使用示例:
string expectedIndexName = $"myCustomIndexName";
var option = new IndexCreationOptions
{
Name = expectedIndexName
};
// 执行
// 对文档的 Version 属性创建文本索引。
var result = await SUT.CreateTextIndexAsync<T, TKey>(x => x.Version, option, PartitionKey);
// 断言
var listOfIndexNames = await SUT.GetIndexesNamesAsync<T, TKey>(PartitionKey);
Assert.Contains(expectedIndexName, listOfIndexNames);
// 清理
await SUT.DropIndexAsync<T, TKey>(expectedIndexName, PartitionKey);
请参考 IntegrationTests (NET45) 和 CoreIntegrationTests (netstandard2.0) 项目以获取更多使用示例。
CoreIntegrationTests.Infrastructure.MongoDbTKeyDocumentTestBase<T, TKey>
测试类是一个很好的起点。
作者
Alexandre Spieser
许可证
mongodb-generic-repository 使用 MIT 许可证 - http://www.opensource.org/licenses/mit-license.php
MIT 许可证 (MIT)
版权所有 (c) 2016-2019 Alexandre Spieser
特此免费授予任何获得本软件副本和相关文档文件(下称"软件")的人不受限制地处置该软件的权利,包括不受限制地使用、复制、修改、合并、发布、分发、再许可和/或出售该软件副本,以及再授权被配发了本软件的人如上的权利,须在下列条件下:
上述版权声明和本许可声明应包含在该软件的所有副本或实质成分中。
本软件是"如此"提供的,没有任何形式的明示或暗示的保证,包括但不限于对适销性、特定用途的适用性和非侵权性的保证。在任何情况下,作者或版权持有人都不对任何索赔、损害或其他责任负责,无论这些追责来自合同、侵权或其它行为中,还是产生于、源于或有关于本软件以及本软件的使用或其它处置。
==============================================================================
Inflector (https://github.com/srkirkland/Inflector) MIT 许可证 (MIT) 版权所有 (c) 2013 Scott Kirkland
==============================================================================
Humanizer (https://github.com/Humanizr/Humanizer) MIT 许可证 (MIT) 版权所有 (c) 2012-2014 Mehdi Khalili (http://omar.io)
==============================================================================
版权
版权所有 © 2019