Azure Cosmos DB 中 Document API Repository 的实现

阅读需要大约 5 分钟。

前景:

Azure Cosmos DB 由 Microsoft 提供，是全球分布式多模型数据库。通过 Azure Cosmos DB 跨任意数量的 Azure 地理区域弹性且独立地缩放吞吐量和存储。它通过综合服务级别协议 (SLA) 提供吞吐量、延迟、可用性和一致性保证。Azure Cosmos DB 可以轻松地生成可缩放且响应迅速的全局规模应用程序。

介绍：

多个数据模型和用于访问及查询数据的常用 API。

Azure Cosmos DB 本身所基于的数据模型以 Atom 记录序列 (ARS) 为基础，该模型支持多个数据模型，包括但不限于文档、图形、键-值、表以及列系列数据模型。
多种语言的 SDK 均支持以下数据模型的 API：
SQL API：具有丰富 SQL 查询功能的无架构 JSON 数据库引擎。
MongoDB API：一种可大规模缩放的服务型 MongoDB，由 Azure Cosmos DB 平台提供支持。与现有 MongoDB 库、驱动程序、工具和应用程序兼容。
Cassandra API：一种可全局分发的服务型 Cassandra，由 Azure Cosmos DB 平台提供支持。与现有Apache Cassandra 库、驱动程序、工具和应用程序兼容。
Gremlin API：一种完全托管的、可横向缩放的图形数据库服务，可以轻松地用于生成和运行特定的应用程序，这些应用程序适用于支持开放式 Gremlin API（基于 Apache TinkerPop 规范：Apache Gremlin）的高度连接数据集。
表 API：一种键值对型数据库服务，可以在不进行任何应用更改的情况下，为现有的 Azure 表存储应用程序提供高级功能（例如，自动索引、低延迟保证、全局分发）

以上是引用Microsoft 官网中文文档，地址：https://docs.microsoft.com/zh-cn/azure/cosmos-db/introduction。

Azure Cosmos DB 是Microsoft 推出的云服务数据库，提供多种API 服务，以下主要讲的是SQL API，以json 形式的文档数据库。

Step 1: 配置环境（使用的是.net core 解决方案）

A > 在appsetting.json 中添加 AccountEndpoint 和 AccountKey

1"DocumentDb": { 
2　　"Endpoint": "https://localhost:8081", 
3　　"Key":"C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5WF2nQ9nDuVTqoch9b8mGGyPMbIZnqyMsEdsGQy67XIw/Jw==" 
4}

B > 创建Model 类,参数命名需要和appsetting.json 中的命名一样

1public class DocumentDbSetting
2    {
3        public string Endpoint { get; set; }
4        public string Key { get; set; }
5    }

C > 在 startup.cs 中添加配置信息

1public void ConfigureServices(IServiceCollection services)
2        {
3            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
4
5            // 添加的配置
6            var documentDbSection = Configuration.GetSection("DocumentDb");
7            services.Configure<DocumentDbSetting>(documentDbSection);
8        }

D > 创建DocumentDbRepository，获取appsetting.json 中的endpoint 和 key，构造client

1private readonly Lazy<IDocumentClient> _client;
2public DocumentDbRepository(IOptions<DocumentDbSetting> documentDbSetting)
3        {
4            var uri = new Uri(documentDbSetting.Value.Endpoint);
5            var documentClient = new DocumentClient(uri, documentDbSetting.Value.Key);
6
7            _client = new Lazy<IDocumentClient>(() => documentClient, true);
8        }

Step 2: 增删改查的实现

A > create document(databaseName 指数据库名，collectionName 指的是文档名（相当于表的名称），document 就是存储的一条记录)(以下代码中catch exception 简写了)

1public async Task<bool> CreateDocumentAsync<T>(string databaseName, string collectionName, T document) where T : class
2        {
3            try
4            {
5                await CreateDocumentCollectionAsync(collectionName, databaseName);
6                var uri = UriFactory.CreateDocumentCollectionUri(databaseName, collectionName);
7
8                var response = await _client.Value.CreateDocumentAsync(uri, document);
9
10                bool result = (response != null && (response.StatusCode == HttpStatusCode.Created || response.StatusCode == HttpStatusCode.OK));
11
12                return result;
13            }
14            catch (Exception ex)
15            {
16                throw new Exception(ex.Message);
17            }
18        }

　　在创建数据时，需要验证database和collection 是否存在，当不存在时，会创建的对应的database和collection。

1protected async Task<bool> CreateDatabaseAsync(string databaseName)
2        {
3            var db = await _client.Value.CreateDatabaseIfNotExistsAsync(new DocDatabase { Id = databaseName });
4
5            return db.StatusCode == HttpStatusCode.Created || db.StatusCode == HttpStatusCode.OK;
6        }
7
8protected async Task<bool> CreateDocumentCollectionAsync(string collectionName, string databaseName)
9        {
10            if (string.IsNullOrWhiteSpace(databaseName))
11            {
12                throw new ArgumentNullException(nameof(databaseName));
13            }
14
15            if (await CreateDatabaseAsync(databaseName))
16            {
17                var result = await _client.Value.CreateDocumentCollectionIfNotExistsAsync(
18                    UriFactory.CreateDatabaseUri(databaseName), new DocumentCollection
19                    {
20                        Id = collectionName,
21                        IndexingPolicy = new IndexingPolicy(new RangeIndex(DataType.String) { Precision = -1 })
22                    });
23
24                return result.StatusCode == HttpStatusCode.Created || result.StatusCode == HttpStatusCode.OK;
25            }
26
27            return false;
28        }

B > 修改document有两种方式Upsert 和Replace，Upsert 的特点是当没有这条数据时，会创建一条，而Replace 会报异常。

Upsert Document

1public async Task<bool> UpdateDocumentAsync<T>(string databaseName, string collectionName, T document) where T : class
2        {
3            try
4            {
5                var uri = UriFactory.CreateDocumentCollectionUri(databaseName, collectionName);
6                var result = await _client.Value.UpsertDocumentAsync(uri, document);
7
8                return result.StatusCode == HttpStatusCode.OK || result.StatusCode == HttpStatusCode.Created;
9            }
10            catch (Exception ex)
11            {
12                throw new Exception(ex.Message);
13            }
14        }

Replace Document

1public async Task<bool> ReplaceDocumentAsync<T>(string databaseName, string collectionName, T document, string id) where T : class
2        {
3            try
4            {
5                var uri = UriFactory.CreateDocumentUri(databaseName, collectionName, id);
6                var result = await _client.Value.ReplaceDocumentAsync(uri, document);
7
8                return result.StatusCode == HttpStatusCode.OK;
9            }
10            catch (Exception ex)
11            {
12                throw new Exception(ex.Message);
13            }
14        }

C > Get Document

根据Id获取Document

1public async Task<T> GetDocument<T>(string databaseName, string collectionName, string id, FeedOptions feedOptions = null) where T : class
2        {
3            try
4            {
5                Document document = await _client.Value.ReadDocumentAsync(UriFactory.CreateDocumentUri(databaseName, collectionName, id));
6
7                return (T)(dynamic)document;
8            }
9            catch (Exception ex)
10            {
11                throw new Exception(ex.Message);
12            }
13        }

根据条件获取Documents

1public async Task<IEnumerable<T>> GetQueryable<T>(string databaseName, string collectionName, Expression<Func<T, bool>> predicate, FeedOptions feedOptions = null) where T : new()
2        {
3            var dummy = new T();
4
5            IDocumentQuery<T> query = _client.Value.CreateDocumentQuery<T>(UriFactory.CreateDocumentCollectionUri(databaseName, collectionName), feedOptions)
6                .Where(predicate)
7                .AsDocumentQuery();
8
9            var results = new List<T>();
10
11            while (query.HasMoreResults)
12            {
13                results.AddRange(await query.ExecuteNextAsync<T>());
14            }
15
16            return results;
17        }

D > Delete Document

1public async Task<bool> DeleteDocumentAsync(string databaseName, string collectionName, string documentId)
2        {
3            try
4            {
5                var documentResponse = await _client.Value.DeleteDocumentAsync(UriFactory.CreateDocumentUri(databaseName, collectionName, documentId));
6                return documentResponse.StatusCode == HttpStatusCode.NoContent;
7            }
8            catch (Exception ex)
9            {
10                throw new Exception(ex.Message);
11            }
12        }

本地测试开发使用工具：

Azure Cosmos DB Emulator. 下载地址：https://aka.ms/cosmosdb-emulator ，使用方法。

Microsoft Azure Storage Explorer 是存储资源管理器下载地址：https://azure.microsoft.com/en-us/features/storage-explorer/ ，使用方法。

在当前的版本中 1. 不支持skip 分页和group by 分组。 2. 不支持批量操作（插入，修改）等。

以上只是本人学习笔记分享！有许多不足之处，还在继续添加和更正。本随笔链接：https://www.cnblogs.com/OneManStep/p/10161565.html

Azure Cosmos DB 中 Document API Repository 的实现

评论区

相关推荐