MongoDB .Net Driver(C#驅動) - 內嵌數組/嵌入文檔的操作(增加、刪除、修改、查詢(Linq 分頁))

標籤：generic   環境   one   文章   eid   html   isnull   準備工作   資料庫名   

目錄

• 一、前言
  • (一) 運行環境
• 二、前期準備工作
  • （一) 建立 MongoDBContext MongoDb操作上下文類
  • （二）建立測試類別
  • （三） 建立測試代碼
• 三、內嵌數組增加元素操作
  • （一） Update.Set()方法 替換內嵌數組（不推薦使用）
  • （二）Update.Push()方法 直接將元素壓入內嵌數組（推薦）
  • (三) Update.PushEach()方法 將多個元素壓入內嵌數組（推薦）
• 四、內嵌數組刪除元素操作
  • (一) Update.Set()方法 替換內嵌數組（不推薦使用）
  • (二) Update.Pull()方法 Pull刪除一個元素（推薦）
  • （三）Update.PullFilter()方法 刪除過濾器刪除元素（推薦）
• 五、內嵌數組修改元素操作
  • （一） Update.Set() Set先查詢後修改（不推薦）
  • （二） Update.Set() 配合過濾器修改（推薦）
• 六、內嵌數組尋找元素操作(Linq)
  • （一）Linq查詢一條記錄（推薦）
  • （二）Linq查詢分頁 (推薦)
• 七、總結

一、前言

本教程是入門基礎教程，主要是筆者在項目中使用MongoDB .Net官方驅動對MongoDB內嵌文檔的操作時遇到了很多不方便的情況，踩了很多的坑，所以單獨整理出來一篇文章，來講一講筆者踩坑的過程。

筆者水平有限，如有錯誤還請批評指正！

(一) 運行環境

.net版本

.Net Framwork 4.6.2 x64

MongoDb資料庫版本

MongoDb 3.6.2 x64

驅動版本

MongoDb Driver 2.5

筆者採用的MongoDB驅動是官方2.5版本驅動，大家可以通過下載GitHub源碼自行編譯，或者通過NuGet包管理工具安裝。
GitHub地址：戳一戳查看、Link
NuGet地址：戳一戳查看、Link

本例源碼已上傳至Gitee

本例源碼地址：戳一戳、Link

二、前期準備工作（一) 建立 MongoDBContext MongoDb操作上下文類

建立MongoDBContext操作上下文類,用於串連Mongodb資料庫和管理Collection對象

using MongoDB.Bson;using MongoDB.Driver;using System;using System.Collections.Generic;using System.Security.Authentication;using System.Threading.Tasks;namespace MongoDBEmbeddedOperation{    public class MongoDbContext    {        #region Fields        /// <summary>        /// 緩衝Mongodb集合        /// </summary>        private Dictionary<string, object> _collectionsMongoDb;        #endregion        #region Properties        /// <summary>        /// 資料庫連接字串        /// </summary>        public string ConnectionString { get; }        /// <summary>        /// Mongo用戶端設定        /// </summary>        public MongoClientSettings Settings { get; }        /// <summary>        /// 資料庫名稱        /// </summary>        public string DatabaseName { get; }        /// <summary>        /// Mongo上下文         /// </summary>        public IMongoDatabase DbContext { get; }        #endregion        /// <summary>        /// MongoDb資料內容        /// </summary>        /// <param name="connectionString">        /// 連接字串，如："mongodb://username:[email protected]:port/[DatabaseName]?ssl=true"        /// 詳情參見：http://www.runoob.com/mongodb/mongodb-connections.html        /// </param>        public MongoDbContext(string connectionString)        {            if (string.IsNullOrWhiteSpace(connectionString))                throw new ArgumentException("connectionString 連接字串不可為空!");            try            {                var mongoUrl = new MongoUrl(connectionString);                ConnectionString = connectionString;                Settings = MongoClientSettings.FromUrl(mongoUrl);                if (string.IsNullOrWhiteSpace(mongoUrl.DatabaseName))                    throw new ArgumentException("資料庫名稱不可為空！");                DatabaseName = mongoUrl.DatabaseName;                // SSL加密                if (Settings.UseSsl)                {                    Settings.SslSettings = new SslSettings                    {                        EnabledSslProtocols = SslProtocols.Tls12                    };                }                var mongoClient = new MongoClient(Settings);                DbContext = mongoClient.GetDatabase(DatabaseName);            }            catch (Exception e)            {                // TODO: 記錄錯誤記錄檔                throw;            }        }        /// <summary>        /// 非同步擷取集合        /// </summary>        /// <typeparam name="TEntity"></typeparam>        /// <returns></returns>        public async Task<IMongoCollection<TEntity>> GetCollectionAsync<TEntity>() where TEntity : class        {            // 集合緩衝如果為空白，那麼建立一個            if (_collectionsMongoDb == null)            {                _collectionsMongoDb = new Dictionary<string, object>();            }            // 擷取集合名稱，使用的標準是在實體類型名後添加Set            var collectionName = $"{typeof(TEntity).Name}Set";            // 如果集合不存在，那麼建立集合            if (false == await IsCollectionExistsAsync<TEntity>())            {                await DbContext.CreateCollectionAsync(collectionName);            }            // 如果緩衝中沒有該集合，那麼加入緩衝            if (!_collectionsMongoDb.ContainsKey(collectionName))            {                _collectionsMongoDb[collectionName] = DbContext.GetCollection<TEntity>(collectionName);            }            // 從緩衝中取出集合返回            return (IMongoCollection<TEntity>)_collectionsMongoDb[collectionName];        }        /// <summary>        /// 集合是否存在        /// </summary>        /// <typeparam name="TEntity"></typeparam>        /// <returns></returns>        public async Task<bool> IsCollectionExistsAsync<TEntity>()        {            var filter = new BsonDocument("name", $"{typeof(TEntity).Name}Set");            // 通過集合名稱過濾            var collections = await DbContext.ListCollectionsAsync(new ListCollectionsOptions { Filter = filter });            // 檢查是否存在            return await collections.AnyAsync();        }    }}

（二）建立測試類別

假設當前是一個物聯網資料擷取項目，其中有很多個感應器節點(SensorNode)，每個節點都會產生記錄(Records),一條記錄(Record)由資料值(Data)和記錄時間(RecordDateTime)組成。要求對其Recods內嵌數組進行增刪改查操作。

那麼由上需求可以抽象出如下對象關係，在實際應用中，不建議將記錄直接放在SensorNode下，因為Mongodb資料庫對單個文檔有16MB的大小限制。

    /// <summary>    /// 感應器節點    /// </summary>    public class SensorNode    {        /// <summary>        /// ID        /// </summary>        public ObjectId Id { get; set; }        /// <summary>        /// 記錄數        /// </summary>        public List<Record> Records { get; set; }    }    /// <summary>    /// 資料記錄    /// </summary>    public class Record    {        /// <summary>        /// 資料值        /// </summary>        public double Data { get; set; }        /// <summary>        /// 記錄時間        /// </summary>        public DateTime RecorDateTime { get; set; }    }

測試類別所對應的Bson結構，如下所示.

{    "_id" : ObjectId("5aa877e4aa25752ab4d4cae3"),    "Records" : [         {            "Data" : 1962163552.0,            "RecorDateTime" : ISODate("2018-03-16T10:01:14.931Z")        },         {            "Data" : 1111405346.0,            "RecorDateTime" : ISODate("2018-03-16T08:53:14.931Z")        },        ......    ]}

（三） 建立測試代碼

建立一個控制台程式，加入以下代碼。對MongodbContext進行初始化，插入用於測試的SensorNode.

using System;using System.Collections.Generic;using System.Text;using System.Threading.Tasks;using MongoDB.Bson;using MongoDB.Driver.Linq; // <---- 此引用非常重要using MongoDB.Driver;......private static ObjectId _sensorNodeId;private static MongoDbContext _dbContext;private static IMongoCollection<SensorNode> _sensorNodes;static void Main(string[] args){    // 使用連結字串建立dbContext對象    _dbContext = new MongoDbContext("mongodb://hynuAdmin:[email protected]:27017/HynuIOTA");    // 建立_Sensors資料庫,入口方法不能使用非同步，我們等待結果返回    _sensorNodes = _dbContext.GetCollectionAsync<SensorNode>().Result;    // 建立一個SensorNode 存入MongoDb資料庫中    _sensorNodeId = ObjectId.Parse("5aa877e4aa25752ab4d4cae3");    #region 建立測試案例    var sensorNode = new SensorNode()    {        Id = _sensorNodeId,        Records = new List<Record>()    };    // 插入資料庫中    _sensorNodes.InsertOne(sensorNode);    #endregion}

添加一個方法，用於隨機產生Record對象。

/// <summary>/// 產生count個Rocred對象/// </summary>/// <param name="count">產生數量</param>/// <returns></returns>static List<Record> GetRandomRecord(int count){    var records = new List<Record>();    var rd = new Random();    for (int i = 0; i < count; i++)    {        records.Add(new Record()        {            Data = rd.Next(),            RecorDateTime = DateTime.Now.AddMinutes(rd.Next() % 100)        });    }    return records;}

三、內嵌數組增加元素操作（一） Update.Set()方法 替換內嵌數組（不推薦使用）

此方法主要使用操作符[$set]，它的思路是先將內嵌文檔的父元素尋找出來，然後對子文檔數組進行增刪改操作，最後將子文檔數組重新替換。此方式效能較低，除非涉及到大批量更改，否則不推薦使用。

    #region 方法一. 查出sensor再更新Records, $set操作 - 隨機插入100個元素(不推薦)    // 查詢需修改的sensorNode對象    var sensor = await _sensorNodes.Find(s => s.Id == _sensorNodeId).FirstOrDefaultAsync();    // 往Records裡面增加隨機元素    sensor.Records.AddRange(GetRandomRecord(100));    // 構建update Bson, 將原有Records替換為新的Records    var update = Builders<SensorNode>.Update.Set(d => d.Records, sensor.Records);    // 使用Update方法    await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, update);    #endregion

（二）Update.Push()方法 直接將元素壓入內嵌數組（推薦）

此方法主要使用操作符[$push]來增加元素到子文檔數組，效能好，推薦使用。

// 構建update Bson ,添加一條記錄使用Push方法var updateOne = Builders<SensorNode>.Update.Push(d => d.Records, GetRandomRecord(1).First());// 更新await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, updateMany);

(三) Update.PushEach()方法 將多個元素壓入內嵌數組（推薦）

此方法使用的也是[$push]操作符，只是在產生BsonDocument時允許接收數組。

#region 方法二. $push操作 - 隨機插入100個元素(推薦)// 構建update Bson 添加多條記錄使用PushEach方法var updateMany = Builders<SensorNode>.Update.PushEach(d => d.Records, GetRandomRecord(100));// 更新await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, updateMany);#endregion

四、內嵌數組刪除元素操作(一) Update.Set()方法 替換內嵌數組（不推薦使用）

此方式思路和增加元素的思路一致，效能較低，不推薦使用。

#region 方法一 . $set方式刪除 - 刪除前5個元素(不推薦)// 查詢需修改的sensorNode對象var sensor = await _sensorNodes.Find(s => s.Id == _sensorNodeId).FirstOrDefaultAsync();// 刪除Recordfor (int i = 0; i < 5; i++){    sensor.Records.RemoveAt(i);}// 構建update Bson, 將原有Records替換為新的Recordsvar update = Builders<SensorNode>.Update.Set(d => d.Records, sensor.Records);// 使用Update方法await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, update);#endregion

(二) Update.Pull()方法 Pull刪除一個元素（推薦）

// 假設需要刪除的Record已經被查詢轉換為對象，那麼使用Pull方式刪除一個元素var record = new Record() { Data = 1670941112.0, RecorDateTime = DateTime.Parse("2018-03-16T09:36:14.930Z") };// 構建Pull刪除Bsonvar update = Builders<SensorNode>.Update.Pull(s => s.Records, record);// 使用Update方法await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, update);

（三）Update.PullFilter()方法 刪除過濾器刪除元素（推薦）

#region 方法三. PullFilter方式刪除 - 刪除符合Filter條件的元素(推薦)// 如果r.Data == 339119843.0，那麼從數組中刪除var update = Builders<SensorNode>.Update.PullFilter(s => s.Records, r => r.Data == 339119843.0);await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, update);#endregion

五、內嵌數組修改元素操作（一） Update.Set() Set先查詢後修改（不推薦）

此方式效能較低，不推薦。

#region 方法一. $set方式修改(將某個元素記錄時間改為最小值) - 先查詢後修改(不推薦)// 查詢需修改的sensorNode對象var sensor = await _sensorNodes.Find(s => s.Id == _sensorNodeId).FirstOrDefaultAsync();// 修改Record值sensor.Records[0].RecorDateTime = DateTime.MinValue;// 構建update Bson, 將原有Records替換為新的Recordsvar update = Builders<SensorNode>.Update.Set(d => d.Records, sensor.Records);// 使用Update方法await _sensorNodes.UpdateOneAsync(s => s.Id == _sensorNodeId, update);#endregion

（二） Update.Set() 配合過濾器修改（推薦）

在資料庫內部完成過濾和修改，效能高，推薦使用。

#region 方法二. $set方式修改(將Data = 1835821478.0的元素記錄時間改為最大值) - 直接過濾修改(推薦)// 構造filter var filter = Builders<SensorNode>.Filter.Where(s => s.Id == _sensorNodeId) & Builders<SensorNode>.Filter.Where(d => d.Records.Any(r => r.Data == 1835821478.0));// 執行更新var update = Builders<SensorNode>.Update.Set(d => d.Records[-1].RecorDateTime, DateTime.MaxValue);await _sensorNodes.UpdateOneAsync(filter, update);#endregion

六、內嵌數組尋找元素操作(Linq)

對於內嵌數組/文檔的查詢，在.net裡建議直接使用Linq或拼接BsonDocument。筆者著重使用Linq方式。

需要先using MongoDB.Driver.Linq,否則Linq無法使用。

（一）Linq查詢一條記錄（推薦）

主要是SelectMany()方法的使用，此方法用於選擇一個數組。

#region SelectMany查詢內嵌數組(查詢Data = 1340695206.0的第一條記錄) - (推薦)// 轉換為Queryablevar result = await _sensorNodes.AsQueryable()    // 尋找對應的sensorNode    .Where(s => s.Id == _sensorNodeId)    // 選擇Records內嵌數組    .SelectMany(s => s.Records)    // 尋找Data == 1340695206.0的元素    .Where(r => r.Data == 1340695206.0)    // 取第一個    .FirstOrDefaultAsync();#endregion

（二）Linq查詢分頁 (推薦)

主要區別使用SelectMany其它與EF Linq方式差不多

#region SelectMany、Skip、Take內嵌數組排序分頁 - (推薦)// 頁碼var index = 4;// 頁面大小var size = 10;// 轉換為Queryablevar page = await _sensorNodes.AsQueryable()    // 尋找對應的sensorNode    .Where(s => s.Id == _sensorNodeId)    // 選擇Records內嵌數組    .SelectMany(s => s.Records)    // 根據記錄時間排序    .OrderBy(r => r.RecorDateTime)    // 跳過 index - 1頁資料    .Skip((index - 1) * size)    // 選取一頁資料    .Take(size)    // 轉換為集合    .ToListAsync();#endregion

對內嵌數組的查詢操作主要是通過彙總來實現，以上代碼轉換為Native方式後是以下命令。

aggregate([    {"$match" : { "_id" : ObjectId("5aa877e4aa25752ab4d4cae3") } },     { "$unwind" : "$Records" },     { "$project" : { "Records" : "$Records", "_id" : 0 } },     { "$sort" : { "Records.RecorDateTime" : 1 } }, { "$skip" : 30 }, { "$limit" : 10 }]);

如果同時引用了System.Linq 和 MongoDB.Driver.Linq 調用Linq方法會產生方法二義性，解決方案連結如下。
Linq方法二義性解決方案：
http://blog.csdn.net/qq_27441069/article/details/79586216

七、總結

  本文簡單的介紹了MongoDB C#驅動對內嵌文檔的增刪改查操作，筆者水平有限，如有錯誤請批評指正！  歡迎轉載，請註明來源！

MongoDB .Net Driver(C#驅動) - 內嵌數組/嵌入文檔的操作(增加、刪除、修改、查詢(Linq 分頁))