asp.net core集成MongoDB的完整步驟

更新時(shí)間：2018年10月13日 15:17:00 作者：LouieGuo

前兩天在學(xué)習(xí)MongoDB相關(guān)的知識(shí)，做了個(gè)小Demo，下面這篇文章主要給大家介紹了關(guān)于asp.net core集成MongoDB的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，需要的朋友可以參考下

一、前言及MongoDB的介紹

最近在整合自己的框架，順便把MongoDBD的最簡(jiǎn)單CRUD重構(gòu)一下作為組件化集成到asp.net core項(xiàng)目中，當(dāng)然此篇文章中沒(méi)有講解mongodb的集群部署，等有機(jī)會(huì)分享一下。

首先，我們?cè)贛ongoDB的官方文檔中看到，MongoDb的2.4以上的For .Net的驅(qū)動(dòng)是支持.Net Core 2.0的。

針對(duì)MongoDB，我想大家應(yīng)該不陌生，沒(méi)有用過(guò)也有聽(tīng)過(guò)。

1、mongodb是什么？

MongoDB是一個(gè)基于分布式文件存儲(chǔ)的數(shù)據(jù)庫(kù)，為web應(yīng)用提供可擴(kuò)展的高性能數(shù)據(jù)存儲(chǔ)解決方案，介于關(guān)系型數(shù)據(jù)庫(kù)和非關(guān)系型數(shù)據(jù)庫(kù)的產(chǎn)品，是非關(guān)系型數(shù)據(jù)庫(kù)中功能最豐富的。針對(duì)于數(shù)據(jù)處理是一把利器。

2、什么是關(guān)系型數(shù)據(jù)庫(kù)和非關(guān)系型數(shù)據(jù)庫(kù)？

關(guān)系型數(shù)據(jù)庫(kù)：在我們所用過(guò)的sqlserver、mysql等，這些都是關(guān)系型數(shù)據(jù)庫(kù)，并且關(guān)系型數(shù)據(jù)庫(kù)是遵循ACID原則的，嚴(yán)格的一致性。

非關(guān)系型數(shù)據(jù)庫(kù)：也叫作NoSQL，用與超大規(guī)模數(shù)據(jù)的存儲(chǔ)，這些類型的數(shù)據(jù)存儲(chǔ)不需要固定的模式，無(wú)需多余的操作就可以橫向擴(kuò)展。

3、RDBMS VS NoSQL

RDBMS:

　　高度組織結(jié)構(gòu)化數(shù)據(jù)

　　結(jié)構(gòu)化查詢語(yǔ)言

　　數(shù)據(jù)和關(guān)系都存儲(chǔ)在單獨(dú)的表中

　　嚴(yán)格一致性

　　基礎(chǔ)事務(wù)

NoSQL：

　　沒(méi)有聲明性查詢語(yǔ)言

　　鍵-值對(duì)存儲(chǔ)，列存儲(chǔ)、文檔存儲(chǔ)等

　　最終一致性

　　非結(jié)構(gòu)化和不可預(yù)知數(shù)據(jù)

　　CAP定理、高可用、高性能、高擴(kuò)展

我相信講到這里，眼尖的同學(xué)應(yīng)該有注意到 CAP定理和最終一致性，肯定會(huì)聯(lián)想到分布式系統(tǒng)，在這里給你大大的一個(gè)贊。在分布式系統(tǒng)中可以完美的結(jié)合nosql，提高我們的性能。

4、介紹一下RDBMS與Mongodb的一些概念，有助于幫助大家理解

翻譯一下，即如下：

二、asp.net core集成mongoDB

1、為了演示方便我下載了 windows版本的mongodb server

大家可以自行去官網(wǎng)下載，然后針對(duì)于可視化界面，我采用了 Robo 3T 這個(gè)工具。很簡(jiǎn)潔美觀的可視化工具。推薦大家使用。

安裝結(jié)束后會(huì)在windows服務(wù)中看到mongodb server

然后我們打開(kāi)一下Robo 3T，連接我們的mongodb。

2、開(kāi)始在項(xiàng)目中配置一下我們的mongodb吧

第一步：我新建一個(gè)Core2.0類庫(kù)

引入了 “MongoDB.Driver” 這個(gè)nuget包。

然后擴(kuò)展了 Startup.cs 中的Services的擴(kuò)展方法

//擴(kuò)展方法public static class ServiceCollectionExtensions
 {
 public static void AddMongoDB(this IServiceCollection services, IConfiguration configuration)
 {
  services.Configure<Settings>(options =>
  {
  options.ConnectionString = configuration.GetSection("MongoConnection:ConnectionString").Value;
  options.Database = configuration.GetSection("MongoConnection:Database").Value;
  });
 }
 }

第二步：重構(gòu)封裝了mongodb的CRUD類，此處大家可以自行封裝，只展示了查找和新增。

public class MongoDBBase
 {
 private readonly IMongoDatabase _database = null;
 public MongoDBBase(string connectionString, string databaseName)
 {
  var client = new MongoClient(connectionString);
  if (client != null)
  {
  _database = client.GetDatabase(databaseName);
  }
 }

 #region SELECT
 /// <summary>
 /// 根據(jù)查詢條件，獲取數(shù)據(jù)
 /// </summary>
 /// <typeparam name="T"></typeparam>
 /// <param name="id"></param>
 /// <returns></returns>
 public List<T> GetList<T>(Expression<Func<T, bool>> conditions = null)
 {
  var collection = _database.GetCollection<T>(typeof(T).Name);
  if (conditions != null)
  {
  return collection.Find(conditions).ToList();
  }
  return collection.Find(_ => true).ToList();
 }#endregion

 #region INSERT/// <summary>
 /// 插入多條數(shù)據(jù)，數(shù)據(jù)用list表示
 /// </summary>
 /// <typeparam name="T"></typeparam>
 /// <param name="list"></param>
 /// <returns></returns>
 public List<T> InsertMany<T>(List<T> list)
 {
  var collection = _database.GetCollection<T>(typeof(T).Name);
  collection.InsertMany(list);
  return list;
 }
 #endregion
 }

第三步：新建一個(gè)asp.net core webapi 項(xiàng)目，引用此類庫(kù)進(jìn)行演示

在項(xiàng)目中的 appsetting.json 添加 mongodb的連接字符串：我在這邊使用自定義的一個(gè)數(shù)據(jù)名稱 testdb，在插入mongodb的時(shí)候會(huì)會(huì)自動(dòng)在創(chuàng)建數(shù)據(jù)庫(kù)和集合以及文檔。接著往下看

 "MongoConnection": { //mongodb數(shù)據(jù)庫(kù)連接
 "ConnectionString": "mongodb://127.0.0.1:27017",
 "Database": "testdb",
 "IsSSL": true
 },

第四步：新建一個(gè)mongodb測(cè)試控制器，展示了插入單條和多條以及查詢的接口。

[Produces("application/json")]
 [Route("api/MongoDB/[action]")]
 public class MongoDBController : Controller
 {
  private readonly MongoDBBase _context = null;
  public MongoDBController(IOptions<Settings> settings)
  {
   _context = new MongoDBBase(settings.Value.ConnectionString, settings.Value.Database);
  }
  [HttpGet]
  public IActionResult AddList()
  {
   List<MongoDBPostTest> list = new List<MongoDBPostTest>()
   {
    new MongoDBPostTest()
    {
     Id = "2",
     Body = "Test note 3",
     UpdatedOn = DateTime.Now,
     UserId = 1,
     HeaderImage = new NoteImage
     {
      ImageSize = 10,
      Url = "http://localhost/image1.png",
      ThumbnailUrl = "http://localhost/image1_small.png"
     }
    },
    new MongoDBPostTest()
    {
     Id = "3",
     Body = "Test note 4",
     UpdatedOn = DateTime.Now,
     UserId = 1,
     HeaderImage = new NoteImage
     {
      ImageSize = 14,
      Url = "http://localhost/image3.png",
      ThumbnailUrl = "http://localhost/image3_small.png"
     }
    }
   };

   try
   {
    _context.InsertMany(list);
   }
   catch (Exception ex)
   {

    throw;
   }

   return Ok("成功");
  }

  [HttpGet]
  public Result<List<MongoDBPostTest>> SelectSingle()
  {
   //無(wú)條件
   var list = _context.GetList<MongoDBPostTest>();

   //有條件
   //var list = _context.GetList<MongoDBPostTest>(a => a.Id == "1");

   //得到單條數(shù)據(jù),無(wú)條件
   //var list = _context.GetSingle<MongoDBPostTest>();

   //得到單條數(shù)據(jù),有條件
   //var list = _context.GetSingle<MongoDBPostTest>(a => a.Id == "3");

   ObjectId internalId = _context.GetInternalId("5bbf41651d3b66668cbb5bfc");

   var a = _context.GetSingle<MongoDBPostTest>(note => note.Id == "5bbf41651d3b66668cbb5bfc" || note.InternalId == internalId);

   return ResHelper.Suc(1, list, "成功");
  }
}

測(cè)試類

public class MongoDBPostTest
 {
  [BsonId]
  // standard BSonId generated by MongoDb
  public ObjectId InternalId { get; set; }
  public string Id { get; set; }

  public string Body { get; set; } = string.Empty;

  [BsonDateTimeOptions]
  public DateTime UpdatedOn { get; set; } = DateTime.Now;

  public NoteImage HeaderImage { get; set; }

  public int UserId { get; set; } = 0;
 }

public class NoteImage
 {
  public string Url { get; set; } = string.Empty;
  public string ThumbnailUrl { get; set; } = string.Empty;
  public long ImageSize { get; set; } = 0L;
 }

第五步：運(yùn)行項(xiàng)目，執(zhí)行一下。

我們執(zhí)行一下插入多條的數(shù)據(jù)吧，執(zhí)行成功。