C# 動態創建類，動態創建表，支持多庫的資料庫維護方案

簡介

本文主要介紹使用 利用 SqlSugar  來實現多資料庫的維護 ，動態建類CRUD，動態建表 ，全局過濾器 ，跨庫查詢等功能

1、創建表

SqlSugar支持了3種模式的建表(無實體建表、實體建表，實體特性建表)，非常的靈活

可以多個資料庫 MYSQL MSSQL ORACLE SQLITE PGSQL 等用同一語法創建資料庫，不需要考慮資料庫的相容性

中間標準：

1.1通過特性建表

我們可以通過創建實體來進行建表

public class CodeFirstTable1
{
        [SugarColumn(IsIdentity = true, IsPrimaryKey = true)]
        public int Id { get; set; } 
        public string Name { get; set; }
        //ColumnDataType 自定格式的情況 length不要設置 （想要多庫相容看4.2和9）
        [SugarColumn(ColumnDataType = "Nvarchar(255)")]
        public string Text { get; set; }
        [SugarColumn(IsNullable = true)]//可以為NULL
        public DateTime CreateTime { get; set; }
}
 
/***創建單個表***/
db.CodeFirst.SetStringDefaultLength(200).InitTables(typeof(CodeFirstTable1));//這樣一個表就能成功創建了
/***手動建多個表***/
db.CodeFirst.SetStringDefaultLength(200)
.InitTables(typeof(CodeFirstTable1),typeof(CodeFirstTable2)); 

建表特性如下

　2.2無特性建表

如果我們的實體不需要加特性，那麼我們可以通過特性方式建表

SugarClient db = new SqlSugarClient(new ConnectionConfig()
{
    DbType = DbType.SqlServer,
    ConnectionString = Config.ConnectionString3,
    InitKeyType = InitKeyType.Attribute,
    IsAutoCloseConnection = true,
    ConfigureExternalServices = new ConfigureExternalServices()
    {
        EntityService = (s, p) =>
        {
            //如果是Order實體進行相關配置
            p.IfTable<Order>()
            .UpdateProperty(it => it.id, it =>
            {
                it.IsIdentity = true;
                it.IsPrimarykey = true;
            })
            .UpdateProperty(it => it.Name, it => {
                it.Length = 100;
                it.IsNullable = true;
  
            })
            .OneToOne(it => it.Item, nameof(Order.ItemId));
              
            //如果Custom實體進行相關配置
             p.IfTable<Custom>()
             .UpdateProperty(it => it.id, it =>
             {
                it.IsIdentity = true;
                it.IsPrimarykey = true;
             })
              .UpdateProperty(it => it.Text, it => {
                it.DataType= StaticConfig.CodeFirst_BigString;//支持多庫的MaxString用法
              })
              
                          
            //可以結合全局邏輯一起使用，下麵的和上面的有衝突的話，下麵會覆蓋上面的
               
              
            //統一設置 nullable等於isnullable=true
            //低版本C#看標題2.2 
             if(p.IsPrimaryKey==false&&new NullabilityInfoContext()
                         .Create(c).WriteState is NullabilityState.Nullable)
             {
                           p.IsNullable = true;
             }
              
               
               
        }
    }
});
//性能說明：
//EntityService 相同實體只會執行一次性不需太操作

1.3 無實體建表

功能與實體建類一模一樣，如果使用SqlSugar中間標準可以支持多個資料庫一套代碼建表

 var type = db.DynamicBuilder().CreateClass("UnitEntityA",
                new SugarTable()
                {
                    TableDescription = "表備註",
                    //DisabledUpdateAll=true 可以禁止更新只創建
                }
            )
           .CreateProperty("Id", typeof(int), new SugarColumn() { IsPrimaryKey = true, IsIdentity = true, ColumnDescription = "列備註" }) 
           .CreateProperty("Name", typeof(string), new SugarColumn() {Length=200, ColumnDescription = "列備註" })
           .BuilderType();
 
            db.CodeFirst.InitTables(type);

3、資料庫維護

SqlSugar有一套資料庫維護API,並且能夠很好的支持多種資料庫，例如備份資料庫等常用功能

//例1 獲取所有表
var tables = db.DbMaintenance.GetTableInfoList(false);//true 走緩存 false不走緩存
foreach (var table in tables)
{
     Console.WriteLine(table.Description);//輸出表信息
      
     //獲取列信息
     //var columns=db.DbMaintenance.GetColumnInfosByTableName("表名",false);
}
 
//例2
db.DbMaintenance.IsAnyTable("tablename",false)//驗證表名是否緩存不走緩存

所以API

2、跨庫支持

可以自動識別在哪個庫

實體

 [TenantAttribute("1")]//對應ConfigId
  public class C1Table
  {
     public string Id { get; set; }
  }
    
  [TenantAttribute("2")]
  public class C2Table
  {
      public string Id { get; set; }
  }

查詢

//通過ConfigId進行資料庫區分
var db = new SqlSugarClient(new List<ConnectionConfig>()
{
 //這兒聲名所有上下文都生效
 new ConnectionConfig(){ConfigId="0",DbType=DbType.SqlServer,ConnectionString=..,IsAutoCloseConnection=true},
 new ConnectionConfig(){ConfigId="1",DbType=DbType.MySql,ConnectionString=..,IsAutoCloseConnection=true  }
});
//自動跨庫聯表查詢
var query5 = db.QueryableWithAttr<Order>()//如果MySql和SqlServer自動支持同伺服器的跨庫聯表查詢
         .LeftJoin<Custom>   ((o, cus ) => o.CustomId == cus.Id)//多個條件用&&
         .LeftJoin<OrderDetail> ((o, cus, oritem) => o.Id == oritem.OrderId)
         .Where(o => o.Id == 1)  
         .Select((o, cus , oritem) => new ViewOrder { Id = o.Id, CustomName = cus.Name })
         .ToList();  
//手動跨庫聯表查詢 ，這種方式結合dblink可以跨伺服器
var query5 = db.Queryable().As("xxx.表名")
         .LeftJoin<Custom>   ((o, cus ) => o.CustomId == cus.Id ,"yyyy.表名") 
         .LeftJoin<OrderDetail> ((o, cus, oritem) => o.Id == oritem.OrderId ,"zzzz.名錶")
         .Where(o => o.Id == 1)  
         .Select((o, cus , oritem) => new ViewOrder { Id = o.Id, CustomName = cus.Name })
         .ToList(); 

插入

db.InsertableWithAttr(list).Execommand()

更新

db.UpdateableWithAttr(list).Execommand()

刪除

db.UpdateableWithAttr(list).Execommand()　

　只要實體配置了資料庫，就不要考慮換庫了，直接使用，並且支持事務

 3、過濾器

SqlSugar支持了全新的過濾器，可以是介面，集成該介面的類都生效，支持多表查詢

db.QueryFilter
.AddTableFilter<IDeletedFilter>(it => it.IsDeleted==false)//IDeletedFilter是自定義介面,繼承這個介面的實體有效
.AddTableFilterIF<ITenantFilter>(isAdmint==false,it=>it.OrgId==用戶OrgId);//ITenantFilter自定義介面
 
//用例1：單條語句清空，隻影響當前語句
db.Queryable<Order>().ClearFilter().ToList();//所有過濾器都無效
db.Queryable<Order>().ClearFilter<IDeletedFilter>().ToList();//只有IDeletedFilter過濾器無效
db.Queryable<Order>().ClearFilter<IDeletedFilter,ITenantFilter>().ToList();//IDeletedFilter+ITenantFilter無效
   
//用例2：當前上下文清空 ，不會影響其他請求，只是當前請求清空
db.QueryFilter.Clear();
db.QueryFilter.Clear<IDeletedFilter>(); 
 
//用例3：清空並還原 ，不會影響其他請求，只是當前請求清空
db.QueryFilter.ClearAndBackup();//有多個重載 ClearAndBackup<T,T2>();
db.Queryable<Order>().ToList();
db.QueryFilter.Restore();//還原過濾器 (適合下麵代碼還需要過濾器情況)

4、子查詢升級

1. ToList() 可以直接查詢一個對象

2. First()  可以直接查單個對象

3.ToList(it=>it.Id) 可以查List<int>一個欄位集合

4..SelectStringJoin(z => z.Name, ",") 子查詢將一列用逗號拼接成字元串

 var list=db.Queryable<Order>()
 .Select(it => new
         {
           CustomId = it.CustomId,
           OrderId = it.Id,
           OrderName = it.Name,
           CustomList = SqlFunc.Subqueryable<Custom>().Where(c => c.Id == it.CustomId).ToList()
         })
        .ToList();

5、自定義類型支持

5.1 自定義類型轉換器

下麵只是講解怎麼定義轉換器，ORM自帶的功能就包含下麵功能，只是用來講解

public class DictionaryConvert : ISugarDataConverter
{
public SugarParameter ParameterConverter<T>(object value, int i)
{
//該功能ORM自帶的IsJson就能實現這裡只是用這個用例來給大家學習
var name = "@myp" + i;
var str = new SerializeService().SerializeObject(value);
return new SugarParameter(name, str);
}

public T QueryConverter<T>(IDataRecord dr, int i)
{
//打斷點調試
//該功能ORM自帶的IsJson就能實現這裡只是用這個用例來給大家學習
var str = dr.GetValue(i) + "";
return new SerializeService().DeserializeObject<T>(str);
}
}
//使用自定義轉換器
[SugarColumn(ColumnDataType="varchar(2000)",SqlParameterDbType=typeof(DictionaryConvert))]
public Dictionary<string, object> DcValue { get; set; }//5.1.3.53-preview08　

現有類型支持

5.1 json類型

https://www.donet5.com/Home/Doc?typeId=1232

5.2 枚舉類型 

int存儲:直接用就行了

public DbType DcValue { get; set; }

string存儲：高版本如下寫法

[SugarColumn(ColumnDataType="varchar(20)",SqlParameterDbType=typeof(EnumToStringConvert))]
public DbType DcValue { get; set; }

3.資料庫獨有類型支持
看左邊菜單 【資料庫特性】 該菜單下麵有 SqlServer菜單或者MySql菜單等 ， 針對不同資料庫都有專門的介紹

6、動態建類，CRUD

如果用DataTable和字典去操作資料庫，那麼在多庫相容上是不夠用的，很多實體功能不能用，比如過濾器和AOP等等

SqlSugar支持了 動態建類，來實現CRUD

//動態建類可以繼承介面有重載
var type = db.DynamicBuilder().CreateClass("table1", new SugarTable()
    {
    })
    .CreateProperty("Id", typeof(int),new SugarColumn() { IsPrimaryKey = true, IsIdentity = true })
    .CreateProperty("Name",typeof(string), new SugarColumn() { })
    .WithCache()//緩存起來根據表名和欄位名組合的KEY
    .BuilderType();

    db.CodeFirst.InitTables(type);
            
    var  value= db.DynamicBuilder().CreateObjectByType(type,new Dictionary<string, object>() { { "Id", 1 }, { "Name", "jack" } });
           
    db.InsertableByObject(value).ExecuteCommand();
    db.UpdateableByObject(value).ExecuteCommand();
    db.DeleteableByObject(value).ExecuteCommand();
    db.StorageableByObject(value).ExecuteCommand();//插入或者更新
    db.Queryable<object>().AsType(type).Filter(type).ToList();

總結

SqlSugar在2021年到2022年大量的開源應用使用了SqlSugar,帶動了SqlSugar的快速發展，我這邊要感謝大家

Admin.NET通用管理平臺

ZrAdminNetCore 後臺

管理Yi框架(Ruoyi Vue)

SimpleAdmin (new)

vboot-netmagic.net (Vue2.0)

網關採集系統（Blazor）

RuYiAdmin

CoreShop商城

Blog.Core

YuebonCore

企業級框架Furion   

WebFirst

騰訊APIJSON.NET

WaterCloud微服務

ViperFamilyBucket應用框架通用後臺

SmartSqlWMS倉庫管理系統a

pevolo-apiFytSoaCms 

開源項目地址：https://www.donet5.com/Home/Doc?typeId=1215

喜歡SqlSugar的可以在下麵源碼點個贊，點個關註

SqlSugar源碼： https://github.com/DotNetNext/SqlSugar/