C# 數據操做系列 - 14 深刻探索SqlSugar

0.前言

在上一篇中，咱們知道了如何使用SqlSugar，可是也只是簡單的瞭解瞭如何使用，彷彿是套着鐐銬行走，這明顯不符合一個合格的程序員應有的素養。因此，這一篇咱們將對其進行深挖，探究其背後的祕密。

1. 花式映射

在實際開發中，程序中的實體類和數據庫的表名並不能徹底一致，形成的緣由有不少，例如說團隊對數據庫的命名和對程序的命名有着不一樣的要求，數據庫是先創建的而程序是後開發的，又或者是程序只使用了數據庫中一部分表等等。

這時候就會與C#約定優於配置相違背，可是這也符合C#的設計哲學，由於配置也是C#的一部分。咱們該如何從實際角度來完成表與實體類之間的關係創建呢？

那就讓我來帶着你們一塊兒看看SqlSugar是否能優雅的完成這一部分：

1.1 Attribute設置

SqlSugar預製了一些Attribute，容許咱們經過Attribute來爲實體表與數據庫表之間創建關係：

• SugarTable：用來定義實體類映射的數據表

public SugarTable(string tableName);
public SugarTable(string tableName, string tableDescription);

這是SugarTable的兩個構造函數，容許設置表名和數據表描述

• SugarColumn：用來定義屬性與數據表中的列的關係

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設置數據表的動態配置：

Client.MappingTables.Add

方法有：

public void Add(string entityName, string dbTableName);
public void Add(string entityName, string dbTableName, string dbTableShortName);
public void Add(MappingTable table);

而後經過SugarClient設置列的動態配置：

Client.MmappingColumn.Add

方法有：

public void Add(string propertyName, string dbColumnName, string entityName);
public void Add(MappingColumn col);

顯然，動態配置並不支持設置列的其餘內容。固然，SugarClient還能夠配置忽略字段：

Client.IgnoreColumns.Add

具體實現方法以下：

public void Add(string propertyName, string EntityName);
publiv void Add(IgnoreColumn col);

1.3 As 別名模式

SqlSugar在增刪改查的時候，爲數據實體添加了別名處理，使用方法As(string newName)便可。

Queryable<T>().As("newName")   //select * from newName
Insertable
Updateable
Deleteable

相似與SQL的別名查詢

2. 外鍵關聯

SqlSugar中並無設置導航屬性的正式加載，而是添加了一個Mapper方法：在查詢的時候，調用Mapper映射外鍵關係，以達到導航屬性一塊兒加載的功能。

首先須要注意的是，在SqlSugar中導航屬性須要配置爲忽略，避免被直接解析爲SQL，不然會提示Sequence contains no elements。

添加幾個示例類：

[SugarTable("P_Person")]
public class Person
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    /// <summary>
    /// 忽略
    /// </summary>
    [SugarColumn(IsIgnore = true)]
    public Employee Employee { get; set; }
}

public class Employee
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    public int PersonId { get; set; }
    [SugarColumn(IsIgnore = true)]
    public Person Person { get; set; }
    public int DeptId{get;set;}
    [SugarColumn(IsIgnore = true)]
    public Dept Dept{get;set;}
}

public class Dept
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    [SugarColumn(IsIgnore = true)]
    public List<Employee> Employees{get;set;}
}

使用上一篇的Context類：

public class DefaultContext
{
    public SqlSugarClient Client { get; }

    public DefaultContext(string connectionString, DbType dbType)
    {
        Client = new SqlSugarClient(new ConnectionConfig
        {
            ConnectionString = connectionString,//"Data Source=./demo.db",
            DbType = dbType,
            IsAutoCloseConnection = true,
            InitKeyType = InitKeyType.Attribute
        });
        // == 新增

        Client.CodeFirst.InitTables<Person, Employee, Dept>();
        Client.Aop.OnLogExecuting = (sql, paramters) =>
        {
            Console.WriteLine(sql);
        };
    }
}

簡單介紹一下，

InitTables這個方法，SqlSugar提供了不少重載版本，但推薦使用如下三個：

void InitTables(string entitiesNamespace);
void InitTables(string[] entitiesNamespaces);
void InitTables(params Type[] entityTypes);

前兩個，能夠約定實體類的命名空間，而後一次性初始化全部實體類。第三個初始化傳入的實體類類型實例，也能夠 根據必定規則反射遍歷出須要的類。

OnLogExecuting是SqlSugar 的一個監聽事件（雖然它不是事件，但我我的以爲寫成事件模式比較好），做用是監控框架執行的SQL語句，能夠用來調試或者作日誌監控等。

使用Mapper查詢一對一映射類型：

var results = context.Client.Queryable<Employee>().Mapper(t=>t.Person, p=>p.PersonId).ToList();

使用Mapper查詢一對多映射類型：

var results = context.Client.Queryable<Dept>().Mapper(p => p.Employees, p => p.Employees.First().DeptId).ToList();

須要注意的是，這兩個是固定寫法。

其中，一對一要求必須從主對象開始查詢。所謂主對象就是必須持有一個外鍵指向另外一個表。

一對多要求從擁有集合屬性的那段（也就是其中的「一」）開始，關聯指示爲 集合.First().外鍵 。

還有一點就是SqlSugar的導航屬性必須手動加載，不會自動加載進來，因此徹底不會出現深度遞歸的問題。

3. 總結

這一篇咱們一塊兒探索瞭如何自定義表和實體類之間的映射關係，下一篇將爲你們寫一個實用的模板類，包括數據庫基本查詢功能。以上是本篇內容，期待後續哦～