.NET中全新的MongoDb?ORM框架SqlSugar詳解(最新)

更新時(shí)間：2025年07月02日 14:02:59 作者：阿妮亞

.NET中好用的MongoDb ORM很少,選擇也很少,所以我打造了一款適合SQL習(xí)慣的MongoDb ORM,讓用戶(hù)多一個(gè)選擇,本文給大家介紹.NET中全新的MongoDb ORM框架SqlSugar詳解,感興趣的朋友一起看看吧

1、 MongoDB ORM教程

1.1 NUGET 安裝

SqlSugar.MongoDbCore
SqlSugarCore

1.2 已支持功能

單表CRUD+分頁(yè)+排序+簡(jiǎn)單分組+嵌套文件（類(lèi)似Json類(lèi)型）+簡(jiǎn)單聯(lián)表

1.3 創(chuàng)建DB對(duì)象

//注冊(cè)DLL防止找不到DLL（扔在程序啟動(dòng)時(shí)）
 InstanceFactory.CustomAssemblies = new System.Reflection.Assembly[] {
 typeof(SqlSugar.MongoDb.MongoDbProvider).Assembly };
 //db對(duì)象（用法和sqlsugar入門(mén)中一樣）
  var db = new SqlSugarClient(new ConnectionConfig()
  {
      IsAutoCloseConnection = true,
      DbType = DbType.MongoDb,
      ConnectionString = SqlSugarConnectionString 
  },
  it =>
  { 
      it.Aop.OnLogExecuting = (sql, para) =>
      {   //AOP打印SQL
          Console.WriteLine(UtilMethods.GetNativeSql(sql, para));
      };
  });
 //字符串2種都可以
var ConnectionString = "mongodb://root:123456@222.71.212.3:27017/testDB?authSource=admin";
var  ConnectionString  = "host=222.71.212.3;Port=27017;Database=testDB;Username= root;Password=123456;authSource=admin;replicaSet=";

1.4 實(shí)體類(lèi)定義（重點(diǎn)注意）

主鍵定義：繼承MongoDbBase里面自定義好了主鍵

外鍵定義：設(shè)置 ColumnDataType =nameof(ObjectId)

//繼承的MongoDbBase里面已經(jīng)有了主鍵，當(dāng)然你也可以復(fù)制出來(lái)不用基類(lèi)
   public class Student:MongoDbBase
   {
       //主鍵在基類(lèi)，也可以自個(gè)復(fù)制出來(lái)不用基類(lèi)
       public string Name { get; set; }
       //外鍵需要設(shè)置ObjectId類(lèi)型不然存儲(chǔ)會(huì)的是string
       [SqlSugar.SugarColumn(ColumnDataType =nameof(ObjectId))]
       public string SchoolId { get; set; }
   }
//MongoDbBase是ORM自帶的一個(gè)類(lèi)，方便你不定義主鍵
public class MongoDbBase
{
    [SugarColumn(IsPrimaryKey = true, IsOnlyIgnoreInsert = true, ColumnName = "_id")]
    public string Id { get; set; }
}

2、CRUD用例

2.1 插入

//插入無(wú)返回值
db.Insertable(data).ExecuteCommand();
//插入并將主鍵賦值到實(shí)體
db.Insertable(data).ExecuteCommandIdentityIntoEntity();
//插入返回IDS
var ids= db.Insertable(data).ExecuteReturnPkList<string>();

2.2 查詢(xún)

MongoDb一般是單表操作比較多，官方并不推薦聯(lián)表操作一般用json做嵌套文檔比較多

不過(guò)SqlSugar也支持了聯(lián)表

//簡(jiǎn)單查詢(xún)
var data2 = db.Queryable<Student>().Where(it => it.Book.Price == 1).ToList(); 
//分頁(yè)
var count = 0;
var list = db.Queryable<School>().OrderBy(it=>it.Name).ToPageList(1,2,ref count); 
//json類(lèi)型（實(shí)體定義isjson）
var data2 = db.Queryable<Student>().Where(it => it.Book.Price == 1).ToList();
//簡(jiǎn)單聯(lián)表（目前只能支持這種基本聯(lián)表）
var list = db.Queryable<Student>()
  .LeftJoin<School>((x, y) => x.SchoolId == y.Id)
  .LeftJoin<School>((x, y, z) => x.SchoolId == z.Id)
  .Where((x, y) =>y.Name == "TestSchool")
  .Select((x, y,z) => new
  {
      StudentName = x.Name,
      SchoolName = y.Name,
      SchoolName2=z.Name
  }).ToList();
 //簡(jiǎn)單分組查詢(xún)
   var list14 = db.Queryable<OrderInfo>()
     .GroupBy(it => new { it.Name ,it.Price })
     .Select(it => new
     {
         key = it.Name,
         Prie=it.Price,
         groupCount = SqlFunc.AggregateCount(it.Id),
         max = SqlFunc.AggregateMax(it.Id),
         min = SqlFunc.AggregateMin(it.Id)
     }).ToList(); 
  //目前不支持導(dǎo)航查詢(xún)和子查詢(xún)

2.3 刪除

//根據(jù)主鍵岀隊(duì)string [] ids= [...]
db.Deleteable<Student>().In(ids).ExecuteCommandAsync() 
//根據(jù)實(shí)體刪除,實(shí)體要有主鍵 var delrow = db.Deleteable(data).ExecuteCommand();

2.4 更新

var updateRow2 = db.Updateable(new List<OrderInfo>() 
   {
       new OrderInfo() { Id = ids.First(),Name="a31",Price=11},
       new OrderInfo() { Id = ids.Last(),Name="a41"}
   })
  .ExecuteCommand();
   var updateRow3= db.Updateable<OrderInfo>()
    .SetColumns(it=>it.Name=="xx")
    .Where(it=> it.Id == id)
   .ExecuteCommand();

2.5 使用原生SQL

db.Ado.ExecuteCommand(@"insertMany UnitSchool123131  [{ ""Name"" : ""XX大學(xué)"" }]");
//C#對(duì)象構(gòu)造  
var documents = new[]
{
    new BsonDocument { { "Name", "XX大學(xué)" } }
}; 
var bsonArray = new BsonArray(documents).ToJson();
var cmd = $"insertMany UnitSchool123131 {json}";
db.Ado.ExecuteCommand(cmd);
//查詢(xún)
 var list=db.Ado.SqlQuery<T>(cmd);
 var dt=db.Ado.GetDataTable(cmd);
//sqlsugar中獲取原生對(duì)象
IMongoDatabase rdb= ((MongoDbConnection)db.Ado.Connection).GetDatabase(); 
//IMongoDatabase 是什么東西？
//var client = new MongoClient("mongodb://localhost:27017");
//IMongoDatabase database = client.GetDatabase("TestDatabase");