C# 資料操作系列 - 14 深入探索SqlSugar
阿新 • • 發佈:2020-05-23
# 0.前言
在上一篇中,我們知道了如何使用SqlSugar,但是也只是簡單的瞭解瞭如何使用,彷彿是套著鐐銬行走,這明顯不符合一個合格的程式設計師應有的素養。所以,這一篇我們將對其進行深挖,探究其背後的祕密。
# 1. 花式對映
在實際開發中,程式中的實體類和資料庫的表名並不能完全一致,造成的原因有很多,例如說團隊對資料庫的命名和對程式的命名有著不同的要求,資料庫是先建立的而程式是後開發的,又或者是程式只使用了資料庫中一部分表等等。
這時候就會與C#約定優於配置相違背,但是這也符合C#的設計哲學,因為配置也是C#的一部分。我們該如何從實際角度來完成表與實體類之間的關係建立呢?
那就讓我來帶著大家一起看看SqlSugar是否能優雅的完成這一部分:
## 1.1 Attribute設定
SqlSugar預製了一些Attribute,允許我們通過Attribute來為實體表與資料庫表之間建立關係:
- SugarTable:用來定義實體類對映的資料表
```c#
public SugarTable(string tableName);
public SugarTable(string tableName, string tableDescription);
```
這是SugarTable的兩個建構函式,允許設定表名和資料表描述
- SugarColumn:用來定義屬性與資料表中的列的關係
```c#
public string ColumnDataType { get; set; }// 列的資料型別,填SQL 的資料型別
public string OldColumnName { get; set; }// 當做了表更新之後,用來生成資料庫用,此處填寫原列名
public bool IsNullable { get; set; }// 設定列是否允許為NULL
public int Length { get; set; } // 設定列的資料長度
public string ColumnDescription { get; set; }// 設定列的描述名稱
public bool IsIdentity { get; set; } // 設定該列是否是自增列
public bool IsPrimaryKey { get; set; } //設定該列是主鍵
public bool IsIgnore { get; set; } // 不作資料庫操作,true將不會進行查詢、新增等操作
public string ColumnName { get; set; } // 設定對應的列名
public string DefaultValue { get; set; } // 設定該列的預設值
```
SqlSugar的Attribute配置非常的簡單,只需要針對類與表的對映和屬性對列的對映做出配置即可。
## 1.2 動態配置
與EF等一樣,SqlSugar也支援動態配置,那麼就跟著我一起去看看,如何實現動態配置吧:
SqlSugar支援的動態配置功能較少,最好是預先設計好了資料庫,然後使用動態配置做好關聯。
通過SugarClient設定資料表的動態配置:
```c#
Client.MappingTables.Add
```
方法有:
```c#
public void Add(string entityName, string dbTableName);
public void Add(string entityName, string dbTableName, string dbTableShortName);
public void Add(MappingTable table);
```
然後通過SugarClient設定列的動態配置:
```c#
Client.MmappingColumn.Add
```
方法有:
```c#
public void Add(string propertyName, string dbColumnName, string entityName);
public void Add(MappingColumn col);
```
顯然,動態配置並不支援設定列的其他內容。當然,SugarClient還可以配置忽略欄位:
```c#
Client.IgnoreColumns.Add
```
具體實現方法如下:
```c#
public void Add(string propertyName, string EntityName);
publiv void Add(IgnoreColumn col);
```
## 1.3 As 別名模式
SqlSugar在增刪改查的時候,為資料實體添加了別名處理,使用方法As(string newName)即可。
```c#
Q