C# 中SqlSugar如何使用

1. 花式映射

在實(shí)際開(kāi)發(fā)中，程序中的實(shí)體類和數(shù)據(jù)庫(kù)的表名并不能完全一致，造成的原因有很多，例如說(shuō)團(tuán)隊(duì)對(duì)數(shù)據(jù)庫(kù)的命名和對(duì)程序的命名有著不同的要求，數(shù)據(jù)庫(kù)是先建立的而程序是后開(kāi)發(fā)的，又或者是程序只使用了數(shù)據(jù)庫(kù)中一部分表等等。

這時(shí)候就會(huì)與C#約定優(yōu)于配置相違背，但是這也符合C#的設(shè)計(jì)哲學(xué)，因?yàn)榕渲靡彩荂#的一部分。我們?cè)撊绾螐膶?shí)際角度來(lái)完成表與實(shí)體類之間的關(guān)系建立呢？

那就讓我來(lái)帶著大家一起看看SqlSugar是否能優(yōu)雅的完成這一部分：

1.1 Attribute設(shè)置

SqlSugar預(yù)制了一些Attribute，允許我們通過(guò)Attribute來(lái)為實(shí)體表與數(shù)據(jù)庫(kù)表之間建立關(guān)系：

• SugarTable：用來(lái)定義實(shí)體類映射的數(shù)據(jù)表

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

這是SugarTable的兩個(gè)構(gòu)造函數(shù)，允許設(shè)置表名和數(shù)據(jù)表描述

• SugarColumn：用來(lái)定義屬性與數(shù)據(jù)表中的列的關(guān)系

public string ColumnDataType { get; set; }// 列的數(shù)據(jù)類型，填SQL 的數(shù)據(jù)類型
public string OldColumnName { get; set; }// 當(dāng)做了表更新之后，用來(lái)生成數(shù)據(jù)庫(kù)用，此處填寫(xiě)原列名
public bool IsNullable { get; set; }// 設(shè)置列是否允許為NULL
public int Length { get; set; } // 設(shè)置列的數(shù)據(jù)長(zhǎng)度
public string ColumnDescription { get; set; }// 設(shè)置列的描述名稱
public bool IsIdentity { get; set; }         // 設(shè)置該列是否是自增列
public bool IsPrimaryKey { get; set; }        //設(shè)置該列是主鍵
public bool IsIgnore { get; set; }            // 不作數(shù)據(jù)庫(kù)操作，true將不會(huì)進(jìn)行查詢、添加等操作
public string ColumnName { get; set; }        // 設(shè)置對(duì)應(yīng)的列名
public string DefaultValue { get; set; }    // 設(shè)置該列的默認(rèn)值

SqlSugar的Attribute配置非常的簡(jiǎn)單，只需要針對(duì)類與表的映射和屬性對(duì)列的映射做出配置即可。

1.2 動(dòng)態(tài)配置

與EF等一樣，SqlSugar也支持動(dòng)態(tài)配置，那么就跟著我一起去看看，如何實(shí)現(xiàn)動(dòng)態(tài)配置吧：

SqlSugar支持的動(dòng)態(tài)配置功能較少，最好是預(yù)先設(shè)計(jì)好了數(shù)據(jù)庫(kù)，然后使用動(dòng)態(tài)配置做好關(guān)聯(lián)。

通過(guò)SugarClient設(shè)置數(shù)據(jù)表的動(dòng)態(tài)配置：

Client.MappingTables.Add

方法有：

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

然后通過(guò)SugarClient設(shè)置列的動(dòng)態(tài)配置：

Client.MmappingColumn.Add

方法有：

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

顯然，動(dòng)態(tài)配置并不支持設(shè)置列的其他內(nèi)容。當(dāng)然，SugarClient還可以配置忽略字段：

Client.IgnoreColumns.Add

具體實(shí)現(xiàn)方法如下：

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

1.3 As 別名模式

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

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

類似與SQL的別名查詢

2. 外鍵關(guān)聯(lián)

SqlSugar中并沒(méi)有設(shè)置導(dǎo)航屬性的正式加載，而是添加了一個(gè)Mapper方法：在查詢的時(shí)候，調(diào)用Mapper映射外鍵關(guān)系，以達(dá)到導(dǎo)航屬性一起加載的功能。

首先需要注意的是，在SqlSugar中導(dǎo)航屬性需要配置為忽略，避免被直接解析為SQL，否則會(huì)提示Sequence contains no elements。

添加幾個(gè)示例類：

[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);
        };
    }
}

簡(jiǎn)單介紹一下，

InitTables這個(gè)方法，SqlSugar提供了很多重載版本，但推薦使用以下三個(gè)：

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

前兩個(gè)，可以約定實(shí)體類的命名空間，然后一次性初始化所有實(shí)體類。第三個(gè)初始化傳入的實(shí)體類類型實(shí)例，也可以 根據(jù)一定規(guī)則反射遍歷出需要的類。

OnLogExecuting是SqlSugar 的一個(gè)監(jiān)聽(tīng)事件（雖然它不是事件，但我個(gè)人覺(jué)得寫(xiě)成事件模式比較好），作用是監(jiān)控框架執(zhí)行的SQL語(yǔ)句，可以用來(lái)調(diào)試或者做日志監(jiān)控等。

使用Mapper查詢一對(duì)一映射類型：

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

使用Mapper查詢一對(duì)多映射類型：

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

需要注意的是，這兩個(gè)是固定寫(xiě)法。

其中，一對(duì)一要求必須從主對(duì)象開(kāi)始查詢。所謂主對(duì)象就是必須持有一個(gè)外鍵指向另一個(gè)表。

一對(duì)多要求從擁有集合屬性的那段（也就是其中的“一”）開(kāi)始，關(guān)聯(lián)指示為 集合.First().外鍵 。

還有一點(diǎn)就是SqlSugar的導(dǎo)航屬性必須手動(dòng)加載，不會(huì)自動(dòng)加載進(jìn)來(lái)，所以完全不會(huì)出現(xiàn)深度遞歸的問(wèn)題。